git.sesse.net Git - vlc/blob - src/config/cmdline.c

   1 /*****************************************************************************
   2  * cmdline.c: command line parsing
   3  *****************************************************************************
   4  * Copyright (C) 2001-2007 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 #ifdef HAVE_CONFIG_H
  25 # include "config.h"
  26 #endif
  27
  28 #include <vlc_common.h>
  29 #include "../libvlc.h"
  30 #include <vlc_keys.h>
  31 #include <vlc_charset.h>
  32
  33 #include "vlc_getopt.h"
  34
  35 #include "configuration.h"
  36 #include "modules/modules.h"
  37
  38 #include <assert.h>
  39
  40 #undef config_LoadCmdLine
  41 /**
  42  * Parse command line for configuration options.
  43  *
  44  * Now that the module_bank has been initialized, we can dynamically
  45  * generate the longopts structure used by getops. We have to do it this way
  46  * because we don't know (and don't want to know) in advance the configuration
  47  * options used (ie. exported) by each module.
  48  *
  49  * @param p_this object to write command line options as variables to
  50  * @param pi_argc number of command line arguments [IN/OUT]
  51  * @param ppsz_args commandl ine arguments [IN/OUT]
  52  * @param b_ignore_errors whether to ignore parsing errors
  53  * @return 0 on success, -1 on error.
  54  *
  55  * @warning This function is not re-entrant (because of getopt_long()).
  56  * It must be called with the module bank initialization global lock held.
  57  * FIXME: this still breaks if getopt() is used outside of LibVLC.
  58  */
  59 int config_LoadCmdLine( vlc_object_t *p_this, int *pi_argc,
  60                         const char *ppsz_argv[], bool b_ignore_errors )
  61 {
  62     int i_cmd, i_index, i_opts, i_shortopts, flag, i_verbose = 0;
  63     module_t *p_parser;
  64     struct option *p_longopts;
  65     const char **argv_copy = NULL;
  66
  67     /* Short options */
  68     module_config_t *pp_shortopts[256];
  69     char *psz_shortopts;
  70
  71     /* List all modules */
  72     module_t **list = module_list_get (NULL);
  73
  74     /*
  75      * Generate the longopts and shortopts structures used by getopt_long
  76      */
  77
  78     i_opts = 0;
  79     for (size_t i = 0; (p_parser = list[i]) != NULL; i++)
  80         /* count the number of exported configuration options (to allocate
  81          * longopts). We also need to allocate space for two options when
  82          * dealing with boolean to allow for --foo and --no-foo */
  83         i_opts += p_parser->i_config_items + 2 * p_parser->i_bool_items;
  84
  85     p_longopts = malloc( sizeof(struct option) * (i_opts + 1) );
  86     if( p_longopts == NULL )
  87     {
  88         module_list_free (list);
  89         return -1;
  90     }
  91
  92     psz_shortopts = malloc( sizeof( char ) * (2 * i_opts + 1) );
  93     if( psz_shortopts == NULL )
  94     {
  95         free( p_longopts );
  96         module_list_free (list);
  97         return -1;
  98     }
  99
 100     /* If we are requested to ignore errors, then we must work on a copy
 101      * of the ppsz_argv array, otherwise getopt_long will reorder it for
 102      * us, ignoring the arity of the options */
 103     if( b_ignore_errors )
 104     {
 105         argv_copy = (const char**)malloc( *pi_argc * sizeof(char *) );
 106         if( argv_copy == NULL )
 107         {
 108             free( psz_shortopts );
 109             free( p_longopts );
 110             module_list_free (list);
 111             return -1;
 112         }
 113         memcpy( argv_copy, ppsz_argv, *pi_argc * sizeof(char *) );
 114         ppsz_argv = argv_copy;
 115     }
 116
 117     i_shortopts = 0;
 118     for( i_index = 0; i_index < 256; i_index++ )
 119     {
 120         pp_shortopts[i_index] = NULL;
 121     }
 122
 123     /* Fill the p_longopts and psz_shortopts structures */
 124     i_index = 0;
 125     for (size_t i = 0; (p_parser = list[i]) != NULL; i++)
 126     {
 127         module_config_t *p_item, *p_end;
 128
 129         if( !p_parser->i_config_items )
 130             continue;
 131
 132         for( p_item = p_parser->p_config, p_end = p_item + p_parser->confsize;
 133              p_item < p_end;
 134              p_item++ )
 135         {
 136             /* Ignore hints */
 137             if( p_item->i_type & CONFIG_HINT )
 138                 continue;
 139
 140             /* Add item to long options */
 141             p_longopts[i_index].name = strdup( p_item->psz_name );
 142             if( p_longopts[i_index].name == NULL ) continue;
 143             p_longopts[i_index].has_arg =
 144                 (p_item->i_type == CONFIG_ITEM_BOOL) ? no_argument :
 145                                                        required_argument;
 146             p_longopts[i_index].flag = &flag;
 147             p_longopts[i_index].val = 0;
 148             i_index++;
 149
 150             /* When dealing with bools we also need to add the --no-foo
 151              * option */
 152             if( p_item->i_type == CONFIG_ITEM_BOOL )
 153             {
 154                 char *psz_name = malloc( strlen(p_item->psz_name) + 3 );
 155                 if( psz_name == NULL ) continue;
 156                 strcpy( psz_name, "no" );
 157                 strcat( psz_name, p_item->psz_name );
 158
 159                 p_longopts[i_index].name = psz_name;
 160                 p_longopts[i_index].has_arg = no_argument;
 161                 p_longopts[i_index].flag = &flag;
 162                 p_longopts[i_index].val = 1;
 163                 i_index++;
 164
 165                 psz_name = malloc( strlen(p_item->psz_name) + 4 );
 166                 if( psz_name == NULL ) continue;
 167                 strcpy( psz_name, "no-" );
 168                 strcat( psz_name, p_item->psz_name );
 169
 170                 p_longopts[i_index].name = psz_name;
 171                 p_longopts[i_index].has_arg = no_argument;
 172                 p_longopts[i_index].flag = &flag;
 173                 p_longopts[i_index].val = 1;
 174                 i_index++;
 175             }
 176
 177             /* If item also has a short option, add it */
 178             if( p_item->i_short )
 179             {
 180                 pp_shortopts[(int)p_item->i_short] = p_item;
 181                 psz_shortopts[i_shortopts] = p_item->i_short;
 182                 i_shortopts++;
 183                 if( p_item->i_type != CONFIG_ITEM_BOOL )
 184                 {
 185                     psz_shortopts[i_shortopts] = ':';
 186                     i_shortopts++;
 187
 188                     if( p_item->i_short == 'v' )
 189                     {
 190                         psz_shortopts[i_shortopts] = ':';
 191                         i_shortopts++;
 192                     }
 193                 }
 194             }
 195         }
 196     }
 197
 198     /* We don't need the module list anymore */
 199     module_list_free( list );
 200
 201     /* Close the longopts and shortopts structures */
 202     memset( &p_longopts[i_index], 0, sizeof(struct option) );
 203     psz_shortopts[i_shortopts] = '\0';
 204
 205     /*
 206      * Parse the command line options
 207      */
 208     optind = 0; /* set to 0 to tell GNU getopt to reinitialize */
 209     while( ( i_cmd = vlc_getopt_long( *pi_argc, (char **)ppsz_argv, psz_shortopts,
 210                                   p_longopts, &i_index ) ) != -1 )
 211     {
 212         /* A long option has been recognized */
 213         if( i_cmd == 0 )
 214         {
 215             module_config_t *p_conf;
 216             const char *psz_name = p_longopts[i_index].name;
 217
 218             /* Check if we deal with a --nofoo or --no-foo long option */
 219             if( flag ) psz_name += psz_name[2] == '-' ? 3 : 2;
 220
 221             /* Store the configuration option */
 222             p_conf = config_FindConfig( p_this, psz_name );
 223             if( p_conf )
 224             {
 225                 /* Check if the option is deprecated */
 226                 if( p_conf->b_removed )
 227                 {
 228                     fprintf(stderr,
 229                             "Warning: option --%s no longer exists.\n",
 230                             psz_name);
 231                     continue;
 232                 }
 233
 234                 if( p_conf->psz_oldname
 235                  && !strcmp( p_conf->psz_oldname, psz_name) )
 236                 {
 237                     fprintf( stderr,
 238                              "%s: option --%s is deprecated. Use --%s instead.\n",
 239                              b_ignore_errors ? "Warning" : "Error",
 240                              psz_name, p_conf->psz_name );
 241                     if( !b_ignore_errors )
 242                     {
 243                         /*free */
 244                         for( i_index = 0; p_longopts[i_index].name; i_index++ )
 245                              free( (char *)p_longopts[i_index].name );
 246
 247                         free( p_longopts );
 248                         free( psz_shortopts );
 249                         return -1;
 250                     }
 251
 252                     psz_name = p_conf->psz_name;
 253                 }
 254
 255                 switch( p_conf->i_type )
 256                 {
 257                     case CONFIG_ITEM_STRING:
 258                     case CONFIG_ITEM_PASSWORD:
 259                     case CONFIG_ITEM_FILE:
 260                     case CONFIG_ITEM_DIRECTORY:
 261                     case CONFIG_ITEM_MODULE:
 262                     case CONFIG_ITEM_MODULE_LIST:
 263                     case CONFIG_ITEM_MODULE_LIST_CAT:
 264                     case CONFIG_ITEM_MODULE_CAT:
 265                         var_Create( p_this, psz_name, VLC_VAR_STRING );
 266                         var_SetString( p_this, psz_name, optarg );
 267                         break;
 268                     case CONFIG_ITEM_INTEGER:
 269                         var_Create( p_this, psz_name, VLC_VAR_INTEGER );
 270                         var_SetInteger( p_this, psz_name,
 271                                         strtol(optarg, NULL, 0));
 272                         break;
 273                     case CONFIG_ITEM_FLOAT:
 274                         var_Create( p_this, psz_name, VLC_VAR_FLOAT );
 275                         var_SetFloat( p_this, psz_name, us_atof(optarg) );
 276                         break;
 277                     case CONFIG_ITEM_KEY:
 278                         var_Create( p_this, psz_name, VLC_VAR_INTEGER );
 279                         var_SetInteger( p_this, psz_name,
 280                                         ConfigStringToKey( optarg ) );
 281                         break;
 282                     case CONFIG_ITEM_BOOL:
 283                         var_Create( p_this, psz_name, VLC_VAR_BOOL );
 284                         var_SetBool( p_this, psz_name, !flag );
 285                         break;
 286                 }
 287                 continue;
 288             }
 289         }
 290
 291         /* A short option has been recognized */
 292         if( pp_shortopts[i_cmd] != NULL )
 293         {
 294             const char *name = pp_shortopts[i_cmd]->psz_name;
 295             switch( pp_shortopts[i_cmd]->i_type )
 296             {
 297                 case CONFIG_ITEM_STRING:
 298                 case CONFIG_ITEM_PASSWORD:
 299                 case CONFIG_ITEM_FILE:
 300                 case CONFIG_ITEM_DIRECTORY:
 301                 case CONFIG_ITEM_MODULE:
 302                 case CONFIG_ITEM_MODULE_CAT:
 303                 case CONFIG_ITEM_MODULE_LIST:
 304                 case CONFIG_ITEM_MODULE_LIST_CAT:
 305                     var_Create( p_this, name, VLC_VAR_STRING );
 306                     var_SetString( p_this, name, optarg );
 307                     break;
 308                 case CONFIG_ITEM_INTEGER:
 309                     var_Create( p_this, name, VLC_VAR_INTEGER );
 310                     if( i_cmd == 'v' )
 311                     {
 312                         if( optarg )
 313                         {
 314                             if( *optarg == 'v' ) /* eg. -vvv */
 315                             {
 316                                 i_verbose++;
 317                                 while( *optarg == 'v' )
 318                                 {
 319                                     i_verbose++;
 320                                     optarg++;
 321                                 }
 322                             }
 323                             else
 324                             {
 325                                 i_verbose += atoi( optarg ); /* eg. -v2 */
 326                             }
 327                         }
 328                         else
 329                         {
 330                             i_verbose++; /* -v */
 331                         }
 332                         var_SetInteger( p_this, name, i_verbose );
 333                     }
 334                     else
 335                     {
 336                         var_SetInteger( p_this, name,
 337                                         strtol(optarg, NULL, 0) );
 338                     }
 339                     break;
 340                 case CONFIG_ITEM_BOOL:
 341                     var_Create( p_this, name, VLC_VAR_BOOL );
 342                     var_SetBool( p_this, name, true );
 343                     break;
 344             }
 345
 346             continue;
 347         }
 348
 349         /* Internal error: unknown option */
 350         if( !b_ignore_errors )
 351         {
 352             fputs( "vlc: unknown option"
 353                      " or missing mandatory argument ", stderr );
 354             if( optopt )
 355             {
 356                 fprintf( stderr, "`-%c'\n", optopt );
 357             }
 358             else
 359             {
 360                 fprintf( stderr, "`%s'\n", ppsz_argv[optind-1] );
 361             }
 362             fputs( "Try `vlc --help' for more information.\n", stderr );
 363
 364             for( i_index = 0; p_longopts[i_index].name; i_index++ )
 365                 free( (char *)p_longopts[i_index].name );
 366             free( p_longopts );
 367             free( psz_shortopts );
 368             return -1;
 369         }
 370     }
 371
 372     /* Free allocated resources */
 373     for( i_index = 0; p_longopts[i_index].name; i_index++ )
 374         free( (char *)p_longopts[i_index].name );
 375     free( p_longopts );
 376     free( psz_shortopts );
 377     free( argv_copy );
 378
 379     return 0;
 380 }
 381