X-Git-Url: https://git.sesse.net/?a=blobdiff_plain;f=include%2Fvlc_configuration.h;h=b9c047fa397ed8ad9cedc5c0012b0c861bb55359;hb=de587c237065de4696d9d035d0504cdf34990d87;hp=0d94ad9ea9bc5aea92c47289a109838c72c17be1;hpb=62ba5767cc3a6cf7283aa2c1c8b22c1a2ed01759;p=vlc diff --git a/include/vlc_configuration.h b/include/vlc_configuration.h index 0d94ad9ea9..b9c047fa39 100644 --- a/include/vlc_configuration.h +++ b/include/vlc_configuration.h @@ -23,10 +23,6 @@ * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA. *****************************************************************************/ -#if !defined( __LIBVLC__ ) - #error You are not libvlc or one of its plugins. You cannot include this file -#endif - #ifndef _VLC_CONFIGURATION_H #define _VLC_CONFIGURATION_H 1 @@ -177,22 +173,22 @@ struct module_config_t int i_action; /* actions list size */ /* Misc */ - vlc_mutex_t *p_lock; /* Lock to use when modifying the config */ - bool b_dirty; /* Dirty flag to indicate a config change */ - bool b_advanced; /* Flag to indicate an advanced option */ - bool b_internal; /* Flag to indicate option is not to be shown */ - bool b_restart; /* Flag to indicate the option needs a restart */ + vlc_mutex_t *p_lock; /* Lock to use when modifying the config */ + bool b_dirty; /* Dirty flag to indicate a config change */ + bool b_advanced; /* Flag to indicate an advanced option */ + bool b_internal; /* Flag to indicate option is not to be shown */ + bool b_restart; /* Flag to indicate the option needs a restart */ /* to take effect */ /* Deprecated */ - char *psz_oldname; /* Old option name */ - bool b_removed; + char *psz_oldname; /* Old option name */ + bool b_removed; /* Option values loaded from config file */ - bool b_autosave; /* Config will be auto-saved at exit time */ - bool b_unsaveable; /* Config should not be saved */ + bool b_autosave; /* Config will be auto-saved at exit time */ + bool b_unsaveable; /* Config should not be saved */ - bool b_safe; + bool b_safe; }; /***************************************************************************** @@ -216,6 +212,7 @@ VLC_EXPORT( module_config_t *, config_FindConfig,( vlc_object_t *, const char * VLC_EXPORT(const char *, config_GetDataDir, ( void )); VLC_EXPORT(const char *, config_GetConfDir, ( void ) ); +VLC_EXPORT(const char *, config_GetHomeDir, ( void )); VLC_EXPORT(char *, config_GetUserConfDir, ( void ) ); VLC_EXPORT(char *, config_GetUserDataDir, ( void ) ); VLC_EXPORT(char *, config_GetCacheDir, ( void ) ); @@ -236,255 +233,6 @@ VLC_EXPORT( bool, __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) -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=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( 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. - * - * Note that internally we support only 3 types of config data: int, float - * and string. - * The other types declared here just map to one of these 3 basic types but - * have the advantage of also providing very good hints to a configuration - * interface so as to make it more user friendly. - * The configuration structure also includes category hints. These hints can - * provide a configuration interface with some very useful data and again - * allow for a more user friendly interface. - *****************************************************************************/ - -#define add_type_inner( 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, 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, 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, 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, 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, VLC_CONFIG_VALUE, (int)(v)) - - -#define set_category( i_id ) \ - add_type_inner( CONFIG_CATEGORY ); \ - vlc_config_set (p_config, VLC_CONFIG_VALUE, (int)(i_id)) - -#define set_subcategory( i_id ) \ - add_type_inner( CONFIG_SUBCATEGORY ); \ - vlc_config_set (p_config, VLC_CONFIG_VALUE, (int)(i_id)) - -#define set_section( text, longtext ) \ - add_typedesc_inner( CONFIG_SECTION, text, longtext ) - -#define add_category_hint( text, longtext, advc ) \ - add_typeadv_inner( CONFIG_HINT_CATEGORY, text, longtext, advc ) - -#define add_subcategory_hint( text, longtext ) \ - add_typedesc_inner( CONFIG_HINT_SUBCATEGORY, text, longtext ) - -#define end_subcategory_hint \ - add_type_inner( CONFIG_HINT_SUBCATEGORY_END ) - -#define add_usage_hint( text ) \ - add_typedesc_inner( CONFIG_HINT_USAGE, text, NULL ) - -#define add_string( name, value, p_callback, text, longtext, advc ) \ - add_string_inner( CONFIG_ITEM_STRING, name, text, longtext, advc, p_callback, value ) - -#define add_password( name, value, p_callback, text, longtext, advc ) \ - add_string_inner( CONFIG_ITEM_PASSWORD, name, text, longtext, advc, p_callback, value ) - -#define add_file( name, value, p_callback, text, longtext, advc ) \ - add_string_inner( CONFIG_ITEM_FILE, name, text, longtext, advc, p_callback, value ) - -#define add_directory( name, value, p_callback, text, longtext, advc ) \ - add_string_inner( CONFIG_ITEM_DIRECTORY, name, text, longtext, advc, p_callback, value ) - -#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 ); \ - 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 ); \ - 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->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 ) - -#define add_key( name, value, p_callback, text, longtext, advc ) \ - add_int_inner( CONFIG_ITEM_KEY, name, text, longtext, advc, p_callback, value ) - -#define add_integer_with_range( name, value, i_min, i_max, p_callback, text, longtext, advc ) \ - add_integer( name, value, p_callback, text, longtext, advc ); \ - change_integer_range( i_min, i_max ) - -#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, 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 ); \ - change_float_range( f_min, f_max ) - -#define add_bool( name, v, p_callback, text, longtext, advc ) \ - add_typename_inner( CONFIG_ITEM_BOOL, name, text, longtext, advc, p_callback ); \ - if (v) vlc_config_set (p_config, VLC_CONFIG_VALUE, (int)true) - -/* For removed option */ -#define add_obsolete_inner( name, type ) \ - add_type_inner( type ); \ - vlc_config_set (p_config, VLC_CONFIG_NAME, \ - (const char *)(name), (vlc_callback_t)NULL); \ - vlc_config_set (p_config, VLC_CONFIG_REMOVED) - -#define add_obsolete_bool( name ) \ - add_obsolete_inner( name, CONFIG_ITEM_BOOL ) - -#define add_obsolete_integer( name ) \ - add_obsolete_inner( name, CONFIG_ITEM_INTEGER ) - -#define add_obsolete_float( name ) \ - add_obsolete_inner( name, CONFIG_ITEM_FLOAT ) - -#define add_obsolete_string( name ) \ - 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 ) \ - vlc_config_set (p_config, VLC_CONFIG_SHORTCUT, (int)(ch)) - -#define change_string_list( list, list_text, list_update_func ) \ - 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 ) \ - 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, VLC_CONFIG_RANGE, (int)(minv), (int)(maxv)) - -#define change_float_range( minv, maxv ) \ - vlc_config_set (p_config, VLC_CONFIG_RANGE, \ - (double)(minv), (double)(maxv)) - -#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, VLC_CONFIG_PRIVATE) - -#define change_need_restart() \ - vlc_config_set (p_config, VLC_CONFIG_RESTART) - -#define change_autosave() \ - vlc_config_set (p_config, VLC_CONFIG_PERSISTENT) - -#define change_unsaveable() \ - 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: ****************************************************************************/