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 *****************************************************************************/
29 #include "../libvlc.h"
31 #include "vlc_charset.h"
33 #include <errno.h> /* errno */
37 # include <unistd.h> /* getuid() */
40 #ifdef HAVE_GETOPT_LONG
42 # include <getopt.h> /* getopt() */
45 # include "../extras/getopt.h"
48 #if defined(HAVE_GETPWUID)
49 # include <pwd.h> /* getpwuid() */
52 #if defined( HAVE_SYS_STAT_H )
53 # include <sys/stat.h>
55 #if defined( HAVE_SYS_TYPES_H )
56 # include <sys/types.h>
59 # if !defined( UNDER_CE )
65 #include "configuration.h"
66 #include "modules/modules.h"
68 /*****************************************************************************
69 * config_LoadCmdLine: parse command line
70 *****************************************************************************
71 * Parse command line for configuration options.
72 * Now that the module_bank has been initialized, we can dynamically
73 * generate the longopts structure used by getops. We have to do it this way
74 * because we don't know (and don't want to know) in advance the configuration
75 * options used (ie. exported) by each module.
76 *****************************************************************************/
77 int __config_LoadCmdLine( vlc_object_t *p_this, int *pi_argc,
78 const char *ppsz_argv[],
79 vlc_bool_t b_ignore_errors )
81 int i_cmd, i_index, i_opts, i_shortopts, flag, i_verbose = 0;
84 struct option *p_longopts;
86 const char **argv_copy = NULL;
89 module_config_t *pp_shortopts[256];
93 /* When VLC.app is run by double clicking in Mac OS X, the 2nd arg
94 * is the PSN - process serial number (a unique PID-ish thingie)
95 * still ok for real Darwin & when run from command line */
96 if ( (*pi_argc > 1) && (strncmp( ppsz_argv[ 1 ] , "-psn" , 4 ) == 0) )
97 /* for example -psn_0_9306113 */
99 /* GDMF!... I can't do this or else the MacOSX window server will
100 * not pick up the PSN and not register the app and we crash...
101 * hence the following kludge otherwise we'll get confused w/ argv[1]
102 * being an input file name */
104 ppsz_argv[ 1 ] = NULL;
106 *pi_argc = *pi_argc - 1;
112 /* List all modules */
113 p_list = vlc_list_find( p_this, VLC_OBJECT_MODULE, FIND_ANYWHERE );
116 * Generate the longopts and shortopts structures used by getopt_long
120 for( i_modules_index = 0; i_modules_index < p_list->i_count;
123 p_parser = (module_t *)p_list->p_values[i_modules_index].p_object ;
125 /* count the number of exported configuration options (to allocate
126 * longopts). We also need to allocate space for two options when
127 * dealing with boolean to allow for --foo and --no-foo */
128 i_opts += p_parser->i_config_items
129 + 2 * p_parser->i_bool_items;
132 p_longopts = malloc( sizeof(struct option) * (i_opts + 1) );
133 if( p_longopts == NULL )
135 msg_Err( p_this, "out of memory" );
136 vlc_list_release( p_list );
140 psz_shortopts = malloc( sizeof( char ) * (2 * i_opts + 1) );
141 if( psz_shortopts == NULL )
143 msg_Err( p_this, "out of memory" );
145 vlc_list_release( p_list );
149 /* If we are requested to ignore errors, then we must work on a copy
150 * of the ppsz_argv array, otherwise getopt_long will reorder it for
151 * us, ignoring the arity of the options */
152 if( b_ignore_errors )
154 argv_copy = (const char**)malloc( *pi_argc * sizeof(char *) );
155 if( argv_copy == NULL )
157 msg_Err( p_this, "out of memory" );
158 free( psz_shortopts );
160 vlc_list_release( p_list );
163 memcpy( argv_copy, ppsz_argv, *pi_argc * sizeof(char *) );
164 ppsz_argv = argv_copy;
168 for( i_index = 0; i_index < 256; i_index++ )
170 pp_shortopts[i_index] = NULL;
173 /* Fill the p_longopts and psz_shortopts structures */
175 for( i_modules_index = 0; i_modules_index < p_list->i_count;
178 module_config_t *p_item, *p_end;
179 p_parser = (module_t *)p_list->p_values[i_modules_index].p_object ;
181 if( !p_parser->i_config_items )
184 for( p_item = p_parser->p_config, p_end = p_item + p_parser->confsize;
189 if( p_item->i_type & CONFIG_HINT )
192 /* Add item to long options */
193 p_longopts[i_index].name = strdup( p_item->psz_name );
194 if( p_longopts[i_index].name == NULL ) continue;
195 p_longopts[i_index].has_arg =
196 (p_item->i_type == CONFIG_ITEM_BOOL)?
197 no_argument : required_argument;
198 p_longopts[i_index].flag = &flag;
199 p_longopts[i_index].val = 0;
202 /* When dealing with bools we also need to add the --no-foo
204 if( p_item->i_type == CONFIG_ITEM_BOOL )
206 char *psz_name = malloc( strlen(p_item->psz_name) + 3 );
207 if( psz_name == NULL ) continue;
208 strcpy( psz_name, "no" );
209 strcat( psz_name, p_item->psz_name );
211 p_longopts[i_index].name = psz_name;
212 p_longopts[i_index].has_arg = no_argument;
213 p_longopts[i_index].flag = &flag;
214 p_longopts[i_index].val = 1;
217 psz_name = malloc( strlen(p_item->psz_name) + 4 );
218 if( psz_name == NULL ) continue;
219 strcpy( psz_name, "no-" );
220 strcat( psz_name, p_item->psz_name );
222 p_longopts[i_index].name = psz_name;
223 p_longopts[i_index].has_arg = no_argument;
224 p_longopts[i_index].flag = &flag;
225 p_longopts[i_index].val = 1;
229 /* If item also has a short option, add it */
230 if( p_item->i_short )
232 pp_shortopts[(int)p_item->i_short] = p_item;
233 psz_shortopts[i_shortopts] = p_item->i_short;
235 if( p_item->i_type != CONFIG_ITEM_BOOL )
237 psz_shortopts[i_shortopts] = ':';
240 if( p_item->i_short == 'v' )
242 psz_shortopts[i_shortopts] = ':';
250 /* We don't need the module list anymore */
251 vlc_list_release( p_list );
253 /* Close the longopts and shortopts structures */
254 memset( &p_longopts[i_index], 0, sizeof(struct option) );
255 psz_shortopts[i_shortopts] = '\0';
258 * Parse the command line options
261 optind = 0; /* set to 0 to tell GNU getopt to reinitialize */
262 while( ( i_cmd = getopt_long( *pi_argc, (char **)ppsz_argv, psz_shortopts,
263 p_longopts, &i_index ) ) != -1 )
265 /* A long option has been recognized */
268 module_config_t *p_conf;
269 char *psz_name = (char *)p_longopts[i_index].name;
271 /* Check if we deal with a --nofoo or --no-foo long option */
272 if( flag ) psz_name += psz_name[2] == '-' ? 3 : 2;
274 /* Store the configuration option */
275 p_conf = config_FindConfig( p_this, psz_name );
278 /* Check if the option is deprecated */
279 if( p_conf->b_removed )
282 "Warning: option --%s no longer exists.\n",
287 if( p_conf->psz_oldname
288 && !strcmp( p_conf->psz_oldname, psz_name) )
291 "%s: option --%s is deprecated. Use --%s instead.\n",
292 b_ignore_errors ? "Warning" : "Error",
293 psz_name, p_conf->psz_name );
294 if( !b_ignore_errors )
297 for( i_index = 0; p_longopts[i_index].name; i_index++ )
298 free( (char *)p_longopts[i_index].name );
301 free( psz_shortopts );
305 psz_name = p_conf->psz_name;
308 switch( p_conf->i_type )
310 case CONFIG_ITEM_STRING:
311 case CONFIG_ITEM_PASSWORD:
312 case CONFIG_ITEM_FILE:
313 case CONFIG_ITEM_DIRECTORY:
314 case CONFIG_ITEM_MODULE:
315 case CONFIG_ITEM_MODULE_LIST:
316 case CONFIG_ITEM_MODULE_LIST_CAT:
317 case CONFIG_ITEM_MODULE_CAT:
318 config_PutPsz( p_this, psz_name, optarg );
320 case CONFIG_ITEM_INTEGER:
321 config_PutInt( p_this, psz_name, strtol(optarg, 0, 0));
323 case CONFIG_ITEM_FLOAT:
324 config_PutFloat( p_this, psz_name, (float)atof(optarg) );
326 case CONFIG_ITEM_KEY:
327 config_PutInt( p_this, psz_name, ConfigStringToKey( optarg ) );
329 case CONFIG_ITEM_BOOL:
330 config_PutInt( p_this, psz_name, !flag );
337 /* A short option has been recognized */
338 if( pp_shortopts[i_cmd] != NULL )
340 switch( pp_shortopts[i_cmd]->i_type )
342 case CONFIG_ITEM_STRING:
343 case CONFIG_ITEM_PASSWORD:
344 case CONFIG_ITEM_FILE:
345 case CONFIG_ITEM_DIRECTORY:
346 case CONFIG_ITEM_MODULE:
347 case CONFIG_ITEM_MODULE_CAT:
348 case CONFIG_ITEM_MODULE_LIST:
349 case CONFIG_ITEM_MODULE_LIST_CAT:
350 config_PutPsz( p_this, pp_shortopts[i_cmd]->psz_name, optarg );
352 case CONFIG_ITEM_INTEGER:
357 if( *optarg == 'v' ) /* eg. -vvv */
360 while( *optarg == 'v' )
368 i_verbose += atoi( optarg ); /* eg. -v2 */
373 i_verbose++; /* -v */
375 config_PutInt( p_this, pp_shortopts[i_cmd]->psz_name,
380 config_PutInt( p_this, pp_shortopts[i_cmd]->psz_name,
381 strtol(optarg, 0, 0) );
384 case CONFIG_ITEM_BOOL:
385 config_PutInt( p_this, pp_shortopts[i_cmd]->psz_name, 1 );
392 /* Internal error: unknown option */
393 if( !b_ignore_errors )
395 fprintf( stderr, "%s: unknown option"
396 " or missing mandatory argument ",
397 p_this->p_libvlc->psz_object_name );
400 fprintf( stderr, "`-%c'\n", optopt );
404 fprintf( stderr, "`%s'\n", ppsz_argv[optind-1] );
406 fprintf( stderr, "Try `%s --help' for more information.\n",
407 p_this->p_libvlc->psz_object_name );
409 for( i_index = 0; p_longopts[i_index].name; i_index++ )
410 free( (char *)p_longopts[i_index].name );
412 free( psz_shortopts );
417 /* Free allocated resources */
418 for( i_index = 0; p_longopts[i_index].name; i_index++ )
419 free( (char *)p_longopts[i_index].name );
421 free( psz_shortopts );