]> git.sesse.net Git - vlc/blobdiff - src/config/cmdline.c
Fix error handling from module_list_get() (fixes #7500)
[vlc] / src / config / cmdline.c
index 9174a4fabacc6df064fea6e031912fec76a73855..12e92ba49711f109cebd0b6d8e25d44938b576e6 100644 (file)
@@ -1,24 +1,24 @@
 /*****************************************************************************
  * cmdline.c: command line parsing
  *****************************************************************************
- * Copyright (C) 2001-2007 the VideoLAN team
+ * Copyright (C) 2001-2007 VLC authors and VideoLAN
  * $Id$
  *
  * Authors: Gildas Bazin <gbazin@videolan.org>
  *
- * This program is free software; you can redistribute it and/or modify
- * it under the terms of the GNU General Public License as published by
- * the Free Software Foundation; either version 2 of the License, or
+ * This program is free software; you can redistribute it and/or modify it
+ * under the terms of the GNU Lesser General Public License as published by
+ * the Free Software Foundation; either version 2.1 of the License, or
  * (at your option) any later version.
  *
  * This program is distributed in the hope that it will be useful,
  * but WITHOUT ANY WARRANTY; without even the implied warranty of
- * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
- * GNU General Public License for more details.
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+ * GNU Lesser General Public License for more details.
  *
- * You should have received a copy of the GNU General Public License
- * along with this program; if not, write to the Free Software
- * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
+ * You should have received a copy of the GNU Lesser General Public License
+ * along with this program; if not, write to the Free Software Foundation,
+ * Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
  *****************************************************************************/
 
 #ifdef HAVE_CONFIG_H
@@ -29,6 +29,8 @@
 #include "../libvlc.h"
 #include <vlc_keys.h>
 #include <vlc_charset.h>
+#include <vlc_modules.h>
+#include <vlc_plugin.h>
 
 #include "vlc_getopt.h"
 
  * options used (ie. exported) by each module.
  *
  * @param p_this object to write command line options as variables to
- * @param pi_argc number of command line arguments [IN/OUT]
+ * @param i_argc number of command line arguments
  * @param ppsz_args commandl ine arguments [IN/OUT]
- * @param b_ignore_errors whether to ignore parsing errors
+ * @param pindex NULL to ignore unknown options,
+ *               otherwise index of the first non-option argument [OUT]
  * @return 0 on success, -1 on error.
- *
- * @warning This function is not re-entrant (because of getopt_long()).
- * It must be called with the module bank initialization global lock held.
  */
-int config_LoadCmdLine( vlc_object_t *p_this, int *pi_argc,
-                        const char *ppsz_argv[], bool b_ignore_errors )
+int config_LoadCmdLine( vlc_object_t *p_this, int i_argc,
+                        const char *ppsz_argv[], int *pindex )
 {
     int i_cmd, i_index, i_opts, i_shortopts, flag, i_verbose = 0;
-    module_t *p_parser;
     struct vlc_option *p_longopts;
     const char **argv_copy = NULL;
+#define b_ignore_errors (pindex == NULL)
 
     /* Short options */
     module_config_t *pp_shortopts[256];
     char *psz_shortopts;
 
     /* List all modules */
-    module_t **list = module_list_get (NULL);
+    size_t count;
+    module_t **list = module_list_get (&count);
 
     /*
      * Generate the longopts and shortopts structures used by getopt_long
      */
 
     i_opts = 0;
-    for (size_t i = 0; (p_parser = list[i]) != NULL; i++)
+    for (size_t i = 0; i < count; i++)
+    {
         /* count the number of exported configuration options (to allocate
          * longopts). We also need to allocate space for two options when
          * dealing with boolean to allow for --foo and --no-foo */
+        module_t *p_parser = list[i];
+
         i_opts += p_parser->i_config_items + 2 * p_parser->i_bool_items;
+    }
 
     p_longopts = malloc( sizeof(*p_longopts) * (i_opts + 1) );
     if( p_longopts == NULL )
@@ -101,7 +106,7 @@ int config_LoadCmdLine( vlc_object_t *p_this, int *pi_argc,
      * us, ignoring the arity of the options */
     if( b_ignore_errors )
     {
-        argv_copy = (const char**)malloc( *pi_argc * sizeof(char *) );
+        argv_copy = (const char**)malloc( i_argc * sizeof(char *) );
         if( argv_copy == NULL )
         {
             free( psz_shortopts );
@@ -109,7 +114,7 @@ int config_LoadCmdLine( vlc_object_t *p_this, int *pi_argc,
             module_list_free (list);
             return -1;
         }
-        memcpy( argv_copy, ppsz_argv, *pi_argc * sizeof(char *) );
+        memcpy( argv_copy, ppsz_argv, i_argc * sizeof(char *) );
         ppsz_argv = argv_copy;
     }
 
@@ -121,8 +126,9 @@ int config_LoadCmdLine( vlc_object_t *p_this, int *pi_argc,
 
     /* Fill the p_longopts and psz_shortopts structures */
     i_index = 0;
-    for (size_t i = 0; (p_parser = list[i]) != NULL; i++)
+    for (size_t i = 0; i < count; i++)
     {
+        module_t *p_parser = list[i];
         module_config_t *p_item, *p_end;
 
         if( !p_parser->i_config_items )
@@ -133,44 +139,41 @@ int config_LoadCmdLine( vlc_object_t *p_this, int *pi_argc,
              p_item++ )
         {
             /* Ignore hints */
-            if( p_item->i_type & CONFIG_HINT )
+            if( !CONFIG_ITEM(p_item->i_type) )
                 continue;
 
             /* Add item to long options */
             p_longopts[i_index].name = strdup( p_item->psz_name );
             if( p_longopts[i_index].name == NULL ) continue;
-            p_longopts[i_index].has_arg =
-                (p_item->i_type != CONFIG_ITEM_BOOL);
             p_longopts[i_index].flag = &flag;
             p_longopts[i_index].val = 0;
-            i_index++;
 
-            /* When dealing with bools we also need to add the --no-foo
-             * option */
-            if( p_item->i_type == CONFIG_ITEM_BOOL )
+            if( CONFIG_CLASS(p_item->i_type) != CONFIG_ITEM_BOOL )
+                p_longopts[i_index].has_arg = true;
+            else
+            /* Booleans also need --no-foo and --nofoo options */
             {
-                char *psz_name = malloc( strlen(p_item->psz_name) + 3 );
-                if( psz_name == NULL ) continue;
-                strcpy( psz_name, "no" );
-                strcat( psz_name, p_item->psz_name );
+                char *psz_name;
 
+                p_longopts[i_index].has_arg = false;
+                i_index++;
+
+                if( asprintf( &psz_name, "no%s", p_item->psz_name ) == -1 )
+                    continue;
                 p_longopts[i_index].name = psz_name;
                 p_longopts[i_index].has_arg = false;
                 p_longopts[i_index].flag = &flag;
                 p_longopts[i_index].val = 1;
                 i_index++;
 
-                psz_name = malloc( strlen(p_item->psz_name) + 4 );
-                if( psz_name == NULL ) continue;
-                strcpy( psz_name, "no-" );
-                strcat( psz_name, p_item->psz_name );
-
+                if( asprintf( &psz_name, "no-%s", p_item->psz_name ) == -1 )
+                    continue;
                 p_longopts[i_index].name = psz_name;
                 p_longopts[i_index].has_arg = false;
                 p_longopts[i_index].flag = &flag;
                 p_longopts[i_index].val = 1;
-                i_index++;
             }
+            i_index++;
 
             /* If item also has a short option, add it */
             if( p_item->i_short )
@@ -195,13 +198,16 @@ int config_LoadCmdLine( vlc_object_t *p_this, int *pi_argc,
     memset( &p_longopts[i_index], 0, sizeof(*p_longopts) );
     psz_shortopts[i_shortopts] = '\0';
 
+    int ret = -1;
+
     /*
      * Parse the command line options
      */
-    vlc_optind = 0; /* set to 0 to tell GNU getopt to reinitialize */
-    while( ( i_cmd = vlc_getopt_long( *pi_argc, (char **)ppsz_argv,
+    vlc_getopt_t state;
+    state.ind = 0 ; /* set to 0 to tell GNU getopt to reinitialize */
+    while( ( i_cmd = vlc_getopt_long( i_argc, (char **)ppsz_argv,
                                       psz_shortopts,
-                                      p_longopts, &i_index ) ) != -1 )
+                                      p_longopts, &i_index, &state ) ) != -1 )
     {
         /* A long option has been recognized */
         if( i_cmd == 0 )
@@ -225,53 +231,20 @@ int config_LoadCmdLine( vlc_object_t *p_this, int *pi_argc,
                     continue;
                 }
 
-                if( p_conf->psz_oldname
-                 && !strcmp( p_conf->psz_oldname, psz_name) )
-                {
-                    fprintf( stderr,
-                             "%s: option --%s is deprecated. Use --%s instead.\n",
-                             b_ignore_errors ? "Warning" : "Error",
-                             psz_name, p_conf->psz_name );
-                    if( !b_ignore_errors )
-                    {
-                        /*free */
-                        for( i_index = 0; p_longopts[i_index].name; i_index++ )
-                             free( (char *)p_longopts[i_index].name );
-
-                        free( p_longopts );
-                        free( psz_shortopts );
-                        return -1;
-                    }
-
-                    psz_name = p_conf->psz_name;
-                }
-
-                switch( p_conf->i_type )
+                switch( CONFIG_CLASS(p_conf->i_type) )
                 {
                     case CONFIG_ITEM_STRING:
-                    case CONFIG_ITEM_PASSWORD:
-                    case CONFIG_ITEM_FILE:
-                    case CONFIG_ITEM_DIRECTORY:
-                    case CONFIG_ITEM_MODULE:
-                    case CONFIG_ITEM_MODULE_LIST:
-                    case CONFIG_ITEM_MODULE_LIST_CAT:
-                    case CONFIG_ITEM_MODULE_CAT:
                         var_Create( p_this, psz_name, VLC_VAR_STRING );
-                        var_SetString( p_this, psz_name, vlc_optarg );
+                        var_SetString( p_this, psz_name, state.arg );
                         break;
                     case CONFIG_ITEM_INTEGER:
                         var_Create( p_this, psz_name, VLC_VAR_INTEGER );
                         var_SetInteger( p_this, psz_name,
-                                        strtol(vlc_optarg, NULL, 0));
+                                        strtoll(state.arg, NULL, 0));
                         break;
                     case CONFIG_ITEM_FLOAT:
                         var_Create( p_this, psz_name, VLC_VAR_FLOAT );
-                        var_SetFloat( p_this, psz_name, us_atof(vlc_optarg) );
-                        break;
-                    case CONFIG_ITEM_KEY:
-                        var_Create( p_this, psz_name, VLC_VAR_INTEGER );
-                        var_SetInteger( p_this, psz_name,
-                                        ConfigStringToKey( vlc_optarg ) );
+                        var_SetFloat( p_this, psz_name, us_atof(state.arg) );
                         break;
                     case CONFIG_ITEM_BOOL:
                         var_Create( p_this, psz_name, VLC_VAR_BOOL );
@@ -286,18 +259,11 @@ int config_LoadCmdLine( vlc_object_t *p_this, int *pi_argc,
         if( pp_shortopts[i_cmd] != NULL )
         {
             const char *name = pp_shortopts[i_cmd]->psz_name;
-            switch( pp_shortopts[i_cmd]->i_type )
+            switch( CONFIG_CLASS(pp_shortopts[i_cmd]->i_type) )
             {
                 case CONFIG_ITEM_STRING:
-                case CONFIG_ITEM_PASSWORD:
-                case CONFIG_ITEM_FILE:
-                case CONFIG_ITEM_DIRECTORY:
-                case CONFIG_ITEM_MODULE:
-                case CONFIG_ITEM_MODULE_CAT:
-                case CONFIG_ITEM_MODULE_LIST:
-                case CONFIG_ITEM_MODULE_LIST_CAT:
                     var_Create( p_this, name, VLC_VAR_STRING );
-                    var_SetString( p_this, name, vlc_optarg );
+                    var_SetString( p_this, name, state.arg );
                     break;
                 case CONFIG_ITEM_INTEGER:
                     var_Create( p_this, name, VLC_VAR_INTEGER );
@@ -309,7 +275,7 @@ int config_LoadCmdLine( vlc_object_t *p_this, int *pi_argc,
                     else
                     {
                         var_SetInteger( p_this, name,
-                                        strtol(vlc_optarg, NULL, 0) );
+                                        strtoll(state.arg, NULL, 0) );
                     }
                     break;
                 case CONFIG_ITEM_BOOL:
@@ -326,31 +292,29 @@ int config_LoadCmdLine( vlc_object_t *p_this, int *pi_argc,
         {
             fputs( "vlc: unknown option"
                      " or missing mandatory argument ", stderr );
-            if( vlc_optopt )
+            if( state.opt )
             {
-                fprintf( stderr, "`-%c'\n", vlc_optopt );
+                fprintf( stderr, "`-%c'\n", state.opt );
             }
             else
             {
-                fprintf( stderr, "`%s'\n", ppsz_argv[vlc_optind-1] );
+                fprintf( stderr, "`%s'\n", ppsz_argv[state.ind-1] );
             }
             fputs( "Try `vlc --help' for more information.\n", stderr );
-
-            for( i_index = 0; p_longopts[i_index].name; i_index++ )
-                free( (char *)p_longopts[i_index].name );
-            free( p_longopts );
-            free( psz_shortopts );
-            return -1;
+            goto out;
         }
     }
 
+    ret = 0;
+    if( pindex != NULL )
+        *pindex = state.ind;
+out:
     /* Free allocated resources */
     for( i_index = 0; p_longopts[i_index].name; i_index++ )
         free( (char *)p_longopts[i_index].name );
     free( p_longopts );
     free( psz_shortopts );
     free( argv_copy );
-
-    return 0;
+    return ret;
 }