1 /*****************************************************************************
2 * chain.c : configuration module chain parsing stuff
3 *****************************************************************************
4 * Copyright (C) 2002-2007 the VideoLAN team
7 * Authors: Christophe Massiot <massiot@via.ecp.fr>
8 * Laurent Aimar <fenrir@via.ecp.fr>
9 * Eric Petit <titer@videolan.org>
11 * This program is free software; you can redistribute it and/or modify
12 * it under the terms of the GNU General Public License as published by
13 * the Free Software Foundation; either version 2 of the License, or
14 * (at your option) any later version.
16 * This program is distributed in the hope that it will be useful,
17 * but WITHOUT ANY WARRANTY; without even the implied warranty of
18 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
19 * GNU General Public License for more details.
21 * You should have received a copy of the GNU General Public License
22 * along with this program; if not, write to the Free Software
23 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
24 *****************************************************************************/
26 /*****************************************************************************
28 *****************************************************************************/
34 #include <vlc_common.h>
37 #include "vlc_interface.h"
39 /*****************************************************************************
41 *****************************************************************************/
42 static bool IsEscapeNeeded( char c )
44 return c == '\'' || c == '"' || c == '\\';
46 static bool IsEscape( const char *psz )
50 return psz[0] == '\\' && IsEscapeNeeded( psz[1] );
52 static bool IsSpace( char c )
54 return c == ' ' || c == '\t';
57 #define SKIPSPACE( p ) p += strspn( p, " \t" )
58 #define SKIPTRAILINGSPACE( p, e ) \
59 do { while( e > p && IsSpace( *(e-1) ) ) e--; } while(0)
62 * This function will return a pointer after the end of a string element.
63 * It will search the closing element which is
64 * } for { (it will handle nested { ... })
68 static const char *ChainGetEnd( const char *psz_string )
70 const char *p = psz_string;
76 /* Look for a opening character */
81 if( *p == '\0' || *p == ',' || *p == '}' )
84 if( *p == '{' || *p == '"' || *p == '\'' )
88 /* Set c to the closing character */
95 /* Search the closing character, handle nested {..} */
105 else if( *p == '{' && c == '}' )
106 p = ChainGetEnd( p );
113 * It will extract an option value (=... or {...}).
114 * It will remove the initial = if present but keep the {}
116 static char *ChainGetValue( const char **ppsz_string )
118 const char *p = *ppsz_string;
120 char *psz_value = NULL;
122 bool b_keep_brackets = (*p == '{');
127 end = ChainGetEnd( p );
134 /* Skip heading and trailing spaces.
135 * This ain't necessary but will avoid simple
146 if( *p == '\'' || *p == '"' || ( !b_keep_brackets && *p == '{' ) )
150 if( *(end-1) != '\'' && *(end-1) == '"' )
151 SKIPTRAILINGSPACE( p, end );
156 psz_value = strndup( p, end -1 - p );
160 SKIPTRAILINGSPACE( p, end );
164 psz_value = strndup( p, end - p );
170 config_StringUnescape( psz_value );
177 char *config_ChainCreate( char **ppsz_name, config_chain_t **pp_cfg,
178 const char *psz_chain )
180 config_chain_t **pp_next = pp_cfg;
188 psz_chain += strspn( psz_chain, " \t" );
190 /* Look for parameter (a {...} or :...) or end of name (space or nul) */
191 len = strcspn( psz_chain, "{: \t" );
195 /* Extract the name */
196 *ppsz_name = strndup( psz_chain, len );
199 /* Parse the parameters */
200 psz_chain += strspn( psz_chain, " \t" );
201 if( *psz_chain == '{' )
203 /* Parse all name=value[,] elements */
206 psz_chain++; /* skip previous delimiter */
207 psz_chain += strspn( psz_chain, " \t" );
209 /* Look for the end of the name (,={}_space_) */
210 len = strcspn( psz_chain, "=,{} \t" );
212 continue; /* ignore empty parameter */
214 /* Append the new parameter */
215 config_chain_t *p_cfg = malloc( sizeof(*p_cfg) );
218 p_cfg->psz_name = strndup( psz_chain, len );
220 p_cfg->psz_value = NULL;
221 p_cfg->p_next = NULL;
224 pp_next = &p_cfg->p_next;
226 /* Extract the option value */
227 psz_chain += strspn( psz_chain, " \t" );
228 if( strchr( "={", *psz_chain ) )
230 p_cfg->psz_value = ChainGetValue( &psz_chain );
231 psz_chain += strspn( psz_chain, " \t" );
234 while( !memchr( "}", *psz_chain, 2 ) );
236 if( *psz_chain ) psz_chain++; /* skip '}' */;
237 psz_chain += strspn( psz_chain, " \t" );
240 if( *psz_chain == ':' )
241 return strdup( psz_chain + 1 );
246 void config_ChainDestroy( config_chain_t *p_cfg )
248 while( p_cfg != NULL )
250 config_chain_t *p_next;
252 p_next = p_cfg->p_next;
254 FREENULL( p_cfg->psz_name );
255 FREENULL( p_cfg->psz_value );
262 void __config_ChainParse( vlc_object_t *p_this, const char *psz_prefix,
263 const char *const *ppsz_options, config_chain_t *cfg )
265 if( psz_prefix == NULL ) psz_prefix = "";
266 size_t plen = 1 + strlen( psz_prefix );
268 /* First, var_Create all variables */
269 for( size_t i = 0; ppsz_options[i] != NULL; i++ )
271 const char *optname = ppsz_options[i];
272 if (optname[0] == '*')
275 char name[plen + strlen( optname )];
276 snprintf( name, sizeof (name), "%s%s", psz_prefix, optname );
277 if( var_Create( p_this, name,
278 config_GetType( p_this, name ) | VLC_VAR_DOINHERIT ) )
279 return /* VLC_xxx */;
282 /* Now parse options and set value */
283 for(; cfg; cfg = cfg->p_next )
288 module_config_t *p_conf;
292 if( cfg->psz_name == NULL || *cfg->psz_name == '\0' )
295 for( i = 0; ppsz_options[i] != NULL; i++ )
297 if( !strcmp( ppsz_options[i], cfg->psz_name ) )
301 if( ( !strncmp( cfg->psz_name, "no-", 3 ) &&
302 !strcmp( ppsz_options[i], cfg->psz_name + 3 ) ) ||
303 ( !strncmp( cfg->psz_name, "no", 2 ) &&
304 !strcmp( ppsz_options[i], cfg->psz_name + 2 ) ) )
310 if( *ppsz_options[i] == '*' &&
311 !strcmp( &ppsz_options[i][1], cfg->psz_name ) )
319 if( ppsz_options[i] == NULL )
321 msg_Warn( p_this, "option %s is unknown", cfg->psz_name );
326 char name[plen + strlen( ppsz_options[i] )];
327 const char *psz_name = name;
328 snprintf( name, sizeof (name), "%s%s", psz_prefix,
329 b_once ? (ppsz_options[i] + 1) : ppsz_options[i] );
331 /* Check if the option is deprecated */
332 p_conf = config_FindConfig( p_this, name );
334 /* This is basically cut and paste from src/misc/configuration.c
335 * with slight changes */
338 if( p_conf->b_removed )
340 msg_Err( p_this, "Option %s is not supported anymore.",
342 /* TODO: this should return an error and end option parsing
343 * ... but doing this would change the VLC API and all the
344 * modules so i'll do it later */
347 if( p_conf->psz_oldname
348 && !strcmp( p_conf->psz_oldname, name ) )
350 psz_name = p_conf->psz_name;
351 msg_Warn( p_this, "Option %s is obsolete. Use %s instead.",
355 /* </Check if the option is deprecated> */
357 /* get the type of the variable */
358 i_type = config_GetType( p_this, psz_name );
361 msg_Warn( p_this, "unknown option %s (value=%s)",
362 cfg->psz_name, cfg->psz_value );
366 i_type &= CONFIG_ITEM;
368 if( i_type != VLC_VAR_BOOL && cfg->psz_value == NULL )
370 msg_Warn( p_this, "missing value for option %s", cfg->psz_name );
373 if( i_type != VLC_VAR_STRING && b_once )
375 msg_Warn( p_this, "*option_name need to be a string option" );
384 case VLC_VAR_INTEGER:
385 val.i_int = strtol( cfg->psz_value ? cfg->psz_value : "0",
389 val.f_float = atof( cfg->psz_value ? cfg->psz_value : "0" );
393 val.psz_string = cfg->psz_value;
396 msg_Warn( p_this, "unhandled config var type (%d)", i_type );
397 memset( &val, 0, sizeof( vlc_value_t ) );
404 var_Get( p_this, psz_name, &val2 );
405 if( *val2.psz_string )
407 free( val2.psz_string );
408 msg_Dbg( p_this, "ignoring option %s (not first occurrence)", psz_name );
411 free( val2.psz_string );
413 var_Set( p_this, psz_name, val );
414 msg_Dbg( p_this, "set config option: %s to %s", psz_name,
415 cfg->psz_value ? cfg->psz_value : "(null)" );
419 char *config_StringUnescape( char *psz_string )
421 char *psz_src = psz_string;
422 char *psz_dst = psz_string;
428 if( IsEscape( psz_src ) )
430 *psz_dst++ = *psz_src++;
437 char *config_StringEscape( const char *psz_string )
447 for( const char *p = psz_string; *p; p++ )
449 if( IsEscapeNeeded( *p ) )
453 psz_return = psz_dst = malloc( strlen( psz_string ) + i_escape + 1 );
454 for( const char *p = psz_string; *p; p++ )
456 if( IsEscapeNeeded( *p ) )