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_modules.h>
32 #include "vlc_configuration.h"
36 #include "configuration.h"
37 #include "modules/modules.h"
39 vlc_rwlock_t config_lock;
41 static inline char *strdupnull (const char *src)
43 return src ? strdup (src) : NULL;
46 /* Item types that use a string value (i.e. serialized in the module cache) */
47 int IsConfigStringType (int type)
49 static const unsigned char config_types[] =
51 CONFIG_ITEM_STRING, CONFIG_ITEM_MODULE,
52 CONFIG_ITEM_DIRECTORY, CONFIG_ITEM_MODULE_CAT, CONFIG_ITEM_PASSWORD,
53 CONFIG_ITEM_MODULE_LIST, CONFIG_ITEM_MODULE_LIST_CAT,
54 CONFIG_ITEM_FONT, CONFIG_ITEM_LOADFILE, CONFIG_ITEM_SAVEFILE,
57 /* NOTE: this needs to be changed if we ever get more than 255 types */
58 return memchr (config_types, type, sizeof (config_types)) != NULL;
62 int IsConfigIntegerType (int type)
64 static const unsigned char config_types[] =
66 CONFIG_ITEM_INTEGER, CONFIG_ITEM_KEY, CONFIG_ITEM_BOOL,
67 CONFIG_CATEGORY, CONFIG_SUBCATEGORY
70 return memchr (config_types, type, sizeof (config_types)) != NULL;
74 /*****************************************************************************
75 * config_GetType: get the type of a variable (bool, int, float, string)
76 *****************************************************************************
77 * This function is used to get the type of a variable from its name.
78 * Beware, this is quite slow.
79 *****************************************************************************/
80 int config_GetType( vlc_object_t *p_this, const char *psz_name )
82 module_config_t *p_config;
85 p_config = config_FindConfig( p_this, psz_name );
93 switch( p_config->i_type )
95 case CONFIG_ITEM_BOOL:
96 i_type = VLC_VAR_BOOL;
99 case CONFIG_ITEM_INTEGER:
100 case CONFIG_ITEM_KEY:
101 i_type = VLC_VAR_INTEGER;
104 case CONFIG_ITEM_FLOAT:
105 i_type = VLC_VAR_FLOAT;
108 case CONFIG_ITEM_MODULE:
109 case CONFIG_ITEM_MODULE_CAT:
110 case CONFIG_ITEM_MODULE_LIST:
111 case CONFIG_ITEM_MODULE_LIST_CAT:
112 i_type = VLC_VAR_MODULE;
115 case CONFIG_ITEM_STRING:
116 i_type = VLC_VAR_STRING;
119 case CONFIG_ITEM_PASSWORD:
120 i_type = VLC_VAR_STRING;
123 case CONFIG_ITEM_LOADFILE:
124 case CONFIG_ITEM_SAVEFILE:
125 i_type = VLC_VAR_FILE;
128 case CONFIG_ITEM_DIRECTORY:
129 i_type = VLC_VAR_DIRECTORY;
141 /*****************************************************************************
142 * config_GetInt: get the value of an int variable
143 *****************************************************************************
144 * This function is used to get the value of variables which are internally
145 * represented by an integer (CONFIG_ITEM_INTEGER and
147 *****************************************************************************/
148 int64_t config_GetInt( vlc_object_t *p_this, const char *psz_name )
150 module_config_t *p_config;
152 p_config = config_FindConfig( p_this, psz_name );
157 msg_Err( p_this, "option %s does not exist", psz_name );
161 if (!IsConfigIntegerType (p_config->i_type))
163 msg_Err( p_this, "option %s does not refer to an int", psz_name );
169 vlc_rwlock_rdlock (&config_lock);
170 val = p_config->value.i;
171 vlc_rwlock_unlock (&config_lock);
175 #undef config_GetFloat
176 /*****************************************************************************
177 * config_GetFloat: get the value of a float variable
178 *****************************************************************************
179 * This function is used to get the value of variables which are internally
180 * represented by a float (CONFIG_ITEM_FLOAT).
181 *****************************************************************************/
182 float config_GetFloat( vlc_object_t *p_this, const char *psz_name )
184 module_config_t *p_config;
186 p_config = config_FindConfig( p_this, psz_name );
191 msg_Err( p_this, "option %s does not exist", psz_name );
195 if (!IsConfigFloatType (p_config->i_type))
197 msg_Err( p_this, "option %s does not refer to a float", psz_name );
203 vlc_rwlock_rdlock (&config_lock);
204 val = p_config->value.f;
205 vlc_rwlock_unlock (&config_lock);
210 /*****************************************************************************
211 * config_GetPsz: get the string value of a string variable
212 *****************************************************************************
213 * This function is used to get the value of variables which are internally
214 * represented by a string (CONFIG_ITEM_STRING, CONFIG_ITEM_*FILE,
215 * CONFIG_ITEM_DIRECTORY, CONFIG_ITEM_PASSWORD, and CONFIG_ITEM_MODULE).
217 * Important note: remember to free() the returned char* because it's a
218 * duplicate of the actual value. It isn't safe to return a pointer to the
219 * actual value as it can be modified at any time.
220 *****************************************************************************/
221 char * config_GetPsz( vlc_object_t *p_this, const char *psz_name )
223 module_config_t *p_config;
225 p_config = config_FindConfig( p_this, psz_name );
230 msg_Err( p_this, "option %s does not exist", psz_name );
234 if (!IsConfigStringType (p_config->i_type))
236 msg_Err( p_this, "option %s does not refer to a string", psz_name );
240 /* return a copy of the string */
241 vlc_rwlock_rdlock (&config_lock);
242 char *psz_value = strdupnull (p_config->value.psz);
243 vlc_rwlock_unlock (&config_lock);
249 /*****************************************************************************
250 * config_PutPsz: set the string value of a string variable
251 *****************************************************************************
252 * This function is used to set the value of variables which are internally
253 * represented by a string (CONFIG_ITEM_STRING, CONFIG_ITEM_*FILE,
254 * CONFIG_ITEM_DIRECTORY, CONFIG_ITEM_PASSWORD, and CONFIG_ITEM_MODULE).
255 *****************************************************************************/
256 void config_PutPsz( vlc_object_t *p_this,
257 const char *psz_name, const char *psz_value )
259 module_config_t *p_config;
262 p_config = config_FindConfig( p_this, psz_name );
268 msg_Warn( p_this, "option %s does not exist", psz_name );
272 if (!IsConfigStringType (p_config->i_type))
274 msg_Err( p_this, "option %s does not refer to a string", psz_name );
279 if ((psz_value != NULL) && *psz_value)
280 str = strdup (psz_value);
284 vlc_rwlock_wrlock (&config_lock);
285 /* backup old value */
286 oldval.psz_string = (char *)p_config->value.psz;
288 p_config->value.psz = str;
289 p_config->b_dirty = true;
290 vlc_rwlock_unlock (&config_lock);
292 if( p_config->pf_callback )
296 val.psz_string = (char *)psz_value;
297 p_config->pf_callback( p_this, psz_name, oldval, val, NULL );
300 /* free old string */
301 free( oldval.psz_string );
305 /*****************************************************************************
306 * config_PutInt: set the integer value of an int variable
307 *****************************************************************************
308 * This function is used to set the value of variables which are internally
309 * represented by an integer (CONFIG_ITEM_INTEGER and
311 *****************************************************************************/
312 void config_PutInt( vlc_object_t *p_this, const char *psz_name,
315 module_config_t *p_config;
318 p_config = config_FindConfig( p_this, psz_name );
323 msg_Warn( p_this, "option %s does not exist", psz_name );
327 if (!IsConfigIntegerType (p_config->i_type))
329 msg_Err( p_this, "option %s does not refer to an int", psz_name );
333 if (i_value < p_config->min.i)
334 i_value = p_config->min.i;
335 if (i_value > p_config->max.i)
336 i_value = p_config->max.i;
338 vlc_rwlock_wrlock (&config_lock);
339 /* backup old value */
340 oldval.i_int = p_config->value.i;
342 p_config->value.i = i_value;
343 p_config->b_dirty = true;
344 vlc_rwlock_unlock (&config_lock);
346 if( p_config->pf_callback )
351 p_config->pf_callback( p_this, psz_name, oldval, val,
352 p_config->p_callback_data );
356 #undef config_PutFloat
357 /*****************************************************************************
358 * config_PutFloat: set the value of a float variable
359 *****************************************************************************
360 * This function is used to set the value of variables which are internally
361 * represented by a float (CONFIG_ITEM_FLOAT).
362 *****************************************************************************/
363 void config_PutFloat( vlc_object_t *p_this,
364 const char *psz_name, float f_value )
366 module_config_t *p_config;
369 p_config = config_FindConfig( p_this, psz_name );
374 msg_Warn( p_this, "option %s does not exist", psz_name );
378 if (!IsConfigFloatType (p_config->i_type))
380 msg_Err( p_this, "option %s does not refer to a float", psz_name );
384 /* if f_min == f_max == 0, then do not use them */
385 if ((p_config->min.f == 0) && (p_config->max.f == 0))
387 else if (f_value < p_config->min.f)
388 f_value = p_config->min.f;
389 else if (f_value > p_config->max.f)
390 f_value = p_config->max.f;
392 vlc_rwlock_wrlock (&config_lock);
393 /* backup old value */
394 oldval.f_float = p_config->value.f;
396 p_config->value.f = f_value;
397 p_config->b_dirty = true;
398 vlc_rwlock_unlock (&config_lock);
400 if( p_config->pf_callback )
404 val.f_float = f_value;
405 p_config->pf_callback( p_this, psz_name, oldval, val,
406 p_config->p_callback_data );
410 static int confcmp (const void *a, const void *b)
412 const module_config_t *const *ca = a, *const *cb = b;
414 return strcmp ((*ca)->psz_name, (*cb)->psz_name);
417 static int confnamecmp (const void *key, const void *elem)
419 const module_config_t *const *conf = elem;
421 return strcmp (key, (*conf)->psz_name);
426 module_config_t **list;
428 } config = { NULL, 0 };
431 * Index the configuration items by name for faster lookups.
433 int config_SortConfig (void)
436 module_t **mlist = module_list_get (&nmod);
437 if (unlikely(mlist == NULL))
441 for (size_t i = 0; i < nmod; i++)
442 nconf += mlist[i]->confsize;
444 module_config_t **clist = malloc (sizeof (*clist) * nconf);
445 if (unlikely(clist == NULL))
447 module_list_free (mlist);
452 for (size_t i = 0; i < nmod; i++)
454 module_t *parser = mlist[i];
455 module_config_t *item, *end;
457 for (item = parser->p_config, end = item + parser->confsize;
461 if (item->i_type & CONFIG_HINT)
462 continue; /* ignore hints */
463 clist[nconf++] = item;
466 module_list_free (mlist);
468 qsort (clist, nconf, sizeof (*clist), confcmp);
471 config.count = nconf;
475 void config_UnsortConfig (void)
477 module_config_t **clist;
486 /*****************************************************************************
487 * config_FindConfig: find the config structure associated with an option.
488 *****************************************************************************
489 * FIXME: remove p_this pointer parameter (or use it)
490 *****************************************************************************/
491 module_config_t *config_FindConfig (vlc_object_t *p_this, const char *name)
495 if (unlikely(name == NULL))
498 module_config_t *const *p;
499 p = bsearch (name, config.list, config.count, sizeof (*p), confnamecmp);
500 return p ? *p : NULL;
503 /*****************************************************************************
504 * config_Free: frees a duplicated module's configuration data.
505 *****************************************************************************
506 * This function frees all the data duplicated by config_Duplicate.
507 *****************************************************************************/
508 void config_Free( module_t *p_module )
512 for (size_t j = 0; j < p_module->confsize; j++)
514 module_config_t *p_item = p_module->p_config + j;
516 free( p_item->psz_type );
517 free( p_item->psz_name );
518 free( p_item->psz_text );
519 free( p_item->psz_longtext );
520 free( p_item->psz_oldname );
522 if (IsConfigStringType (p_item->i_type))
524 free (p_item->value.psz);
525 free (p_item->orig.psz);
526 free (p_item->saved.psz);
529 if( p_item->ppsz_list )
530 for( i = 0; i < p_item->i_list; i++ )
531 free( p_item->ppsz_list[i] );
532 if( p_item->ppsz_list_text )
533 for( i = 0; i < p_item->i_list; i++ )
534 free( p_item->ppsz_list_text[i] );
535 free( p_item->ppsz_list );
536 free( p_item->ppsz_list_text );
537 free( p_item->pi_list );
539 if( p_item->i_action )
541 for( i = 0; i < p_item->i_action; i++ )
543 free( p_item->ppsz_action_text[i] );
545 free( p_item->ppf_action );
546 free( p_item->ppsz_action_text );
550 free (p_module->p_config);
551 p_module->p_config = NULL;
554 #undef config_ResetAll
555 /*****************************************************************************
556 * config_ResetAll: reset the configuration data for all the modules.
557 *****************************************************************************/
558 void config_ResetAll( vlc_object_t *p_this )
562 module_t **list = module_list_get (NULL);
564 vlc_rwlock_wrlock (&config_lock);
565 for (size_t j = 0; (p_module = list[j]) != NULL; j++)
567 if( p_module->b_submodule ) continue;
569 for (size_t i = 0; i < p_module->confsize; i++ )
571 module_config_t *p_config = p_module->p_config + i;
573 if (IsConfigIntegerType (p_config->i_type))
574 p_config->value.i = p_config->orig.i;
576 if (IsConfigFloatType (p_config->i_type))
577 p_config->value.f = p_config->orig.f;
579 if (IsConfigStringType (p_config->i_type))
581 free ((char *)p_config->value.psz);
582 p_config->value.psz =
583 strdupnull (p_config->orig.psz);
587 vlc_rwlock_unlock (&config_lock);
589 module_list_free (list);