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 "../extras/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 #ifndef __APPLE__
 146                                                        required_argument;
 147 #else
 148 /* It seems that required_argument is broken on Darwin.
 149  * Radar ticket #6113829 */
 150                                                        optional_argument;
 151 #endif
 152             p_longopts[i_index].flag = &flag;
 153             p_longopts[i_index].val = 0;
 154             i_index++;
 155
 156             /* When dealing with bools we also need to add the --no-foo
 157              * option */
 158             if( p_item->i_type == CONFIG_ITEM_BOOL )
 159             {
 160                 char *psz_name = malloc( strlen(p_item->psz_name) + 3 );
 161                 if( psz_name == NULL ) continue;
 162                 strcpy( psz_name, "no" );
 163                 strcat( psz_name, p_item->psz_name );
 164
 165                 p_longopts[i_index].name = psz_name;
 166                 p_longopts[i_index].has_arg = no_argument;
 167                 p_longopts[i_index].flag = &flag;
 168                 p_longopts[i_index].val = 1;
 169                 i_index++;
 170
 171                 psz_name = malloc( strlen(p_item->psz_name) + 4 );
 172                 if( psz_name == NULL ) continue;
 173                 strcpy( psz_name, "no-" );
 174                 strcat( psz_name, p_item->psz_name );
 175
 176                 p_longopts[i_index].name = psz_name;
 177                 p_longopts[i_index].has_arg = no_argument;
 178                 p_longopts[i_index].flag = &flag;
 179                 p_longopts[i_index].val = 1;
 180                 i_index++;
 181             }
 182
 183             /* If item also has a short option, add it */
 184             if( p_item->i_short )
 185             {
 186                 pp_shortopts[(int)p_item->i_short] = p_item;
 187                 psz_shortopts[i_shortopts] = p_item->i_short;
 188                 i_shortopts++;
 189                 if( p_item->i_type != CONFIG_ITEM_BOOL )
 190                 {
 191                     psz_shortopts[i_shortopts] = ':';
 192                     i_shortopts++;
 193
 194                     if( p_item->i_short == 'v' )
 195                     {
 196                         psz_shortopts[i_shortopts] = ':';
 197                         i_shortopts++;
 198                     }
 199                 }
 200             }
 201         }
 202     }
 203
 204     /* We don't need the module list anymore */
 205     module_list_free( list );
 206
 207     /* Close the longopts and shortopts structures */
 208     memset( &p_longopts[i_index], 0, sizeof(struct option) );
 209     psz_shortopts[i_shortopts] = '\0';
 210
 211     /*
 212      * Parse the command line options
 213      */
 214     opterr = 0;
 215     optind = 0; /* set to 0 to tell GNU getopt to reinitialize */
 216     while( ( i_cmd = vlc_getopt_long( *pi_argc, (char **)ppsz_argv, psz_shortopts,
 217                                   p_longopts, &i_index ) ) != -1 )
 218     {
 219         /* A long option has been recognized */
 220         if( i_cmd == 0 )
 221         {
 222             module_config_t *p_conf;
 223             const char *psz_name = p_longopts[i_index].name;
 224
 225             /* Check if we deal with a --nofoo or --no-foo long option */
 226             if( flag ) psz_name += psz_name[2] == '-' ? 3 : 2;
 227
 228             /* Store the configuration option */
 229             p_conf = config_FindConfig( p_this, psz_name );
 230             if( p_conf )
 231             {
 232                 /* Check if the option is deprecated */
 233                 if( p_conf->b_removed )
 234                 {
 235                     fprintf(stderr,
 236                             "Warning: option --%s no longer exists.\n",
 237                             psz_name);
 238                     continue;
 239                 }
 240
 241                 if( p_conf->psz_oldname
 242                  && !strcmp( p_conf->psz_oldname, psz_name) )
 243                 {
 244                     fprintf( stderr,
 245                              "%s: option --%s is deprecated. Use --%s instead.\n",
 246                              b_ignore_errors ? "Warning" : "Error",
 247                              psz_name, p_conf->psz_name );
 248                     if( !b_ignore_errors )
 249                     {
 250                         /*free */
 251                         for( i_index = 0; p_longopts[i_index].name; i_index++ )
 252                              free( (char *)p_longopts[i_index].name );
 253
 254                         free( p_longopts );
 255                         free( psz_shortopts );
 256                         return -1;
 257                     }
 258
 259                     psz_name = p_conf->psz_name;
 260                 }
 261 #ifdef __APPLE__
 262                 if( p_conf->i_type != CONFIG_ITEM_BOOL && !optarg )
 263                 {
 264                     fprintf( stderr, "Warning: missing argument for option --%s\n", p_conf->psz_name );
 265                     fprintf( stderr, "Try specifying options as '--optionname=value' instead of '--optionname value'\n" );
 266                     continue;
 267                 }
 268 #endif
 269                 switch( p_conf->i_type )
 270                 {
 271                     case CONFIG_ITEM_STRING:
 272                     case CONFIG_ITEM_PASSWORD:
 273                     case CONFIG_ITEM_FILE:
 274                     case CONFIG_ITEM_DIRECTORY:
 275                     case CONFIG_ITEM_MODULE:
 276                     case CONFIG_ITEM_MODULE_LIST:
 277                     case CONFIG_ITEM_MODULE_LIST_CAT:
 278                     case CONFIG_ITEM_MODULE_CAT:
 279                         var_Create( p_this, psz_name, VLC_VAR_STRING );
 280                         var_SetString( p_this, psz_name, optarg );
 281                         break;
 282                     case CONFIG_ITEM_INTEGER:
 283                         var_Create( p_this, psz_name, VLC_VAR_INTEGER );
 284                         var_SetInteger( p_this, psz_name,
 285                                         strtol(optarg, NULL, 0));
 286                         break;
 287                     case CONFIG_ITEM_FLOAT:
 288                         var_Create( p_this, psz_name, VLC_VAR_FLOAT );
 289                         var_SetFloat( p_this, psz_name, us_atof(optarg) );
 290                         break;
 291                     case CONFIG_ITEM_KEY:
 292                         var_Create( p_this, psz_name, VLC_VAR_INTEGER );
 293                         var_SetInteger( p_this, psz_name,
 294                                         ConfigStringToKey( optarg ) );
 295                         break;
 296                     case CONFIG_ITEM_BOOL:
 297                         var_Create( p_this, psz_name, VLC_VAR_BOOL );
 298                         var_SetBool( p_this, psz_name, !flag );
 299                         break;
 300                 }
 301                 continue;
 302             }
 303         }
 304
 305         /* A short option has been recognized */
 306         if( pp_shortopts[i_cmd] != NULL )
 307         {
 308             const char *name = pp_shortopts[i_cmd]->psz_name;
 309             switch( pp_shortopts[i_cmd]->i_type )
 310             {
 311                 case CONFIG_ITEM_STRING:
 312                 case CONFIG_ITEM_PASSWORD:
 313                 case CONFIG_ITEM_FILE:
 314                 case CONFIG_ITEM_DIRECTORY:
 315                 case CONFIG_ITEM_MODULE:
 316                 case CONFIG_ITEM_MODULE_CAT:
 317                 case CONFIG_ITEM_MODULE_LIST:
 318                 case CONFIG_ITEM_MODULE_LIST_CAT:
 319                     var_Create( p_this, name, VLC_VAR_STRING );
 320                     var_SetString( p_this, name, optarg );
 321                     break;
 322                 case CONFIG_ITEM_INTEGER:
 323                     var_Create( p_this, name, VLC_VAR_INTEGER );
 324                     if( i_cmd == 'v' )
 325                     {
 326                         if( optarg )
 327                         {
 328                             if( *optarg == 'v' ) /* eg. -vvv */
 329                             {
 330                                 i_verbose++;
 331                                 while( *optarg == 'v' )
 332                                 {
 333                                     i_verbose++;
 334                                     optarg++;
 335                                 }
 336                             }
 337                             else
 338                             {
 339                                 i_verbose += atoi( optarg ); /* eg. -v2 */
 340                             }
 341                         }
 342                         else
 343                         {
 344                             i_verbose++; /* -v */
 345                         }
 346                         var_SetInteger( p_this, name, i_verbose );
 347                     }
 348                     else
 349                     {
 350                         var_SetInteger( p_this, name,
 351                                         strtol(optarg, NULL, 0) );
 352                     }
 353                     break;
 354                 case CONFIG_ITEM_BOOL:
 355                     var_Create( p_this, name, VLC_VAR_BOOL );
 356                     var_SetBool( p_this, name, true );
 357                     break;
 358             }
 359
 360             continue;
 361         }
 362
 363         /* Internal error: unknown option */
 364         if( !b_ignore_errors )
 365         {
 366             fputs( "vlc: unknown option"
 367                      " or missing mandatory argument ", stderr );
 368             if( optopt )
 369             {
 370                 fprintf( stderr, "`-%c'\n", optopt );
 371             }
 372             else
 373             {
 374                 fprintf( stderr, "`%s'\n", ppsz_argv[optind-1] );
 375             }
 376             fputs( "Try `vlc --help' for more information.\n", stderr );
 377
 378             for( i_index = 0; p_longopts[i_index].name; i_index++ )
 379                 free( (char *)p_longopts[i_index].name );
 380             free( p_longopts );
 381             free( psz_shortopts );
 382             return -1;
 383         }
 384     }
 385
 386     /* Free allocated resources */
 387     for( i_index = 0; p_longopts[i_index].name; i_index++ )
 388         free( (char *)p_longopts[i_index].name );
 389     free( p_longopts );
 390     free( psz_shortopts );
 391     free( argv_copy );
 392
 393     return 0;
 394 }
 395