1 /*****************************************************************************
2 * cmdline.c: command line parsing
3 *****************************************************************************
4 * Copyright (C) 2001-2007 the VideoLAN team
7 * Authors: Gildas Bazin <gbazin@videolan.org>
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.
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.
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 *****************************************************************************/
25 #include "../libvlc.h"
27 #include "vlc_charset.h"
29 #include <errno.h> /* errno */
36 # include <unistd.h> /* getuid() */
39 #ifdef HAVE_GETOPT_LONG
41 # include <getopt.h> /* getopt() */
44 # include "../extras/getopt.h"
47 #if defined(HAVE_GETPWUID)
48 # include <pwd.h> /* getpwuid() */
51 #if defined( HAVE_SYS_STAT_H )
52 # include <sys/stat.h>
54 #if defined( HAVE_SYS_TYPES_H )
55 # include <sys/types.h>
58 # if !defined( UNDER_CE )
65 #include "modules/modules.h"
67 /*****************************************************************************
68 * config_LoadCmdLine: parse command line
69 *****************************************************************************
70 * Parse command line for configuration options.
71 * Now that the module_bank has been initialized, we can dynamically
72 * generate the longopts structure used by getops. We have to do it this way
73 * because we don't know (and don't want to know) in advance the configuration
74 * options used (ie. exported) by each module.
75 *****************************************************************************/
76 int __config_LoadCmdLine( vlc_object_t *p_this, int *pi_argc,
77 const char *ppsz_argv[],
78 vlc_bool_t b_ignore_errors )
80 int i_cmd, i_index, i_opts, i_shortopts, flag, i_verbose = 0;
83 struct option *p_longopts;
87 module_config_t *pp_shortopts[256];
90 /* Set default configuration and copy arguments */
91 p_this->p_libvlc->i_argc = *pi_argc;
92 p_this->p_libvlc->ppsz_argv = ppsz_argv;
95 /* When VLC.app is run by double clicking in Mac OS X, the 2nd arg
96 * is the PSN - process serial number (a unique PID-ish thingie)
97 * still ok for real Darwin & when run from command line */
98 if ( (*pi_argc > 1) && (strncmp( ppsz_argv[ 1 ] , "-psn" , 4 ) == 0) )
99 /* for example -psn_0_9306113 */
101 /* GDMF!... I can't do this or else the MacOSX window server will
102 * not pick up the PSN and not register the app and we crash...
103 * hence the following kludge otherwise we'll get confused w/ argv[1]
104 * being an input file name */
106 ppsz_argv[ 1 ] = NULL;
108 *pi_argc = *pi_argc - 1;
114 /* List all modules */
115 p_list = vlc_list_find( p_this, VLC_OBJECT_MODULE, FIND_ANYWHERE );
118 * Generate the longopts and shortopts structures used by getopt_long
122 for( i_modules_index = 0; i_modules_index < p_list->i_count;
125 p_parser = (module_t *)p_list->p_values[i_modules_index].p_object ;
127 /* count the number of exported configuration options (to allocate
128 * longopts). We also need to allocate space for two options when
129 * dealing with boolean to allow for --foo and --no-foo */
130 i_opts += p_parser->i_config_items
131 + 2 * p_parser->i_bool_items;
134 p_longopts = malloc( sizeof(struct option) * (i_opts + 1) );
135 if( p_longopts == NULL )
137 msg_Err( p_this, "out of memory" );
138 vlc_list_release( p_list );
142 psz_shortopts = malloc( sizeof( char ) * (2 * i_opts + 1) );
143 if( psz_shortopts == NULL )
145 msg_Err( p_this, "out of memory" );
147 vlc_list_release( p_list );
151 /* If we are requested to ignore errors, then we must work on a copy
152 * of the ppsz_argv array, otherwise getopt_long will reorder it for
153 * us, ignoring the arity of the options */
154 if( b_ignore_errors )
156 ppsz_argv = (const char**)malloc( *pi_argc * sizeof(char *) );
157 if( ppsz_argv == NULL )
159 msg_Err( p_this, "out of memory" );
160 free( psz_shortopts );
162 vlc_list_release( p_list );
165 memcpy( ppsz_argv, p_this->p_libvlc->ppsz_argv,
166 *pi_argc * sizeof(char *) );
170 for( i_index = 0; i_index < 256; i_index++ )
172 pp_shortopts[i_index] = NULL;
175 /* Fill the p_longopts and psz_shortopts structures */
177 for( i_modules_index = 0; i_modules_index < p_list->i_count;
180 module_config_t *p_item, *p_end;
181 p_parser = (module_t *)p_list->p_values[i_modules_index].p_object ;
183 if( !p_parser->i_config_items )
186 for( p_item = p_parser->p_config, p_end = p_item + p_parser->confsize;
191 if( p_item->i_type & CONFIG_HINT )
194 /* Add item to long options */
195 p_longopts[i_index].name = strdup( p_item->psz_name );
196 if( p_longopts[i_index].name == NULL ) continue;
197 p_longopts[i_index].has_arg =
198 (p_item->i_type == CONFIG_ITEM_BOOL)?
199 no_argument : required_argument;
200 p_longopts[i_index].flag = &flag;
201 p_longopts[i_index].val = 0;
204 /* When dealing with bools we also need to add the --no-foo
206 if( p_item->i_type == CONFIG_ITEM_BOOL )
208 char *psz_name = malloc( strlen(p_item->psz_name) + 3 );
209 if( psz_name == NULL ) continue;
210 strcpy( psz_name, "no" );
211 strcat( psz_name, p_item->psz_name );
213 p_longopts[i_index].name = psz_name;
214 p_longopts[i_index].has_arg = no_argument;
215 p_longopts[i_index].flag = &flag;
216 p_longopts[i_index].val = 1;
219 psz_name = malloc( strlen(p_item->psz_name) + 4 );
220 if( psz_name == NULL ) continue;
221 strcpy( psz_name, "no-" );
222 strcat( psz_name, p_item->psz_name );
224 p_longopts[i_index].name = psz_name;
225 p_longopts[i_index].has_arg = no_argument;
226 p_longopts[i_index].flag = &flag;
227 p_longopts[i_index].val = 1;
231 /* If item also has a short option, add it */
232 if( p_item->i_short )
234 pp_shortopts[(int)p_item->i_short] = p_item;
235 psz_shortopts[i_shortopts] = p_item->i_short;
237 if( p_item->i_type != CONFIG_ITEM_BOOL )
239 psz_shortopts[i_shortopts] = ':';
242 if( p_item->i_short == 'v' )
244 psz_shortopts[i_shortopts] = ':';
252 /* We don't need the module list anymore */
253 vlc_list_release( p_list );
255 /* Close the longopts and shortopts structures */
256 memset( &p_longopts[i_index], 0, sizeof(struct option) );
257 psz_shortopts[i_shortopts] = '\0';
260 * Parse the command line options
263 optind = 0; /* set to 0 to tell GNU getopt to reinitialize */
264 while( ( i_cmd = getopt_long( *pi_argc, (char **)ppsz_argv, psz_shortopts,
265 p_longopts, &i_index ) ) != -1 )
267 /* A long option has been recognized */
270 module_config_t *p_conf;
271 char *psz_name = (char *)p_longopts[i_index].name;
273 /* Check if we deal with a --nofoo or --no-foo long option */
274 if( flag ) psz_name += psz_name[2] == '-' ? 3 : 2;
276 /* Store the configuration option */
277 p_conf = config_FindConfig( p_this, psz_name );
280 /* Check if the option is deprecated */
281 if( p_conf->b_removed )
284 "Warning: option --%s no longer exists.\n",
289 if( p_conf->psz_oldname
290 && !strcmp( p_conf->psz_oldname, psz_name) )
293 "%s: option --%s is deprecated. Use --%s instead.\n",
294 b_ignore_errors ? "Warning" : "Error",
295 psz_name, p_conf->psz_name );
296 if( !b_ignore_errors )
299 for( i_index = 0; p_longopts[i_index].name; i_index++ )
300 free( (char *)p_longopts[i_index].name );
303 free( psz_shortopts );
307 psz_name = p_conf->psz_name;
310 switch( p_conf->i_type )
312 case CONFIG_ITEM_STRING:
313 case CONFIG_ITEM_PASSWORD:
314 case CONFIG_ITEM_FILE:
315 case CONFIG_ITEM_DIRECTORY:
316 case CONFIG_ITEM_MODULE:
317 case CONFIG_ITEM_MODULE_LIST:
318 case CONFIG_ITEM_MODULE_LIST_CAT:
319 case CONFIG_ITEM_MODULE_CAT:
320 config_PutPsz( p_this, psz_name, optarg );
322 case CONFIG_ITEM_INTEGER:
323 config_PutInt( p_this, psz_name, strtol(optarg, 0, 0));
325 case CONFIG_ITEM_FLOAT:
326 config_PutFloat( p_this, psz_name, (float)atof(optarg) );
328 case CONFIG_ITEM_KEY:
329 config_PutInt( p_this, psz_name, ConfigStringToKey( optarg ) );
331 case CONFIG_ITEM_BOOL:
332 config_PutInt( p_this, psz_name, !flag );
339 /* A short option has been recognized */
340 if( pp_shortopts[i_cmd] != NULL )
342 switch( pp_shortopts[i_cmd]->i_type )
344 case CONFIG_ITEM_STRING:
345 case CONFIG_ITEM_PASSWORD:
346 case CONFIG_ITEM_FILE:
347 case CONFIG_ITEM_DIRECTORY:
348 case CONFIG_ITEM_MODULE:
349 case CONFIG_ITEM_MODULE_CAT:
350 case CONFIG_ITEM_MODULE_LIST:
351 case CONFIG_ITEM_MODULE_LIST_CAT:
352 config_PutPsz( p_this, pp_shortopts[i_cmd]->psz_name, optarg );
354 case CONFIG_ITEM_INTEGER:
359 if( *optarg == 'v' ) /* eg. -vvv */
362 while( *optarg == 'v' )
370 i_verbose += atoi( optarg ); /* eg. -v2 */
375 i_verbose++; /* -v */
377 config_PutInt( p_this, pp_shortopts[i_cmd]->psz_name,
382 config_PutInt( p_this, pp_shortopts[i_cmd]->psz_name,
383 strtol(optarg, 0, 0) );
386 case CONFIG_ITEM_BOOL:
387 config_PutInt( p_this, pp_shortopts[i_cmd]->psz_name, 1 );
394 /* Internal error: unknown option */
395 if( !b_ignore_errors )
397 fprintf( stderr, "%s: unknown option"
398 " or missing mandatory argument ",
399 p_this->p_libvlc->psz_object_name );
402 fprintf( stderr, "`-%c'\n", optopt );
406 fprintf( stderr, "`%s'\n", ppsz_argv[optind-1] );
408 fprintf( stderr, "Try `%s --help' for more information.\n",
409 p_this->p_libvlc->psz_object_name );
411 for( i_index = 0; p_longopts[i_index].name; i_index++ )
412 free( (char *)p_longopts[i_index].name );
414 free( psz_shortopts );
419 /* Free allocated resources */
420 for( i_index = 0; p_longopts[i_index].name; i_index++ )
421 free( (char *)p_longopts[i_index].name );
423 free( psz_shortopts );
424 if( b_ignore_errors ) free( ppsz_argv );