1 /*****************************************************************************
2 * core.c management of the modules configuration
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>
30 #include "vlc_charset.h"
31 #include "vlc_configuration.h"
35 #include "configuration.h"
36 #include "modules/modules.h"
38 vlc_rwlock_t config_lock;
40 static inline char *strdupnull (const char *src)
42 return src ? strdup (src) : NULL;
45 /* Item types that use a string value (i.e. serialized in the module cache) */
46 int IsConfigStringType (int type)
48 static const unsigned char config_types[] =
50 CONFIG_ITEM_STRING, CONFIG_ITEM_FILE, CONFIG_ITEM_MODULE,
51 CONFIG_ITEM_DIRECTORY, CONFIG_ITEM_MODULE_CAT, CONFIG_ITEM_PASSWORD,
52 CONFIG_ITEM_MODULE_LIST, CONFIG_ITEM_MODULE_LIST_CAT, CONFIG_ITEM_FONT
55 /* NOTE: this needs to be changed if we ever get more than 255 types */
56 return memchr (config_types, type, sizeof (config_types)) != NULL;
60 int IsConfigIntegerType (int type)
62 static const unsigned char config_types[] =
64 CONFIG_ITEM_INTEGER, CONFIG_ITEM_KEY, CONFIG_ITEM_BOOL,
65 CONFIG_CATEGORY, CONFIG_SUBCATEGORY
68 return memchr (config_types, type, sizeof (config_types)) != NULL;
72 /*****************************************************************************
73 * config_GetType: get the type of a variable (bool, int, float, string)
74 *****************************************************************************
75 * This function is used to get the type of a variable from its name.
76 * Beware, this is quite slow.
77 *****************************************************************************/
78 int __config_GetType( vlc_object_t *p_this, const char *psz_name )
80 module_config_t *p_config;
83 p_config = config_FindConfig( p_this, psz_name );
91 switch( p_config->i_type )
93 case CONFIG_ITEM_BOOL:
94 i_type = VLC_VAR_BOOL;
97 case CONFIG_ITEM_INTEGER:
99 i_type = VLC_VAR_INTEGER;
102 case CONFIG_ITEM_FLOAT:
103 i_type = VLC_VAR_FLOAT;
106 case CONFIG_ITEM_MODULE:
107 case CONFIG_ITEM_MODULE_CAT:
108 case CONFIG_ITEM_MODULE_LIST:
109 case CONFIG_ITEM_MODULE_LIST_CAT:
110 i_type = VLC_VAR_MODULE;
113 case CONFIG_ITEM_STRING:
114 i_type = VLC_VAR_STRING;
117 case CONFIG_ITEM_PASSWORD:
118 i_type = VLC_VAR_STRING;
121 case CONFIG_ITEM_FILE:
122 i_type = VLC_VAR_FILE;
125 case CONFIG_ITEM_DIRECTORY:
126 i_type = VLC_VAR_DIRECTORY;
137 /*****************************************************************************
138 * config_GetInt: get the value of an int variable
139 *****************************************************************************
140 * This function is used to get the value of variables which are internally
141 * represented by an integer (CONFIG_ITEM_INTEGER and
143 *****************************************************************************/
144 int __config_GetInt( vlc_object_t *p_this, const char *psz_name )
146 module_config_t *p_config;
148 p_config = config_FindConfig( p_this, psz_name );
153 msg_Err( p_this, "option %s does not exist", psz_name );
157 if (!IsConfigIntegerType (p_config->i_type))
159 msg_Err( p_this, "option %s does not refer to an int", psz_name );
163 return p_config->value.i;
166 /*****************************************************************************
167 * config_GetFloat: get the value of a float variable
168 *****************************************************************************
169 * This function is used to get the value of variables which are internally
170 * represented by a float (CONFIG_ITEM_FLOAT).
171 *****************************************************************************/
172 float __config_GetFloat( vlc_object_t *p_this, const char *psz_name )
174 module_config_t *p_config;
176 p_config = config_FindConfig( p_this, psz_name );
181 msg_Err( p_this, "option %s does not exist", psz_name );
185 if (!IsConfigFloatType (p_config->i_type))
187 msg_Err( p_this, "option %s does not refer to a float", psz_name );
191 return p_config->value.f;
194 /*****************************************************************************
195 * config_GetPsz: get the string value of a string variable
196 *****************************************************************************
197 * This function is used to get the value of variables which are internally
198 * represented by a string (CONFIG_ITEM_STRING, CONFIG_ITEM_FILE,
199 * CONFIG_ITEM_DIRECTORY, CONFIG_ITEM_PASSWORD, and CONFIG_ITEM_MODULE).
201 * Important note: remember to free() the returned char* because it's a
202 * duplicate of the actual value. It isn't safe to return a pointer to the
203 * actual value as it can be modified at any time.
204 *****************************************************************************/
205 char * __config_GetPsz( vlc_object_t *p_this, const char *psz_name )
207 module_config_t *p_config;
209 p_config = config_FindConfig( p_this, psz_name );
214 msg_Err( p_this, "option %s does not exist", psz_name );
218 if (!IsConfigStringType (p_config->i_type))
220 msg_Err( p_this, "option %s does not refer to a string", psz_name );
224 /* return a copy of the string */
225 vlc_rwlock_rdlock (&config_lock);
226 char *psz_value = strdupnull (p_config->value.psz);
227 vlc_rwlock_unlock (&config_lock);
232 /*****************************************************************************
233 * config_PutPsz: set the string value of a string variable
234 *****************************************************************************
235 * This function is used to set the value of variables which are internally
236 * represented by a string (CONFIG_ITEM_STRING, CONFIG_ITEM_FILE,
237 * CONFIG_ITEM_DIRECTORY, CONFIG_ITEM_PASSWORD, and CONFIG_ITEM_MODULE).
238 *****************************************************************************/
239 void __config_PutPsz( vlc_object_t *p_this,
240 const char *psz_name, const char *psz_value )
242 module_config_t *p_config;
243 vlc_value_t oldval, val;
245 p_config = config_FindConfig( p_this, psz_name );
251 msg_Warn( p_this, "option %s does not exist", psz_name );
255 if (!IsConfigStringType (p_config->i_type))
257 msg_Err( p_this, "option %s does not refer to a string", psz_name );
261 vlc_rwlock_wrlock (&config_lock);
263 /* backup old value */
264 oldval.psz_string = (char *)p_config->value.psz;
266 if ((psz_value != NULL) && *psz_value)
267 p_config->value.psz = strdup (psz_value);
269 p_config->value.psz = NULL;
271 p_config->b_dirty = true;
273 val.psz_string = (char *)p_config->value.psz;
275 vlc_rwlock_unlock (&config_lock);
277 if( p_config->pf_callback )
279 p_config->pf_callback( p_this, psz_name, oldval, val,
280 p_config->p_callback_data );
283 /* free old string */
284 free( oldval.psz_string );
287 /*****************************************************************************
288 * config_PutInt: set the integer value of an int variable
289 *****************************************************************************
290 * This function is used to set the value of variables which are internally
291 * represented by an integer (CONFIG_ITEM_INTEGER and
293 *****************************************************************************/
294 void __config_PutInt( vlc_object_t *p_this, const char *psz_name, int i_value )
296 module_config_t *p_config;
297 vlc_value_t oldval, val;
299 p_config = config_FindConfig( p_this, psz_name );
304 msg_Warn( p_this, "option %s does not exist", psz_name );
308 if (!IsConfigIntegerType (p_config->i_type))
310 msg_Err( p_this, "option %s does not refer to an int", psz_name );
314 /* backup old value */
315 oldval.i_int = p_config->value.i;
317 /* if i_min == i_max == 0, then do not use them */
318 if ((p_config->min.i == 0) && (p_config->max.i == 0))
320 p_config->value.i = i_value;
322 else if (i_value < p_config->min.i)
324 p_config->value.i = p_config->min.i;
326 else if (i_value > p_config->max.i)
328 p_config->value.i = p_config->max.i;
332 p_config->value.i = i_value;
335 p_config->b_dirty = true;
337 val.i_int = p_config->value.i;
339 if( p_config->pf_callback )
341 p_config->pf_callback( p_this, psz_name, oldval, val,
342 p_config->p_callback_data );
346 /*****************************************************************************
347 * config_PutFloat: set the value of a float variable
348 *****************************************************************************
349 * This function is used to set the value of variables which are internally
350 * represented by a float (CONFIG_ITEM_FLOAT).
351 *****************************************************************************/
352 void __config_PutFloat( vlc_object_t *p_this,
353 const char *psz_name, float f_value )
355 module_config_t *p_config;
356 vlc_value_t oldval, val;
358 p_config = config_FindConfig( p_this, psz_name );
363 msg_Warn( p_this, "option %s does not exist", psz_name );
367 if (!IsConfigFloatType (p_config->i_type))
369 msg_Err( p_this, "option %s does not refer to a float", psz_name );
373 /* backup old value */
374 oldval.f_float = p_config->value.f;
376 /* if f_min == f_max == 0, then do not use them */
377 if ((p_config->min.f == 0) && (p_config->max.f == 0))
379 p_config->value.f = f_value;
381 else if (f_value < p_config->min.f)
383 p_config->value.f = p_config->min.f;
385 else if (f_value > p_config->max.f)
387 p_config->value.f = p_config->max.f;
391 p_config->value.f = f_value;
394 p_config->b_dirty = true;
396 val.f_float = p_config->value.f;
398 if( p_config->pf_callback )
400 p_config->pf_callback( p_this, psz_name, oldval, val,
401 p_config->p_callback_data );
405 /*****************************************************************************
406 * config_FindConfig: find the config structure associated with an option.
407 *****************************************************************************
408 * FIXME: This function really needs to be optimized.
409 * FIXME: And now even more.
410 * FIXME: remove p_this pointer parameter (or use it)
411 *****************************************************************************/
412 module_config_t *config_FindConfig( vlc_object_t *p_this, const char *psz_name )
417 if( !psz_name ) return NULL;
419 module_t **list = module_list_get (NULL);
423 for (size_t i = 0; (p_parser = list[i]) != NULL; i++)
425 module_config_t *p_item, *p_end;
427 if( !p_parser->i_config_items )
430 for( p_item = p_parser->p_config, p_end = p_item + p_parser->confsize;
434 if( p_item->i_type & CONFIG_HINT )
437 if( !strcmp( psz_name, p_item->psz_name )
438 || ( p_item->psz_oldname
439 && !strcmp( psz_name, p_item->psz_oldname ) ) )
441 module_list_free (list);
447 module_list_free (list);
451 /*****************************************************************************
452 * config_Free: frees a duplicated module's configuration data.
453 *****************************************************************************
454 * This function frees all the data duplicated by config_Duplicate.
455 *****************************************************************************/
456 void config_Free( module_t *p_module )
460 for (size_t j = 0; j < p_module->confsize; j++)
462 module_config_t *p_item = p_module->p_config + j;
464 free( p_item->psz_type );
465 free( p_item->psz_name );
466 free( p_item->psz_text );
467 free( p_item->psz_longtext );
468 free( p_item->psz_oldname );
470 if (IsConfigStringType (p_item->i_type))
472 free (p_item->value.psz);
473 free (p_item->orig.psz);
474 free (p_item->saved.psz);
477 if( p_item->ppsz_list )
478 for( i = 0; i < p_item->i_list; i++ )
479 free( p_item->ppsz_list[i] );
480 if( p_item->ppsz_list_text )
481 for( i = 0; i < p_item->i_list; i++ )
482 free( p_item->ppsz_list_text[i] );
483 free( p_item->ppsz_list );
484 free( p_item->ppsz_list_text );
485 free( p_item->pi_list );
487 if( p_item->i_action )
489 for( i = 0; i < p_item->i_action; i++ )
491 free( p_item->ppsz_action_text[i] );
493 free( p_item->ppf_action );
494 free( p_item->ppsz_action_text );
498 free (p_module->p_config);
499 p_module->p_config = NULL;
502 /*****************************************************************************
503 * config_ResetAll: reset the configuration data for all the modules.
504 *****************************************************************************/
505 void __config_ResetAll( vlc_object_t *p_this )
509 module_t **list = module_list_get (NULL);
511 vlc_rwlock_wrlock (&config_lock);
512 for (size_t j = 0; (p_module = list[j]) != NULL; j++)
514 if( p_module->b_submodule ) continue;
516 for (size_t i = 0; i < p_module->confsize; i++ )
518 module_config_t *p_config = p_module->p_config + i;
520 if (IsConfigIntegerType (p_config->i_type))
521 p_config->value.i = p_config->orig.i;
523 if (IsConfigFloatType (p_config->i_type))
524 p_config->value.f = p_config->orig.f;
526 if (IsConfigStringType (p_config->i_type))
528 free ((char *)p_config->value.psz);
529 p_config->value.psz =
530 strdupnull (p_config->orig.psz);
534 vlc_rwlock_unlock (&config_lock);
536 module_list_free (list);