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"
31 #include <vlc_charset.h>
33 #include "vlc_getopt.h"
35 #include "configuration.h"
36 #include "modules/modules.h"
40 #undef config_LoadCmdLine
42 * Parse command line for configuration options.
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.
49 * @param p_this object to write command line options as variables to
50 * @param pi_argc number of command line arguments [IN/OUT]
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.
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.
58 int config_LoadCmdLine( vlc_object_t *p_this, int *pi_argc,
59 const char *ppsz_argv[], bool b_ignore_errors )
61 int i_cmd, i_index, i_opts, i_shortopts, flag, i_verbose = 0;
63 struct vlc_option *p_longopts;
64 const char **argv_copy = NULL;
67 module_config_t *pp_shortopts[256];
70 /* List all modules */
71 module_t **list = module_list_get (NULL);
74 * Generate the longopts and shortopts structures used by getopt_long
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;
84 p_longopts = malloc( sizeof(*p_longopts) * (i_opts + 1) );
85 if( p_longopts == NULL )
87 module_list_free (list);
91 psz_shortopts = malloc( 2 * i_opts + 1 );
92 if( psz_shortopts == NULL )
95 module_list_free (list);
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 )
104 argv_copy = (const char**)malloc( *pi_argc * sizeof(char *) );
105 if( argv_copy == NULL )
107 free( psz_shortopts );
109 module_list_free (list);
112 memcpy( argv_copy, ppsz_argv, *pi_argc * sizeof(char *) );
113 ppsz_argv = argv_copy;
117 for( i_index = 0; i_index < 256; i_index++ )
119 pp_shortopts[i_index] = NULL;
122 /* Fill the p_longopts and psz_shortopts structures */
124 for (size_t i = 0; (p_parser = list[i]) != NULL; i++)
126 module_config_t *p_item, *p_end;
128 if( !p_parser->i_config_items )
131 for( p_item = p_parser->p_config, p_end = p_item + p_parser->confsize;
136 if( p_item->i_type & CONFIG_HINT )
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;
148 /* When dealing with bools we also need to add the --no-foo
150 if( p_item->i_type == CONFIG_ITEM_BOOL )
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 );
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;
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 );
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;
175 /* If item also has a short option, add it */
176 if( p_item->i_short )
178 pp_shortopts[(int)p_item->i_short] = p_item;
179 psz_shortopts[i_shortopts] = p_item->i_short;
181 if( p_item->i_type != CONFIG_ITEM_BOOL
182 && p_item->i_short != 'v' )
184 psz_shortopts[i_shortopts] = ':';
191 /* We don't need the module list anymore */
192 module_list_free( list );
194 /* Close the longopts and shortopts structures */
195 memset( &p_longopts[i_index], 0, sizeof(*p_longopts) );
196 psz_shortopts[i_shortopts] = '\0';
199 * Parse the command line options
201 vlc_optind = 0; /* set to 0 to tell GNU getopt to reinitialize */
202 while( ( i_cmd = vlc_getopt_long( *pi_argc, (char **)ppsz_argv,
204 p_longopts, &i_index ) ) != -1 )
206 /* A long option has been recognized */
209 module_config_t *p_conf;
210 const char *psz_name = p_longopts[i_index].name;
212 /* Check if we deal with a --nofoo or --no-foo long option */
213 if( flag ) psz_name += psz_name[2] == '-' ? 3 : 2;
215 /* Store the configuration option */
216 p_conf = config_FindConfig( p_this, psz_name );
219 /* Check if the option is deprecated */
220 if( p_conf->b_removed )
223 "Warning: option --%s no longer exists.\n",
228 if( p_conf->psz_oldname
229 && !strcmp( p_conf->psz_oldname, psz_name) )
232 "%s: option --%s is deprecated. Use --%s instead.\n",
233 b_ignore_errors ? "Warning" : "Error",
234 psz_name, p_conf->psz_name );
235 if( !b_ignore_errors )
238 for( i_index = 0; p_longopts[i_index].name; i_index++ )
239 free( (char *)p_longopts[i_index].name );
242 free( psz_shortopts );
246 psz_name = p_conf->psz_name;
249 switch( p_conf->i_type )
251 case CONFIG_ITEM_STRING:
252 case CONFIG_ITEM_PASSWORD:
253 case CONFIG_ITEM_FILE:
254 case CONFIG_ITEM_DIRECTORY:
255 case CONFIG_ITEM_MODULE:
256 case CONFIG_ITEM_MODULE_LIST:
257 case CONFIG_ITEM_MODULE_LIST_CAT:
258 case CONFIG_ITEM_MODULE_CAT:
259 var_Create( p_this, psz_name, VLC_VAR_STRING );
260 var_SetString( p_this, psz_name, vlc_optarg );
262 case CONFIG_ITEM_INTEGER:
263 var_Create( p_this, psz_name, VLC_VAR_INTEGER );
264 var_SetInteger( p_this, psz_name,
265 strtol(vlc_optarg, NULL, 0));
267 case CONFIG_ITEM_FLOAT:
268 var_Create( p_this, psz_name, VLC_VAR_FLOAT );
269 var_SetFloat( p_this, psz_name, us_atof(vlc_optarg) );
271 case CONFIG_ITEM_KEY:
272 var_Create( p_this, psz_name, VLC_VAR_INTEGER );
273 var_SetInteger( p_this, psz_name,
274 ConfigStringToKey( vlc_optarg ) );
276 case CONFIG_ITEM_BOOL:
277 var_Create( p_this, psz_name, VLC_VAR_BOOL );
278 var_SetBool( p_this, psz_name, !flag );
285 /* A short option has been recognized */
286 if( pp_shortopts[i_cmd] != NULL )
288 const char *name = pp_shortopts[i_cmd]->psz_name;
289 switch( pp_shortopts[i_cmd]->i_type )
291 case CONFIG_ITEM_STRING:
292 case CONFIG_ITEM_PASSWORD:
293 case CONFIG_ITEM_FILE:
294 case CONFIG_ITEM_DIRECTORY:
295 case CONFIG_ITEM_MODULE:
296 case CONFIG_ITEM_MODULE_CAT:
297 case CONFIG_ITEM_MODULE_LIST:
298 case CONFIG_ITEM_MODULE_LIST_CAT:
299 var_Create( p_this, name, VLC_VAR_STRING );
300 var_SetString( p_this, name, vlc_optarg );
302 case CONFIG_ITEM_INTEGER:
303 var_Create( p_this, name, VLC_VAR_INTEGER );
306 i_verbose++; /* -v */
307 var_SetInteger( p_this, name, i_verbose );
311 var_SetInteger( p_this, name,
312 strtol(vlc_optarg, NULL, 0) );
315 case CONFIG_ITEM_BOOL:
316 var_Create( p_this, name, VLC_VAR_BOOL );
317 var_SetBool( p_this, name, true );
324 /* Internal error: unknown option */
325 if( !b_ignore_errors )
327 fputs( "vlc: unknown option"
328 " or missing mandatory argument ", stderr );
331 fprintf( stderr, "`-%c'\n", vlc_optopt );
335 fprintf( stderr, "`%s'\n", ppsz_argv[vlc_optind-1] );
337 fputs( "Try `vlc --help' for more information.\n", stderr );
339 for( i_index = 0; p_longopts[i_index].name; i_index++ )
340 free( (char *)p_longopts[i_index].name );
342 free( psz_shortopts );
347 /* Free allocated resources */
348 for( i_index = 0; p_longopts[i_index].name; i_index++ )
349 free( (char *)p_longopts[i_index].name );
351 free( psz_shortopts );