git.sesse.net Git - vlc/blob - src/misc/configuration_chain.c

   1 /*****************************************************************************
   2  * configuration_chain.c : configuration module chain parsing stuff
   3  *****************************************************************************
   4  * Copyright (C) 2002-2006 the VideoLAN team
   5  * $Id$
   6  *
   7  * Authors: Christophe Massiot <massiot@via.ecp.fr>
   8  *          Laurent Aimar <fenrir@via.ecp.fr>
   9  *          Eric Petit <titer@videolan.org>
  10  *
  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.
  15  *
  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.
  20  *
  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  *****************************************************************************/
  25
  26 /*****************************************************************************
  27  * Preamble
  28  *****************************************************************************/
  29
  30 #include <vlc/vlc.h>
  31
  32 #include <stdlib.h>                                                /* free() */
  33 #include <stdio.h>                                              /* sprintf() */
  34 #include <string.h>                                            /* strerror() */
  35
  36 /*****************************************************************************
  37  * Local prototypes
  38  *****************************************************************************/
  39
  40 /* chain format:
  41     module{option=*:option=*}[:module{option=*:...}]
  42  */
  43 #define SKIPSPACE( p ) { while( *p && ( *p == ' ' || *p == '\t' ) ) p++; }
  44 #define SKIPTRAILINGSPACE( p, e ) \
  45     { while( e > p && ( *(e-1) == ' ' || *(e-1) == '\t' ) ) e--; }
  46
  47 /* go accross " " and { } */
  48 static char *_get_chain_end( char *str )
  49 {
  50     char c, *p = str;
  51
  52     SKIPSPACE( p );
  53
  54     for( ;; )
  55     {
  56         if( !*p || *p == ',' || *p == '}' ) return p;
  57
  58         if( *p != '{' && *p != '"' && *p != '\'' )
  59         {
  60             p++;
  61             continue;
  62         }
  63
  64         if( *p == '{' ) c = '}';
  65         else c = *p;
  66         p++;
  67
  68         for( ;; )
  69         {
  70             if( !*p ) return p;
  71
  72             if( *p == c ) return ++p;
  73             else if( *p == '{' && c == '}' ) p = _get_chain_end( p );
  74             else p++;
  75         }
  76     }
  77 }
  78
  79 char *config_ChainCreate( char **ppsz_name, config_chain_t **pp_cfg, char *psz_chain )
  80 {
  81     config_chain_t *p_cfg = NULL;
  82     char       *p = psz_chain;
  83
  84     *ppsz_name = NULL;
  85     *pp_cfg    = NULL;
  86
  87     if( !p ) return NULL;
  88
  89     SKIPSPACE( p );
  90
  91     while( *p && *p != '{' && *p != ':' && *p != ' ' && *p != '\t' ) p++;
  92
  93     if( p == psz_chain ) return NULL;
  94
  95     *ppsz_name = strndup( psz_chain, p - psz_chain );
  96
  97     SKIPSPACE( p );
  98
  99     if( *p == '{' )
 100     {
 101         char *psz_name;
 102
 103         p++;
 104
 105         for( ;; )
 106         {
 107             config_chain_t cfg;
 108
 109             SKIPSPACE( p );
 110
 111             psz_name = p;
 112
 113             while( *p && *p != '=' && *p != ',' && *p != '{' && *p != '}' &&
 114                    *p != ' ' && *p != '\t' ) p++;
 115
 116             /* fprintf( stderr, "name=%s - rest=%s\n", psz_name, p ); */
 117             if( p == psz_name )
 118             {
 119                 fprintf( stderr, "invalid options (empty)" );
 120                 break;
 121             }
 122
 123             cfg.psz_name = strndup( psz_name, p - psz_name );
 124
 125             SKIPSPACE( p );
 126
 127             if( *p == '=' || *p == '{' )
 128             {
 129                 char *end;
 130                 vlc_bool_t b_keep_brackets = (*p == '{');
 131
 132                 if( *p == '=' ) p++;
 133
 134                 end = _get_chain_end( p );
 135                 if( end <= p )
 136                 {
 137                     cfg.psz_value = NULL;
 138                 }
 139                 else
 140                 {
 141                     /* Skip heading and trailing spaces.
 142                      * This ain't necessary but will avoid simple
 143                      * user mistakes. */
 144                     SKIPSPACE( p );
 145                 }
 146
 147                 if( end <= p )
 148                 {
 149                     cfg.psz_value = NULL;
 150                 }
 151                 else
 152                 {
 153                     if( *p == '\'' || *p == '"' ||
 154                         ( !b_keep_brackets && *p == '{' ) )
 155                     {
 156                         p++;
 157
 158                         if( *(end-1) != '\'' && *(end-1) == '"' )
 159                             SKIPTRAILINGSPACE( p, end );
 160
 161                         if( end - 1 <= p ) cfg.psz_value = NULL;
 162                         else cfg.psz_value = strndup( p, end -1 - p );
 163                     }
 164                     else
 165                     {
 166                         SKIPTRAILINGSPACE( p, end );
 167                         if( end <= p ) cfg.psz_value = NULL;
 168                         else cfg.psz_value = strndup( p, end - p );
 169                     }
 170                 }
 171
 172                 p = end;
 173                 SKIPSPACE( p );
 174             }
 175             else
 176             {
 177                 cfg.psz_value = NULL;
 178             }
 179
 180             cfg.p_next = NULL;
 181             if( p_cfg )
 182             {
 183                 p_cfg->p_next = malloc( sizeof( config_chain_t ) );
 184                 memcpy( p_cfg->p_next, &cfg, sizeof( config_chain_t ) );
 185
 186                 p_cfg = p_cfg->p_next;
 187             }
 188             else
 189             {
 190                 p_cfg = malloc( sizeof( config_chain_t ) );
 191                 memcpy( p_cfg, &cfg, sizeof( config_chain_t ) );
 192
 193                 *pp_cfg = p_cfg;
 194             }
 195
 196             if( *p == ',' ) p++;
 197
 198             if( *p == '}' )
 199             {
 200                 p++;
 201                 break;
 202             }
 203         }
 204     }
 205
 206     if( *p == ':' ) return( strdup( p + 1 ) );
 207
 208     return NULL;
 209 }
 210
 211 void config_ChainDestroy( config_chain_t *p_cfg )
 212 {
 213     while( p_cfg != NULL )
 214     {
 215         config_chain_t *p_next;
 216
 217         p_next = p_cfg->p_next;
 218
 219         FREENULL( p_cfg->psz_name );
 220         FREENULL( p_cfg->psz_value );
 221         free( p_cfg );
 222
 223         p_cfg = p_next;
 224     }
 225 }
 226
 227 void __config_ChainParse( vlc_object_t *p_this, char *psz_prefix,
 228                       const char **ppsz_options, config_chain_t *cfg )
 229 {
 230     char *psz_name;
 231     int  i_type;
 232     int  i;
 233
 234     /* First, var_Create all variables */
 235     for( i = 0; ppsz_options[i] != NULL; i++ )
 236     {
 237         asprintf( &psz_name, "%s%s", psz_prefix,
 238                   *ppsz_options[i] == '*' ? &ppsz_options[i][1] : ppsz_options[i] );
 239
 240         i_type = config_GetType( p_this, psz_name );
 241
 242         var_Create( p_this, psz_name, i_type | VLC_VAR_DOINHERIT );
 243         free( psz_name );
 244     }
 245
 246     /* Now parse options and set value */
 247     if( psz_prefix == NULL ) psz_prefix = "";
 248
 249     while( cfg )
 250     {
 251         vlc_value_t val;
 252         vlc_bool_t b_yes = VLC_TRUE;
 253         vlc_bool_t b_once = VLC_FALSE;
 254         module_config_t *p_conf;
 255
 256         if( cfg->psz_name == NULL || *cfg->psz_name == '\0' )
 257         {
 258             cfg = cfg->p_next;
 259             continue;
 260         }
 261         for( i = 0; ppsz_options[i] != NULL; i++ )
 262         {
 263             if( !strcmp( ppsz_options[i], cfg->psz_name ) )
 264             {
 265                 break;
 266             }
 267             if( ( !strncmp( cfg->psz_name, "no-", 3 ) &&
 268                   !strcmp( ppsz_options[i], cfg->psz_name + 3 ) ) ||
 269                 ( !strncmp( cfg->psz_name, "no", 2 ) &&
 270                   !strcmp( ppsz_options[i], cfg->psz_name + 2 ) ) )
 271             {
 272                 b_yes = VLC_FALSE;
 273                 break;
 274             }
 275
 276             if( *ppsz_options[i] == '*' &&
 277                 !strcmp( &ppsz_options[i][1], cfg->psz_name ) )
 278             {
 279                 b_once = VLC_TRUE;
 280                 break;
 281             }
 282
 283         }
 284         if( ppsz_options[i] == NULL )
 285         {
 286             msg_Warn( p_this, "option %s is unknown", cfg->psz_name );
 287             cfg = cfg->p_next;
 288             continue;
 289         }
 290
 291         /* create name */
 292         asprintf( &psz_name, "%s%s", psz_prefix, b_once ? &ppsz_options[i][1] : ppsz_options[i] );
 293
 294         /* Check if the option is deprecated */
 295         p_conf = config_FindConfig( p_this, psz_name );
 296
 297         /* This is basically cut and paste from src/misc/configuration.c
 298          * with slight changes */
 299         if( p_conf && p_conf->psz_current )
 300         {
 301             if( !strcmp( p_conf->psz_current, "SUPPRESSED" ) )
 302             {
 303                 msg_Err( p_this, "Option %s is no longer used.",
 304                          p_conf->psz_name );
 305                 goto next;
 306             }
 307             else if( p_conf->b_strict )
 308             {
 309                 msg_Err( p_this, "Option %s is deprecated. Use %s instead.",
 310                          p_conf->psz_name, p_conf->psz_current );
 311                 /* TODO: this should return an error and end option parsing
 312                  * ... but doing this would change the VLC API and all the
 313                  * modules so i'll do it later */
 314                 goto next;
 315             }
 316             else
 317             {
 318                 msg_Warn( p_this, "Option %s is deprecated. You should use "
 319                         "%s instead.", p_conf->psz_name, p_conf->psz_current );
 320                 free( psz_name );
 321                 psz_name = strdup( p_conf->psz_current );
 322             }
 323         }
 324         /* </Check if the option is deprecated> */
 325
 326         /* get the type of the variable */
 327         i_type = config_GetType( p_this, psz_name );
 328         if( !i_type )
 329         {
 330             msg_Warn( p_this, "unknown option %s (value=%s)",
 331                       cfg->psz_name, cfg->psz_value );
 332             goto next;
 333         }
 334         if( i_type != VLC_VAR_BOOL && cfg->psz_value == NULL )
 335         {
 336             msg_Warn( p_this, "missing value for option %s", cfg->psz_name );
 337             goto next;
 338         }
 339         if( i_type != VLC_VAR_STRING && b_once )
 340         {
 341             msg_Warn( p_this, "*option_name need to be a string option" );
 342             goto next;
 343         }
 344
 345         switch( i_type )
 346         {
 347             case VLC_VAR_BOOL:
 348                 val.b_bool = b_yes;
 349                 break;
 350             case VLC_VAR_INTEGER:
 351                 val.i_int = strtol( cfg->psz_value ? cfg->psz_value : "0",
 352                                     NULL, 0 );
 353                 break;
 354             case VLC_VAR_FLOAT:
 355                 val.f_float = atof( cfg->psz_value ? cfg->psz_value : "0" );
 356                 break;
 357             case VLC_VAR_STRING:
 358             case VLC_VAR_MODULE:
 359                 val.psz_string = cfg->psz_value;
 360                 break;
 361             default:
 362                 msg_Warn( p_this, "unhandled config var type" );
 363                 memset( &val, 0, sizeof( vlc_value_t ) );
 364                 break;
 365         }
 366         if( b_once )
 367         {
 368             vlc_value_t val2;
 369
 370             var_Get( p_this, psz_name, &val2 );
 371             if( *val2.psz_string )
 372             {
 373                 free( val2.psz_string );
 374                 msg_Dbg( p_this, "ignoring option %s (not first occurrence)", psz_name );
 375                 goto next;
 376             }
 377             free( val2.psz_string );
 378         }
 379         var_Set( p_this, psz_name, val );
 380         msg_Dbg( p_this, "set config option: %s to %s", psz_name, cfg->psz_value );
 381
 382     next:
 383         free( psz_name );
 384         cfg = cfg->p_next;
 385     }
 386 }