core.c
上传用户:kjfoods
上传日期:2020-07-06
资源大小:29949k
文件大小:17k
源码类别:

midi

开发平台:

Unix_Linux

  1. /*****************************************************************************
  2.  * core.c management of the modules configuration
  3.  *****************************************************************************
  4.  * Copyright (C) 2001-2007 the VideoLAN team
  5.  * $Id: 721c2b58d560239022bf49abd91339cdf390b423 $
  6.  *
  7.  * Authors: Gildas Bazin <gbazin@videolan.org>
  8.  *
  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.
  13.  *
  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.
  18.  *
  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.  *****************************************************************************/
  23. #ifdef HAVE_CONFIG_H
  24. # include "config.h"
  25. #endif
  26. #include <vlc_common.h>
  27. #include "vlc_keys.h"
  28. #include "vlc_charset.h"
  29. #include "vlc_configuration.h"
  30. #include <assert.h>
  31. #include "configuration.h"
  32. #include "modules/modules.h"
  33. static inline char *strdupnull (const char *src)
  34. {
  35.     return src ? strdup (src) : NULL;
  36. }
  37. /* Item types that use a string value (i.e. serialized in the module cache) */
  38. int IsConfigStringType (int type)
  39. {
  40.     static const unsigned char config_types[] =
  41.     {
  42.         CONFIG_ITEM_STRING, CONFIG_ITEM_FILE, CONFIG_ITEM_MODULE,
  43.         CONFIG_ITEM_DIRECTORY, CONFIG_ITEM_MODULE_CAT, CONFIG_ITEM_PASSWORD,
  44.         CONFIG_ITEM_MODULE_LIST, CONFIG_ITEM_MODULE_LIST_CAT
  45.     };
  46.     /* NOTE: this needs to be changed if we ever get more than 255 types */
  47.     return memchr (config_types, type, sizeof (config_types)) != NULL;
  48. }
  49. int IsConfigIntegerType (int type)
  50. {
  51.     static const unsigned char config_types[] =
  52.     {
  53.         CONFIG_ITEM_INTEGER, CONFIG_ITEM_KEY, CONFIG_ITEM_BOOL,
  54.         CONFIG_CATEGORY, CONFIG_SUBCATEGORY
  55.     };
  56.     return memchr (config_types, type, sizeof (config_types)) != NULL;
  57. }
  58. /*****************************************************************************
  59.  * config_GetType: get the type of a variable (bool, int, float, string)
  60.  *****************************************************************************
  61.  * This function is used to get the type of a variable from its name.
  62.  * Beware, this is quite slow.
  63.  *****************************************************************************/
  64. int __config_GetType( vlc_object_t *p_this, const char *psz_name )
  65. {
  66.     module_config_t *p_config;
  67.     int i_type;
  68.     p_config = config_FindConfig( p_this, psz_name );
  69.     /* sanity checks */
  70.     if( !p_config )
  71.     {
  72.         return 0;
  73.     }
  74.     switch( p_config->i_type )
  75.     {
  76.     case CONFIG_ITEM_BOOL:
  77.         i_type = VLC_VAR_BOOL;
  78.         break;
  79.     case CONFIG_ITEM_INTEGER:
  80.     case CONFIG_ITEM_KEY:
  81.         i_type = VLC_VAR_INTEGER;
  82.         break;
  83.     case CONFIG_ITEM_FLOAT:
  84.         i_type = VLC_VAR_FLOAT;
  85.         break;
  86.     case CONFIG_ITEM_MODULE:
  87.     case CONFIG_ITEM_MODULE_CAT:
  88.     case CONFIG_ITEM_MODULE_LIST:
  89.     case CONFIG_ITEM_MODULE_LIST_CAT:
  90.         i_type = VLC_VAR_MODULE;
  91.         break;
  92.     case CONFIG_ITEM_STRING:
  93.         i_type = VLC_VAR_STRING;
  94.         break;
  95.     case CONFIG_ITEM_PASSWORD:
  96.         i_type = VLC_VAR_STRING;
  97.         break;
  98.     case CONFIG_ITEM_FILE:
  99.         i_type = VLC_VAR_FILE;
  100.         break;
  101.     case CONFIG_ITEM_DIRECTORY:
  102.         i_type = VLC_VAR_DIRECTORY;
  103.         break;
  104.     default:
  105.         i_type = 0;
  106.         break;
  107.     }
  108.     return i_type;
  109. }
  110. /*****************************************************************************
  111.  * config_GetInt: get the value of an int variable
  112.  *****************************************************************************
  113.  * This function is used to get the value of variables which are internally
  114.  * represented by an integer (CONFIG_ITEM_INTEGER and
  115.  * CONFIG_ITEM_BOOL).
  116.  *****************************************************************************/
  117. int __config_GetInt( vlc_object_t *p_this, const char *psz_name )
  118. {
  119.     module_config_t *p_config;
  120.     p_config = config_FindConfig( p_this, psz_name );
  121.     /* sanity checks */
  122.     if( !p_config )
  123.     {
  124.         msg_Err( p_this, "option %s does not exist", psz_name );
  125.         return -1;
  126.     }
  127.     if (!IsConfigIntegerType (p_config->i_type))
  128.     {
  129.         msg_Err( p_this, "option %s does not refer to an int", psz_name );
  130.         return -1;
  131.     }
  132.     return p_config->value.i;
  133. }
  134. /*****************************************************************************
  135.  * config_GetFloat: get the value of a float variable
  136.  *****************************************************************************
  137.  * This function is used to get the value of variables which are internally
  138.  * represented by a float (CONFIG_ITEM_FLOAT).
  139.  *****************************************************************************/
  140. float __config_GetFloat( vlc_object_t *p_this, const char *psz_name )
  141. {
  142.     module_config_t *p_config;
  143.     p_config = config_FindConfig( p_this, psz_name );
  144.     /* sanity checks */
  145.     if( !p_config )
  146.     {
  147.         msg_Err( p_this, "option %s does not exist", psz_name );
  148.         return -1;
  149.     }
  150.     if (!IsConfigFloatType (p_config->i_type))
  151.     {
  152.         msg_Err( p_this, "option %s does not refer to a float", psz_name );
  153.         return -1;
  154.     }
  155.     return p_config->value.f;
  156. }
  157. /*****************************************************************************
  158.  * config_GetPsz: get the string value of a string variable
  159.  *****************************************************************************
  160.  * This function is used to get the value of variables which are internally
  161.  * represented by a string (CONFIG_ITEM_STRING, CONFIG_ITEM_FILE,
  162.  * CONFIG_ITEM_DIRECTORY, CONFIG_ITEM_PASSWORD, and CONFIG_ITEM_MODULE).
  163.  *
  164.  * Important note: remember to free() the returned char* because it's a
  165.  *   duplicate of the actual value. It isn't safe to return a pointer to the
  166.  *   actual value as it can be modified at any time.
  167.  *****************************************************************************/
  168. char * __config_GetPsz( vlc_object_t *p_this, const char *psz_name )
  169. {
  170.     module_config_t *p_config;
  171.     p_config = config_FindConfig( p_this, psz_name );
  172.     /* sanity checks */
  173.     if( !p_config )
  174.     {
  175.         msg_Err( p_this, "option %s does not exist", psz_name );
  176.         return NULL;
  177.     }
  178.     if (!IsConfigStringType (p_config->i_type))
  179.     {
  180.         msg_Err( p_this, "option %s does not refer to a string", psz_name );
  181.         return NULL;
  182.     }
  183.     /* return a copy of the string */
  184.     vlc_mutex_lock( p_config->p_lock );
  185.     char *psz_value = strdupnull (p_config->value.psz);
  186.     vlc_mutex_unlock( p_config->p_lock );
  187.     return psz_value;
  188. }
  189. /*****************************************************************************
  190.  * config_PutPsz: set the string value of a string variable
  191.  *****************************************************************************
  192.  * This function is used to set the value of variables which are internally
  193.  * represented by a string (CONFIG_ITEM_STRING, CONFIG_ITEM_FILE,
  194.  * CONFIG_ITEM_DIRECTORY, CONFIG_ITEM_PASSWORD, and CONFIG_ITEM_MODULE).
  195.  *****************************************************************************/
  196. void __config_PutPsz( vlc_object_t *p_this,
  197.                       const char *psz_name, const char *psz_value )
  198. {
  199.     module_config_t *p_config;
  200.     vlc_value_t oldval, val;
  201.     p_config = config_FindConfig( p_this, psz_name );
  202.     /* sanity checks */
  203.     if( !p_config )
  204.     {
  205.         msg_Warn( p_this, "option %s does not exist", psz_name );
  206.         return;
  207.     }
  208.     if (!IsConfigStringType (p_config->i_type))
  209.     {
  210.         msg_Err( p_this, "option %s does not refer to a string", psz_name );
  211.         return;
  212.     }
  213.     vlc_mutex_lock( p_config->p_lock );
  214.     /* backup old value */
  215.     oldval.psz_string = (char *)p_config->value.psz;
  216.     if ((psz_value != NULL) && *psz_value)
  217.         p_config->value.psz = strdup (psz_value);
  218.     else
  219.         p_config->value.psz = NULL;
  220.     p_config->b_dirty = true;
  221.     val.psz_string = (char *)p_config->value.psz;
  222.     vlc_mutex_unlock( p_config->p_lock );
  223.     if( p_config->pf_callback )
  224.     {
  225.         p_config->pf_callback( p_this, psz_name, oldval, val,
  226.                                p_config->p_callback_data );
  227.     }
  228.     /* free old string */
  229.     free( oldval.psz_string );
  230. }
  231. /*****************************************************************************
  232.  * config_PutInt: set the integer value of an int variable
  233.  *****************************************************************************
  234.  * This function is used to set the value of variables which are internally
  235.  * represented by an integer (CONFIG_ITEM_INTEGER and
  236.  * CONFIG_ITEM_BOOL).
  237.  *****************************************************************************/
  238. void __config_PutInt( vlc_object_t *p_this, const char *psz_name, int i_value )
  239. {
  240.     module_config_t *p_config;
  241.     vlc_value_t oldval, val;
  242.     p_config = config_FindConfig( p_this, psz_name );
  243.     /* sanity checks */
  244.     if( !p_config )
  245.     {
  246.         msg_Warn( p_this, "option %s does not exist", psz_name );
  247.         return;
  248.     }
  249.     if (!IsConfigIntegerType (p_config->i_type))
  250.     {
  251.         msg_Err( p_this, "option %s does not refer to an int", psz_name );
  252.         return;
  253.     }
  254.     /* backup old value */
  255.     oldval.i_int = p_config->value.i;
  256.     /* if i_min == i_max == 0, then do not use them */
  257.     if ((p_config->min.i == 0) && (p_config->max.i == 0))
  258.     {
  259.         p_config->value.i = i_value;
  260.     }
  261.     else if (i_value < p_config->min.i)
  262.     {
  263.         p_config->value.i = p_config->min.i;
  264.     }
  265.     else if (i_value > p_config->max.i)
  266.     {
  267.         p_config->value.i = p_config->max.i;
  268.     }
  269.     else
  270.     {
  271.         p_config->value.i = i_value;
  272.     }
  273.     p_config->b_dirty = true;
  274.     val.i_int = p_config->value.i;
  275.     if( p_config->pf_callback )
  276.     {
  277.         p_config->pf_callback( p_this, psz_name, oldval, val,
  278.                                p_config->p_callback_data );
  279.     }
  280. }
  281. /*****************************************************************************
  282.  * config_PutFloat: set the value of a float variable
  283.  *****************************************************************************
  284.  * This function is used to set the value of variables which are internally
  285.  * represented by a float (CONFIG_ITEM_FLOAT).
  286.  *****************************************************************************/
  287. void __config_PutFloat( vlc_object_t *p_this,
  288.                         const char *psz_name, float f_value )
  289. {
  290.     module_config_t *p_config;
  291.     vlc_value_t oldval, val;
  292.     p_config = config_FindConfig( p_this, psz_name );
  293.     /* sanity checks */
  294.     if( !p_config )
  295.     {
  296.         msg_Warn( p_this, "option %s does not exist", psz_name );
  297.         return;
  298.     }
  299.     if (!IsConfigFloatType (p_config->i_type))
  300.     {
  301.         msg_Err( p_this, "option %s does not refer to a float", psz_name );
  302.         return;
  303.     }
  304.     /* backup old value */
  305.     oldval.f_float = p_config->value.f;
  306.     /* if f_min == f_max == 0, then do not use them */
  307.     if ((p_config->min.f == 0) && (p_config->max.f == 0))
  308.     {
  309.         p_config->value.f = f_value;
  310.     }
  311.     else if (f_value < p_config->min.f)
  312.     {
  313.         p_config->value.f = p_config->min.f;
  314.     }
  315.     else if (f_value > p_config->max.f)
  316.     {
  317.         p_config->value.f = p_config->max.f;
  318.     }
  319.     else
  320.     {
  321.         p_config->value.f = f_value;
  322.     }
  323.     p_config->b_dirty = true;
  324.     val.f_float = p_config->value.f;
  325.     if( p_config->pf_callback )
  326.     {
  327.         p_config->pf_callback( p_this, psz_name, oldval, val,
  328.                                p_config->p_callback_data );
  329.     }
  330. }
  331. /*****************************************************************************
  332.  * config_FindConfig: find the config structure associated with an option.
  333.  *****************************************************************************
  334.  * FIXME: This function really needs to be optimized.
  335.  * FIXME: And now even more.
  336.  * FIXME: remove p_this pointer parameter (or use it)
  337.  *****************************************************************************/
  338. module_config_t *config_FindConfig( vlc_object_t *p_this, const char *psz_name )
  339. {
  340.     module_t *p_parser;
  341.     if( !psz_name ) return NULL;
  342.     module_t **list = module_list_get (NULL);
  343.     if (list == NULL)
  344.         return NULL;
  345.     for (size_t i = 0; (p_parser = list[i]) != NULL; i++)
  346.     {
  347.         module_config_t *p_item, *p_end;
  348.         if( !p_parser->i_config_items )
  349.             continue;
  350.         for( p_item = p_parser->p_config, p_end = p_item + p_parser->confsize;
  351.              p_item < p_end;
  352.              p_item++ )
  353.         {
  354.             if( p_item->i_type & CONFIG_HINT )
  355.                 /* ignore hints */
  356.                 continue;
  357.             if( !strcmp( psz_name, p_item->psz_name )
  358.              || ( p_item->psz_oldname
  359.               && !strcmp( psz_name, p_item->psz_oldname ) ) )
  360.             {
  361.                 module_list_free (list);
  362.                 return p_item;
  363.             }
  364.         }
  365.     }
  366.     module_list_free (list);
  367.     return NULL;
  368. }
  369. /*****************************************************************************
  370.  * config_Free: frees a duplicated module's configuration data.
  371.  *****************************************************************************
  372.  * This function frees all the data duplicated by config_Duplicate.
  373.  *****************************************************************************/
  374. void config_Free( module_t *p_module )
  375. {
  376.     int i;
  377.     for (size_t j = 0; j < p_module->confsize; j++)
  378.     {
  379.         module_config_t *p_item = p_module->p_config + j;
  380.         free( p_item->psz_type );
  381.         free( p_item->psz_name );
  382.         free( p_item->psz_text );
  383.         free( p_item->psz_longtext );
  384.         free( p_item->psz_oldname );
  385.         if (IsConfigStringType (p_item->i_type))
  386.         {
  387.             free (p_item->value.psz);
  388.             free (p_item->orig.psz);
  389.             free (p_item->saved.psz);
  390.         }
  391.         if( p_item->ppsz_list )
  392.             for( i = 0; i < p_item->i_list; i++ )
  393.                 free( p_item->ppsz_list[i] );
  394.         if( p_item->ppsz_list_text )
  395.             for( i = 0; i < p_item->i_list; i++ )
  396.                 free( p_item->ppsz_list_text[i] );
  397.         free( p_item->ppsz_list );
  398.         free( p_item->ppsz_list_text );
  399.         free( p_item->pi_list );
  400.         if( p_item->i_action )
  401.         {
  402.             for( i = 0; i < p_item->i_action; i++ )
  403.             {
  404.                 free( p_item->ppsz_action_text[i] );
  405.             }
  406.             free( p_item->ppf_action );
  407.             free( p_item->ppsz_action_text );
  408.         }
  409.     }
  410.     free (p_module->p_config);
  411.     p_module->p_config = NULL;
  412. }
  413. /*****************************************************************************
  414.  * config_SetCallbacks: sets callback functions in the duplicate p_config.
  415.  *****************************************************************************
  416.  * Unfortunatly we cannot work directly with the module's config data as
  417.  * this module might be unloaded from memory at any time (remember HideModule).
  418.  * This is why we need to duplicate callbacks each time we reload the module.
  419.  *****************************************************************************/
  420. void config_SetCallbacks( module_config_t *p_new, module_config_t *p_orig,
  421.                           size_t n )
  422. {
  423.     for (size_t i = 0; i < n; i++)
  424.     {
  425.         p_new->pf_callback = p_orig->pf_callback;
  426.         p_new++;
  427.         p_orig++;
  428.     }
  429. }
  430. /*****************************************************************************
  431.  * config_UnsetCallbacks: unsets callback functions in the duplicate p_config.
  432.  *****************************************************************************
  433.  * We simply undo what we did in config_SetCallbacks.
  434.  *****************************************************************************/
  435. void config_UnsetCallbacks( module_config_t *p_new, size_t n )
  436. {
  437.     for (size_t i = 0; i < n; i++)
  438.     {
  439.         p_new->pf_callback = NULL;
  440.         p_new++;
  441.     }
  442. }
  443. /*****************************************************************************
  444.  * config_ResetAll: reset the configuration data for all the modules.
  445.  *****************************************************************************/
  446. void __config_ResetAll( vlc_object_t *p_this )
  447. {
  448.     module_t *p_module;
  449.     module_t **list = module_list_get (NULL);
  450.     for (size_t j = 0; (p_module = list[j]) != NULL; j++)
  451.     {
  452.         if( p_module->b_submodule ) continue;
  453.         for (size_t i = 0; i < p_module->confsize; i++ )
  454.         {
  455.             module_config_t *p_config = p_module->p_config + i;
  456.             vlc_mutex_lock (p_config->p_lock);
  457.             if (IsConfigIntegerType (p_config->i_type))
  458.                 p_config->value.i = p_config->orig.i;
  459.             else
  460.             if (IsConfigFloatType (p_config->i_type))
  461.                 p_config->value.f = p_config->orig.f;
  462.             else
  463.             if (IsConfigStringType (p_config->i_type))
  464.             {
  465.                 free ((char *)p_config->value.psz);
  466.                 p_config->value.psz =
  467.                         strdupnull (p_config->orig.psz);
  468.             }
  469.             vlc_mutex_unlock (p_config->p_lock);
  470.         }
  471.     }
  472.     module_list_free (list);
  473. }