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_configuration.h"
34 #include "configuration.h"
35 #include "modules/modules.h"
37 vlc_rwlock_t config_lock;
39 static inline char *strdupnull (const char *src)
41 return src ? strdup (src) : NULL;
44 /* Item types that use a string value (i.e. serialized in the module cache) */
45 int IsConfigStringType (int type)
47 static const unsigned char config_types[] =
49 CONFIG_ITEM_STRING, CONFIG_ITEM_FILE, CONFIG_ITEM_MODULE,
50 CONFIG_ITEM_DIRECTORY, CONFIG_ITEM_MODULE_CAT, CONFIG_ITEM_PASSWORD,
51 CONFIG_ITEM_MODULE_LIST, CONFIG_ITEM_MODULE_LIST_CAT, CONFIG_ITEM_FONT
54 /* NOTE: this needs to be changed if we ever get more than 255 types */
55 return memchr (config_types, type, sizeof (config_types)) != NULL;
59 int IsConfigIntegerType (int type)
61 static const unsigned char config_types[] =
63 CONFIG_ITEM_INTEGER, CONFIG_ITEM_KEY, CONFIG_ITEM_BOOL,
64 CONFIG_CATEGORY, CONFIG_SUBCATEGORY
67 return memchr (config_types, type, sizeof (config_types)) != NULL;
71 /*****************************************************************************
72 * config_GetType: get the type of a variable (bool, int, float, string)
73 *****************************************************************************
74 * This function is used to get the type of a variable from its name.
75 * Beware, this is quite slow.
76 *****************************************************************************/
77 int config_GetType( vlc_object_t *p_this, const char *psz_name )
79 module_config_t *p_config;
82 p_config = config_FindConfig( p_this, psz_name );
90 switch( p_config->i_type )
92 case CONFIG_ITEM_BOOL:
93 i_type = VLC_VAR_BOOL;
96 case CONFIG_ITEM_INTEGER:
98 i_type = VLC_VAR_INTEGER;
101 case CONFIG_ITEM_FLOAT:
102 i_type = VLC_VAR_FLOAT;
105 case CONFIG_ITEM_MODULE:
106 case CONFIG_ITEM_MODULE_CAT:
107 case CONFIG_ITEM_MODULE_LIST:
108 case CONFIG_ITEM_MODULE_LIST_CAT:
109 i_type = VLC_VAR_MODULE;
112 case CONFIG_ITEM_STRING:
113 i_type = VLC_VAR_STRING;
116 case CONFIG_ITEM_PASSWORD:
117 i_type = VLC_VAR_STRING;
120 case CONFIG_ITEM_FILE:
121 i_type = VLC_VAR_FILE;
124 case CONFIG_ITEM_DIRECTORY:
125 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 );
165 vlc_rwlock_rdlock (&config_lock);
166 val = p_config->value.i;
167 vlc_rwlock_unlock (&config_lock);
171 #undef config_GetFloat
172 /*****************************************************************************
173 * config_GetFloat: get the value of a float variable
174 *****************************************************************************
175 * This function is used to get the value of variables which are internally
176 * represented by a float (CONFIG_ITEM_FLOAT).
177 *****************************************************************************/
178 float config_GetFloat( vlc_object_t *p_this, const char *psz_name )
180 module_config_t *p_config;
182 p_config = config_FindConfig( p_this, psz_name );
187 msg_Err( p_this, "option %s does not exist", psz_name );
191 if (!IsConfigFloatType (p_config->i_type))
193 msg_Err( p_this, "option %s does not refer to a float", psz_name );
199 vlc_rwlock_rdlock (&config_lock);
200 val = p_config->value.f;
201 vlc_rwlock_unlock (&config_lock);
206 /*****************************************************************************
207 * config_GetPsz: get the string value of a string variable
208 *****************************************************************************
209 * This function is used to get the value of variables which are internally
210 * represented by a string (CONFIG_ITEM_STRING, CONFIG_ITEM_FILE,
211 * CONFIG_ITEM_DIRECTORY, CONFIG_ITEM_PASSWORD, and CONFIG_ITEM_MODULE).
213 * Important note: remember to free() the returned char* because it's a
214 * duplicate of the actual value. It isn't safe to return a pointer to the
215 * actual value as it can be modified at any time.
216 *****************************************************************************/
217 char * config_GetPsz( vlc_object_t *p_this, const char *psz_name )
219 module_config_t *p_config;
221 p_config = config_FindConfig( p_this, psz_name );
226 msg_Err( p_this, "option %s does not exist", psz_name );
230 if (!IsConfigStringType (p_config->i_type))
232 msg_Err( p_this, "option %s does not refer to a string", psz_name );
236 /* return a copy of the string */
237 vlc_rwlock_rdlock (&config_lock);
238 char *psz_value = strdupnull (p_config->value.psz);
239 vlc_rwlock_unlock (&config_lock);
245 /*****************************************************************************
246 * config_PutPsz: set the string value of a string variable
247 *****************************************************************************
248 * This function is used to set the value of variables which are internally
249 * represented by a string (CONFIG_ITEM_STRING, CONFIG_ITEM_FILE,
250 * CONFIG_ITEM_DIRECTORY, CONFIG_ITEM_PASSWORD, and CONFIG_ITEM_MODULE).
251 *****************************************************************************/
252 void config_PutPsz( vlc_object_t *p_this,
253 const char *psz_name, const char *psz_value )
255 module_config_t *p_config;
256 vlc_value_t oldval, val;
258 p_config = config_FindConfig( p_this, psz_name );
264 msg_Warn( p_this, "option %s does not exist", psz_name );
268 if (!IsConfigStringType (p_config->i_type))
270 msg_Err( p_this, "option %s does not refer to a string", psz_name );
274 vlc_rwlock_wrlock (&config_lock);
276 /* backup old value */
277 oldval.psz_string = (char *)p_config->value.psz;
279 if ((psz_value != NULL) && *psz_value)
280 p_config->value.psz = strdup (psz_value);
282 p_config->value.psz = NULL;
284 p_config->b_dirty = true;
286 val.psz_string = (char *)p_config->value.psz;
288 vlc_rwlock_unlock (&config_lock);
290 if( p_config->pf_callback )
292 p_config->pf_callback( p_this, psz_name, oldval, val,
293 p_config->p_callback_data );
296 /* free old string */
297 free( oldval.psz_string );
301 /*****************************************************************************
302 * config_PutInt: set the integer value of an int variable
303 *****************************************************************************
304 * This function is used to set the value of variables which are internally
305 * represented by an integer (CONFIG_ITEM_INTEGER and
307 *****************************************************************************/
308 void config_PutInt( vlc_object_t *p_this, const char *psz_name, int i_value )
310 module_config_t *p_config;
313 p_config = config_FindConfig( p_this, psz_name );
318 msg_Warn( p_this, "option %s does not exist", psz_name );
322 if (!IsConfigIntegerType (p_config->i_type))
324 msg_Err( p_this, "option %s does not refer to an int", psz_name );
328 /* if i_min == i_max == 0, then do not use them */
329 if ((p_config->min.i == 0) && (p_config->max.i == 0))
331 else if (i_value < p_config->min.i)
332 i_value = p_config->min.i;
333 else if (i_value > p_config->max.i)
334 i_value = p_config->max.i;
336 vlc_rwlock_wrlock (&config_lock);
337 /* backup old value */
338 oldval.i_int = p_config->value.i;
340 p_config->value.i = i_value;
341 p_config->b_dirty = true;
342 vlc_rwlock_unlock (&config_lock);
344 if( p_config->pf_callback )
349 p_config->pf_callback( p_this, psz_name, oldval, val,
350 p_config->p_callback_data );
354 #undef config_PutFloat
355 /*****************************************************************************
356 * config_PutFloat: set the value of a float variable
357 *****************************************************************************
358 * This function is used to set the value of variables which are internally
359 * represented by a float (CONFIG_ITEM_FLOAT).
360 *****************************************************************************/
361 void config_PutFloat( vlc_object_t *p_this,
362 const char *psz_name, float f_value )
364 module_config_t *p_config;
367 p_config = config_FindConfig( p_this, psz_name );
372 msg_Warn( p_this, "option %s does not exist", psz_name );
376 if (!IsConfigFloatType (p_config->i_type))
378 msg_Err( p_this, "option %s does not refer to a float", psz_name );
382 /* if f_min == f_max == 0, then do not use them */
383 if ((p_config->min.f == 0) && (p_config->max.f == 0))
385 else if (f_value < p_config->min.f)
386 f_value = p_config->min.f;
387 else if (f_value > p_config->max.f)
388 f_value = p_config->max.f;
390 vlc_rwlock_wrlock (&config_lock);
391 /* backup old value */
392 oldval.f_float = p_config->value.f;
394 p_config->value.f = f_value;
395 p_config->b_dirty = true;
396 vlc_rwlock_unlock (&config_lock);
398 if( p_config->pf_callback )
402 val.f_float = f_value;
403 p_config->pf_callback( p_this, psz_name, oldval, val,
404 p_config->p_callback_data );
408 static int confcmp (const void *a, const void *b)
410 const module_config_t *const *ca = a, *const *cb = b;
412 return strcmp ((*ca)->psz_name, (*cb)->psz_name);
415 static int confnamecmp (const void *key, const void *elem)
417 const module_config_t *const *conf = elem;
419 return strcmp (key, (*conf)->psz_name);
424 module_config_t **list;
426 } config = { NULL, 0 };
429 * Index the configuration items by name for faster lookups.
431 int config_SortConfig (void)
434 module_t **mlist = module_list_get (&nmod);
435 if (unlikely(mlist == NULL))
439 for (size_t i = 0; i < nmod; i++)
440 nconf += mlist[i]->confsize;
442 module_config_t **clist = malloc (sizeof (*clist) * nconf);
443 if (unlikely(clist == NULL))
445 module_list_free (mlist);
450 for (size_t i = 0; i < nmod; i++)
452 module_t *parser = mlist[i];
453 module_config_t *item, *end;
455 for (item = parser->p_config, end = item + parser->confsize;
459 if (item->i_type & CONFIG_HINT)
460 continue; /* ignore hints */
461 clist[nconf++] = item;
464 module_list_free (mlist);
466 qsort (clist, nconf, sizeof (*clist), confcmp);
469 config.count = nconf;
473 void config_UnsortConfig (void)
475 module_config_t **clist;
484 /*****************************************************************************
485 * config_FindConfig: find the config structure associated with an option.
486 *****************************************************************************
487 * FIXME: remove p_this pointer parameter (or use it)
488 *****************************************************************************/
489 module_config_t *config_FindConfig (vlc_object_t *p_this, const char *name)
493 if (unlikely(name == NULL))
496 module_config_t *const *p;
497 p = bsearch (name, config.list, config.count, sizeof (*p), confnamecmp);
498 return p ? *p : NULL;
501 /*****************************************************************************
502 * config_Free: frees a duplicated module's configuration data.
503 *****************************************************************************
504 * This function frees all the data duplicated by config_Duplicate.
505 *****************************************************************************/
506 void config_Free( module_t *p_module )
510 for (size_t j = 0; j < p_module->confsize; j++)
512 module_config_t *p_item = p_module->p_config + j;
514 free( p_item->psz_type );
515 free( p_item->psz_name );
516 free( p_item->psz_text );
517 free( p_item->psz_longtext );
518 free( p_item->psz_oldname );
520 if (IsConfigStringType (p_item->i_type))
522 free (p_item->value.psz);
523 free (p_item->orig.psz);
524 free (p_item->saved.psz);
527 if( p_item->ppsz_list )
528 for( i = 0; i < p_item->i_list; i++ )
529 free( p_item->ppsz_list[i] );
530 if( p_item->ppsz_list_text )
531 for( i = 0; i < p_item->i_list; i++ )
532 free( p_item->ppsz_list_text[i] );
533 free( p_item->ppsz_list );
534 free( p_item->ppsz_list_text );
535 free( p_item->pi_list );
537 if( p_item->i_action )
539 for( i = 0; i < p_item->i_action; i++ )
541 free( p_item->ppsz_action_text[i] );
543 free( p_item->ppf_action );
544 free( p_item->ppsz_action_text );
548 free (p_module->p_config);
549 p_module->p_config = NULL;
552 #undef config_ResetAll
553 /*****************************************************************************
554 * config_ResetAll: reset the configuration data for all the modules.
555 *****************************************************************************/
556 void config_ResetAll( vlc_object_t *p_this )
560 module_t **list = module_list_get (NULL);
562 vlc_rwlock_wrlock (&config_lock);
563 for (size_t j = 0; (p_module = list[j]) != NULL; j++)
565 if( p_module->b_submodule ) continue;
567 for (size_t i = 0; i < p_module->confsize; i++ )
569 module_config_t *p_config = p_module->p_config + i;
571 if (IsConfigIntegerType (p_config->i_type))
572 p_config->value.i = p_config->orig.i;
574 if (IsConfigFloatType (p_config->i_type))
575 p_config->value.f = p_config->orig.f;
577 if (IsConfigStringType (p_config->i_type))
579 free ((char *)p_config->value.psz);
580 p_config->value.psz =
581 strdupnull (p_config->orig.psz);
585 vlc_rwlock_unlock (&config_lock);
587 module_list_free (list);