X-Git-Url: https://git.sesse.net/?a=blobdiff_plain;f=include%2Fvlc_variables.h;h=21c32f3ecce1f57d22710e551fbb8d39c5b77b68;hb=5203cf9acca84a550deacc9661f9d3d79fd270fe;hp=f8a542fefc60d32e0d024aa459678d5f8c9135dc;hpb=5a93b614c2658450638f812cd388e66216a130ed;p=vlc diff --git a/include/vlc_variables.h b/include/vlc_variables.h index f8a542fefc..21c32f3ecc 100644 --- a/include/vlc_variables.h +++ b/include/vlc_variables.h @@ -45,6 +45,7 @@ * Variable types - probably very incomplete *****************************************************************************/ #define VLC_VAR_TYPE 0x00ff +#define VLC_VAR_CLASS 0x00f0 #define VLC_VAR_FLAGS 0xff00 /** \defgroup var_flags Additive flags @@ -60,6 +61,8 @@ #define VLC_VAR_ISCOMMAND 0x2000 /** Creation flag */ +/* If the variable is not found on the current module + search all parents and finally module config until found */ #define VLC_VAR_DOINHERIT 0x8000 /**@}*/ @@ -104,17 +107,30 @@ #define VLC_VAR_CLEARCHOICES 0x0022 #define VLC_VAR_SETDEFAULT 0x0023 #define VLC_VAR_GETCHOICES 0x0024 -#define VLC_VAR_FREECHOICES 0x0025 -#define VLC_VAR_GETLIST 0x0026 -#define VLC_VAR_FREELIST 0x0027 -#define VLC_VAR_CHOICESCOUNT 0x0028 +#define VLC_VAR_GETLIST 0x0025 +#define VLC_VAR_CHOICESCOUNT 0x0026 #define VLC_VAR_INHERITVALUE 0x0030 -#define VLC_VAR_TRIGGER_CALLBACKS 0x0035 #define VLC_VAR_SETISCOMMAND 0x0040 /**@}*/ +/** \defgroup var_GetAndSet Variable actions + * These are the different actions that can be used with __var_GetAndSet() + * @{ + */ +/** + * Toggle the value of this boolean + * \param val Unused + */ +#define VLC_VAR_TOGGLE_BOOL 0x0010 +/** + * Increment or decrement an integer of a given value + * \param val the value + */ +#define VLC_VAR_INTEGER_INCDEC 0x0020 +/**@}*/ + /***************************************************************************** * Prototypes *****************************************************************************/ @@ -126,28 +142,14 @@ VLC_EXPORT( int, __var_Change, ( vlc_object_t *, const char *, int, vlc_value_t VLC_EXPORT( int, __var_Type, ( vlc_object_t *, const char * ) LIBVLC_USED ); VLC_EXPORT( int, __var_Set, ( vlc_object_t *, const char *, vlc_value_t ) ); VLC_EXPORT( int, __var_Get, ( vlc_object_t *, const char *, vlc_value_t * ) ); +VLC_EXPORT( int, var_SetChecked, ( vlc_object_t *, const char *, int, vlc_value_t ) ); +VLC_EXPORT( int, var_GetChecked, ( vlc_object_t *, const char *, int, vlc_value_t * ) ); +VLC_EXPORT( int, __var_GetAndSet, ( vlc_object_t *, const char *, int, vlc_value_t ) ); #define var_Command(a,b,c,d,e) __var_Command( VLC_OBJECT( a ), b, c, d, e ) VLC_EXPORT( int, __var_Command, ( vlc_object_t *, const char *, const char *, const char *, char ** ) ); -VLC_EXPORT( vlc_mutex_t *, var_AcquireMutex, ( const char * ) LIBVLC_USED ); -#ifdef __GNUC__ -static -__attribute__((unused)) -__attribute__((noinline)) -__attribute__((error("variable mutex name leaks memory at run-time"))) -const char *nonconst_mutex_name( const char *str ) -{ - return str; -} - -# define check_named_mutex( m ) \ - (__builtin_constant_p(m) ? m : nonconst_mutex_name(m)) -#else -# define check_named_mutex( m ) (m) -#endif - -#define var_AcquireMutex( n ) var_AcquireMutex(check_named_mutex(n)) +VLC_EXPORT( void, var_FreeList, ( vlc_value_t *, vlc_value_t * ) ); /** * __var_Create() with automatic casting. @@ -175,6 +177,10 @@ const char *nonconst_mutex_name( const char *str ) * __var_Get() with automatic casting */ #define var_Get(a,b,c) __var_Get( VLC_OBJECT(a), b, c ) +/** + * __var_GetAndSet() with automatic casting + */ +#define var_GetAndSet(a,b,c,d) __var_GetAndSet(VLC_OBJECT(a), b, c, d) /***************************************************************************** * Variable callbacks @@ -193,12 +199,10 @@ VLC_EXPORT( int, __var_TriggerCallback, ( vlc_object_t *, const char * ) ); * __var_AddCallback() with automatic casting */ #define var_AddCallback(a,b,c,d) __var_AddCallback( VLC_OBJECT(a), b, c, d ) - /** * __var_DelCallback() with automatic casting */ #define var_DelCallback(a,b,c,d) __var_DelCallback( VLC_OBJECT(a), b, c, d ) - /** * __var_TriggerCallback() with automatic casting */ @@ -219,9 +223,9 @@ static inline int __var_SetInteger( vlc_object_t *p_obj, const char *psz_name, i { vlc_value_t val; val.i_int = i; - return __var_Set( p_obj, psz_name, val ); + return var_SetChecked( p_obj, psz_name, VLC_VAR_INTEGER, val ); } -#define var_SetInteger(a,b,c) __var_SetInteger( VLC_OBJECT(a),b,c) + /** * Set the value of an boolean variable * @@ -233,7 +237,7 @@ static inline int __var_SetBool( vlc_object_t *p_obj, const char *psz_name, bool { vlc_value_t val; val.b_bool = b; - return __var_Set( p_obj, psz_name, val ); + return var_SetChecked( p_obj, psz_name, VLC_VAR_BOOL, val ); } /** @@ -247,7 +251,7 @@ static inline int __var_SetTime( vlc_object_t *p_obj, const char *psz_name, int6 { vlc_value_t val; val.i_time = i; - return __var_Set( p_obj, psz_name, val ); + return var_SetChecked( p_obj, psz_name, VLC_VAR_TIME, val ); } /** @@ -261,7 +265,7 @@ static inline int __var_SetFloat( vlc_object_t *p_obj, const char *psz_name, flo { vlc_value_t val; val.f_float = f; - return __var_Set( p_obj, psz_name, val ); + return var_SetChecked( p_obj, psz_name, VLC_VAR_FLOAT, val ); } /** @@ -275,28 +279,32 @@ static inline int __var_SetString( vlc_object_t *p_obj, const char *psz_name, co { vlc_value_t val; val.psz_string = (char *)psz_string; - return __var_Set( p_obj, psz_name, val ); + return var_SetChecked( p_obj, psz_name, VLC_VAR_STRING, val ); } /** - * Trigger the callbacks on a void variable + * Set the value of a pointer variable * * \param p_obj The object that holds the variable * \param psz_name The name of the variable + * \param ptr The new pointer value of this variable */ -static inline int __var_SetVoid( vlc_object_t *p_obj, const char *psz_name ) +static inline +int __var_SetAddress( vlc_object_t *p_obj, const char *psz_name, void *ptr ) { vlc_value_t val; - val.b_bool = true; - return __var_Set( p_obj, psz_name, val ); + val.p_address = ptr; + return var_SetChecked( p_obj, psz_name, VLC_VAR_ADDRESS, val ); } -#define var_SetVoid(a,b) __var_SetVoid( VLC_OBJECT(a),b) +/** + * __var_SetInteger() with automatic casting + */ +#define var_SetInteger(a,b,c) __var_SetInteger( VLC_OBJECT(a),b,c) /** * __var_SetBool() with automatic casting */ -#define var_SetBool(a,b,c) __var_SetBool( VLC_OBJECT(a),b,c) - +#define var_SetBool(a,b,c) __var_SetBool( VLC_OBJECT(a),b,c) /** * __var_SetTime() with automatic casting */ @@ -308,7 +316,12 @@ static inline int __var_SetVoid( vlc_object_t *p_obj, const char *psz_name ) /** * __var_SetString() with automatic casting */ -#define var_SetString(a,b,c) __var_SetString( VLC_OBJECT(a),b,c) +#define var_SetString(a,b,c) __var_SetString( VLC_OBJECT(a),b,c) +/** + * __var_SetAddress() with automatic casting + */ +#define var_SetAddress(o, n, p) __var_SetAddress(VLC_OBJECT(o), n, p) + /** * Get an integer value @@ -319,8 +332,8 @@ static inline int __var_SetVoid( vlc_object_t *p_obj, const char *psz_name ) LIBVLC_USED static inline int __var_GetInteger( vlc_object_t *p_obj, const char *psz_name ) { - vlc_value_t val;val.i_int = 0; - if( !__var_Get( p_obj, psz_name, &val ) ) + vlc_value_t val; + if( !var_GetChecked( p_obj, psz_name, VLC_VAR_INTEGER, &val ) ) return val.i_int; else return 0; @@ -333,10 +346,11 @@ static inline int __var_GetInteger( vlc_object_t *p_obj, const char *psz_name ) * \param psz_name The name of the variable */ LIBVLC_USED -static inline int __var_GetBool( vlc_object_t *p_obj, const char *psz_name ) +static inline bool __var_GetBool( vlc_object_t *p_obj, const char *psz_name ) { vlc_value_t val; val.b_bool = false; - if( !__var_Get( p_obj, psz_name, &val ) ) + + if( !var_GetChecked( p_obj, psz_name, VLC_VAR_BOOL, &val ) ) return val.b_bool; else return false; @@ -352,7 +366,7 @@ LIBVLC_USED static inline int64_t __var_GetTime( vlc_object_t *p_obj, const char *psz_name ) { vlc_value_t val; val.i_time = 0L; - if( !__var_Get( p_obj, psz_name, &val ) ) + if( !var_GetChecked( p_obj, psz_name, VLC_VAR_TIME, &val ) ) return val.i_time; else return 0; @@ -368,7 +382,7 @@ LIBVLC_USED static inline float __var_GetFloat( vlc_object_t *p_obj, const char *psz_name ) { vlc_value_t val; val.f_float = 0.0; - if( !__var_Get( p_obj, psz_name, &val ) ) + if( !var_GetChecked( p_obj, psz_name, VLC_VAR_FLOAT, &val ) ) return val.f_float; else return 0.0; @@ -384,24 +398,33 @@ LIBVLC_USED static inline char *__var_GetString( vlc_object_t *p_obj, const char *psz_name ) { vlc_value_t val; val.psz_string = NULL; - if( __var_Get( p_obj, psz_name, &val ) ) + if( var_GetChecked( p_obj, psz_name, VLC_VAR_STRING, &val ) ) return NULL; else return val.psz_string; } LIBVLC_USED -static inline char *__var_GetNonEmptyString( vlc_object_t *obj, const char *name ) +static inline char *__var_GetNonEmptyString( vlc_object_t *p_obj, const char *psz_name ) { vlc_value_t val; - if( __var_Get( obj, name, &val ) ) + if( var_GetChecked( p_obj, psz_name, VLC_VAR_STRING, &val ) ) return NULL; - if( *val.psz_string ) + if( val.psz_string && *val.psz_string ) return val.psz_string; free( val.psz_string ); return NULL; } +LIBVLC_USED +static inline void *__var_GetAddress( vlc_object_t *p_obj, const char *psz_name ) +{ + vlc_value_t val; + if( var_GetChecked( p_obj, psz_name, VLC_VAR_ADDRESS, &val ) ) + return NULL; + else + return val.p_address; +} /** * __var_GetInteger() with automatic casting @@ -424,6 +447,10 @@ static inline char *__var_GetNonEmptyString( vlc_object_t *obj, const char *name */ #define var_GetString(a,b) __var_GetString( VLC_OBJECT(a),b) #define var_GetNonEmptyString(a,b) __var_GetNonEmptyString( VLC_OBJECT(a),b) +/** + * __var_GetAddress() with automatic casting + */ +#define var_GetAddress(a,b) __var_GetAddress( VLC_OBJECT(a),b) @@ -434,8 +461,9 @@ static inline char *__var_GetNonEmptyString( vlc_object_t *obj, const char *name */ static inline void __var_IncInteger( vlc_object_t *p_obj, const char *psz_name ) { - int i_val = __var_GetInteger( p_obj, psz_name ); - __var_SetInteger( p_obj, psz_name, ++i_val ); + vlc_value_t val; + val.i_int = 1; + __var_GetAndSet( p_obj, psz_name, VLC_VAR_INTEGER_INCDEC, val ); } #define var_IncInteger(a,b) __var_IncInteger( VLC_OBJECT(a), b ) @@ -446,8 +474,9 @@ static inline void __var_IncInteger( vlc_object_t *p_obj, const char *psz_name ) */ static inline void __var_DecInteger( vlc_object_t *p_obj, const char *psz_name ) { - int i_val = __var_GetInteger( p_obj, psz_name ); - __var_SetInteger( p_obj, psz_name, --i_val ); + vlc_value_t val; + val.i_int = -1; + __var_GetAndSet( p_obj, psz_name, VLC_VAR_INTEGER_INCDEC, val ); } #define var_DecInteger(a,b) __var_DecInteger( VLC_OBJECT(a), b ) @@ -471,7 +500,7 @@ static inline int __var_CreateGetInteger( vlc_object_t *p_obj, const char *psz_n * \param psz_name The name of the variable */ LIBVLC_USED -static inline int __var_CreateGetBool( vlc_object_t *p_obj, const char *psz_name ) +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 ); return __var_GetBool( p_obj, psz_name ); @@ -525,6 +554,20 @@ static inline char *__var_CreateGetNonEmptyString( vlc_object_t *p_obj, return __var_GetNonEmptyString( p_obj, psz_name ); } +/** + * Create an address variable with inherit and get its value. + * + * \param p_obj The object that holds the variable + * \param psz_name The name of the variable + */ +LIBVLC_USED +static inline void *__var_CreateGetAddress( vlc_object_t *p_obj, + const char *psz_name ) +{ + __var_Create( p_obj, psz_name, VLC_VAR_ADDRESS | VLC_VAR_DOINHERIT ); + return __var_GetAddress( p_obj, psz_name ); +} + /** * __var_CreateGetInteger() with automatic casting */ @@ -546,6 +589,10 @@ static inline char *__var_CreateGetNonEmptyString( vlc_object_t *p_obj, */ #define var_CreateGetString(a,b) __var_CreateGetString( VLC_OBJECT(a),b) #define var_CreateGetNonEmptyString(a,b) __var_CreateGetNonEmptyString( VLC_OBJECT(a),b) +/** + * __var_CreateGetString() with automatic casting + */ +#define var_CreateGetAddress(a,b) __var_CreateGetAddress( VLC_OBJECT(a),b) /** * Create a integer command variable with inherit and get its value. @@ -568,7 +615,7 @@ static inline int __var_CreateGetIntegerCommand( vlc_object_t *p_obj, const char * \param psz_name The name of the variable */ LIBVLC_USED -static inline int __var_CreateGetBoolCommand( vlc_object_t *p_obj, const char *psz_name ) +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 | VLC_VAR_ISCOMMAND ); @@ -648,6 +695,30 @@ 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 +static inline int __var_CountChoices( vlc_object_t *p_obj, const char *psz_name ) +{ + vlc_value_t count; + if( __var_Change( p_obj, psz_name, VLC_VAR_CHOICESCOUNT, &count, NULL ) ) + return 0; + return count.i_int; +} +/** + * __var_CountChoices() with automatic casting + */ +#define var_CountChoices(a,b) __var_CountChoices( VLC_OBJECT(a),b) + + +static inline int __var_ToggleBool( vlc_object_t *p_obj, const char *psz_name ) +{ + vlc_value_t val; + return __var_GetAndSet( p_obj, psz_name, VLC_VAR_TOGGLE_BOOL, val ); +} +/** + * __var_ToggleBool() with automatic casting + */ +#define var_ToggleBool(a,b) __var_ToggleBool( VLC_OBJECT(a),b ) /** * @} */