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 *****************************************************************************/
28 #include <vlc_common.h>
29 #include "../libvlc.h"
32 #ifdef HAVE_GETOPT_LONG
34 # include <getopt.h> /* getopt() */
37 # include "../extras/getopt.h"
40 #include "configuration.h"
41 #include "modules/modules.h"
45 /*****************************************************************************
46 * config_LoadCmdLine: parse command line
47 *****************************************************************************
48 * Parse command line for configuration options.
49 * Now that the module_bank has been initialized, we can dynamically
50 * generate the longopts structure used by getops. We have to do it this way
51 * because we don't know (and don't want to know) in advance the configuration
52 * options used (ie. exported) by each module.
53 *****************************************************************************/
54 int __config_LoadCmdLine( vlc_object_t *p_this, int *pi_argc,
55 const char *ppsz_argv[],
56 bool b_ignore_errors )
58 int i_cmd, i_index, i_opts, i_shortopts, flag, i_verbose = 0;
60 struct option *p_longopts;
61 const char **argv_copy = NULL;
64 module_config_t *pp_shortopts[256];
68 /* When VLC.app is run by double clicking in Mac OS X, the 2nd arg
69 * is the PSN - process serial number (a unique PID-ish thingie)
70 * still ok for real Darwin & when run from command line */
71 if ( (*pi_argc > 1) && (strncmp( ppsz_argv[ 1 ] , "-psn" , 4 ) == 0) )
72 /* for example -psn_0_9306113 */
74 /* GDMF!... I can't do this or else the MacOSX window server will
75 * not pick up the PSN and not register the app and we crash...
76 * hence the following kludge otherwise we'll get confused w/ argv[1]
77 * being an input file name.
78 * As there won't be any more args to parse, just exit. */
79 assert( *pi_argc == 2 );
85 /* List all modules */
86 module_t **list = module_list_get (NULL);
89 * Generate the longopts and shortopts structures used by getopt_long
93 for (size_t i = 0; (p_parser = list[i]) != NULL; i++)
94 /* count the number of exported configuration options (to allocate
95 * longopts). We also need to allocate space for two options when
96 * dealing with boolean to allow for --foo and --no-foo */
97 i_opts += p_parser->i_config_items + 2 * p_parser->i_bool_items;
99 p_longopts = malloc( sizeof(struct option) * (i_opts + 1) );
100 if( p_longopts == NULL )
102 module_list_free (list);
106 psz_shortopts = malloc( sizeof( char ) * (2 * i_opts + 1) );
107 if( psz_shortopts == NULL )
110 module_list_free (list);
114 /* If we are requested to ignore errors, then we must work on a copy
115 * of the ppsz_argv array, otherwise getopt_long will reorder it for
116 * us, ignoring the arity of the options */
117 if( b_ignore_errors )
119 argv_copy = (const char**)malloc( *pi_argc * sizeof(char *) );
120 if( argv_copy == NULL )
122 free( psz_shortopts );
124 module_list_free (list);
127 memcpy( argv_copy, ppsz_argv, *pi_argc * sizeof(char *) );
128 ppsz_argv = argv_copy;
132 for( i_index = 0; i_index < 256; i_index++ )
134 pp_shortopts[i_index] = NULL;
137 /* Fill the p_longopts and psz_shortopts structures */
139 for (size_t i = 0; (p_parser = list[i]) != NULL; i++)
141 module_config_t *p_item, *p_end;
143 if( !p_parser->i_config_items )
146 for( p_item = p_parser->p_config, p_end = p_item + p_parser->confsize;
151 if( p_item->i_type & CONFIG_HINT )
154 /* Add item to long options */
155 p_longopts[i_index].name = strdup( p_item->psz_name );
156 if( p_longopts[i_index].name == NULL ) continue;
157 p_longopts[i_index].has_arg =
158 (p_item->i_type == CONFIG_ITEM_BOOL) ? no_argument :
162 /* It seems that required_argument is broken on Darwin.
163 * Radar ticket #6113829 */
166 p_longopts[i_index].flag = &flag;
167 p_longopts[i_index].val = 0;
170 /* When dealing with bools we also need to add the --no-foo
172 if( p_item->i_type == CONFIG_ITEM_BOOL )
174 char *psz_name = malloc( strlen(p_item->psz_name) + 3 );
175 if( psz_name == NULL ) continue;
176 strcpy( psz_name, "no" );
177 strcat( psz_name, p_item->psz_name );
179 p_longopts[i_index].name = psz_name;
180 p_longopts[i_index].has_arg = no_argument;
181 p_longopts[i_index].flag = &flag;
182 p_longopts[i_index].val = 1;
185 psz_name = malloc( strlen(p_item->psz_name) + 4 );
186 if( psz_name == NULL ) continue;
187 strcpy( psz_name, "no-" );
188 strcat( psz_name, p_item->psz_name );
190 p_longopts[i_index].name = psz_name;
191 p_longopts[i_index].has_arg = no_argument;
192 p_longopts[i_index].flag = &flag;
193 p_longopts[i_index].val = 1;
197 /* If item also has a short option, add it */
198 if( p_item->i_short )
200 pp_shortopts[(int)p_item->i_short] = p_item;
201 psz_shortopts[i_shortopts] = p_item->i_short;
203 if( p_item->i_type != CONFIG_ITEM_BOOL )
205 psz_shortopts[i_shortopts] = ':';
208 if( p_item->i_short == 'v' )
210 psz_shortopts[i_shortopts] = ':';
218 /* We don't need the module list anymore */
219 module_list_free( list );
221 /* Close the longopts and shortopts structures */
222 memset( &p_longopts[i_index], 0, sizeof(struct option) );
223 psz_shortopts[i_shortopts] = '\0';
226 * Parse the command line options
229 optind = 0; /* set to 0 to tell GNU getopt to reinitialize */
230 while( ( i_cmd = getopt_long( *pi_argc, (char **)ppsz_argv, psz_shortopts,
231 p_longopts, &i_index ) ) != -1 )
233 /* A long option has been recognized */
236 module_config_t *p_conf;
237 char *psz_name = (char *)p_longopts[i_index].name;
239 /* Check if we deal with a --nofoo or --no-foo long option */
240 if( flag ) psz_name += psz_name[2] == '-' ? 3 : 2;
242 /* Store the configuration option */
243 p_conf = config_FindConfig( p_this, psz_name );
246 /* Check if the option is deprecated */
247 if( p_conf->b_removed )
250 "Warning: option --%s no longer exists.\n",
255 if( p_conf->psz_oldname
256 && !strcmp( p_conf->psz_oldname, psz_name) )
259 "%s: option --%s is deprecated. Use --%s instead.\n",
260 b_ignore_errors ? "Warning" : "Error",
261 psz_name, p_conf->psz_name );
262 if( !b_ignore_errors )
265 for( i_index = 0; p_longopts[i_index].name; i_index++ )
266 free( (char *)p_longopts[i_index].name );
269 free( psz_shortopts );
273 psz_name = p_conf->psz_name;
276 if( p_conf->i_type != CONFIG_ITEM_BOOL && !optarg )
278 fprintf( stderr, "Warning: missing argument for option --%s\n", p_conf->psz_name );
279 fprintf( stderr, "Try specifying options as '--optionname=value' instead of '--optionname value'\n" );
284 switch( p_conf->i_type )
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_LIST:
292 case CONFIG_ITEM_MODULE_LIST_CAT:
293 case CONFIG_ITEM_MODULE_CAT:
294 config_PutPsz( p_this, psz_name, optarg );
296 case CONFIG_ITEM_INTEGER:
297 config_PutInt( p_this, psz_name, strtol(optarg, 0, 0));
299 case CONFIG_ITEM_FLOAT:
300 config_PutFloat( p_this, psz_name, (float)atof(optarg) );
302 case CONFIG_ITEM_KEY:
303 config_PutInt( p_this, psz_name, ConfigStringToKey( optarg ) );
305 case CONFIG_ITEM_BOOL:
306 config_PutInt( p_this, psz_name, !flag );
313 /* A short option has been recognized */
314 if( pp_shortopts[i_cmd] != NULL )
316 switch( pp_shortopts[i_cmd]->i_type )
318 case CONFIG_ITEM_STRING:
319 case CONFIG_ITEM_PASSWORD:
320 case CONFIG_ITEM_FILE:
321 case CONFIG_ITEM_DIRECTORY:
322 case CONFIG_ITEM_MODULE:
323 case CONFIG_ITEM_MODULE_CAT:
324 case CONFIG_ITEM_MODULE_LIST:
325 case CONFIG_ITEM_MODULE_LIST_CAT:
326 config_PutPsz( p_this, pp_shortopts[i_cmd]->psz_name, optarg );
328 case CONFIG_ITEM_INTEGER:
333 if( *optarg == 'v' ) /* eg. -vvv */
336 while( *optarg == 'v' )
344 i_verbose += atoi( optarg ); /* eg. -v2 */
349 i_verbose++; /* -v */
351 config_PutInt( p_this, pp_shortopts[i_cmd]->psz_name,
356 config_PutInt( p_this, pp_shortopts[i_cmd]->psz_name,
357 strtol(optarg, 0, 0) );
360 case CONFIG_ITEM_BOOL:
361 config_PutInt( p_this, pp_shortopts[i_cmd]->psz_name, 1 );
368 /* Internal error: unknown option */
369 if( !b_ignore_errors )
371 fputs( "vlc: unknown option"
372 " or missing mandatory argument ", stderr );
375 fprintf( stderr, "`-%c'\n", optopt );
379 fprintf( stderr, "`%s'\n", ppsz_argv[optind-1] );
381 fputs( "Try `vlc --help' for more information.\n", stderr );
383 for( i_index = 0; p_longopts[i_index].name; i_index++ )
384 free( (char *)p_longopts[i_index].name );
386 free( psz_shortopts );
391 /* Free allocated resources */
392 for( i_index = 0; p_longopts[i_index].name; i_index++ )
393 free( (char *)p_longopts[i_index].name );
395 free( psz_shortopts );