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 i_argc number of command line arguments
  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  */
  58 int config_LoadCmdLine( vlc_object_t *p_this, int i_argc,
  59                         const char *ppsz_argv[], bool b_ignore_errors )
  60 {
  61     int i_cmd, i_index, i_opts, i_shortopts, flag, i_verbose = 0;
  62     module_t *p_parser;
  63     struct vlc_option *p_longopts;
  64     const char **argv_copy = NULL;
  65
  66     /* Short options */
  67     module_config_t *pp_shortopts[256];
  68     char *psz_shortopts;
  69
  70     /* List all modules */
  71     module_t **list = module_list_get (NULL);
  72
  73     /*
  74      * Generate the longopts and shortopts structures used by getopt_long
  75      */
  76
  77     i_opts = 0;
  78     for (size_t i = 0; (p_parser = list[i]) != NULL; i++)
  79         /* count the number of exported configuration options (to allocate
  80          * longopts). We also need to allocate space for two options when
  81          * dealing with boolean to allow for --foo and --no-foo */
  82         i_opts += p_parser->i_config_items + 2 * p_parser->i_bool_items;
  83
  84     p_longopts = malloc( sizeof(*p_longopts) * (i_opts + 1) );
  85     if( p_longopts == NULL )
  86     {
  87         module_list_free (list);
  88         return -1;
  89     }
  90
  91     psz_shortopts = malloc( 2 * i_opts + 1 );
  92     if( psz_shortopts == NULL )
  93     {
  94         free( p_longopts );
  95         module_list_free (list);
  96         return -1;
  97     }
  98
  99     /* If we are requested to ignore errors, then we must work on a copy
 100      * of the ppsz_argv array, otherwise getopt_long will reorder it for
 101      * us, ignoring the arity of the options */
 102     if( b_ignore_errors )
 103     {
 104         argv_copy = (const char**)malloc( i_argc * sizeof(char *) );
 105         if( argv_copy == NULL )
 106         {
 107             free( psz_shortopts );
 108             free( p_longopts );
 109             module_list_free (list);
 110             return -1;
 111         }
 112         memcpy( argv_copy, ppsz_argv, i_argc * sizeof(char *) );
 113         ppsz_argv = argv_copy;
 114     }
 115
 116     i_shortopts = 0;
 117     for( i_index = 0; i_index < 256; i_index++ )
 118     {
 119         pp_shortopts[i_index] = NULL;
 120     }
 121
 122     /* Fill the p_longopts and psz_shortopts structures */
 123     i_index = 0;
 124     for (size_t i = 0; (p_parser = list[i]) != NULL; i++)
 125     {
 126         module_config_t *p_item, *p_end;
 127
 128         if( !p_parser->i_config_items )
 129             continue;
 130
 131         for( p_item = p_parser->p_config, p_end = p_item + p_parser->confsize;
 132              p_item < p_end;
 133              p_item++ )
 134         {
 135             /* Ignore hints */
 136             if( p_item->i_type & CONFIG_HINT )
 137                 continue;
 138
 139             /* Add item to long options */
 140             p_longopts[i_index].name = strdup( p_item->psz_name );
 141             if( p_longopts[i_index].name == NULL ) continue;
 142             p_longopts[i_index].has_arg =
 143                 (p_item->i_type != CONFIG_ITEM_BOOL);
 144             p_longopts[i_index].flag = &flag;
 145             p_longopts[i_index].val = 0;
 146             i_index++;
 147
 148             /* When dealing with bools we also need to add the --no-foo
 149              * option */
 150             if( p_item->i_type == CONFIG_ITEM_BOOL )
 151             {
 152                 char *psz_name = malloc( strlen(p_item->psz_name) + 3 );
 153                 if( psz_name == NULL ) continue;
 154                 strcpy( psz_name, "no" );
 155                 strcat( psz_name, p_item->psz_name );
 156
 157                 p_longopts[i_index].name = psz_name;
 158                 p_longopts[i_index].has_arg = false;
 159                 p_longopts[i_index].flag = &flag;
 160                 p_longopts[i_index].val = 1;
 161                 i_index++;
 162
 163                 psz_name = malloc( strlen(p_item->psz_name) + 4 );
 164                 if( psz_name == NULL ) continue;
 165                 strcpy( psz_name, "no-" );
 166                 strcat( psz_name, p_item->psz_name );
 167
 168                 p_longopts[i_index].name = psz_name;
 169                 p_longopts[i_index].has_arg = false;
 170                 p_longopts[i_index].flag = &flag;
 171                 p_longopts[i_index].val = 1;
 172                 i_index++;
 173             }
 174
 175             /* If item also has a short option, add it */
 176             if( p_item->i_short )
 177             {
 178                 pp_shortopts[(int)p_item->i_short] = p_item;
 179                 psz_shortopts[i_shortopts] = p_item->i_short;
 180                 i_shortopts++;
 181                 if( p_item->i_type != CONFIG_ITEM_BOOL
 182                  && p_item->i_short != 'v' )
 183                 {
 184                     psz_shortopts[i_shortopts] = ':';
 185                     i_shortopts++;
 186                 }
 187             }
 188         }
 189     }
 190
 191     /* We don't need the module list anymore */
 192     module_list_free( list );
 193
 194     /* Close the longopts and shortopts structures */
 195     memset( &p_longopts[i_index], 0, sizeof(*p_longopts) );
 196     psz_shortopts[i_shortopts] = '\0';
 197
 198     int ret = -1;
 199
 200     /*
 201      * Parse the command line options
 202      */
 203     vlc_optind = 0; /* set to 0 to tell GNU getopt to reinitialize */
 204     while( ( i_cmd = vlc_getopt_long( i_argc, (char **)ppsz_argv,
 205                                       psz_shortopts,
 206                                       p_longopts, &i_index ) ) != -1 )
 207     {
 208         /* A long option has been recognized */
 209         if( i_cmd == 0 )
 210         {
 211             module_config_t *p_conf;
 212             const char *psz_name = p_longopts[i_index].name;
 213
 214             /* Check if we deal with a --nofoo or --no-foo long option */
 215             if( flag ) psz_name += psz_name[2] == '-' ? 3 : 2;
 216
 217             /* Store the configuration option */
 218             p_conf = config_FindConfig( p_this, psz_name );
 219             if( p_conf )
 220             {
 221                 /* Check if the option is deprecated */
 222                 if( p_conf->b_removed )
 223                 {
 224                     fprintf(stderr,
 225                             "Warning: option --%s no longer exists.\n",
 226                             psz_name);
 227                     continue;
 228                 }
 229
 230                 if( p_conf->psz_oldname
 231                  && !strcmp( p_conf->psz_oldname, psz_name) )
 232                 {
 233                     if( !b_ignore_errors )
 234                     {
 235                         fprintf( stderr, "Error: option --%s is deprecated. "
 236                                  "Use --%s instead.\n",
 237                                  psz_name, p_conf->psz_name );
 238                         goto out;
 239                     }
 240
 241                     psz_name = p_conf->psz_name;
 242                 }
 243
 244                 switch( p_conf->i_type )
 245                 {
 246                     case CONFIG_ITEM_STRING:
 247                     case CONFIG_ITEM_PASSWORD:
 248                     case CONFIG_ITEM_FILE:
 249                     case CONFIG_ITEM_DIRECTORY:
 250                     case CONFIG_ITEM_MODULE:
 251                     case CONFIG_ITEM_MODULE_LIST:
 252                     case CONFIG_ITEM_MODULE_LIST_CAT:
 253                     case CONFIG_ITEM_MODULE_CAT:
 254                         var_Create( p_this, psz_name, VLC_VAR_STRING );
 255                         var_SetString( p_this, psz_name, vlc_optarg );
 256                         break;
 257                     case CONFIG_ITEM_INTEGER:
 258                         var_Create( p_this, psz_name, VLC_VAR_INTEGER );
 259                         var_SetInteger( p_this, psz_name,
 260                                         strtol(vlc_optarg, NULL, 0));
 261                         break;
 262                     case CONFIG_ITEM_FLOAT:
 263                         var_Create( p_this, psz_name, VLC_VAR_FLOAT );
 264                         var_SetFloat( p_this, psz_name, us_atof(vlc_optarg) );
 265                         break;
 266                     case CONFIG_ITEM_KEY:
 267                         var_Create( p_this, psz_name, VLC_VAR_INTEGER );
 268                         var_SetInteger( p_this, psz_name,
 269                                         ConfigStringToKey( vlc_optarg ) );
 270                         break;
 271                     case CONFIG_ITEM_BOOL:
 272                         var_Create( p_this, psz_name, VLC_VAR_BOOL );
 273                         var_SetBool( p_this, psz_name, !flag );
 274                         break;
 275                 }
 276                 continue;
 277             }
 278         }
 279
 280         /* A short option has been recognized */
 281         if( pp_shortopts[i_cmd] != NULL )
 282         {
 283             const char *name = pp_shortopts[i_cmd]->psz_name;
 284             switch( pp_shortopts[i_cmd]->i_type )
 285             {
 286                 case CONFIG_ITEM_STRING:
 287                 case CONFIG_ITEM_PASSWORD:
 288                 case CONFIG_ITEM_FILE:
 289                 case CONFIG_ITEM_DIRECTORY:
 290                 case CONFIG_ITEM_MODULE:
 291                 case CONFIG_ITEM_MODULE_CAT:
 292                 case CONFIG_ITEM_MODULE_LIST:
 293                 case CONFIG_ITEM_MODULE_LIST_CAT:
 294                     var_Create( p_this, name, VLC_VAR_STRING );
 295                     var_SetString( p_this, name, vlc_optarg );
 296                     break;
 297                 case CONFIG_ITEM_INTEGER:
 298                     var_Create( p_this, name, VLC_VAR_INTEGER );
 299                     if( i_cmd == 'v' )
 300                     {
 301                         i_verbose++; /* -v */
 302                         var_SetInteger( p_this, name, i_verbose );
 303                     }
 304                     else
 305                     {
 306                         var_SetInteger( p_this, name,
 307                                         strtol(vlc_optarg, NULL, 0) );
 308                     }
 309                     break;
 310                 case CONFIG_ITEM_BOOL:
 311                     var_Create( p_this, name, VLC_VAR_BOOL );
 312                     var_SetBool( p_this, name, true );
 313                     break;
 314             }
 315
 316             continue;
 317         }
 318
 319         /* Internal error: unknown option */
 320         if( !b_ignore_errors )
 321         {
 322             fputs( "vlc: unknown option"
 323                      " or missing mandatory argument ", stderr );
 324             if( vlc_optopt )
 325             {
 326                 fprintf( stderr, "`-%c'\n", vlc_optopt );
 327             }
 328             else
 329             {
 330                 fprintf( stderr, "`%s'\n", ppsz_argv[vlc_optind-1] );
 331             }
 332             fputs( "Try `vlc --help' for more information.\n", stderr );
 333             goto out;
 334         }
 335     }
 336
 337     ret = 0;
 338 out:
 339     /* Free allocated resources */
 340     for( i_index = 0; p_longopts[i_index].name; i_index++ )
 341         free( (char *)p_longopts[i_index].name );
 342     free( p_longopts );
 343     free( psz_shortopts );
 344     free( argv_copy );
 345     return ret;
 346 }
 347