/*****************************************************************************
* core.c management of the modules configuration
*****************************************************************************
- * Copyright (C) 2001-2007 the VideoLAN team
+ * Copyright (C) 2001-2007 VLC authors and VideoLAN
* $Id$
*
* Authors: Gildas Bazin <gbazin@videolan.org>
*
- * This program is free software; you can redistribute it and/or modify
- * it under the terms of the GNU General Public License as published by
- * the Free Software Foundation; either version 2 of the License, or
+ * This program is free software; you can redistribute it and/or modify it
+ * under the terms of the GNU Lesser General Public License as published by
+ * the Free Software Foundation; either version 2.1 of the License, or
* (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
- * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
- * GNU General Public License for more details.
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+ * GNU Lesser General Public License for more details.
*
- * You should have received a copy of the GNU General Public License
- * along with this program; if not, write to the Free Software
- * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
+ * You should have received a copy of the GNU Lesser General Public License
+ * along with this program; if not, write to the Free Software Foundation,
+ * Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
*****************************************************************************/
#ifdef HAVE_CONFIG_H
#include <vlc_common.h>
#include <vlc_keys.h>
#include <vlc_modules.h>
+#include <vlc_plugin.h>
#include "vlc_configuration.h"
+#include <errno.h>
#include <assert.h>
#include "configuration.h"
#include "modules/modules.h"
-vlc_rwlock_t config_lock;
+vlc_rwlock_t config_lock = VLC_STATIC_RWLOCK;
+bool config_dirty = false;
static inline char *strdupnull (const char *src)
{
return src ? strdup (src) : NULL;
}
-/* Item types that use a string value (i.e. serialized in the module cache) */
-int IsConfigStringType (int type)
-{
- static const unsigned char config_types[] =
- {
- CONFIG_ITEM_STRING, CONFIG_ITEM_MODULE,
- CONFIG_ITEM_DIRECTORY, CONFIG_ITEM_MODULE_CAT, CONFIG_ITEM_PASSWORD,
- CONFIG_ITEM_MODULE_LIST, CONFIG_ITEM_MODULE_LIST_CAT,
- CONFIG_ITEM_FONT, CONFIG_ITEM_LOADFILE, CONFIG_ITEM_SAVEFILE,
- };
-
- /* NOTE: this needs to be changed if we ever get more than 255 types */
- return memchr (config_types, type, sizeof (config_types)) != NULL;
-}
-
-
-int IsConfigIntegerType (int type)
-{
- static const unsigned char config_types[] =
- {
- CONFIG_ITEM_INTEGER, CONFIG_ITEM_KEY, CONFIG_ITEM_BOOL,
- CONFIG_CATEGORY, CONFIG_SUBCATEGORY
- };
-
- return memchr (config_types, type, sizeof (config_types)) != NULL;
-}
-
#undef config_GetType
/*****************************************************************************
* config_GetType: get the type of a variable (bool, int, float, string)
return 0;
}
- switch( p_config->i_type )
+ switch( CONFIG_CLASS(p_config->i_type) )
{
- case CONFIG_ITEM_BOOL:
- i_type = VLC_VAR_BOOL;
+ case CONFIG_ITEM_FLOAT:
+ i_type = VLC_VAR_FLOAT;
break;
case CONFIG_ITEM_INTEGER:
- case CONFIG_ITEM_KEY:
i_type = VLC_VAR_INTEGER;
break;
- case CONFIG_ITEM_FLOAT:
- i_type = VLC_VAR_FLOAT;
+ case CONFIG_ITEM_BOOL:
+ i_type = VLC_VAR_BOOL;
break;
- case CONFIG_ITEM_MODULE:
- case CONFIG_ITEM_MODULE_CAT:
- case CONFIG_ITEM_MODULE_LIST:
- case CONFIG_ITEM_MODULE_LIST_CAT:
case CONFIG_ITEM_STRING:
- case CONFIG_ITEM_PASSWORD:
- case CONFIG_ITEM_LOADFILE:
- case CONFIG_ITEM_SAVEFILE:
- case CONFIG_ITEM_DIRECTORY:
i_type = VLC_VAR_STRING;
break;
return i_type;
}
+bool config_IsSafe( const char *name )
+{
+ module_config_t *p_config = config_FindConfig( NULL, name );
+ return p_config != NULL && p_config->b_safe;
+}
+
#undef config_GetInt
/*****************************************************************************
* config_GetInt: get the value of an int variable
vlc_rwlock_wrlock (&config_lock);
oldstr = (char *)p_config->value.psz;
p_config->value.psz = str;
- p_config->b_dirty = true;
+ config_dirty = true;
vlc_rwlock_unlock (&config_lock);
free (oldstr);
vlc_rwlock_wrlock (&config_lock);
p_config->value.i = i_value;
- p_config->b_dirty = true;
+ config_dirty = true;
vlc_rwlock_unlock (&config_lock);
}
vlc_rwlock_wrlock (&config_lock);
p_config->value.f = f_value;
- p_config->b_dirty = true;
+ config_dirty = true;
vlc_rwlock_unlock (&config_lock);
}
+/**
+ * Determines a list of suggested values for an integer configuration item.
+ * \param values pointer to a table of integer values [OUT]
+ * \param texts pointer to a table of descriptions strings [OUT]
+ * \return number of choices, or -1 on error
+ * \note the caller is responsible for calling free() on all descriptions and
+ * on both tables. In case of error, both pointers are set to NULL.
+ */
+ssize_t config_GetIntChoices (vlc_object_t *obj, const char *name,
+ int64_t **restrict values, char ***restrict texts)
+{
+ *values = NULL;
+ *texts = NULL;
+
+ module_config_t *cfg = config_FindConfig (obj, name);
+ if (cfg == NULL)
+ {
+ msg_Warn (obj, "option %s does not exist", name);
+ errno = ENOENT;
+ return -1;
+ }
+
+ size_t count = cfg->list_count;
+ if (count == 0)
+ {
+ if (cfg->list.i_cb == NULL)
+ return 0;
+ return cfg->list.i_cb(obj, name, values, texts);
+ }
+
+ int64_t *vals = xmalloc (sizeof (*vals) * count);
+ char **txts = xmalloc (sizeof (*txts) * count);
+
+ for (size_t i = 0; i < count; i++)
+ {
+ vals[i] = cfg->list.i[i];
+ /* FIXME: use module_gettext() instead */
+ txts[i] = strdup ((cfg->list_text[i] != NULL)
+ ? vlc_gettext (cfg->list_text[i]) : "");
+ if (unlikely(txts[i] == NULL))
+ abort ();
+ }
+
+ *values = vals;
+ *texts = txts;
+ return count;
+}
+
+
+static ssize_t config_ListModules (const char *cap, char ***restrict values,
+ char ***restrict texts)
+{
+ module_t **list;
+ ssize_t n = module_list_cap (&list, cap);
+ if (n <= 0)
+ {
+ *values = *texts = NULL;
+ return n;
+ }
+
+ char **vals = xmalloc ((n + 2) * sizeof (*vals));
+ char **txts = xmalloc ((n + 2) * sizeof (*txts));
+
+ vals[0] = xstrdup ("any");
+ txts[0] = xstrdup (_("Automatic"));
+
+ for (ssize_t i = 0; i < n; i++)
+ {
+ vals[i + 1] = xstrdup (module_get_object (list[i]));
+ txts[i + 1] = xstrdup (module_gettext (list[i],
+ module_get_name (list[i], true)));
+ }
+
+ vals[n + 1] = xstrdup ("none");
+ txts[n + 1] = xstrdup (_("Disable"));
+
+ *values = vals;
+ *texts = txts;
+ return n + 2;
+}
+
+/**
+ * Determines a list of suggested values for a string configuration item.
+ * \param values pointer to a table of value strings [OUT]
+ * \param texts pointer to a table of descriptions strings [OUT]
+ * \return number of choices, or -1 on error
+ * \note the caller is responsible for calling free() on all values, on all
+ * descriptions and on both tables.
+ * In case of error, both pointers are set to NULL.
+ */
+ssize_t config_GetPszChoices (vlc_object_t *obj, const char *name,
+ char ***restrict values, char ***restrict texts)
+{
+ *values = *texts = NULL;
+
+ module_config_t *cfg = config_FindConfig (obj, name);
+ if (cfg == NULL)
+ {
+ errno = ENOENT;
+ return -1;
+ }
+
+ switch (cfg->i_type)
+ {
+ case CONFIG_ITEM_MODULE:
+ return config_ListModules (cfg->psz_type, values, texts);
+ default:
+ if (!IsConfigStringType (cfg->i_type))
+ {
+ errno = EINVAL;
+ return -1;
+ }
+ break;
+ }
+
+ size_t count = cfg->list_count;
+ if (count == 0)
+ {
+ if (cfg->list.psz_cb == NULL)
+ return 0;
+ return cfg->list.psz_cb(obj, name, values, texts);
+ }
+
+ char **vals = xmalloc (sizeof (*vals) * count);
+ char **txts = xmalloc (sizeof (*txts) * count);
+
+ for (size_t i = 0; i < count; i++)
+ {
+ vals[i] = xstrdup ((cfg->list.psz[i] != NULL) ? cfg->list.psz[i] : "");
+ /* FIXME: use module_gettext() instead */
+ txts[i] = xstrdup ((cfg->list_text[i] != NULL)
+ ? vlc_gettext (cfg->list_text[i]) : "");
+ }
+
+ *values = vals;
+ *texts = txts;
+ return count;
+}
+
static int confcmp (const void *a, const void *b)
{
const module_config_t *const *ca = a, *const *cb = b;
*/
int config_SortConfig (void)
{
- size_t nmod;
+ size_t nmod, nconf = 0;
module_t **mlist = module_list_get (&nmod);
- if (unlikely(mlist == NULL))
- return VLC_ENOMEM;
- size_t nconf = 0;
for (size_t i = 0; i < nmod; i++)
nconf += mlist[i]->confsize;
item < end;
item++)
{
- if (item->i_type & CONFIG_HINT)
+ if (!CONFIG_ITEM(item->i_type))
continue; /* ignore hints */
clist[nconf++] = item;
}
return p ? *p : NULL;
}
-/*****************************************************************************
- * config_Free: frees a duplicated module's configuration data.
- *****************************************************************************
- * This function frees all the data duplicated by config_Duplicate.
- *****************************************************************************/
-void config_Free( module_t *p_module )
+/**
+ * Destroys an array of configuration items.
+ * \param config start of array of items
+ * \param confsize number of items in the array
+ */
+void config_Free (module_config_t *config, size_t confsize)
{
- int i;
-
- for (size_t j = 0; j < p_module->confsize; j++)
+ for (size_t j = 0; j < confsize; j++)
{
- module_config_t *p_item = p_module->p_config + j;
+ module_config_t *p_item = config + j;
free( p_item->psz_type );
free( p_item->psz_name );
free( p_item->psz_text );
free( p_item->psz_longtext );
- free( p_item->psz_oldname );
+ if (IsConfigIntegerType (p_item->i_type))
+ {
+ if (p_item->list_count)
+ free (p_item->list.i);
+ }
+ else
if (IsConfigStringType (p_item->i_type))
{
free (p_item->value.psz);
free (p_item->orig.psz);
- free (p_item->saved.psz);
- }
-
- if( p_item->ppsz_list )
- for( i = 0; i < p_item->i_list; i++ )
- free( p_item->ppsz_list[i] );
- if( p_item->ppsz_list_text )
- for( i = 0; i < p_item->i_list; i++ )
- free( p_item->ppsz_list_text[i] );
- free( p_item->ppsz_list );
- free( p_item->ppsz_list_text );
- free( p_item->pi_list );
-
- if( p_item->i_action )
- {
- for( i = 0; i < p_item->i_action; i++ )
+ if (p_item->list_count)
{
- free( p_item->ppsz_action_text[i] );
+ for (size_t i = 0; i < p_item->list_count; i++)
+ free (p_item->list.psz[i]);
+ free (p_item->list.psz);
}
- free( p_item->ppf_action );
- free( p_item->ppsz_action_text );
}
+
+ for (size_t i = 0; i < p_item->list_count; i++)
+ free (p_item->list_text[i]);
+ free (p_item->list_text);
}
- free (p_module->p_config);
- p_module->p_config = NULL;
+ free (config);
}
#undef config_ResetAll
*****************************************************************************/
void config_ResetAll( vlc_object_t *p_this )
{
- VLC_UNUSED(p_this);
- module_t *p_module;
- module_t **list = module_list_get (NULL);
+ size_t count;
+ module_t **list = module_list_get (&count);
vlc_rwlock_wrlock (&config_lock);
- for (size_t j = 0; (p_module = list[j]) != NULL; j++)
+ for (size_t j = 0; j < count; j++)
{
- if( p_module->b_submodule ) continue;
+ module_t *p_module = list[j];
for (size_t i = 0; i < p_module->confsize; i++ )
{
vlc_rwlock_unlock (&config_lock);
module_list_free (list);
+ VLC_UNUSED(p_this);
}
projects / vlc / blobdiff