X-Git-Url: https://git.sesse.net/?a=blobdiff_plain;ds=sidebyside;f=include%2Fvlc_variables.h;h=6d095c3056027cdf1f77ba53eef56a84b610a0df;hb=85aa03d0af48e9db48c8fab1a8c13d968ad0de2b;hp=16b358421678e229210be72ce1f7e92b43e45c83;hpb=73e0e21f603e24f8ede4a5703f010bd456ac5593;p=vlc diff --git a/include/vlc_variables.h b/include/vlc_variables.h index 16b3584216..6d095c3056 100644 --- a/include/vlc_variables.h +++ b/include/vlc_variables.h @@ -41,13 +41,27 @@ * @{ */ -/***************************************************************************** - * Variable types - probably very incomplete - *****************************************************************************/ #define VLC_VAR_TYPE 0x00ff #define VLC_VAR_CLASS 0x00f0 #define VLC_VAR_FLAGS 0xff00 +/** + * \defgroup var_type Variable types + * These are the different types a vlc variable can have. + * @{ + */ +#define VLC_VAR_VOID 0x0010 +#define VLC_VAR_BOOL 0x0020 +#define VLC_VAR_INTEGER 0x0030 +#define VLC_VAR_HOTKEY 0x0031 +#define VLC_VAR_STRING 0x0040 +#define VLC_VAR_VARIABLE 0x0044 +#define VLC_VAR_FLOAT 0x0050 +#define VLC_VAR_TIME 0x0060 +#define VLC_VAR_ADDRESS 0x0070 +#define VLC_VAR_COORDS 0x00A0 +/**@}*/ + /** \defgroup var_flags Additive flags * These flags are added to the type field of the variable. Most as a result of * a var_Change() call, but some may be added at creation time @@ -128,36 +142,36 @@ enum { /***************************************************************************** * Prototypes *****************************************************************************/ -VLC_EXPORT( int, var_Create, ( vlc_object_t *, const char *, int ) ); +VLC_API int var_Create( vlc_object_t *, const char *, int ); #define var_Create(a,b,c) var_Create( VLC_OBJECT(a), b, c ) -VLC_EXPORT( int, var_Destroy, ( vlc_object_t *, const char * ) ); +VLC_API int var_Destroy( vlc_object_t *, const char * ); #define var_Destroy(a,b) var_Destroy( VLC_OBJECT(a), b ) -VLC_EXPORT( int, var_Change, ( vlc_object_t *, const char *, int, vlc_value_t *, vlc_value_t * ) ); +VLC_API int var_Change( vlc_object_t *, const char *, int, vlc_value_t *, vlc_value_t * ); #define var_Change(a,b,c,d,e) var_Change( VLC_OBJECT(a), b, c, d, e ) -VLC_EXPORT( int, var_Type, ( vlc_object_t *, const char * ) LIBVLC_USED ); +VLC_API int var_Type( vlc_object_t *, const char * ) VLC_USED; #define var_Type(a,b) var_Type( VLC_OBJECT(a), b ) -VLC_EXPORT( int, var_Set, ( vlc_object_t *, const char *, vlc_value_t ) ); +VLC_API int var_Set( vlc_object_t *, const char *, vlc_value_t ); #define var_Set(a,b,c) var_Set( VLC_OBJECT(a), b, c ) -VLC_EXPORT( int, var_Get, ( vlc_object_t *, const char *, vlc_value_t * ) ); +VLC_API int var_Get( vlc_object_t *, const char *, vlc_value_t * ); #define var_Get(a,b,c) var_Get( VLC_OBJECT(a), b, c ) -VLC_EXPORT( int, var_SetChecked, ( vlc_object_t *, const char *, int, vlc_value_t ) ); +VLC_API int var_SetChecked( vlc_object_t *, const char *, int, vlc_value_t ); #define var_SetChecked(o,n,t,v) var_SetChecked(VLC_OBJECT(o),n,t,v) -VLC_EXPORT( int, var_GetChecked, ( vlc_object_t *, const char *, int, vlc_value_t * ) ); +VLC_API int var_GetChecked( vlc_object_t *, const char *, int, vlc_value_t * ); #define var_GetChecked(o,n,t,v) var_GetChecked(VLC_OBJECT(o),n,t,v) -VLC_EXPORT( int, var_GetAndSet, ( vlc_object_t *, const char *, int, vlc_value_t * ) ); +VLC_API int var_GetAndSet( vlc_object_t *, const char *, int, vlc_value_t * ); -VLC_EXPORT( int, var_Inherit, ( vlc_object_t *, const char *, int, vlc_value_t * ) ); +VLC_API int var_Inherit( vlc_object_t *, const char *, int, vlc_value_t * ); -VLC_EXPORT( int, var_Command, ( vlc_object_t *, const char *, const char *, const char *, char ** ) ); +VLC_API int var_Command( vlc_object_t *, const char *, const char *, const char *, char ** ); #define var_Command(a,b,c,d,e) var_Command( VLC_OBJECT( a ), b, c, d, e ) -VLC_EXPORT( void, var_FreeList, ( vlc_value_t *, vlc_value_t * ) ); +VLC_API void var_FreeList( vlc_value_t *, vlc_value_t * ); /***************************************************************************** @@ -169,9 +183,9 @@ VLC_EXPORT( void, var_FreeList, ( vlc_value_t *, vlc_value_t * ) ); * vlc_value_t newvalue, * void *p_data); *****************************************************************************/ -VLC_EXPORT( int, var_AddCallback, ( vlc_object_t *, const char *, vlc_callback_t, void * ) ); -VLC_EXPORT( int, var_DelCallback, ( vlc_object_t *, const char *, vlc_callback_t, void * ) ); -VLC_EXPORT( int, var_TriggerCallback, ( vlc_object_t *, const char * ) ); +VLC_API int var_AddCallback( vlc_object_t *, const char *, vlc_callback_t, void * ); +VLC_API int var_DelCallback( vlc_object_t *, const char *, vlc_callback_t, void * ); +VLC_API int var_TriggerCallback( vlc_object_t *, const char * ); #define var_AddCallback(a,b,c,d) var_AddCallback( VLC_OBJECT(a), b, c, d ) #define var_DelCallback(a,b,c,d) var_DelCallback( VLC_OBJECT(a), b, c, d ) @@ -291,7 +305,7 @@ int var_SetAddress( vlc_object_t *p_obj, const char *psz_name, void *ptr ) * \param p_obj The object that holds the variable * \param psz_name The name of the variable */ -LIBVLC_USED +VLC_USED static inline int64_t var_GetInteger( vlc_object_t *p_obj, const char *psz_name ) { vlc_value_t val; @@ -307,7 +321,7 @@ static inline int64_t var_GetInteger( vlc_object_t *p_obj, const char *psz_name * \param p_obj The object that holds the variable * \param psz_name The name of the variable */ -LIBVLC_USED +VLC_USED static inline bool var_GetBool( vlc_object_t *p_obj, const char *psz_name ) { vlc_value_t val; val.b_bool = false; @@ -324,7 +338,7 @@ static inline bool var_GetBool( vlc_object_t *p_obj, const char *psz_name ) * \param p_obj The object that holds the variable * \param psz_name The name of the variable */ -LIBVLC_USED +VLC_USED static inline int64_t var_GetTime( vlc_object_t *p_obj, const char *psz_name ) { vlc_value_t val; val.i_time = 0L; @@ -355,7 +369,7 @@ static inline void var_GetCoords( vlc_object_t *obj, const char *name, * \param p_obj The object that holds the variable * \param psz_name The name of the variable */ -LIBVLC_USED +VLC_USED static inline float var_GetFloat( vlc_object_t *p_obj, const char *psz_name ) { vlc_value_t val; val.f_float = 0.0; @@ -371,7 +385,7 @@ static inline float var_GetFloat( vlc_object_t *p_obj, const char *psz_name ) * \param p_obj The object that holds the variable * \param psz_name The name of the variable */ -LIBVLC_USED LIBVLC_MALLOC +VLC_USED VLC_MALLOC static inline char *var_GetString( vlc_object_t *p_obj, const char *psz_name ) { vlc_value_t val; val.psz_string = NULL; @@ -381,7 +395,7 @@ static inline char *var_GetString( vlc_object_t *p_obj, const char *psz_name ) return val.psz_string; } -LIBVLC_USED LIBVLC_MALLOC +VLC_USED VLC_MALLOC static inline char *var_GetNonEmptyString( vlc_object_t *p_obj, const char *psz_name ) { vlc_value_t val; @@ -393,7 +407,7 @@ static inline char *var_GetNonEmptyString( vlc_object_t *p_obj, const char *psz_ return NULL; } -LIBVLC_USED +VLC_USED static inline void *var_GetAddress( vlc_object_t *p_obj, const char *psz_name ) { vlc_value_t val; @@ -457,7 +471,7 @@ static inline uint64_t var_NAndInteger( vlc_object_t *obj, const char *name, * \param p_obj The object that holds the variable * \param psz_name The name of the variable */ -LIBVLC_USED +VLC_USED static inline int64_t var_CreateGetInteger( vlc_object_t *p_obj, const char *psz_name ) { var_Create( p_obj, psz_name, VLC_VAR_INTEGER | VLC_VAR_DOINHERIT ); @@ -470,7 +484,7 @@ static inline int64_t var_CreateGetInteger( vlc_object_t *p_obj, const char *psz * \param p_obj The object that holds the variable * \param psz_name The name of the variable */ -LIBVLC_USED +VLC_USED static inline bool var_CreateGetBool( vlc_object_t *p_obj, const char *psz_name ) { var_Create( p_obj, psz_name, VLC_VAR_BOOL | VLC_VAR_DOINHERIT ); @@ -483,7 +497,7 @@ static inline bool var_CreateGetBool( vlc_object_t *p_obj, const char *psz_name * \param p_obj The object that holds the variable * \param psz_name The name of the variable */ -LIBVLC_USED +VLC_USED static inline int64_t var_CreateGetTime( vlc_object_t *p_obj, const char *psz_name ) { var_Create( p_obj, psz_name, VLC_VAR_TIME | VLC_VAR_DOINHERIT ); @@ -496,7 +510,7 @@ static inline int64_t var_CreateGetTime( vlc_object_t *p_obj, const char *psz_na * \param p_obj The object that holds the variable * \param psz_name The name of the variable */ -LIBVLC_USED +VLC_USED static inline float var_CreateGetFloat( vlc_object_t *p_obj, const char *psz_name ) { var_Create( p_obj, psz_name, VLC_VAR_FLOAT | VLC_VAR_DOINHERIT ); @@ -509,7 +523,7 @@ static inline float var_CreateGetFloat( vlc_object_t *p_obj, const char *psz_nam * \param p_obj The object that holds the variable * \param psz_name The name of the variable */ -LIBVLC_USED LIBVLC_MALLOC +VLC_USED VLC_MALLOC static inline char *var_CreateGetString( vlc_object_t *p_obj, const char *psz_name ) { @@ -517,7 +531,7 @@ static inline char *var_CreateGetString( vlc_object_t *p_obj, return var_GetString( p_obj, psz_name ); } -LIBVLC_USED LIBVLC_MALLOC +VLC_USED VLC_MALLOC static inline char *var_CreateGetNonEmptyString( vlc_object_t *p_obj, const char *psz_name ) { @@ -531,7 +545,7 @@ static inline char *var_CreateGetNonEmptyString( vlc_object_t *p_obj, * \param p_obj The object that holds the variable * \param psz_name The name of the variable */ -LIBVLC_USED +VLC_USED static inline void *var_CreateGetAddress( vlc_object_t *p_obj, const char *psz_name ) { @@ -553,7 +567,7 @@ static inline void *var_CreateGetAddress( vlc_object_t *p_obj, * \param p_obj The object that holds the variable * \param psz_name The name of the variable */ -LIBVLC_USED +VLC_USED static inline int64_t var_CreateGetIntegerCommand( vlc_object_t *p_obj, const char *psz_name ) { var_Create( p_obj, psz_name, VLC_VAR_INTEGER | VLC_VAR_DOINHERIT @@ -567,7 +581,7 @@ static inline int64_t var_CreateGetIntegerCommand( vlc_object_t *p_obj, const ch * \param p_obj The object that holds the variable * \param psz_name The name of the variable */ -LIBVLC_USED +VLC_USED static inline bool var_CreateGetBoolCommand( vlc_object_t *p_obj, const char *psz_name ) { var_Create( p_obj, psz_name, VLC_VAR_BOOL | VLC_VAR_DOINHERIT @@ -581,7 +595,7 @@ static inline bool var_CreateGetBoolCommand( vlc_object_t *p_obj, const char *ps * \param p_obj The object that holds the variable * \param psz_name The name of the variable */ -LIBVLC_USED +VLC_USED static inline int64_t var_CreateGetTimeCommand( vlc_object_t *p_obj, const char *psz_name ) { var_Create( p_obj, psz_name, VLC_VAR_TIME | VLC_VAR_DOINHERIT @@ -595,7 +609,7 @@ static inline int64_t var_CreateGetTimeCommand( vlc_object_t *p_obj, const char * \param p_obj The object that holds the variable * \param psz_name The name of the variable */ -LIBVLC_USED +VLC_USED static inline float var_CreateGetFloatCommand( vlc_object_t *p_obj, const char *psz_name ) { var_Create( p_obj, psz_name, VLC_VAR_FLOAT | VLC_VAR_DOINHERIT @@ -609,7 +623,7 @@ static inline float var_CreateGetFloatCommand( vlc_object_t *p_obj, const char * * \param p_obj The object that holds the variable * \param psz_name The name of the variable */ -LIBVLC_USED LIBVLC_MALLOC +VLC_USED VLC_MALLOC static inline char *var_CreateGetStringCommand( vlc_object_t *p_obj, const char *psz_name ) { @@ -618,7 +632,7 @@ static inline char *var_CreateGetStringCommand( vlc_object_t *p_obj, return var_GetString( p_obj, psz_name ); } -LIBVLC_USED LIBVLC_MALLOC +VLC_USED VLC_MALLOC static inline char *var_CreateGetNonEmptyStringCommand( vlc_object_t *p_obj, const char *psz_name ) { @@ -634,7 +648,7 @@ static inline char *var_CreateGetNonEmptyStringCommand( vlc_object_t *p_obj, #define var_CreateGetStringCommand(a,b) var_CreateGetStringCommand( VLC_OBJECT(a),b) #define var_CreateGetNonEmptyStringCommand(a,b) var_CreateGetNonEmptyStringCommand( VLC_OBJECT(a),b) -LIBVLC_USED +VLC_USED static inline int var_CountChoices( vlc_object_t *p_obj, const char *psz_name ) { vlc_value_t count; @@ -654,7 +668,7 @@ static inline bool var_ToggleBool( vlc_object_t *p_obj, const char *psz_name ) #define var_ToggleBool(a,b) var_ToggleBool( VLC_OBJECT(a),b ) -LIBVLC_USED +VLC_USED static inline bool var_InheritBool( vlc_object_t *obj, const char *name ) { vlc_value_t val; @@ -665,7 +679,7 @@ static inline bool var_InheritBool( vlc_object_t *obj, const char *name ) } #define var_InheritBool(o, n) var_InheritBool(VLC_OBJECT(o), n) -LIBVLC_USED +VLC_USED static inline int64_t var_InheritInteger( vlc_object_t *obj, const char *name ) { vlc_value_t val; @@ -676,7 +690,7 @@ static inline int64_t var_InheritInteger( vlc_object_t *obj, const char *name ) } #define var_InheritInteger(o, n) var_InheritInteger(VLC_OBJECT(o), n) -LIBVLC_USED +VLC_USED static inline float var_InheritFloat( vlc_object_t *obj, const char *name ) { vlc_value_t val; @@ -687,7 +701,7 @@ static inline float var_InheritFloat( vlc_object_t *obj, const char *name ) } #define var_InheritFloat(o, n) var_InheritFloat(VLC_OBJECT(o), n) -LIBVLC_USED LIBVLC_MALLOC +VLC_USED VLC_MALLOC static inline char *var_InheritString( vlc_object_t *obj, const char *name ) { vlc_value_t val; @@ -703,7 +717,7 @@ static inline char *var_InheritString( vlc_object_t *obj, const char *name ) } #define var_InheritString(o, n) var_InheritString(VLC_OBJECT(o), n) -LIBVLC_USED +VLC_USED static inline mtime_t var_InheritTime( vlc_object_t *obj, const char *name ) { vlc_value_t val; @@ -714,7 +728,7 @@ static inline mtime_t var_InheritTime( vlc_object_t *obj, const char *name ) } #define var_InheritTime(o, n) var_InheritTime(VLC_OBJECT(o), n) -LIBVLC_USED +VLC_USED static inline void *var_InheritAddress( vlc_object_t *obj, const char *name ) { vlc_value_t val; @@ -725,7 +739,7 @@ static inline void *var_InheritAddress( vlc_object_t *obj, const char *name ) } #define var_InheritAddress(o, n) var_InheritAddress(VLC_OBJECT(o), n) -VLC_EXPORT( int, var_InheritURational, ( vlc_object_t *, unsigned *num, unsigned *den, const char *var ) ); +VLC_API int var_InheritURational( vlc_object_t *, unsigned *num, unsigned *den, const char *var ); #define var_InheritURational(a,b,c,d) var_InheritURational(VLC_OBJECT(a), b, c, d) #define var_GetInteger(a,b) var_GetInteger( VLC_OBJECT(a),b) @@ -736,7 +750,7 @@ VLC_EXPORT( int, var_InheritURational, ( vlc_object_t *, unsigned *num, unsigned #define var_GetNonEmptyString(a,b) var_GetNonEmptyString( VLC_OBJECT(a),b) #define var_GetAddress(a,b) var_GetAddress( VLC_OBJECT(a),b) -VLC_EXPORT( int, var_LocationParse, (vlc_object_t *, const char *mrl, const char *prefix) ); +VLC_API int var_LocationParse(vlc_object_t *, const char *mrl, const char *prefix); #define var_LocationParse(o, m, p) var_LocationParse(VLC_OBJECT(o), m, p) /**