efe5049d2be2121fd981ef54d27978a95c78d2f3
[vlc.git] / src / misc / configuration.c
1 /*****************************************************************************
2  * configuration.c management of the modules configuration
3  *****************************************************************************
4  * Copyright (C) 2001-2004 the VideoLAN team
5  * $Id$
6  *
7  * Authors: Gildas Bazin <gbazin@videolan.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 #include <vlc/vlc.h>
25 #include "vlc_keys.h"
26 #include "charset.h"
27
28 #include <stdio.h>                                              /* sprintf() */
29 #include <stdlib.h>                                      /* free(), strtol() */
30 #include <string.h>                                              /* strdup() */
31 #include <errno.h>                                                  /* errno */
32
33 #ifdef HAVE_LIMITS_H
34 #   include <limits.h>
35 #endif
36
37 #ifdef HAVE_UNISTD_H
38 #    include <unistd.h>                                          /* getuid() */
39 #endif
40
41 #ifdef HAVE_GETOPT_LONG
42 #   ifdef HAVE_GETOPT_H
43 #       include <getopt.h>                                       /* getopt() */
44 #   endif
45 #else
46 #   include "../extras/getopt.h"
47 #endif
48
49 #if defined(HAVE_GETPWUID)
50 #   include <pwd.h>                                            /* getpwuid() */
51 #endif
52
53 #if defined( HAVE_SYS_STAT_H )
54 #   include <sys/stat.h>
55 #endif
56 #if defined( HAVE_SYS_TYPES_H )
57 #   include <sys/types.h>
58 #endif
59 #if defined( WIN32 )
60 #   if !defined( UNDER_CE )
61 #       include <direct.h>
62 #   endif
63 #include <tchar.h>
64 #endif
65
66 static int ConfigStringToKey( char * );
67 static char *ConfigKeyToString( int );
68
69 /*****************************************************************************
70  * config_GetType: get the type of a variable (bool, int, float, string)
71  *****************************************************************************
72  * This function is used to get the type of a variable from its name.
73  * Beware, this is quite slow.
74  *****************************************************************************/
75 int __config_GetType( vlc_object_t *p_this, const char *psz_name )
76 {
77     module_config_t *p_config;
78     int i_type;
79
80     p_config = config_FindConfig( p_this, psz_name );
81
82     /* sanity checks */
83     if( !p_config )
84     {
85         return 0;
86     }
87
88     switch( p_config->i_type )
89     {
90     case CONFIG_ITEM_BOOL:
91         i_type = VLC_VAR_BOOL;
92         break;
93
94     case CONFIG_ITEM_INTEGER:
95         i_type = VLC_VAR_INTEGER;
96         break;
97
98     case CONFIG_ITEM_FLOAT:
99         i_type = VLC_VAR_FLOAT;
100         break;
101
102     case CONFIG_ITEM_MODULE:
103     case CONFIG_ITEM_MODULE_CAT:
104     case CONFIG_ITEM_MODULE_LIST:
105     case CONFIG_ITEM_MODULE_LIST_CAT:
106         i_type = VLC_VAR_MODULE;
107         break;
108
109     case CONFIG_ITEM_STRING:
110         i_type = VLC_VAR_STRING;
111         break;
112
113     case CONFIG_ITEM_FILE:
114         i_type = VLC_VAR_FILE;
115         break;
116
117     case CONFIG_ITEM_DIRECTORY:
118         i_type = VLC_VAR_DIRECTORY;
119         break;
120
121     default:
122         i_type = 0;
123         break;
124     }
125
126     return i_type;
127 }
128
129 /*****************************************************************************
130  * config_GetInt: get the value of an int variable
131  *****************************************************************************
132  * This function is used to get the value of variables which are internally
133  * represented by an integer (CONFIG_ITEM_INTEGER and
134  * CONFIG_ITEM_BOOL).
135  *****************************************************************************/
136 int __config_GetInt( vlc_object_t *p_this, const char *psz_name )
137 {
138     module_config_t *p_config;
139
140     p_config = config_FindConfig( p_this, psz_name );
141
142     /* sanity checks */
143     if( !p_config )
144     {
145         msg_Err( p_this, "option %s does not exist", psz_name );
146         return -1;
147     }
148     if( (p_config->i_type!=CONFIG_ITEM_INTEGER) &&
149         (p_config->i_type!=CONFIG_ITEM_KEY) &&
150         (p_config->i_type!=CONFIG_ITEM_BOOL) )
151     {
152         msg_Err( p_this, "option %s does not refer to an int", psz_name );
153         return -1;
154     }
155
156     return p_config->i_value;
157 }
158
159 /*****************************************************************************
160  * config_GetFloat: get the value of a float variable
161  *****************************************************************************
162  * This function is used to get the value of variables which are internally
163  * represented by a float (CONFIG_ITEM_FLOAT).
164  *****************************************************************************/
165 float __config_GetFloat( vlc_object_t *p_this, const char *psz_name )
166 {
167     module_config_t *p_config;
168
169     p_config = config_FindConfig( p_this, psz_name );
170
171     /* sanity checks */
172     if( !p_config )
173     {
174         msg_Err( p_this, "option %s does not exist", psz_name );
175         return -1;
176     }
177     if( p_config->i_type != CONFIG_ITEM_FLOAT )
178     {
179         msg_Err( p_this, "option %s does not refer to a float", psz_name );
180         return -1;
181     }
182
183     return p_config->f_value;
184 }
185
186 /*****************************************************************************
187  * config_GetPsz: get the string value of a string variable
188  *****************************************************************************
189  * This function is used to get the value of variables which are internally
190  * represented by a string (CONFIG_ITEM_STRING, CONFIG_ITEM_FILE,
191  * CONFIG_ITEM_DIRECTORY, and CONFIG_ITEM_MODULE).
192  *
193  * Important note: remember to free() the returned char* because it's a
194  *   duplicate of the actual value. It isn't safe to return a pointer to the
195  *   actual value as it can be modified at any time.
196  *****************************************************************************/
197 char * __config_GetPsz( vlc_object_t *p_this, const char *psz_name )
198 {
199     module_config_t *p_config;
200     char *psz_value = NULL;
201
202     p_config = config_FindConfig( p_this, psz_name );
203
204     /* sanity checks */
205     if( !p_config )
206     {
207         msg_Err( p_this, "option %s does not exist", psz_name );
208         return NULL;
209     }
210     if( (p_config->i_type!=CONFIG_ITEM_STRING) &&
211         (p_config->i_type!=CONFIG_ITEM_FILE) &&
212         (p_config->i_type!=CONFIG_ITEM_DIRECTORY) &&
213         (p_config->i_type!=CONFIG_ITEM_MODULE_LIST) &&
214         (p_config->i_type!=CONFIG_ITEM_MODULE_LIST_CAT) &&
215         (p_config->i_type!=CONFIG_ITEM_MODULE_CAT) &&
216         (p_config->i_type!=CONFIG_ITEM_MODULE) )
217     {
218         msg_Err( p_this, "option %s does not refer to a string", psz_name );
219         return NULL;
220     }
221
222
223     /* return a copy of the string */
224     vlc_mutex_lock( p_config->p_lock );
225     if( p_config->psz_value ) psz_value = strdup( p_config->psz_value );
226     vlc_mutex_unlock( p_config->p_lock );
227
228     return psz_value;
229 }
230
231 /*****************************************************************************
232  * config_PutPsz: set the string value of a string variable
233  *****************************************************************************
234  * This function is used to set the value of variables which are internally
235  * represented by a string (CONFIG_ITEM_STRING, CONFIG_ITEM_FILE,
236  * CONFIG_ITEM_DIRECTORY, and CONFIG_ITEM_MODULE).
237  *****************************************************************************/
238 void __config_PutPsz( vlc_object_t *p_this,
239                       const char *psz_name, const char *psz_value )
240 {
241     module_config_t *p_config;
242     vlc_value_t oldval, val;
243
244     p_config = config_FindConfig( p_this, psz_name );
245
246
247     /* sanity checks */
248     if( !p_config )
249     {
250         msg_Warn( p_this, "option %s does not exist", psz_name );
251         return;
252     }
253     if( (p_config->i_type!=CONFIG_ITEM_STRING) &&
254         (p_config->i_type!=CONFIG_ITEM_FILE) &&
255         (p_config->i_type!=CONFIG_ITEM_DIRECTORY) &&
256         (p_config->i_type!=CONFIG_ITEM_MODULE_LIST) &&
257         (p_config->i_type!=CONFIG_ITEM_MODULE_CAT) &&
258         (p_config->i_type!=CONFIG_ITEM_MODULE_LIST_CAT) &&
259         (p_config->i_type!=CONFIG_ITEM_MODULE) )
260     {
261         msg_Err( p_this, "option %s does not refer to a string", psz_name );
262         return;
263     }
264
265     vlc_mutex_lock( p_config->p_lock );
266
267     /* backup old value */
268     oldval.psz_string = p_config->psz_value;
269
270     if( psz_value && *psz_value ) p_config->psz_value = strdup( psz_value );
271     else p_config->psz_value = NULL;
272
273     p_config->b_dirty = VLC_TRUE;
274
275     val.psz_string = p_config->psz_value;
276
277     vlc_mutex_unlock( p_config->p_lock );
278
279     if( p_config->pf_callback )
280     {
281         p_config->pf_callback( p_this, psz_name, oldval, val,
282                                p_config->p_callback_data );
283     }
284
285     /* free old string */
286     if( oldval.psz_string ) free( oldval.psz_string );
287 }
288
289 /*****************************************************************************
290  * config_PutInt: set the integer value of an int variable
291  *****************************************************************************
292  * This function is used to set the value of variables which are internally
293  * represented by an integer (CONFIG_ITEM_INTEGER and
294  * CONFIG_ITEM_BOOL).
295  *****************************************************************************/
296 void __config_PutInt( vlc_object_t *p_this, const char *psz_name, int i_value )
297 {
298     module_config_t *p_config;
299     vlc_value_t oldval, val;
300
301     p_config = config_FindConfig( p_this, psz_name );
302
303     /* sanity checks */
304     if( !p_config )
305     {
306         msg_Warn( p_this, "option %s does not exist", psz_name );
307         return;
308     }
309     if( (p_config->i_type!=CONFIG_ITEM_INTEGER) &&
310         (p_config->i_type!=CONFIG_ITEM_KEY) &&
311         (p_config->i_type!=CONFIG_ITEM_BOOL) )
312     {
313         msg_Err( p_this, "option %s does not refer to an int", psz_name );
314         return;
315     }
316
317     /* backup old value */
318     oldval.i_int = p_config->i_value;
319
320     /* if i_min == i_max == 0, then do not use them */
321     if ((p_config->i_min == 0) && (p_config->i_max == 0))
322     {
323         p_config->i_value = i_value;
324     }
325     else if (i_value < p_config->i_min)
326     {
327         p_config->i_value = p_config->i_min;
328     }
329     else if (i_value > p_config->i_max)
330     {
331         p_config->i_value = p_config->i_max;
332     }
333     else
334     {
335         p_config->i_value = i_value;
336     }
337
338     p_config->b_dirty = VLC_TRUE;
339
340     val.i_int = p_config->i_value;
341
342     if( p_config->pf_callback )
343     {
344         p_config->pf_callback( p_this, psz_name, oldval, val,
345                                p_config->p_callback_data );
346     }
347 }
348
349 /*****************************************************************************
350  * config_PutFloat: set the value of a float variable
351  *****************************************************************************
352  * This function is used to set the value of variables which are internally
353  * represented by a float (CONFIG_ITEM_FLOAT).
354  *****************************************************************************/
355 void __config_PutFloat( vlc_object_t *p_this,
356                         const char *psz_name, float f_value )
357 {
358     module_config_t *p_config;
359     vlc_value_t oldval, val;
360
361     p_config = config_FindConfig( p_this, psz_name );
362
363     /* sanity checks */
364     if( !p_config )
365     {
366         msg_Warn( p_this, "option %s does not exist", psz_name );
367         return;
368     }
369     if( p_config->i_type != CONFIG_ITEM_FLOAT )
370     {
371         msg_Err( p_this, "option %s does not refer to a float", psz_name );
372         return;
373     }
374
375     /* backup old value */
376     oldval.f_float = p_config->f_value;
377
378     /* if f_min == f_max == 0, then do not use them */
379     if ((p_config->f_min == 0) && (p_config->f_max == 0))
380     {
381         p_config->f_value = f_value;
382     }
383     else if (f_value < p_config->f_min)
384     {
385         p_config->f_value = p_config->f_min;
386     }
387     else if (f_value > p_config->f_max)
388     {
389         p_config->f_value = p_config->f_max;
390     }
391     else
392     {
393         p_config->f_value = f_value;
394     }
395
396     p_config->b_dirty = VLC_TRUE;
397
398     val.f_float = p_config->f_value;
399
400     if( p_config->pf_callback )
401     {
402         p_config->pf_callback( p_this, psz_name, oldval, val,
403                                p_config->p_callback_data );
404     }
405 }
406
407 /*****************************************************************************
408  * config_FindConfig: find the config structure associated with an option.
409  *****************************************************************************
410  * FIXME: This function really needs to be optimized.
411  * FIXME: And now even more.
412  *****************************************************************************/
413 module_config_t *config_FindConfig( vlc_object_t *p_this, const char *psz_name )
414 {
415     vlc_list_t *p_list;
416     module_t *p_parser;
417     module_config_t *p_item;
418     int i_index;
419
420     if( !psz_name ) return NULL;
421
422     p_list = vlc_list_find( p_this, VLC_OBJECT_MODULE, FIND_ANYWHERE );
423
424     for( i_index = 0; i_index < p_list->i_count; i_index++ )
425     {
426         p_parser = (module_t *)p_list->p_values[i_index].p_object ;
427
428         if( !p_parser->i_config_items )
429             continue;
430
431         for( p_item = p_parser->p_config;
432              p_item->i_type != CONFIG_HINT_END;
433              p_item++ )
434         {
435             if( p_item->i_type & CONFIG_HINT )
436                 /* ignore hints */
437                 continue;
438             if( !strcmp( psz_name, p_item->psz_name ) )
439             {
440                 vlc_list_release( p_list );
441                 return p_item;
442             }
443         }
444     }
445
446     vlc_list_release( p_list );
447
448     return NULL;
449 }
450
451 /*****************************************************************************
452  * config_FindModule: find a specific module structure.
453  *****************************************************************************/
454 module_t *config_FindModule( vlc_object_t *p_this, const char *psz_name )
455 {
456     vlc_list_t *p_list;
457     module_t *p_module, *p_result = NULL;
458     int i_index;
459
460     if( !psz_name ) return NULL;
461
462     p_list = vlc_list_find( p_this, VLC_OBJECT_MODULE, FIND_ANYWHERE );
463
464     for( i_index = 0; i_index < p_list->i_count; i_index++ )
465     {
466         p_module = (module_t *)p_list->p_values[i_index].p_object;
467         if( !strcmp( p_module->psz_object_name, psz_name ) )
468         {
469              p_result = p_module;
470              break;
471         }
472     }
473
474     vlc_list_release( p_list );
475
476     return p_result;
477 }
478
479 /*****************************************************************************
480  * config_Duplicate: creates a duplicate of a module's configuration data.
481  *****************************************************************************
482  * Unfortunatly we cannot work directly with the module's config data as
483  * this module might be unloaded from memory at any time (remember HideModule).
484  * This is why we need to create an exact copy of the config data.
485  *****************************************************************************/
486 void config_Duplicate( module_t *p_module, module_config_t *p_orig )
487 {
488     int i, j, i_lines = 1;
489     module_config_t *p_item;
490
491     /* Calculate the structure length */
492     p_module->i_config_items = 0;
493     p_module->i_bool_items = 0;
494
495     for( p_item = p_orig; p_item->i_type != CONFIG_HINT_END; p_item++ )
496     {
497         i_lines++;
498
499         if( p_item->i_type & CONFIG_ITEM )
500         {
501             p_module->i_config_items++;
502         }
503
504         if( p_item->i_type == CONFIG_ITEM_BOOL )
505         {
506             p_module->i_bool_items++;
507         }
508     }
509
510     /* Allocate memory */
511     p_module->p_config = (module_config_t *)malloc( sizeof(module_config_t)
512                                                      * i_lines );
513     if( p_module->p_config == NULL )
514     {
515         msg_Err( p_module, "config error: can't duplicate p_config" );
516         return;
517     }
518
519     /* Do the duplication job */
520     for( i = 0; i < i_lines ; i++ )
521     {
522         p_module->p_config[i] = p_orig[i];
523
524         p_module->p_config[i].i_value_orig = p_orig[i].i_value;
525         p_module->p_config[i].f_value_orig = p_orig[i].f_value;
526         p_module->p_config[i].i_value_saved = p_orig[i].i_value;
527         p_module->p_config[i].f_value_saved = p_orig[i].f_value;
528         p_module->p_config[i].psz_value_saved = 0;
529
530         p_module->p_config[i].psz_type = p_orig[i].psz_type ?
531                                    strdup( p_orig[i].psz_type ) : NULL;
532         p_module->p_config[i].psz_name = p_orig[i].psz_name ?
533                                    strdup( p_orig[i].psz_name ) : NULL;
534         p_module->p_config[i].psz_current = p_orig[i].psz_current?
535                                    strdup( p_orig[i].psz_current ) : NULL;
536         p_module->p_config[i].psz_text = p_orig[i].psz_text ?
537                                    strdup( _(p_orig[i].psz_text) ) : NULL;
538         p_module->p_config[i].psz_longtext = p_orig[i].psz_longtext ?
539                                    strdup( _(p_orig[i].psz_longtext) ) : NULL;
540         p_module->p_config[i].psz_value = p_orig[i].psz_value ?
541                                    strdup( p_orig[i].psz_value ) : NULL;
542         p_module->p_config[i].psz_value_orig = p_orig[i].psz_value ?
543                                    strdup( p_orig[i].psz_value ) : NULL;
544
545         p_module->p_config[i].p_lock = &p_module->object_lock;
546
547         /* duplicate the string list */
548         if( p_orig[i].i_list )
549         {
550             if( p_orig[i].ppsz_list )
551             {
552                 p_module->p_config[i].ppsz_list =
553                     malloc( (p_orig[i].i_list + 1) * sizeof(char *) );
554                 if( p_module->p_config[i].ppsz_list )
555                 {
556                     for( j = 0; j < p_orig[i].i_list; j++ )
557                         p_module->p_config[i].ppsz_list[j] = p_orig[i].ppsz_list[j] ?
558                             strdup( p_orig[i].ppsz_list[j] ) : NULL ;
559                     p_module->p_config[i].ppsz_list[j] = NULL;
560                 }
561             }
562             if( p_orig[i].ppsz_list_text )
563             {
564                 p_module->p_config[i].ppsz_list_text =
565                     malloc( (p_orig[i].i_list + 1) * sizeof(char *) );
566                 if( p_module->p_config[i].ppsz_list_text )
567                 {
568                     for( j = 0; j < p_orig[i].i_list; j++ )
569                         p_module->p_config[i].ppsz_list_text[j] = _(p_orig[i].ppsz_list_text[j]) ?
570                             strdup( _(p_orig[i].ppsz_list_text[j] ) ) : NULL ;
571                     p_module->p_config[i].ppsz_list_text[j] = NULL;
572                 }
573             }
574             if( p_orig[i].pi_list )
575             {
576                 p_module->p_config[i].pi_list =
577                     malloc( (p_orig[i].i_list + 1) * sizeof(int) );
578                 if( p_module->p_config[i].pi_list )
579                 {
580                     for( j = 0; j < p_orig[i].i_list; j++ )
581                         p_module->p_config[i].pi_list[j] =
582                             p_orig[i].pi_list[j];
583                 }
584             }
585         }
586
587         /* duplicate the actions list */
588         if( p_orig[i].i_action )
589         {
590             int j;
591
592             p_module->p_config[i].ppf_action =
593                 malloc( p_orig[i].i_action * sizeof(void *) );
594             p_module->p_config[i].ppsz_action_text =
595                 malloc( p_orig[i].i_action * sizeof(char *) );
596
597             for( j = 0; j < p_orig[i].i_action; j++ )
598             {
599                 p_module->p_config[i].ppf_action[j] =
600                     p_orig[i].ppf_action[j];
601                 p_module->p_config[i].ppsz_action_text[j] =
602                     p_orig[i].ppsz_action_text[j] ?
603                     strdup( p_orig[i].ppsz_action_text[j] ) : NULL;
604             }
605         }
606
607         p_module->p_config[i].pf_callback = p_orig[i].pf_callback;
608     }
609 }
610
611 /*****************************************************************************
612  * config_Free: frees a duplicated module's configuration data.
613  *****************************************************************************
614  * This function frees all the data duplicated by config_Duplicate.
615  *****************************************************************************/
616 void config_Free( module_t *p_module )
617 {
618     module_config_t *p_item = p_module->p_config;
619     int i;
620
621     if( p_item == NULL )
622     {
623         return;
624     }
625
626     for( ; p_item->i_type != CONFIG_HINT_END ; p_item++ )
627     {
628         if( p_item->psz_type )
629             free( p_item->psz_type );
630
631         if( p_item->psz_name )
632             free( p_item->psz_name );
633
634         if( p_item->psz_current )
635             free( p_item->psz_current );
636
637         if( p_item->psz_text )
638             free( p_item->psz_text );
639
640         if( p_item->psz_longtext )
641             free( p_item->psz_longtext );
642
643         if( p_item->psz_value )
644             free( p_item->psz_value );
645
646         if( p_item->psz_value_orig )
647             free( p_item->psz_value_orig );
648
649         if( p_item->psz_value_saved )
650             free( p_item->psz_value_saved );
651
652         if( p_item->i_list )
653         {
654             for( i = 0; i < p_item->i_list; i++ )
655             {
656                 if( p_item->ppsz_list && p_item->ppsz_list[i] )
657                     free( p_item->ppsz_list[i] );
658                 if( p_item->ppsz_list_text && p_item->ppsz_list_text[i] )
659                     free( p_item->ppsz_list_text[i] );
660             }
661             if( p_item->ppsz_list ) free( p_item->ppsz_list );
662             if( p_item->ppsz_list_text ) free( p_item->ppsz_list_text );
663             if( p_item->pi_list ) free( p_item->pi_list );
664         }
665
666         if( p_item->i_action )
667         {
668             for( i = 0; i < p_item->i_action; i++ )
669             {
670                 if( p_item->ppsz_action_text[i] )
671                     free( p_item->ppsz_action_text[i] );
672             }
673             if( p_item->ppf_action ) free( p_item->ppf_action );
674             if( p_item->ppsz_action_text ) free( p_item->ppsz_action_text );
675         }
676     }
677
678     free( p_module->p_config );
679     p_module->p_config = NULL;
680 }
681
682 /*****************************************************************************
683  * config_SetCallbacks: sets callback functions in the duplicate p_config.
684  *****************************************************************************
685  * Unfortunatly we cannot work directly with the module's config data as
686  * this module might be unloaded from memory at any time (remember HideModule).
687  * This is why we need to duplicate callbacks each time we reload the module.
688  *****************************************************************************/
689 void config_SetCallbacks( module_config_t *p_new, module_config_t *p_orig )
690 {
691     while( p_new->i_type != CONFIG_HINT_END )
692     {
693         p_new->pf_callback = p_orig->pf_callback;
694         p_new++;
695         p_orig++;
696     }
697 }
698
699 /*****************************************************************************
700  * config_UnsetCallbacks: unsets callback functions in the duplicate p_config.
701  *****************************************************************************
702  * We simply undo what we did in config_SetCallbacks.
703  *****************************************************************************/
704 void config_UnsetCallbacks( module_config_t *p_new )
705 {
706     while( p_new->i_type != CONFIG_HINT_END )
707     {
708         p_new->pf_callback = NULL;
709         p_new++;
710     }
711 }
712
713 /*****************************************************************************
714  * config_ResetAll: reset the configuration data for all the modules.
715  *****************************************************************************/
716 void __config_ResetAll( vlc_object_t *p_this )
717 {
718     int i_index, i;
719     vlc_list_t *p_list;
720     module_t *p_module;
721
722     /* Acquire config file lock */
723     vlc_mutex_lock( &p_this->p_libvlc->config_lock );
724
725     p_list = vlc_list_find( p_this, VLC_OBJECT_MODULE, FIND_ANYWHERE );
726
727     for( i_index = 0; i_index < p_list->i_count; i_index++ )
728     {
729         p_module = (module_t *)p_list->p_values[i_index].p_object ;
730         if( p_module->b_submodule ) continue;
731
732         for( i = 0; p_module->p_config[i].i_type != CONFIG_HINT_END; i++ )
733         {
734             p_module->p_config[i].i_value = p_module->p_config[i].i_value_orig;
735             p_module->p_config[i].f_value = p_module->p_config[i].f_value_orig;
736             if( p_module->p_config[i].psz_value )
737                 free( p_module->p_config[i].psz_value );
738             p_module->p_config[i].psz_value =
739                 p_module->p_config[i].psz_value_orig ?
740                 strdup( p_module->p_config[i].psz_value_orig ) : NULL;
741         }
742     }
743
744     vlc_list_release( p_list );
745     vlc_mutex_unlock( &p_this->p_libvlc->config_lock );
746 }
747
748 /*****************************************************************************
749  * config_LoadConfigFile: loads the configuration file.
750  *****************************************************************************
751  * This function is called to load the config options stored in the config
752  * file.
753  *****************************************************************************/
754 int __config_LoadConfigFile( vlc_object_t *p_this, const char *psz_module_name )
755 {
756     vlc_list_t *p_list;
757     module_t *p_parser;
758     module_config_t *p_item;
759     FILE *file;
760     char line[1024];
761     char *p_index, *psz_option_name, *psz_option_value;
762     char *psz_filename, *psz_homedir, *psz_configfile;
763     int i_index;
764
765     psz_configfile = p_this->p_libvlc->psz_configfile;
766     if( !psz_configfile || !psz_configfile )
767     {
768         psz_homedir = p_this->p_libvlc->psz_homedir;
769         if( !psz_homedir )
770         {
771             msg_Err( p_this, "psz_homedir is null" );
772             return -1;
773         }
774         psz_filename = (char *)malloc( sizeof("/" CONFIG_DIR "/" CONFIG_FILE) +
775                                        strlen(psz_homedir) );
776         if( psz_filename )
777             sprintf( psz_filename,
778                      "%s" DIR_SEP CONFIG_DIR DIR_SEP CONFIG_FILE,
779                      psz_homedir );
780     }
781     else
782     {
783         psz_filename = strdup( psz_configfile );
784     }
785
786     if( !psz_filename )
787     {
788         msg_Err( p_this, "out of memory" );
789         return -1;
790     }
791
792     msg_Dbg( p_this, "opening config file %s", psz_filename );
793
794     /* Acquire config file lock */
795     vlc_mutex_lock( &p_this->p_libvlc->config_lock );
796
797     file = utf8_fopen( psz_filename, "rt" );
798     if( !file )
799     {
800         msg_Warn( p_this, "config file %s does not exist yet", psz_filename );
801         free( psz_filename );
802         vlc_mutex_unlock( &p_this->p_libvlc->config_lock );
803         return -1;
804     }
805
806     /* Look for the selected module, if NULL then save everything */
807     p_list = vlc_list_find( p_this, VLC_OBJECT_MODULE, FIND_ANYWHERE );
808
809     for( i_index = 0; i_index < p_list->i_count; i_index++ )
810     {
811         p_parser = (module_t *)p_list->p_values[i_index].p_object ;
812
813         if( psz_module_name
814              && strcmp( psz_module_name, p_parser->psz_object_name ) )
815         {
816             continue;
817         }
818
819         /* The config file is organized in sections, one per module. Look for
820          * the interesting section ( a section is of the form [foo] ) */
821         fseek( file, 0L, SEEK_SET );
822         while( fgets( line, 1024, file ) )
823         {
824             if( (line[0] == '[')
825                && (p_index = strchr(line,']'))
826                && (p_index - &line[1]
827                     == (int)strlen(p_parser->psz_object_name))
828                && !memcmp( &line[1], p_parser->psz_object_name,
829                            strlen(p_parser->psz_object_name) ) )
830             {
831 #if 0
832                 msg_Dbg( p_this, "loading config for module \"%s\"",
833                                  p_parser->psz_object_name );
834 #endif
835
836                 break;
837             }
838         }
839         /* either we found the section or we're at the EOF */
840
841         /* Now try to load the options in this section */
842         while( fgets( line, 1024, file ) )
843         {
844             if( line[0] == '[' ) break; /* end of section */
845
846             /* ignore comments or empty lines */
847             if( (line[0] == '#') || (line[0] == '\n') || (line[0] == (char)0) )
848                 continue;
849
850             /* get rid of line feed */
851             if( line[strlen(line)-1] == '\n' )
852                 line[strlen(line)-1] = (char)0;
853
854             /* look for option name */
855             psz_option_name = line;
856             psz_option_value = NULL;
857             p_index = strchr( line, '=' );
858             if( !p_index ) break; /* this ain't an option!!! */
859
860             *p_index = (char)0;
861             psz_option_value = p_index + 1;
862
863             if( !p_parser->i_config_items )
864             {
865                 continue;
866             }
867
868             /* try to match this option with one of the module's options */
869             for( p_item = p_parser->p_config;
870                  p_item->i_type != CONFIG_HINT_END;
871                  p_item++ )
872             {
873                 if( p_item->i_type & CONFIG_HINT )
874                     /* ignore hints */
875                     continue;
876
877                 if( !strcmp( p_item->psz_name, psz_option_name ) )
878                 {
879                     /* We found it */
880                     switch( p_item->i_type )
881                     {
882                     case CONFIG_ITEM_BOOL:
883                     case CONFIG_ITEM_INTEGER:
884                         if( !*psz_option_value )
885                             break;                    /* ignore empty option */
886                         p_item->i_value = strtol( psz_option_value, 0, 0 );
887                         p_item->i_value_saved = p_item->i_value;
888 #if 0
889                         msg_Dbg( p_this, "option \"%s\", value %i",
890                                  p_item->psz_name, p_item->i_value );
891 #endif
892                         break;
893
894                     case CONFIG_ITEM_FLOAT:
895                         if( !*psz_option_value )
896                             break;                    /* ignore empty option */
897                         p_item->f_value = (float)i18n_atof( psz_option_value);
898                         p_item->f_value_saved = p_item->f_value;
899 #if 0
900                         msg_Dbg( p_this, "option \"%s\", value %f",
901                                  p_item->psz_name, (double)p_item->f_value );
902 #endif
903                         break;
904                     case CONFIG_ITEM_KEY:
905                         if( !*psz_option_value )
906                             break;                    /* ignore empty option */
907                         p_item->i_value = ConfigStringToKey(psz_option_value);
908                         p_item->i_value_saved = p_item->i_value;
909                         break;
910
911                     default:
912                         vlc_mutex_lock( p_item->p_lock );
913
914                         /* free old string */
915                         if( p_item->psz_value )
916                             free( p_item->psz_value );
917
918                         p_item->psz_value = *psz_option_value ?
919                             strdup( psz_option_value ) : NULL;
920
921                         if( p_item->psz_value_saved )
922                             free( p_item->psz_value_saved );
923                         p_item->psz_value_saved = 0;
924                         if( !p_item->psz_value || !p_item->psz_value_orig ||
925                             (p_item->psz_value && p_item->psz_value_orig &&
926                              strcmp(p_item->psz_value,p_item->psz_value_orig)))
927                             p_item->psz_value_saved = p_item->psz_value ?
928                                 strdup( p_item->psz_value ) : 0;
929
930                         vlc_mutex_unlock( p_item->p_lock );
931
932 #if 0
933                         msg_Dbg( p_this, "option \"%s\", value \"%s\"",
934                                  p_item->psz_name,
935                                  p_item->psz_value ? p_item->psz_value : "" );
936 #endif
937                         break;
938                     }
939                 }
940             }
941         }
942
943     }
944
945     vlc_list_release( p_list );
946
947     fclose( file );
948     free( psz_filename );
949
950     vlc_mutex_unlock( &p_this->p_libvlc->config_lock );
951
952     return 0;
953 }
954
955 /*****************************************************************************
956  * config_CreateDir: Create configuration directory if it doesn't exist.
957  *****************************************************************************/
958 int config_CreateDir( vlc_object_t *p_this, const char *psz_dirname )
959 {
960     if( !psz_dirname && !*psz_dirname ) return -1;
961
962     if( utf8_mkdir( psz_dirname ) && ( errno != EEXIST ) )
963     {
964         msg_Err( p_this, "could not create %s (%s)",
965                  psz_dirname, strerror(errno) );
966         return -1;
967     }
968
969     return 0;
970 }
971
972 /*****************************************************************************
973  * config_SaveConfigFile: Save a module's config options.
974  *****************************************************************************
975  * This will save the specified module's config options to the config file.
976  * If psz_module_name is NULL then we save all the modules config options.
977  * It's no use to save the config options that kept their default values, so
978  * we'll try to be a bit clever here.
979  *
980  * When we save we mustn't delete the config options of the modules that
981  * haven't been loaded. So we cannot just create a new config file with the
982  * config structures we've got in memory.
983  * I don't really know how to deal with this nicely, so I will use a completly
984  * dumb method ;-)
985  * I will load the config file in memory, but skipping all the sections of the
986  * modules we want to save. Then I will create a brand new file, dump the file
987  * loaded in memory and then append the sections of the modules we want to
988  * save.
989  * Really stupid no ?
990  *****************************************************************************/
991 static int SaveConfigFile( vlc_object_t *p_this, const char *psz_module_name,
992                            vlc_bool_t b_autosave )
993 {
994     module_t *p_parser;
995     vlc_list_t *p_list;
996     module_config_t *p_item;
997     FILE *file;
998     char p_line[1024], *p_index2;
999     int i_sizebuf = 0;
1000     char *p_bigbuffer, *p_index;
1001     vlc_bool_t b_backup;
1002     char *psz_filename, *psz_homedir, *psz_configfile;
1003     int i_index;
1004
1005     /* Acquire config file lock */
1006     vlc_mutex_lock( &p_this->p_libvlc->config_lock );
1007
1008     psz_configfile = p_this->p_libvlc->psz_configfile;
1009     if( !psz_configfile || !psz_configfile )
1010     {
1011         psz_homedir = p_this->p_libvlc->psz_homedir;
1012         if( !psz_homedir )
1013         {
1014             msg_Err( p_this, "psz_homedir is null" );
1015             vlc_mutex_unlock( &p_this->p_libvlc->config_lock );
1016             return -1;
1017         }
1018         psz_filename = (char *)malloc( sizeof("/" CONFIG_DIR "/" CONFIG_FILE) +
1019                                        strlen(psz_homedir) );
1020
1021         if( psz_filename )
1022             sprintf( psz_filename, "%s" DIR_SEP CONFIG_DIR, psz_homedir );
1023
1024         if( !psz_filename )
1025         {
1026             msg_Err( p_this, "out of memory" );
1027             vlc_mutex_unlock( &p_this->p_libvlc->config_lock );
1028             return -1;
1029         }
1030
1031         config_CreateDir( p_this, psz_filename );
1032
1033         strcat( psz_filename, DIR_SEP CONFIG_FILE );
1034     }
1035     else
1036     {
1037         psz_filename = strdup( psz_configfile );
1038         if( !psz_filename )
1039         {
1040             msg_Err( p_this, "out of memory" );
1041             vlc_mutex_unlock( &p_this->p_libvlc->config_lock );
1042             return -1;
1043         }
1044     }
1045
1046     msg_Dbg( p_this, "opening config file %s", psz_filename );
1047
1048     file = utf8_fopen( psz_filename, "rt" );
1049     if( !file )
1050     {
1051         msg_Warn( p_this, "config file %s does not exist yet", psz_filename );
1052     }
1053     else
1054     {
1055         /* look for file size */
1056         fseek( file, 0L, SEEK_END );
1057         i_sizebuf = ftell( file );
1058         fseek( file, 0L, SEEK_SET );
1059     }
1060
1061     p_bigbuffer = p_index = malloc( i_sizebuf+1 );
1062     if( !p_bigbuffer )
1063     {
1064         msg_Err( p_this, "out of memory" );
1065         if( file ) fclose( file );
1066         free( psz_filename );
1067         vlc_mutex_unlock( &p_this->p_libvlc->config_lock );
1068         return -1;
1069     }
1070     p_bigbuffer[0] = 0;
1071
1072     /* List all available modules */
1073     p_list = vlc_list_find( p_this, VLC_OBJECT_MODULE, FIND_ANYWHERE );
1074
1075     /* backup file into memory, we only need to backup the sections we won't
1076      * save later on */
1077     b_backup = 0;
1078     while( file && fgets( p_line, 1024, file ) )
1079     {
1080         if( (p_line[0] == '[') && (p_index2 = strchr(p_line,']')))
1081         {
1082
1083             /* we found a section, check if we need to do a backup */
1084             for( i_index = 0; i_index < p_list->i_count; i_index++ )
1085             {
1086                 p_parser = (module_t *)p_list->p_values[i_index].p_object ;
1087
1088                 if( ((p_index2 - &p_line[1])
1089                        == (int)strlen(p_parser->psz_object_name) )
1090                     && !memcmp( &p_line[1], p_parser->psz_object_name,
1091                                 strlen(p_parser->psz_object_name) ) )
1092                 {
1093                     if( !psz_module_name )
1094                         break;
1095                     else if( !strcmp( psz_module_name,
1096                                       p_parser->psz_object_name ) )
1097                         break;
1098                 }
1099             }
1100
1101             if( i_index == p_list->i_count )
1102             {
1103                 /* we don't have this section in our list so we need to back
1104                  * it up */
1105                 *p_index2 = 0;
1106 #if 0
1107                 msg_Dbg( p_this, "backing up config for unknown module \"%s\"",
1108                                  &p_line[1] );
1109 #endif
1110                 *p_index2 = ']';
1111
1112                 b_backup = 1;
1113             }
1114             else
1115             {
1116                 b_backup = 0;
1117             }
1118         }
1119
1120         /* save line if requested and line is valid (doesn't begin with a
1121          * space, tab, or eol) */
1122         if( b_backup && (p_line[0] != '\n') && (p_line[0] != ' ')
1123             && (p_line[0] != '\t') )
1124         {
1125             strcpy( p_index, p_line );
1126             p_index += strlen( p_line );
1127         }
1128     }
1129     if( file ) fclose( file );
1130
1131
1132     /*
1133      * Save module config in file
1134      */
1135
1136     file = utf8_fopen( psz_filename, "wt" );
1137     if( !file )
1138     {
1139         msg_Warn( p_this, "could not open config file %s for writing",
1140                           psz_filename );
1141         free( psz_filename );
1142         vlc_list_release( p_list );
1143         vlc_mutex_unlock( &p_this->p_libvlc->config_lock );
1144         return -1;
1145     }
1146
1147     fprintf( file, "###\n###  " COPYRIGHT_MESSAGE "\n###\n\n"
1148        "###\n### lines begining with a '#' character are comments\n###\n\n" );
1149
1150     /* Look for the selected module, if NULL then save everything */
1151     for( i_index = 0; i_index < p_list->i_count; i_index++ )
1152     {
1153         p_parser = (module_t *)p_list->p_values[i_index].p_object ;
1154
1155         if( psz_module_name && strcmp( psz_module_name,
1156                                        p_parser->psz_object_name ) )
1157             continue;
1158
1159         if( !p_parser->i_config_items )
1160             continue;
1161
1162         if( psz_module_name )
1163             msg_Dbg( p_this, "saving config for module \"%s\"",
1164                      p_parser->psz_object_name );
1165
1166         fprintf( file, "[%s]", p_parser->psz_object_name );
1167         if( p_parser->psz_longname )
1168             utf8_fprintf( file, " # %s\n\n", p_parser->psz_longname );
1169         else
1170             fprintf( file, "\n\n" );
1171
1172         for( p_item = p_parser->p_config;
1173              p_item->i_type != CONFIG_HINT_END;
1174              p_item++ )
1175         {
1176             char  *psz_key;
1177             int   i_value = p_item->i_value;
1178             float f_value = p_item->f_value;
1179             char  *psz_value = p_item->psz_value;
1180
1181             if( p_item->i_type & CONFIG_HINT )
1182                 /* ignore hints */
1183                 continue;
1184             /* Ignore deprecated options */
1185             if( p_item->psz_current )
1186                 continue;
1187             if( b_autosave && !p_item->b_autosave )
1188             {
1189                 i_value = p_item->i_value_saved;
1190                 f_value = p_item->f_value_saved;
1191                 psz_value = p_item->psz_value_saved;
1192                 if( !psz_value ) psz_value = p_item->psz_value_orig;
1193             }
1194             else
1195             {
1196                 p_item->b_dirty = VLC_FALSE;
1197             }
1198
1199             switch( p_item->i_type )
1200             {
1201             case CONFIG_ITEM_BOOL:
1202             case CONFIG_ITEM_INTEGER:
1203                 if( p_item->psz_text )
1204                     utf8_fprintf( file, "# %s (%s)\n", p_item->psz_text,
1205                              (p_item->i_type == CONFIG_ITEM_BOOL) ?
1206                              _("boolean") : _("integer") );
1207                 if( i_value == p_item->i_value_orig )
1208                     fprintf( file, "#" );
1209                 fprintf( file, "%s=%i\n", p_item->psz_name, i_value );
1210
1211                 p_item->i_value_saved = i_value;
1212                 break;
1213
1214             case CONFIG_ITEM_KEY:
1215                 if( p_item->psz_text )
1216                     utf8_fprintf( file, "# %s (%s)\n", p_item->psz_text,
1217                              _("key") );
1218                 if( i_value == p_item->i_value_orig )
1219                     fprintf( file, "#" );
1220                 psz_key = ConfigKeyToString( i_value );
1221                 fprintf( file, "%s=%s\n", p_item->psz_name,
1222                          psz_key ? psz_key : "" );
1223                 if ( psz_key ) free( psz_key );
1224
1225                 p_item->i_value_saved = i_value;
1226                 break;
1227
1228             case CONFIG_ITEM_FLOAT:
1229                 if( p_item->psz_text )
1230                     utf8_fprintf( file, "# %s (%s)\n", p_item->psz_text,
1231                              _("float") );
1232                 if( f_value == p_item->f_value_orig )
1233                     fprintf( file, "#" );
1234                 fprintf( file, "%s=%f\n", p_item->psz_name, (double)f_value );
1235
1236                 p_item->f_value_saved = f_value;
1237                 break;
1238
1239             default:
1240                 if( p_item->psz_text )
1241                     utf8_fprintf( file, "# %s (%s)\n", p_item->psz_text,
1242                              _("string") );
1243                 if( (!psz_value && !p_item->psz_value_orig) ||
1244                     (psz_value && p_item->psz_value_orig &&
1245                      !strcmp( psz_value, p_item->psz_value_orig )) )
1246                     fprintf( file, "#" );
1247                 fprintf( file, "%s=%s\n", p_item->psz_name,
1248                          psz_value ? psz_value : "" );
1249
1250                 if( b_autosave && !p_item->b_autosave ) break;
1251
1252                 if( p_item->psz_value_saved ) free( p_item->psz_value_saved );
1253                 p_item->psz_value_saved = 0;
1254                 if( (psz_value && p_item->psz_value_orig &&
1255                      strcmp( psz_value, p_item->psz_value_orig )) ||
1256                     !psz_value || !p_item->psz_value_orig)
1257                     p_item->psz_value_saved = psz_value ? strdup(psz_value):0;
1258             }
1259         }
1260
1261         fprintf( file, "\n" );
1262     }
1263
1264     vlc_list_release( p_list );
1265
1266     /*
1267      * Restore old settings from the config in file
1268      */
1269     fputs( p_bigbuffer, file );
1270     free( p_bigbuffer );
1271
1272     fclose( file );
1273     free( psz_filename );
1274     vlc_mutex_unlock( &p_this->p_libvlc->config_lock );
1275
1276     return 0;
1277 }
1278
1279 int config_AutoSaveConfigFile( vlc_object_t *p_this )
1280 {
1281     vlc_list_t *p_list;
1282     module_t *p_parser;
1283     module_config_t *p_item;
1284     int i_index, i_count;
1285
1286     /* Check if there's anything to save */
1287     vlc_mutex_lock( &p_this->p_libvlc->config_lock );
1288     p_list = vlc_list_find( p_this, VLC_OBJECT_MODULE, FIND_ANYWHERE );
1289     i_count = p_list->i_count;
1290     for( i_index = 0; i_index < i_count; i_index++ )
1291     {
1292         p_parser = (module_t *)p_list->p_values[i_index].p_object ;
1293
1294         if( !p_parser->i_config_items ) continue;
1295
1296         for( p_item = p_parser->p_config;
1297              p_item->i_type != CONFIG_HINT_END;
1298              p_item++ )
1299         {
1300             if( p_item->b_autosave && p_item->b_dirty ) break;
1301         }
1302         if( p_item->i_type != CONFIG_HINT_END ) break;
1303     }
1304     vlc_list_release( p_list );
1305     vlc_mutex_unlock( &p_this->p_libvlc->config_lock );
1306
1307     if( i_index == i_count ) return VLC_SUCCESS;
1308     return SaveConfigFile( p_this, 0, VLC_TRUE );
1309 }
1310
1311 int __config_SaveConfigFile( vlc_object_t *p_this, const char *psz_module_name )
1312 {
1313     return SaveConfigFile( p_this, psz_module_name, VLC_FALSE );
1314 }
1315
1316 /*****************************************************************************
1317  * config_LoadCmdLine: parse command line
1318  *****************************************************************************
1319  * Parse command line for configuration options.
1320  * Now that the module_bank has been initialized, we can dynamically
1321  * generate the longopts structure used by getops. We have to do it this way
1322  * because we don't know (and don't want to know) in advance the configuration
1323  * options used (ie. exported) by each module.
1324  *****************************************************************************/
1325 int __config_LoadCmdLine( vlc_object_t *p_this, int *pi_argc, char *ppsz_argv[],
1326                           vlc_bool_t b_ignore_errors )
1327 {
1328     int i_cmd, i_index, i_opts, i_shortopts, flag, i_verbose = 0;
1329     module_t *p_parser;
1330     vlc_list_t *p_list;
1331     module_config_t *p_item;
1332     struct option *p_longopts;
1333     int i_modules_index;
1334
1335     /* Short options */
1336     module_config_t *pp_shortopts[256];
1337     char *psz_shortopts;
1338
1339     /* Set default configuration and copy arguments */
1340     p_this->p_libvlc->i_argc    = *pi_argc;
1341     p_this->p_libvlc->ppsz_argv = ppsz_argv;
1342
1343 #ifdef __APPLE__
1344     /* When VLC.app is run by double clicking in Mac OS X, the 2nd arg
1345      * is the PSN - process serial number (a unique PID-ish thingie)
1346      * still ok for real Darwin & when run from command line */
1347     if ( (*pi_argc > 1) && (strncmp( ppsz_argv[ 1 ] , "-psn" , 4 ) == 0) )
1348                                         /* for example -psn_0_9306113 */
1349     {
1350         /* GDMF!... I can't do this or else the MacOSX window server will
1351          * not pick up the PSN and not register the app and we crash...
1352          * hence the following kludge otherwise we'll get confused w/ argv[1]
1353          * being an input file name */
1354 #if 0
1355         ppsz_argv[ 1 ] = NULL;
1356 #endif
1357         *pi_argc = *pi_argc - 1;
1358         pi_argc--;
1359         return 0;
1360     }
1361 #endif
1362
1363     /* List all modules */
1364     p_list = vlc_list_find( p_this, VLC_OBJECT_MODULE, FIND_ANYWHERE );
1365
1366     /*
1367      * Generate the longopts and shortopts structures used by getopt_long
1368      */
1369
1370     i_opts = 0;
1371     for( i_modules_index = 0; i_modules_index < p_list->i_count;
1372          i_modules_index++ )
1373     {
1374         p_parser = (module_t *)p_list->p_values[i_modules_index].p_object ;
1375
1376         /* count the number of exported configuration options (to allocate
1377          * longopts). We also need to allocate space for two options when
1378          * dealing with boolean to allow for --foo and --no-foo */
1379         i_opts += p_parser->i_config_items
1380                      + 2 * p_parser->i_bool_items;
1381     }
1382
1383     p_longopts = malloc( sizeof(struct option) * (i_opts + 1) );
1384     if( p_longopts == NULL )
1385     {
1386         msg_Err( p_this, "out of memory" );
1387         vlc_list_release( p_list );
1388         return -1;
1389     }
1390
1391     psz_shortopts = malloc( sizeof( char ) * (2 * i_opts + 1) );
1392     if( psz_shortopts == NULL )
1393     {
1394         msg_Err( p_this, "out of memory" );
1395         free( p_longopts );
1396         vlc_list_release( p_list );
1397         return -1;
1398     }
1399
1400     /* If we are requested to ignore errors, then we must work on a copy
1401      * of the ppsz_argv array, otherwise getopt_long will reorder it for
1402      * us, ignoring the arity of the options */
1403     if( b_ignore_errors )
1404     {
1405         ppsz_argv = (char**)malloc( *pi_argc * sizeof(char *) );
1406         if( ppsz_argv == NULL )
1407         {
1408             msg_Err( p_this, "out of memory" );
1409             free( psz_shortopts );
1410             free( p_longopts );
1411             vlc_list_release( p_list );
1412             return -1;
1413         }
1414         memcpy( ppsz_argv, p_this->p_libvlc->ppsz_argv,
1415                 *pi_argc * sizeof(char *) );
1416     }
1417
1418     i_shortopts = 0;
1419     for( i_index = 0; i_index < 256; i_index++ )
1420     {
1421         pp_shortopts[i_index] = NULL;
1422     }
1423
1424     /* Fill the p_longopts and psz_shortopts structures */
1425     i_index = 0;
1426     for( i_modules_index = 0; i_modules_index < p_list->i_count;
1427          i_modules_index++ )
1428     {
1429         p_parser = (module_t *)p_list->p_values[i_modules_index].p_object ;
1430
1431         if( !p_parser->i_config_items )
1432             continue;
1433
1434         for( p_item = p_parser->p_config;
1435              p_item->i_type != CONFIG_HINT_END;
1436              p_item++ )
1437         {
1438             /* Ignore hints */
1439             if( p_item->i_type & CONFIG_HINT )
1440                 continue;
1441
1442             /* Add item to long options */
1443             p_longopts[i_index].name = strdup( p_item->psz_name );
1444             if( p_longopts[i_index].name == NULL ) continue;
1445             p_longopts[i_index].has_arg =
1446                 (p_item->i_type == CONFIG_ITEM_BOOL)?
1447                                                no_argument : required_argument;
1448             p_longopts[i_index].flag = &flag;
1449             p_longopts[i_index].val = 0;
1450             i_index++;
1451
1452             /* When dealing with bools we also need to add the --no-foo
1453              * option */
1454             if( p_item->i_type == CONFIG_ITEM_BOOL )
1455             {
1456                 char *psz_name = malloc( strlen(p_item->psz_name) + 3 );
1457                 if( psz_name == NULL ) continue;
1458                 strcpy( psz_name, "no" );
1459                 strcat( psz_name, p_item->psz_name );
1460
1461                 p_longopts[i_index].name = psz_name;
1462                 p_longopts[i_index].has_arg = no_argument;
1463                 p_longopts[i_index].flag = &flag;
1464                 p_longopts[i_index].val = 1;
1465                 i_index++;
1466
1467                 psz_name = malloc( strlen(p_item->psz_name) + 4 );
1468                 if( psz_name == NULL ) continue;
1469                 strcpy( psz_name, "no-" );
1470                 strcat( psz_name, p_item->psz_name );
1471
1472                 p_longopts[i_index].name = psz_name;
1473                 p_longopts[i_index].has_arg = no_argument;
1474                 p_longopts[i_index].flag = &flag;
1475                 p_longopts[i_index].val = 1;
1476                 i_index++;
1477             }
1478
1479             /* If item also has a short option, add it */
1480             if( p_item->i_short )
1481             {
1482                 pp_shortopts[(int)p_item->i_short] = p_item;
1483                 psz_shortopts[i_shortopts] = p_item->i_short;
1484                 i_shortopts++;
1485                 if( p_item->i_type != CONFIG_ITEM_BOOL )
1486                 {
1487                     psz_shortopts[i_shortopts] = ':';
1488                     i_shortopts++;
1489
1490                     if( p_item->i_short == 'v' )
1491                     {
1492                         psz_shortopts[i_shortopts] = ':';
1493                         i_shortopts++;
1494                     }
1495                 }
1496             }
1497         }
1498     }
1499
1500     /* We don't need the module list anymore */
1501     vlc_list_release( p_list );
1502
1503     /* Close the longopts and shortopts structures */
1504     memset( &p_longopts[i_index], 0, sizeof(struct option) );
1505     psz_shortopts[i_shortopts] = '\0';
1506
1507     /*
1508      * Parse the command line options
1509      */
1510     opterr = 0;
1511     optind = 1;
1512     while( ( i_cmd = getopt_long( *pi_argc, ppsz_argv, psz_shortopts,
1513                                   p_longopts, &i_index ) ) != EOF )
1514     {
1515         /* A long option has been recognized */
1516         if( i_cmd == 0 )
1517         {
1518             module_config_t *p_conf;
1519             char *psz_name = (char *)p_longopts[i_index].name;
1520
1521             /* Check if we deal with a --nofoo or --no-foo long option */
1522             if( flag ) psz_name += psz_name[2] == '-' ? 3 : 2;
1523
1524             /* Store the configuration option */
1525             p_conf = config_FindConfig( p_this, psz_name );
1526             if( p_conf )
1527             {
1528                 /* Check if the option is deprecated */
1529                 if( p_conf->psz_current )
1530                 {
1531                     if( !strcmp(p_conf->psz_current,"SUPPRESSED") )
1532                     {
1533                         if( !b_ignore_errors )
1534                         {
1535                             fprintf(stderr,
1536                                     "Warning: option --%s is no longer used.\n",
1537                                     p_conf->psz_name);
1538                         }
1539                        continue;
1540                     }
1541                     if( !b_ignore_errors )
1542                     {
1543                         if( p_conf->b_strict )
1544                         {
1545                             fprintf( stderr,
1546                                      "Error: option --%s is deprecated. "
1547                                      "Use --%s instead.\n",
1548                                      p_conf->psz_name, p_conf->psz_current);
1549                             /*free */
1550                             for( i_index = 0; p_longopts[i_index].name; i_index++ )
1551                                 free( (char *)p_longopts[i_index].name );
1552
1553                             free( p_longopts );
1554                             free( psz_shortopts );
1555                             return -1;
1556                         }
1557                         fprintf(stderr,
1558                                 "Warning: option --%s is deprecated. "
1559                                 "You should use --%s instead.\n",
1560                                 p_conf->psz_name, p_conf->psz_current);
1561                     }
1562                     psz_name=p_conf->psz_current;
1563                     p_conf = config_FindConfig( p_this, psz_name );
1564                 }
1565
1566                 switch( p_conf->i_type )
1567                 {
1568                     case CONFIG_ITEM_STRING:
1569                     case CONFIG_ITEM_FILE:
1570                     case CONFIG_ITEM_DIRECTORY:
1571                     case CONFIG_ITEM_MODULE:
1572                     case CONFIG_ITEM_MODULE_LIST:
1573                     case CONFIG_ITEM_MODULE_LIST_CAT:
1574                     case CONFIG_ITEM_MODULE_CAT:
1575                         config_PutPsz( p_this, psz_name, optarg );
1576                         break;
1577                     case CONFIG_ITEM_INTEGER:
1578                         config_PutInt( p_this, psz_name, strtol(optarg, 0, 0));
1579                         break;
1580                     case CONFIG_ITEM_FLOAT:
1581                         config_PutFloat( p_this, psz_name, (float)atof(optarg) );
1582                         break;
1583                     case CONFIG_ITEM_KEY:
1584                         config_PutInt( p_this, psz_name, ConfigStringToKey( optarg ) );
1585                         break;
1586                     case CONFIG_ITEM_BOOL:
1587                         config_PutInt( p_this, psz_name, !flag );
1588                         break;
1589                 }
1590                 continue;
1591             }
1592         }
1593
1594         /* A short option has been recognized */
1595         if( pp_shortopts[i_cmd] != NULL )
1596         {
1597             switch( pp_shortopts[i_cmd]->i_type )
1598             {
1599                 case CONFIG_ITEM_STRING:
1600                 case CONFIG_ITEM_FILE:
1601                 case CONFIG_ITEM_DIRECTORY:
1602                 case CONFIG_ITEM_MODULE:
1603                 case CONFIG_ITEM_MODULE_CAT:
1604                 case CONFIG_ITEM_MODULE_LIST:
1605                 case CONFIG_ITEM_MODULE_LIST_CAT:
1606                     config_PutPsz( p_this, pp_shortopts[i_cmd]->psz_name, optarg );
1607                     break;
1608                 case CONFIG_ITEM_INTEGER:
1609                     if( i_cmd == 'v' )
1610                     {
1611                         if( optarg )
1612                         {
1613                             if( *optarg == 'v' ) /* eg. -vvv */
1614                             {
1615                                 i_verbose++;
1616                                 while( *optarg == 'v' )
1617                                 {
1618                                     i_verbose++;
1619                                     optarg++;
1620                                 }
1621                             }
1622                             else
1623                             {
1624                                 i_verbose += atoi( optarg ); /* eg. -v2 */
1625                             }
1626                         }
1627                         else
1628                         {
1629                             i_verbose++; /* -v */
1630                         }
1631                         config_PutInt( p_this, pp_shortopts[i_cmd]->psz_name,
1632                                                i_verbose );
1633                     }
1634                     else
1635                     {
1636                         config_PutInt( p_this, pp_shortopts[i_cmd]->psz_name,
1637                                                strtol(optarg, 0, 0) );
1638                     }
1639                     break;
1640                 case CONFIG_ITEM_BOOL:
1641                     config_PutInt( p_this, pp_shortopts[i_cmd]->psz_name, 1 );
1642                     break;
1643             }
1644
1645             continue;
1646         }
1647
1648         /* Internal error: unknown option */
1649         if( !b_ignore_errors )
1650         {
1651             fprintf( stderr, "%s: unknown option"
1652                      " or missing mandatory argument ",
1653                      p_this->p_libvlc->psz_object_name );
1654             if( optopt )
1655             {
1656                 fprintf( stderr, "`-%c'\n", optopt );
1657             }
1658             else
1659             {
1660                 fprintf( stderr, "`%s'\n", ppsz_argv[optind-1] );
1661             }
1662             fprintf( stderr, "Try `%s --help' for more information.\n",
1663                              p_this->p_libvlc->psz_object_name );
1664
1665             for( i_index = 0; p_longopts[i_index].name; i_index++ )
1666                 free( (char *)p_longopts[i_index].name );
1667             free( p_longopts );
1668             free( psz_shortopts );
1669             return -1;
1670         }
1671     }
1672
1673     /* Free allocated resources */
1674     for( i_index = 0; p_longopts[i_index].name; i_index++ )
1675         free( (char *)p_longopts[i_index].name );
1676     free( p_longopts );
1677     free( psz_shortopts );
1678     if( b_ignore_errors ) free( ppsz_argv );
1679
1680     return 0;
1681 }
1682
1683 /**
1684  * config_GetDataDir: find directory where shared data is installed
1685  *
1686  * @return a string (always succeeds).
1687  */
1688 const char *config_GetDataDir( const vlc_object_t *p_this )
1689 {
1690 #if defined (WIN32) || defined (UNDER_CE)
1691     return p_this->p_libvlc_global->psz_vlcpath;
1692 #elif defined(__APPLE__) || defined (SYS_BEOS)
1693     static char path[PATH_MAX] = "";
1694
1695     if( *path == '\0' )
1696     {
1697         snprintf( path, sizeof( path ), "%s/share",
1698                   p_this->p_libvlc_global->psz_vlcpath );
1699         path[sizeof( path ) - 1] = '\0';
1700     }
1701     return path;
1702 #else
1703     return DATA_PATH;
1704 #endif
1705 }
1706
1707 /*****************************************************************************
1708  * config_GetHomeDir, config_GetUserDir: find the user's home directory.
1709  *****************************************************************************
1710  * This function will try by different ways to find the user's home path.
1711  * Note that this function is not reentrant, it should be called only once
1712  * at the beginning of main where the result will be stored for later use.
1713  *****************************************************************************/
1714 static char *GetDir( vlc_bool_t b_appdata )
1715 {
1716     const char *psz_localhome = NULL;
1717
1718 #if defined(HAVE_GETPWUID)
1719     struct passwd *p_pw = NULL;
1720 #endif
1721
1722 #if defined(WIN32) && !defined(UNDER_CE)
1723     typedef HRESULT (WINAPI *SHGETFOLDERPATH)( HWND, int, HANDLE, DWORD,
1724                                                LPWSTR );
1725 #ifndef CSIDL_FLAG_CREATE
1726 #   define CSIDL_FLAG_CREATE 0x8000
1727 #endif
1728 #ifndef CSIDL_APPDATA
1729 #   define CSIDL_APPDATA 0x1A
1730 #endif
1731 #ifndef CSIDL_PROFILE
1732 #   define CSIDL_PROFILE 0x28
1733 #endif
1734 #ifndef SHGFP_TYPE_CURRENT
1735 #   define SHGFP_TYPE_CURRENT 0
1736 #endif
1737
1738     HINSTANCE shfolder_dll;
1739     SHGETFOLDERPATH SHGetFolderPath ;
1740
1741     /* load the shfolder dll to retrieve SHGetFolderPath */
1742     if( ( shfolder_dll = LoadLibrary( _T("SHFolder.dll") ) ) != NULL )
1743     {
1744         SHGetFolderPath = (void *)GetProcAddress( shfolder_dll,
1745                                                   _T("SHGetFolderPathW") );
1746         if ( SHGetFolderPath != NULL )
1747         {
1748             wchar_t whomedir[MAX_PATH];
1749
1750             /* get the "Application Data" folder for the current user */
1751             if( S_OK == SHGetFolderPath( NULL,
1752                                          (b_appdata ? CSIDL_APPDATA :
1753                                            CSIDL_PROFILE) | CSIDL_FLAG_CREATE,
1754                                          NULL, SHGFP_TYPE_CURRENT,
1755                                          whomedir ) )
1756             {
1757                 FreeLibrary( shfolder_dll );
1758                 return FromWide( whomedir );
1759             }
1760         }
1761         FreeLibrary( shfolder_dll );
1762     }
1763
1764 #elif defined(UNDER_CE)
1765
1766 #ifndef CSIDL_APPDATA
1767 #   define CSIDL_APPDATA 0x1A
1768 #endif
1769
1770     wchar_t whomedir[MAX_PATH];
1771
1772     /* get the "Application Data" folder for the current user */
1773     if( SHGetSpecialFolderPath( NULL, whomedir, CSIDL_APPDATA, 1 ) )
1774         return FromWide( whomedir );
1775 #endif
1776
1777 #if defined(HAVE_GETPWUID)
1778     if( ( p_pw = getpwuid( getuid() ) ) == NULL )
1779 #endif
1780     {
1781         psz_localhome = getenv( "HOME" );
1782         if( psz_localhome == NULL )
1783         {
1784             psz_localhome = getenv( "TMP" );
1785             if( psz_localhome == NULL )
1786                 psz_localhome = "/tmp";
1787         }
1788     }
1789 #if defined(HAVE_GETPWUID)
1790     else
1791         psz_localhome = p_pw->pw_dir;
1792 #endif
1793
1794     return FromLocaleDup( psz_localhome );
1795 }
1796
1797 char *config_GetHomeDir( void )
1798 {
1799     return GetDir( VLC_TRUE );
1800 }
1801
1802 char *config_GetUserDir( void )
1803 {
1804     return GetDir( VLC_FALSE );
1805 }
1806
1807
1808 static int ConfigStringToKey( char *psz_key )
1809 {
1810     int i_key = 0;
1811     unsigned int i;
1812     char *psz_parser = strchr( psz_key, '-' );
1813     while( psz_parser && psz_parser != psz_key )
1814     {
1815         for( i = 0; i < sizeof(vlc_modifiers) / sizeof(key_descriptor_t); i++ )
1816         {
1817             if( !strncasecmp( vlc_modifiers[i].psz_key_string, psz_key,
1818                               strlen( vlc_modifiers[i].psz_key_string ) ) )
1819             {
1820                 i_key |= vlc_modifiers[i].i_key_code;
1821             }
1822         }
1823         psz_key = psz_parser + 1;
1824         psz_parser = strchr( psz_key, '-' );
1825     }
1826     for( i = 0; i < sizeof(vlc_keys) / sizeof( key_descriptor_t ); i++ )
1827     {
1828         if( !strcasecmp( vlc_keys[i].psz_key_string, psz_key ) )
1829         {
1830             i_key |= vlc_keys[i].i_key_code;
1831             break;
1832         }
1833     }
1834     return i_key;
1835 }
1836
1837 static char *ConfigKeyToString( int i_key )
1838 {
1839     char *psz_key = malloc( 100 );
1840     char *p;
1841     size_t index;
1842
1843     if ( !psz_key )
1844     {
1845         return NULL;
1846     }
1847     *psz_key = '\0';
1848     p = psz_key;
1849     for( index = 0; index < (sizeof(vlc_modifiers) / sizeof(key_descriptor_t));
1850          index++ )
1851     {
1852         if( i_key & vlc_modifiers[index].i_key_code )
1853         {
1854             p += sprintf( p, "%s-", vlc_modifiers[index].psz_key_string );
1855         }
1856     }
1857     for( index = 0; index < (sizeof(vlc_keys) / sizeof( key_descriptor_t));
1858          index++)
1859     {
1860         if( (int)( i_key & ~KEY_MODIFIER ) == vlc_keys[index].i_key_code )
1861         {
1862             p += sprintf( p, "%s", vlc_keys[index].psz_key_string );
1863             break;
1864         }
1865     }
1866     return psz_key;
1867 }