X-Git-Url: https://git.sesse.net/?a=blobdiff_plain;f=include%2Fvlc_configuration.h;h=31cd7615e0d2f03a580b65f64e0ed59ed81e5923;hb=0462f44e2a133be0b07f365570b91c5f3cd4c38e;hp=98dd14b5e0c483e4aa460622ba282a59baa6a7e5;hpb=f64d068967546aff0281bbc83ed8ad1d5bd7f871;p=vlc diff --git a/include/vlc_configuration.h b/include/vlc_configuration.h index 98dd14b5e0..31cd7615e0 100644 --- a/include/vlc_configuration.h +++ b/include/vlc_configuration.h @@ -56,7 +56,7 @@ extern "C" { /* Configuration item types */ #define CONFIG_ITEM_STRING 0x0010 /* String option */ -#define CONFIG_ITEM_FILE 0x0020 /* File option */ +/* unused 0x0020 */ #define CONFIG_ITEM_MODULE 0x0030 /* Module option */ #define CONFIG_ITEM_INTEGER 0x0040 /* Integer option */ #define CONFIG_ITEM_BOOL 0x0050 /* Bool option */ @@ -68,6 +68,8 @@ extern "C" { #define CONFIG_ITEM_MODULE_LIST_CAT 0x00B0 /* Module option */ #define CONFIG_ITEM_FONT 0x00C0 /* Font option */ #define CONFIG_ITEM_PASSWORD 0x00D0 /* Password option (*) */ +#define CONFIG_ITEM_LOADFILE 0x00E0 /* Read file option */ +#define CONFIG_ITEM_SAVEFILE 0x00F0 /* Written file option */ #define CONFIG_ITEM 0x00F0 @@ -137,58 +139,46 @@ struct config_category_t typedef union { char *psz; - int i; + int64_t i; float f; } module_value_t; -typedef union -{ - int i; - float f; -} module_nvalue_t; - struct module_config_t { - int i_type; /* Configuration type */ char *psz_type; /* Configuration subtype */ char *psz_name; /* Option name */ - char i_short; /* Optional short option name */ char *psz_text; /* Short comment on the configuration option */ char *psz_longtext; /* Long comment on the configuration option */ module_value_t value; /* Option value */ module_value_t orig; module_value_t saved; - module_nvalue_t min; - module_nvalue_t max; - - /* Function to call when commiting a change */ - vlc_callback_t pf_callback; - void *p_callback_data; + module_value_t min; + module_value_t max; /* Values list */ char ** ppsz_list; /* List of possible values for the option */ int *pi_list; /* Idem for integers */ char **ppsz_list_text; /* Friendly names for list values */ int i_list; /* Options list size */ + int i_type; /* Configuration type */ vlc_callback_t pf_update_list; /*callback to initialize dropdownlists */ + char i_short; /* Optional short option name */ /* Actions list */ + int i_action; /* actions list size */ vlc_callback_t *ppf_action; /* List of possible actions for a config */ char **ppsz_action_text; /* Friendly names for actions */ - int i_action; /* actions list size */ + + /* Deprecated */ + char *psz_oldname; /* Old option name */ + bool b_removed; /* 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 */ /* to take effect */ - - /* Deprecated */ - 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 */ @@ -200,21 +190,23 @@ struct module_config_t * Prototypes - these methods are used to get, set or manipulate configuration * data. *****************************************************************************/ -VLC_EXPORT( int, __config_GetType, (vlc_object_t *, const char *) LIBVLC_USED ); -VLC_EXPORT( int, __config_GetInt, (vlc_object_t *, const char *) LIBVLC_USED ); -VLC_EXPORT( void, __config_PutInt, (vlc_object_t *, const char *, int) ); -VLC_EXPORT( float, __config_GetFloat, (vlc_object_t *, const char *) LIBVLC_USED ); -VLC_EXPORT( void, __config_PutFloat, (vlc_object_t *, const char *, float) ); -VLC_EXPORT( char *, __config_GetPsz, (vlc_object_t *, const char *) LIBVLC_USED ); -VLC_EXPORT( void, __config_PutPsz, (vlc_object_t *, const char *, const char *) ); - -#define config_SaveConfigFile(a,b) __config_SaveConfigFile(VLC_OBJECT(a),b) -VLC_EXPORT( int, __config_SaveConfigFile, ( vlc_object_t *, const char * ) ); -#define config_ResetAll(a) __config_ResetAll(VLC_OBJECT(a)) -VLC_EXPORT( void, __config_ResetAll, ( vlc_object_t * ) ); +VLC_EXPORT( int, config_GetType, (vlc_object_t *, const char *) LIBVLC_USED ); +VLC_EXPORT( int64_t, config_GetInt, (vlc_object_t *, const char *) LIBVLC_USED ); +VLC_EXPORT( void, config_PutInt, (vlc_object_t *, const char *, int64_t) ); +VLC_EXPORT( float, config_GetFloat, (vlc_object_t *, const char *) LIBVLC_USED ); +VLC_EXPORT( void, config_PutFloat, (vlc_object_t *, const char *, float) ); +VLC_EXPORT( char *, config_GetPsz, (vlc_object_t *, const char *) LIBVLC_USED LIBVLC_MALLOC ); +VLC_EXPORT( void, config_PutPsz, (vlc_object_t *, const char *, const char *) ); + +VLC_EXPORT( int, config_SaveConfigFile, ( vlc_object_t *, const char * ) ); +#define config_SaveConfigFile(a,b) config_SaveConfigFile(VLC_OBJECT(a),b) +VLC_EXPORT( void, config_ResetAll, ( vlc_object_t * ) ); +#define config_ResetAll(a) config_ResetAll(VLC_OBJECT(a)) VLC_EXPORT( module_config_t *, config_FindConfig,( vlc_object_t *, const char * ) LIBVLC_USED ); -VLC_EXPORT(const char *, config_GetDataDir, ( void ) LIBVLC_USED); +VLC_EXPORT(char *, config_GetDataDir, ( vlc_object_t * ) LIBVLC_USED LIBVLC_MALLOC ); +#define config_GetDataDir(a) config_GetDataDir(VLC_OBJECT(a)) +VLC_EXPORT(const char *, config_GetLibDir, ( void ) LIBVLC_USED); VLC_EXPORT(const char *, config_GetConfDir, ( void ) LIBVLC_USED); typedef enum vlc_userdir @@ -222,30 +214,35 @@ typedef enum vlc_userdir VLC_HOME_DIR, /* User's home */ VLC_CONFIG_DIR, /* VLC-specific configuration directory */ VLC_DATA_DIR, /* VLC-specific data directory */ - VLC_DOWNLOAD_DIR, /* VLC-specific download directory */ - VLC_PICTURE_DIR, /* VLC-specific snapshot directory */ - VLC_MUSIC_DIR, /* VLC-specific music directory */ - VLC_VIDEO_DIR, /* VLC-specific video directory */ + VLC_CACHE_DIR, /* VLC-specific user cached data directory */ + /* Generic directories (same as XDG) */ + VLC_DESKTOP_DIR=0x80, + VLC_DOWNLOAD_DIR, + VLC_TEMPLATES_DIR, + VLC_PUBLICSHARE_DIR, + VLC_DOCUMENTS_DIR, + VLC_MUSIC_DIR, + VLC_PICTURES_DIR, + VLC_VIDEOS_DIR, } vlc_userdir_t; -VLC_EXPORT(char *, config_GetUserDir, ( vlc_userdir_t ) LIBVLC_USED); -VLC_EXPORT(char *, config_GetCacheDir, ( void ) LIBVLC_USED); +VLC_EXPORT(char *, config_GetUserDir, ( vlc_userdir_t ) LIBVLC_USED LIBVLC_MALLOC ); -VLC_EXPORT( void, __config_AddIntf, ( vlc_object_t *, const char * ) ); -VLC_EXPORT( void, __config_RemoveIntf, ( vlc_object_t *, const char * ) ); -VLC_EXPORT( bool, __config_ExistIntf, ( vlc_object_t *, const char * ) LIBVLC_USED); +VLC_EXPORT( void, config_AddIntf, ( vlc_object_t *, const char * ) ); +VLC_EXPORT( void, config_RemoveIntf, ( vlc_object_t *, const char * ) ); +VLC_EXPORT( bool, config_ExistIntf, ( vlc_object_t *, const char * ) LIBVLC_USED); -#define config_GetType(a,b) __config_GetType(VLC_OBJECT(a),b) -#define config_GetInt(a,b) __config_GetInt(VLC_OBJECT(a),b) -#define config_PutInt(a,b,c) __config_PutInt(VLC_OBJECT(a),b,c) -#define config_GetFloat(a,b) __config_GetFloat(VLC_OBJECT(a),b) -#define config_PutFloat(a,b,c) __config_PutFloat(VLC_OBJECT(a),b,c) -#define config_GetPsz(a,b) __config_GetPsz(VLC_OBJECT(a),b) -#define config_PutPsz(a,b,c) __config_PutPsz(VLC_OBJECT(a),b,c) +#define config_GetType(a,b) config_GetType(VLC_OBJECT(a),b) +#define config_GetInt(a,b) config_GetInt(VLC_OBJECT(a),b) +#define config_PutInt(a,b,c) config_PutInt(VLC_OBJECT(a),b,c) +#define config_GetFloat(a,b) config_GetFloat(VLC_OBJECT(a),b) +#define config_PutFloat(a,b,c) config_PutFloat(VLC_OBJECT(a),b,c) +#define config_GetPsz(a,b) config_GetPsz(VLC_OBJECT(a),b) +#define config_PutPsz(a,b,c) config_PutPsz(VLC_OBJECT(a),b,c) -#define config_AddIntf(a,b) __config_AddIntf(VLC_OBJECT(a),b) -#define config_RemoveIntf(a,b) __config_RemoveIntf(VLC_OBJECT(a),b) -#define config_ExistIntf(a,b) __config_ExistIntf(VLC_OBJECT(a),b) +#define config_AddIntf(a,b) config_AddIntf(VLC_OBJECT(a),b) +#define config_RemoveIntf(a,b) config_RemoveIntf(VLC_OBJECT(a),b) +#define config_ExistIntf(a,b) config_ExistIntf(VLC_OBJECT(a),b) /**************************************************************************** * config_chain_t: @@ -265,8 +262,8 @@ struct config_chain_t * * The option names will be created by adding the psz_prefix prefix. */ -#define config_ChainParse( a, b, c, d ) __config_ChainParse( VLC_OBJECT(a), b, c, d ) -VLC_EXPORT( void, __config_ChainParse, ( vlc_object_t *, const char *psz_prefix, const char *const *ppsz_options, config_chain_t * ) ); +VLC_EXPORT( void, config_ChainParse, ( vlc_object_t *, const char *psz_prefix, const char *const *ppsz_options, config_chain_t * ) ); +#define config_ChainParse( a, b, c, d ) config_ChainParse( VLC_OBJECT(a), b, c, d ) /** * This function will parse a configuration string (psz_string) and @@ -279,7 +276,7 @@ VLC_EXPORT( void, __config_ChainParse, ( vlc_object_t *, const char *psz_prefi * * The options values are unescaped using config_StringUnescape. */ -VLC_EXPORT( char *, config_ChainCreate, ( char **ppsz_name, config_chain_t **pp_cfg, const char *psz_string ) ); +VLC_EXPORT( char *, config_ChainCreate, ( char **ppsz_name, config_chain_t **pp_cfg, const char *psz_string ) ) LIBVLC_USED LIBVLC_MALLOC; /** * This function will release a linked list of config_chain_t @@ -290,7 +287,7 @@ VLC_EXPORT( void, config_ChainDestroy, ( config_chain_t * ) ); /** * This function will duplicate a linked list of config_chain_t */ -VLC_EXPORT( config_chain_t *, config_ChainDuplicate, ( const config_chain_t * ) ); +VLC_EXPORT( config_chain_t *, config_ChainDuplicate, ( const config_chain_t * ) LIBVLC_USED LIBVLC_MALLOC ); /** * This function will unescape a string in place and will return a pointer on @@ -312,7 +309,7 @@ VLC_EXPORT( char *, config_StringUnescape, ( char *psz_string ) ); * * The escaped characters are ' " and \ */ -VLC_EXPORT( char *, config_StringEscape, ( const char *psz_string ) LIBVLC_USED); +VLC_EXPORT( char *, config_StringEscape, ( const char *psz_string ) LIBVLC_USED LIBVLC_MALLOC ); # ifdef __cplusplus }