X-Git-Url: https://git.sesse.net/?a=blobdiff_plain;f=include%2Fvlc_configuration.h;h=c0ee83a31672588957524be3ae9943950c2c0110;hb=87014491480629af9a590f723b4683fc2ccc55c9;hp=8cf91e54c3cfb077baedaa56a53dc12cd032c189;hpb=0ed17f99bb99ca20fc26061a238a1ed051a21bd1;p=vlc diff --git a/include/vlc_configuration.h b/include/vlc_configuration.h index 8cf91e54c3..c0ee83a316 100644 --- a/include/vlc_configuration.h +++ b/include/vlc_configuration.h @@ -135,7 +135,7 @@ struct config_category_t typedef union { - const char *psz; + char *psz; int i; float f; } module_value_t; @@ -165,14 +165,15 @@ struct module_config_t void *p_callback_data; /* Values list */ - const char **ppsz_list; /* List of possible values for the option */ + char ** ppsz_list; /* List of possible values for the option */ int *pi_list; /* Idem for integers */ - const char **ppsz_list_text; /* Friendly names for list values */ + char **ppsz_list_text; /* Friendly names for list values */ int i_list; /* Options list size */ + vlc_callback_t pf_update_list; /*callback to initialize dropdownlists */ /* Actions list */ vlc_callback_t *ppf_action; /* List of possible actions for a config */ - const char **ppsz_action_text; /* Friendly names for actions */ + char **ppsz_action_text; /* Friendly names for actions */ int i_action; /* actions list size */ /* Misc */ @@ -184,12 +185,14 @@ struct module_config_t /* to take effect */ /* Deprecated */ - const char *psz_current; /* Good option name */ - vlc_bool_t b_strict; /* Transitionnal or strict */ + char *psz_oldname; /* Old option name */ + vlc_bool_t b_removed; /* Option values loaded from config file */ vlc_bool_t b_autosave; /* Config will be auto-saved at exit time */ - vlc_bool_t b_unsaveable; /* Config should be saved */ + vlc_bool_t b_unsaveable; /* Config should not be saved */ + + vlc_bool_t b_safe; }; /***************************************************************************** @@ -211,8 +214,6 @@ VLC_EXPORT( void, __config_ResetAll, ( vlc_object_t * ) ); VLC_EXPORT( module_config_t *, config_FindConfig,( vlc_object_t *, const char * ) ); -VLC_EXPORT( int, config_Duplicate,( module_t *, const module_config_t *, size_t )); - VLC_EXPORT(const char *, config_GetDataDir, ( void )); VLC_EXPORT( void, __config_AddIntf, ( vlc_object_t *, const char * ) ); @@ -231,23 +232,64 @@ VLC_EXPORT( vlc_bool_t, __config_ExistIntf, ( vlc_object_t *, const char * ) ); #define config_RemoveIntf(a,b) __config_RemoveIntf(VLC_OBJECT(a),b) #define config_ExistIntf(a,b) __config_ExistIntf(VLC_OBJECT(a),b) -typedef enum vlc_config_properties +enum vlc_config_properties { /* DO NOT EVER REMOVE, INSERT OR REPLACE ANY ITEM! It would break the ABI! * Append new items at the end ONLY. */ - VLC_CONFIG_NAME, /* command line name (args=const char *, vlc_callback_t) */ - VLC_CONFIG_DESC, /* description (args=const char *, const char *) */ - VLC_CONFIG_VALUE, /* actual value (args=) */ - VLC_CONFIG_RANGE, /* minimum value (args=, ) */ - VLC_CONFIG_ADVANCED, /* enable advanced flag (args=none) */ - VLC_CONFIG_VOLATILE, /* don't write variable to storage (args=none) */ - VLC_CONFIG_PERSISTENT, /* always write variable to storage (args=none) */ - VLC_CONFIG_RESTART, /* restart required to apply value change (args=none) */ - VLC_CONFIG_PRIVATE, /* hide from user (args=none) */ -} vlc_config_t; + VLC_CONFIG_NAME, + /* command line name (args=const char *, vlc_callback_t) */ + + VLC_CONFIG_DESC, + /* description (args=const char *, const char *) */ + + VLC_CONFIG_VALUE, + /* actual value (args=int/double/const char *) */ + + VLC_CONFIG_RANGE, + /* minimum value (args=int/double/const char * twice) */ + + VLC_CONFIG_ADVANCED, + /* enable advanced flag (args=none) */ + + VLC_CONFIG_VOLATILE, + /* don't write variable to storage (args=none) */ + + VLC_CONFIG_PERSISTENT, + /* always write variable to storage (args=none) */ + + VLC_CONFIG_RESTART, + /* restart required to apply value change (args=none) */ + + VLC_CONFIG_PRIVATE, + /* hide from user (args=none) */ + + VLC_CONFIG_REMOVED, + /* tag as no longer supported (args=none) */ + + VLC_CONFIG_CAPABILITY, + /* capability for a module or list thereof (args=const char*) */ + + VLC_CONFIG_SHORTCUT, + /* one-character (short) command line option name (args=char) */ + + VLC_CONFIG_LIST, + /* possible values list + * (args=size_t, const *, const char *const *) */ + + VLC_CONFIG_ADD_ACTION, + /* add value change callback (args=vlc_callback_t, const char *) */ + + VLC_CONFIG_OLDNAME, + /* former option name (args=const char *) */ + + VLC_CONFIG_SAFE, + /* tag as modifiable by untrusted input item "sources" (args=none) */ +}; -VLC_EXPORT( int, vlc_config_set, (module_config_t *, vlc_config_t, ...) ); + +VLC_EXPORT( module_config_t *, vlc_config_create, (module_t *, int type) ); +VLC_EXPORT( int, vlc_config_set, (module_config_t *, int, ...) ); /***************************************************************************** * Macros used to build the configuration structure. @@ -262,47 +304,39 @@ VLC_EXPORT( int, vlc_config_set, (module_config_t *, vlc_config_t, ...) ); * allow for a more user friendly interface. *****************************************************************************/ -#define add_config_inner( ) \ - i_config++; \ - if( (i_config % 10) == 0 ) \ - p_config = (module_config_t *) \ - realloc(p_config, (i_config+11) * sizeof(module_config_t)); \ - memset( p_config + i_config, 0, sizeof( *p_config ) ) - #define add_type_inner( type ) \ - add_config_inner( ); \ - p_config[i_config].i_type = type + p_config = vlc_config_create (p_module, type) #define add_typedesc_inner( type, text, longtext ) \ add_type_inner( type ); \ - vlc_config_set (p_config + i_config, VLC_CONFIG_DESC, \ + vlc_config_set (p_config, VLC_CONFIG_DESC, \ (const char *)(text), (const char *)(longtext)) #define add_typeadv_inner( type, text, longtext, advc ) \ add_typedesc_inner( type, text, longtext ); \ - if (advc) vlc_config_set (p_config + i_config, VLC_CONFIG_ADVANCED) + if (advc) vlc_config_set (p_config, VLC_CONFIG_ADVANCED) #define add_typename_inner( type, name, text, longtext, advc, cb ) \ add_typeadv_inner( type, text, longtext, advc ); \ - vlc_config_set (p_config + i_config, VLC_CONFIG_NAME, \ + vlc_config_set (p_config, VLC_CONFIG_NAME, \ (const char *)(name), (vlc_callback_t)(cb)) #define add_string_inner( type, name, text, longtext, advc, cb, v ) \ add_typename_inner( type, name, text, longtext, advc, cb ); \ - vlc_config_set (p_config + i_config, VLC_CONFIG_VALUE, (const char *)(v)) + vlc_config_set (p_config, VLC_CONFIG_VALUE, (const char *)(v)) #define add_int_inner( type, name, text, longtext, advc, cb, v ) \ add_typename_inner( type, name, text, longtext, advc, cb ); \ - vlc_config_set (p_config + i_config, VLC_CONFIG_VALUE, (int)(v)) + vlc_config_set (p_config, VLC_CONFIG_VALUE, (int)(v)) #define set_category( i_id ) \ add_type_inner( CONFIG_CATEGORY ); \ - p_config[i_config].value.i = i_id + vlc_config_set (p_config, VLC_CONFIG_VALUE, (int)(i_id)) #define set_subcategory( i_id ) \ add_type_inner( CONFIG_SUBCATEGORY ); \ - p_config[i_config].value.i = i_id + vlc_config_set (p_config, VLC_CONFIG_VALUE, (int)(i_id)) #define set_section( text, longtext ) \ add_typedesc_inner( CONFIG_SECTION, text, longtext ) @@ -333,19 +367,21 @@ VLC_EXPORT( int, vlc_config_set, (module_config_t *, vlc_config_t, ...) ); #define add_module( name, psz_caps, value, p_callback, text, longtext, advc ) \ add_string_inner( CONFIG_ITEM_MODULE, name, text, longtext, advc, p_callback, value ); \ - p_config[i_config].psz_type = psz_caps - -#define add_module_cat( name, i_subcategory, value, p_callback, text, longtext, advc ) \ - add_string_inner( CONFIG_ITEM_MODULE_CAT, name, text, longtext, advc, p_callback, value ); \ - p_config[i_config].min.i = i_subcategory /* gruik */ + vlc_config_set (p_config, VLC_CONFIG_CAPABILITY, (const char *)(psz_caps)) #define add_module_list( name, psz_caps, value, p_callback, text, longtext, advc ) \ add_string_inner( CONFIG_ITEM_MODULE_LIST, name, text, longtext, advc, p_callback, value ); \ - p_config[i_config].psz_type = psz_caps + vlc_config_set (p_config, VLC_CONFIG_CAPABILITY, (const char *)(psz_caps)) + +#ifndef __PLUGIN__ +#define add_module_cat( name, i_subcategory, value, p_callback, text, longtext, advc ) \ + add_string_inner( CONFIG_ITEM_MODULE_CAT, name, text, longtext, advc, p_callback, value ); \ + p_config->min.i = i_subcategory /* gruik */ #define add_module_list_cat( name, i_subcategory, value, p_callback, text, longtext, advc ) \ add_string_inner( CONFIG_ITEM_MODULE_LIST_CAT, name, text, longtext, advc, p_callback, value ); \ - p_config[i_config].min.i = i_subcategory /* gruik */ + p_config->min.i = i_subcategory /* gruik */ +#endif #define add_integer( name, value, p_callback, text, longtext, advc ) \ add_int_inner( CONFIG_ITEM_INTEGER, name, text, longtext, advc, p_callback, value ) @@ -359,7 +395,7 @@ VLC_EXPORT( int, vlc_config_set, (module_config_t *, vlc_config_t, ...) ); #define add_float( name, v, p_callback, text, longtext, advc ) \ add_typename_inner( CONFIG_ITEM_FLOAT, name, text, longtext, advc, p_callback ); \ - vlc_config_set (p_config + i_config, VLC_CONFIG_VALUE, (double)(v)) + vlc_config_set (p_config, VLC_CONFIG_VALUE, (double)(v)) #define add_float_with_range( name, value, f_min, f_max, p_callback, text, longtext, advc ) \ add_float( name, value, p_callback, text, longtext, advc ); \ @@ -367,25 +403,14 @@ VLC_EXPORT( int, vlc_config_set, (module_config_t *, vlc_config_t, ...) ); #define add_bool( name, v, p_callback, text, longtext, advc ) \ add_typename_inner( CONFIG_ITEM_BOOL, name, text, longtext, advc, p_callback ); \ - p_config[i_config].value.i = v - -/* For renamed option */ -#define add_deprecated_alias( name ) \ - add_config_inner( ); \ - p_config[ i_config ].i_type = p_config[ i_config -1 ].i_type; \ - vlc_config_set (p_config + i_config, VLC_CONFIG_NAME, \ - (const char *)(name), (vlc_callback_t)NULL); \ - p_config[i_config].b_strict = VLC_FALSE; \ - p_config[ i_config ].psz_current = p_config[ i_config-1 ].psz_current \ - ? p_config[ i_config-1 ].psz_current \ - : p_config[ i_config-1 ].psz_name; + if (v) vlc_config_set (p_config, VLC_CONFIG_VALUE, (int)VLC_TRUE) /* For removed option */ #define add_obsolete_inner( name, type ) \ add_type_inner( type ); \ - vlc_config_set (p_config + i_config, VLC_CONFIG_NAME, \ + vlc_config_set (p_config, VLC_CONFIG_NAME, \ (const char *)(name), (vlc_callback_t)NULL); \ - p_config[ i_config ].psz_current = "SUPPRESSED" + vlc_config_set (p_config, VLC_CONFIG_REMOVED) #define add_obsolete_bool( name ) \ add_obsolete_inner( name, CONFIG_ITEM_BOOL ) @@ -400,53 +425,61 @@ VLC_EXPORT( int, vlc_config_set, (module_config_t *, vlc_config_t, ...) ); add_obsolete_inner( name, CONFIG_ITEM_STRING ) /* Modifier macros for the config options (used for fine tuning) */ + +#define add_deprecated_alias( name ) \ + vlc_config_set (p_config, VLC_CONFIG_OLDNAME, (const char *)(name)) + #define change_short( ch ) \ - p_config[i_config].i_short = ch; + vlc_config_set (p_config, VLC_CONFIG_SHORTCUT, (int)(ch)) #define change_string_list( list, list_text, list_update_func ) \ - p_config[i_config].i_list = sizeof(list)/sizeof(char *); \ - p_config[i_config].ppsz_list = list; \ - p_config[i_config].ppsz_list_text = list_text; + vlc_config_set (p_config, VLC_CONFIG_LIST, \ + (size_t)(sizeof (list) / sizeof (char *)), \ + (const char *const *)(list), \ + (const char *const *)(list_text), \ + list_update_func) #define change_integer_list( list, list_text, list_update_func ) \ - p_config[i_config].i_list = sizeof(list)/sizeof(int); \ - p_config[i_config].pi_list = (int *)list; \ - p_config[i_config].ppsz_list_text = list_text; + vlc_config_set (p_config, VLC_CONFIG_LIST, \ + (size_t)(sizeof (list) / sizeof (int)), \ + (const int *)(list), \ + (const char *const *)(list_text), \ + list_update_func) + +#define change_float_list( list, list_text, list_update_func ) \ + vlc_config_set (p_config, VLC_CONFIG_LIST, \ + (size_t)(sizeof (list) / sizeof (float)), \ + (const float *)(list), \ + (const char *const *)(list_text), \ + list_update_func) #define change_integer_range( minv, maxv ) \ - vlc_config_set (p_config + i_config, VLC_CONFIG_RANGE, \ - (int)(minv), (int)(maxv)) + vlc_config_set (p_config, VLC_CONFIG_RANGE, (int)(minv), (int)(maxv)) #define change_float_range( minv, maxv ) \ - vlc_config_set (p_config + i_config, VLC_CONFIG_RANGE, \ + vlc_config_set (p_config, VLC_CONFIG_RANGE, \ (double)(minv), (double)(maxv)) -#define change_action_add( pf_action, action_text ) \ - if( !p_config[i_config].i_action ) \ - { p_config[i_config].ppsz_action_text = 0; \ - p_config[i_config].ppf_action = 0; } \ - p_config[i_config].ppf_action = (vlc_callback_t *) \ - realloc( p_config[i_config].ppf_action, \ - (p_config[i_config].i_action + 1) * sizeof(void *) ); \ - p_config[i_config].ppsz_action_text = (const char **)\ - realloc( p_config[i_config].ppsz_action_text, \ - (p_config[i_config].i_action + 1) * sizeof(void *) ); \ - p_config[i_config].ppf_action[p_config[i_config].i_action] = pf_action; \ - p_config[i_config].ppsz_action_text[p_config[i_config].i_action] = \ - action_text; \ - p_config[i_config].i_action++; +#define change_action_add( pf_action, text ) \ + vlc_config_set (p_config, VLC_CONFIG_ADD_ACTION, \ + (vlc_callback_t)(pf_action), (const char *)(text)) #define change_internal() \ - vlc_config_set (p_config + i_config, VLC_CONFIG_PRIVATE) + vlc_config_set (p_config, VLC_CONFIG_PRIVATE) #define change_need_restart() \ - vlc_config_set (p_config + i_config, VLC_CONFIG_RESTART) + vlc_config_set (p_config, VLC_CONFIG_RESTART) #define change_autosave() \ - vlc_config_set (p_config + i_config, VLC_CONFIG_PERSISTENT) + vlc_config_set (p_config, VLC_CONFIG_PERSISTENT) #define change_unsaveable() \ - vlc_config_set (p_config + i_config, VLC_VOLATILE) + vlc_config_set (p_config, VLC_CONFIG_VOLATILE) + +#define change_unsafe() (void)0 /* no-op */ + +#define change_safe() \ + vlc_config_set (p_config, VLC_CONFIG_SAFE) /**************************************************************************** * config_chain_t: