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