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" );
192 *ppsz_name = strndup( psz_chain, len );
195 /* Parse the parameters */
196 psz_chain += strspn( psz_chain, " \t" );
197 if( *psz_chain == '{' )
199 /* Parse all name=value[,] elements */
202 psz_chain++; /* skip previous delimiter */
203 psz_chain += strspn( psz_chain, " \t" );
205 /* Look for the end of the name (,={}_space_) */
206 len = strcspn( psz_chain, "=,{} \t" );
208 continue; /* ignore empty parameter */
210 /* Append the new parameter */
211 config_chain_t *p_cfg = malloc( sizeof(*p_cfg) );
214 p_cfg->psz_name = strndup( psz_chain, len );
216 p_cfg->psz_value = NULL;
217 p_cfg->p_next = NULL;
220 pp_next = &p_cfg->p_next;
222 /* Extract the option value */
223 psz_chain += strspn( psz_chain, " \t" );
224 if( strchr( "={", *psz_chain ) )
226 p_cfg->psz_value = ChainGetValue( &psz_chain );
227 psz_chain += strspn( psz_chain, " \t" );
230 while( !memchr( "}", *psz_chain, 2 ) );
232 if( *psz_chain ) psz_chain++; /* skip '}' */;
233 psz_chain += strspn( psz_chain, " \t" );
236 if( *psz_chain == ':' )
237 return strdup( psz_chain + 1 );
242 void config_ChainDestroy( config_chain_t *p_cfg )
244 while( p_cfg != NULL )
246 config_chain_t *p_next;
248 p_next = p_cfg->p_next;
250 FREENULL( p_cfg->psz_name );
251 FREENULL( p_cfg->psz_value );
258 void __config_ChainParse( vlc_object_t *p_this, const char *psz_prefix,
259 const char *const *ppsz_options, config_chain_t *cfg )
261 if( psz_prefix == NULL ) psz_prefix = "";
262 size_t plen = 1 + strlen( psz_prefix );
264 /* First, var_Create all variables */
265 for( size_t i = 0; ppsz_options[i] != NULL; i++ )
267 const char *optname = ppsz_options[i];
268 if (optname[0] == '*')
271 char name[plen + strlen( optname )];
272 snprintf( name, sizeof (name), "%s%s", psz_prefix, optname );
273 if( var_Create( p_this, name,
274 config_GetType( p_this, name ) | VLC_VAR_DOINHERIT ) )
275 return /* VLC_xxx */;
278 /* Now parse options and set value */
279 for(; cfg; cfg = cfg->p_next )
284 module_config_t *p_conf;
288 if( cfg->psz_name == NULL || *cfg->psz_name == '\0' )
291 for( i = 0; ppsz_options[i] != NULL; i++ )
293 if( !strcmp( ppsz_options[i], cfg->psz_name ) )
297 if( ( !strncmp( cfg->psz_name, "no-", 3 ) &&
298 !strcmp( ppsz_options[i], cfg->psz_name + 3 ) ) ||
299 ( !strncmp( cfg->psz_name, "no", 2 ) &&
300 !strcmp( ppsz_options[i], cfg->psz_name + 2 ) ) )
306 if( *ppsz_options[i] == '*' &&
307 !strcmp( &ppsz_options[i][1], cfg->psz_name ) )
315 if( ppsz_options[i] == NULL )
317 msg_Warn( p_this, "option %s is unknown", cfg->psz_name );
322 char name[plen + strlen( ppsz_options[i] )];
323 const char *psz_name = name;
324 snprintf( name, sizeof (name), "%s%s", psz_prefix,
325 b_once ? (ppsz_options[i] + 1) : ppsz_options[i] );
327 /* Check if the option is deprecated */
328 p_conf = config_FindConfig( p_this, name );
330 /* This is basically cut and paste from src/misc/configuration.c
331 * with slight changes */
334 if( p_conf->b_removed )
336 msg_Err( p_this, "Option %s is not supported anymore.",
338 /* TODO: this should return an error and end option parsing
339 * ... but doing this would change the VLC API and all the
340 * modules so i'll do it later */
343 if( p_conf->psz_oldname
344 && !strcmp( p_conf->psz_oldname, name ) )
346 psz_name = p_conf->psz_name;
347 msg_Warn( p_this, "Option %s is obsolete. Use %s instead.",
351 /* </Check if the option is deprecated> */
353 /* get the type of the variable */
354 i_type = config_GetType( p_this, psz_name );
357 msg_Warn( p_this, "unknown option %s (value=%s)",
358 cfg->psz_name, cfg->psz_value );
362 i_type &= CONFIG_ITEM;
364 if( i_type != VLC_VAR_BOOL && cfg->psz_value == NULL )
366 msg_Warn( p_this, "missing value for option %s", cfg->psz_name );
369 if( i_type != VLC_VAR_STRING && b_once )
371 msg_Warn( p_this, "*option_name need to be a string option" );
380 case VLC_VAR_INTEGER:
381 val.i_int = strtol( cfg->psz_value ? cfg->psz_value : "0",
385 val.f_float = atof( cfg->psz_value ? cfg->psz_value : "0" );
389 val.psz_string = cfg->psz_value;
392 msg_Warn( p_this, "unhandled config var type (%d)", i_type );
393 memset( &val, 0, sizeof( vlc_value_t ) );
400 var_Get( p_this, psz_name, &val2 );
401 if( *val2.psz_string )
403 free( val2.psz_string );
404 msg_Dbg( p_this, "ignoring option %s (not first occurrence)", psz_name );
407 free( val2.psz_string );
409 var_Set( p_this, psz_name, val );
410 msg_Dbg( p_this, "set config option: %s to %s", psz_name,
411 cfg->psz_value ? cfg->psz_value : "(null)" );
415 char *config_StringUnescape( char *psz_string )
417 char *psz_src = psz_string;
418 char *psz_dst = psz_string;
424 if( IsEscape( psz_src ) )
426 *psz_dst++ = *psz_src++;
433 char *config_StringEscape( const char *psz_string )
443 for( const char *p = psz_string; *p; p++ )
445 if( IsEscapeNeeded( *p ) )
449 psz_return = psz_dst = malloc( strlen( psz_string ) + i_escape + 1 );
450 for( const char *p = psz_string; *p; p++ )
452 if( IsEscapeNeeded( *p ) )