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>
36 #include <vlc_charset.h>
38 #include "vlc_interface.h"
40 /*****************************************************************************
42 *****************************************************************************/
43 static bool IsEscapeNeeded( char c )
45 return c == '\'' || c == '"' || c == '\\';
47 static bool IsEscape( const char *psz )
51 return psz[0] == '\\' && IsEscapeNeeded( psz[1] );
53 static bool IsSpace( char c )
55 return c == ' ' || c == '\t';
58 #define SKIPSPACE( p ) p += strspn( p, " \t" )
59 #define SKIPTRAILINGSPACE( p, e ) \
60 do { while( e > p && IsSpace( *(e-1) ) ) e--; } while(0)
63 * This function will return a pointer after the end of a string element.
64 * It will search the closing element which is
65 * } for { (it will handle nested { ... })
69 static const char *ChainGetEnd( const char *psz_string )
71 const char *p = psz_string;
77 /* Look for a opening character */
82 if( *p == '\0' || *p == ',' || *p == '}' )
85 if( *p == '{' || *p == '"' || *p == '\'' )
89 /* Set c to the closing character */
96 /* Search the closing character, handle nested {..} */
106 else if( *p == '{' && c == '}' )
107 p = ChainGetEnd( p );
114 * It will extract an option value (=... or {...}).
115 * It will remove the initial = if present but keep the {}
117 static char *ChainGetValue( const char **ppsz_string )
119 const char *p = *ppsz_string;
121 char *psz_value = NULL;
123 bool b_keep_brackets = (*p == '{');
128 end = ChainGetEnd( p );
135 /* Skip heading and trailing spaces.
136 * This ain't necessary but will avoid simple
147 if( *p == '\'' || *p == '"' || ( !b_keep_brackets && *p == '{' ) )
151 if( *(end-1) != '\'' && *(end-1) == '"' )
152 SKIPTRAILINGSPACE( p, end );
157 psz_value = strndup( p, end -1 - p );
161 SKIPTRAILINGSPACE( p, end );
165 psz_value = strndup( p, end - p );
171 config_StringUnescape( psz_value );
178 char *config_ChainCreate( char **ppsz_name, config_chain_t **pp_cfg,
179 const char *psz_chain )
181 config_chain_t **pp_next = pp_cfg;
189 SKIPSPACE( psz_chain );
191 /* Look for parameter (a {...} or :...) or end of name (space or nul) */
192 len = strcspn( psz_chain, "{: \t" );
193 *ppsz_name = strndup( psz_chain, len );
196 /* Parse the parameters */
197 SKIPSPACE( psz_chain );
198 if( *psz_chain == '{' )
200 /* Parse all name=value[,] elements */
203 psz_chain++; /* skip previous delimiter */
204 SKIPSPACE( psz_chain );
206 /* Look for the end of the name (,={}_space_) */
207 len = strcspn( psz_chain, "=,{} \t" );
209 continue; /* ignore empty parameter */
211 /* Append the new parameter */
212 config_chain_t *p_cfg = malloc( sizeof(*p_cfg) );
215 p_cfg->psz_name = strndup( psz_chain, len );
217 p_cfg->psz_value = NULL;
218 p_cfg->p_next = NULL;
221 pp_next = &p_cfg->p_next;
223 /* Extract the option value */
224 SKIPSPACE( psz_chain );
225 if( strchr( "={", *psz_chain ) )
227 p_cfg->psz_value = ChainGetValue( &psz_chain );
228 SKIPSPACE( psz_chain );
231 while( !memchr( "}", *psz_chain, 2 ) );
233 if( *psz_chain ) psz_chain++; /* skip '}' */;
234 SKIPSPACE( psz_chain );
237 if( *psz_chain == ':' )
238 return strdup( psz_chain + 1 );
243 void config_ChainDestroy( config_chain_t *p_cfg )
245 while( p_cfg != NULL )
247 config_chain_t *p_next;
249 p_next = p_cfg->p_next;
251 FREENULL( p_cfg->psz_name );
252 FREENULL( p_cfg->psz_value );
259 #undef config_ChainParse
260 void config_ChainParse( vlc_object_t *p_this, const char *psz_prefix,
261 const char *const *ppsz_options, config_chain_t *cfg )
263 if( psz_prefix == NULL ) psz_prefix = "";
264 size_t plen = 1 + strlen( psz_prefix );
266 /* First, var_Create all variables */
267 for( size_t i = 0; ppsz_options[i] != NULL; i++ )
269 const char *optname = ppsz_options[i];
270 if (optname[0] == '*')
273 char name[plen + strlen( optname )];
274 snprintf( name, sizeof (name), "%s%s", psz_prefix, optname );
275 if( var_Create( p_this, name,
276 config_GetType( p_this, name ) | VLC_VAR_DOINHERIT ) )
277 return /* VLC_xxx */;
280 /* Now parse options and set value */
281 for(; cfg; cfg = cfg->p_next )
286 module_config_t *p_conf;
290 if( cfg->psz_name == NULL || *cfg->psz_name == '\0' )
293 for( i = 0; ppsz_options[i] != NULL; i++ )
295 if( !strcmp( ppsz_options[i], cfg->psz_name ) )
299 if( ( !strncmp( cfg->psz_name, "no-", 3 ) &&
300 !strcmp( ppsz_options[i], cfg->psz_name + 3 ) ) ||
301 ( !strncmp( cfg->psz_name, "no", 2 ) &&
302 !strcmp( ppsz_options[i], cfg->psz_name + 2 ) ) )
308 if( *ppsz_options[i] == '*' &&
309 !strcmp( &ppsz_options[i][1], cfg->psz_name ) )
317 if( ppsz_options[i] == NULL )
319 msg_Warn( p_this, "option %s is unknown", cfg->psz_name );
324 char name[plen + strlen( ppsz_options[i] )];
325 const char *psz_name = name;
326 snprintf( name, sizeof (name), "%s%s", psz_prefix,
327 b_once ? (ppsz_options[i] + 1) : ppsz_options[i] );
329 /* Check if the option is deprecated */
330 p_conf = config_FindConfig( p_this, name );
332 /* This is basically cut and paste from src/misc/configuration.c
333 * with slight changes */
336 if( p_conf->b_removed )
338 msg_Err( p_this, "Option %s is not supported anymore.",
340 /* TODO: this should return an error and end option parsing
341 * ... but doing this would change the VLC API and all the
342 * modules so i'll do it later */
345 if( p_conf->psz_oldname
346 && !strcmp( p_conf->psz_oldname, name ) )
348 psz_name = p_conf->psz_name;
349 msg_Warn( p_this, "Option %s is obsolete. Use %s instead.",
353 /* </Check if the option is deprecated> */
355 /* get the type of the variable */
356 i_type = config_GetType( p_this, psz_name );
359 msg_Warn( p_this, "unknown option %s (value=%s)",
360 cfg->psz_name, cfg->psz_value );
364 i_type &= CONFIG_ITEM;
366 if( i_type != VLC_VAR_BOOL && cfg->psz_value == NULL )
368 msg_Warn( p_this, "missing value for option %s", cfg->psz_name );
371 if( i_type != VLC_VAR_STRING && b_once )
373 msg_Warn( p_this, "*option_name need to be a string option" );
382 case VLC_VAR_INTEGER:
383 val.i_int = strtol( cfg->psz_value ? cfg->psz_value : "0",
387 val.f_float = us_atof( cfg->psz_value ? cfg->psz_value : "0" );
391 val.psz_string = cfg->psz_value;
394 msg_Warn( p_this, "unhandled config var type (%d)", i_type );
395 memset( &val, 0, sizeof( vlc_value_t ) );
402 var_Get( p_this, psz_name, &val2 );
403 if( *val2.psz_string )
405 free( val2.psz_string );
406 msg_Dbg( p_this, "ignoring option %s (not first occurrence)", psz_name );
409 free( val2.psz_string );
411 var_Set( p_this, psz_name, val );
412 msg_Dbg( p_this, "set config option: %s to %s", psz_name,
413 cfg->psz_value ? cfg->psz_value : "(null)" );
417 config_chain_t *config_ChainDuplicate( const config_chain_t *p_src )
419 config_chain_t *p_dst = NULL;
420 config_chain_t **pp_last = &p_dst;
422 for( ; p_src != NULL; p_src = p_src->p_next )
424 config_chain_t *p = malloc( sizeof(*p) );
428 p->psz_name = p_src->psz_name ? strdup( p_src->psz_name ) : NULL;
429 p->psz_value = p_src->psz_value ? strdup( p_src->psz_value ) : NULL;
432 pp_last = &p->p_next;
437 char *config_StringUnescape( char *psz_string )
439 char *psz_src = psz_string;
440 char *psz_dst = psz_string;
446 if( IsEscape( psz_src ) )
448 *psz_dst++ = *psz_src++;
455 char *config_StringEscape( const char *psz_string )
465 for( const char *p = psz_string; *p; p++ )
467 if( IsEscapeNeeded( *p ) )
471 psz_return = psz_dst = malloc( strlen( psz_string ) + i_escape + 1 );
472 for( const char *p = psz_string; *p; p++ )
474 if( IsEscapeNeeded( *p ) )