objects: vlc_object_yield() returns the yield()-ed object for convenience.

[vlc] / include / vlc_variables.h

diff --git a/include/vlc_variables.h b/include/vlc_variables.h
index aa1c6b466be8740ff2c701ae3658b6ca1776bf54..9015b0b3290034295baa7b48e4655af6dbdca102 100644 (file)
--- a/include/vlc_variables.h
+++ b/include/vlc_variables.h
@@ -25,6 +25,8 @@
 #ifndef VLC_VARIABLES_H
 #define VLC_VARIABLES_H 1
 
+#include <assert.h>
+
 /**
  * \file
  * This file defines functions and structures for dynamic variables in vlc
@@ -45,6 +47,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
@@ -123,14 +126,31 @@ VLC_EXPORT( int, __var_Destroy, ( vlc_object_t *, const char * ) );
 
 VLC_EXPORT( int, __var_Change, ( vlc_object_t *, const char *, int, vlc_value_t *, vlc_value_t * ) );
 
-VLC_EXPORT( int, __var_Type, ( vlc_object_t *, const char * ) );
+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 * ) );
 
 #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 * ) );
+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))
 
 /**
  * __var_Create() with automatic casting.
@@ -191,6 +211,17 @@ VLC_EXPORT( int, __var_TriggerCallback, ( vlc_object_t *, const char * ) );
  * helpers functions
  *****************************************************************************/
 
+/**
+ * This function assert the variable is of the expected type or it
+ * is not defined
+ */
+static inline void __var_AssertType( vlc_object_t *p_obj, const char *psz_name,
+                                     int i_expected )
+{
+    const int i_type = __var_Type( p_obj, psz_name ) & VLC_VAR_CLASS;
+    assert( i_type == 0 || i_type == (i_expected&VLC_VAR_CLASS) );
+}
+
 /**
  * Set the value of an integer variable
  *
@@ -202,6 +233,7 @@ static inline int __var_SetInteger( vlc_object_t *p_obj, const char *psz_name, i
 {
     vlc_value_t val;
     val.i_int = i;
+    __var_AssertType( p_obj, psz_name, VLC_VAR_INTEGER );
     return __var_Set( p_obj, psz_name, val );
 }
 #define var_SetInteger(a,b,c)   __var_SetInteger( VLC_OBJECT(a),b,c)
@@ -216,6 +248,7 @@ static inline int __var_SetBool( vlc_object_t *p_obj, const char *psz_name, bool
 {
     vlc_value_t val;
     val.b_bool = b;
+    __var_AssertType( p_obj, psz_name, VLC_VAR_BOOL );
     return __var_Set( p_obj, psz_name, val );
 }
 
@@ -230,6 +263,7 @@ static inline int __var_SetTime( vlc_object_t *p_obj, const char *psz_name, int6
 {
     vlc_value_t val;
     val.i_time = i;
+    __var_AssertType( p_obj, psz_name, VLC_VAR_TIME );
     return __var_Set( p_obj, psz_name, val );
 }
 
@@ -244,6 +278,7 @@ static inline int __var_SetFloat( vlc_object_t *p_obj, const char *psz_name, flo
 {
     vlc_value_t val;
     val.f_float = f;
+    __var_AssertType( p_obj, psz_name, VLC_VAR_FLOAT );
     return __var_Set( p_obj, psz_name, val );
 }
 
@@ -258,6 +293,7 @@ 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;
+    __var_AssertType( p_obj, psz_name, VLC_VAR_STRING );
     return __var_Set( p_obj, psz_name, val );
 }
 
@@ -271,6 +307,7 @@ static inline int __var_SetVoid( vlc_object_t *p_obj, const char *psz_name )
 {
     vlc_value_t val;
     val.b_bool = true;
+    __var_AssertType( p_obj, psz_name, VLC_VAR_VOID );
     return __var_Set( p_obj, psz_name, val );
 }
 #define var_SetVoid(a,b)        __var_SetVoid( VLC_OBJECT(a),b)
@@ -299,9 +336,11 @@ static inline int __var_SetVoid( 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
 static inline int __var_GetInteger( vlc_object_t *p_obj, const char *psz_name )
 {
     vlc_value_t val;val.i_int = 0;
+    __var_AssertType( p_obj, psz_name, VLC_VAR_INTEGER );
     if( !__var_Get( p_obj, psz_name, &val ) )
         return val.i_int;
     else
@@ -314,9 +353,12 @@ static inline int __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
 static inline int __var_GetBool( vlc_object_t *p_obj, const char *psz_name )
 {
     vlc_value_t val; val.b_bool = false;
+
+    __var_AssertType( p_obj, psz_name, VLC_VAR_BOOL );
     if( !__var_Get( p_obj, psz_name, &val ) )
         return val.b_bool;
     else
@@ -329,9 +371,11 @@ static inline int __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
 static inline int64_t __var_GetTime( vlc_object_t *p_obj, const char *psz_name )
 {
     vlc_value_t val; val.i_time = 0L;
+    __var_AssertType( p_obj, psz_name, VLC_VAR_TIME );
     if( !__var_Get( p_obj, psz_name, &val ) )
         return val.i_time;
     else
@@ -344,9 +388,11 @@ static inline int64_t __var_GetTime( 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
 static inline float __var_GetFloat( vlc_object_t *p_obj, const char *psz_name )
 {
     vlc_value_t val; val.f_float = 0.0;
+    __var_AssertType( p_obj, psz_name, VLC_VAR_FLOAT );
     if( !__var_Get( p_obj, psz_name, &val ) )
         return val.f_float;
     else
@@ -359,19 +405,23 @@ 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
 static inline char *__var_GetString( vlc_object_t *p_obj, const char *psz_name )
 {
     vlc_value_t val; val.psz_string = NULL;
+    __var_AssertType( p_obj, psz_name, VLC_VAR_STRING );
     if( __var_Get( p_obj, psz_name, &val ) )
         return NULL;
     else
         return val.psz_string;
 }
 
-static inline char *__var_GetNonEmptyString( vlc_object_t *obj, const char *name )
+LIBVLC_USED
+static inline char *__var_GetNonEmptyString( vlc_object_t *p_obj, const char *psz_name )
 {
     vlc_value_t val;
-    if( __var_Get( obj, name, &val ) )
+    __var_AssertType( p_obj, psz_name, VLC_VAR_STRING );
+    if( __var_Get( p_obj, psz_name, &val ) )
         return NULL;
     if( *val.psz_string )
         return val.psz_string;
@@ -434,6 +484,7 @@ static inline void __var_DecInteger( 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
 static inline int __var_CreateGetInteger( vlc_object_t *p_obj, const char *psz_name )
 {
     __var_Create( p_obj, psz_name, VLC_VAR_INTEGER | VLC_VAR_DOINHERIT );
@@ -446,6 +497,7 @@ static inline int __var_CreateGetInteger( vlc_object_t *p_obj, const char *psz_n
  * \param p_obj The object that holds the variable
  * \param psz_name The name of the variable
  */
+LIBVLC_USED
 static inline int __var_CreateGetBool( vlc_object_t *p_obj, const char *psz_name )
 {
     __var_Create( p_obj, psz_name, VLC_VAR_BOOL | VLC_VAR_DOINHERIT );
@@ -458,6 +510,7 @@ static inline int __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
 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 );
@@ -470,6 +523,7 @@ static inline int64_t __var_CreateGetTime( 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
 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 );
@@ -482,6 +536,7 @@ static inline float __var_CreateGetFloat( vlc_object_t *p_obj, const char *psz_n
  * \param p_obj The object that holds the variable
  * \param psz_name The name of the variable
  */
+LIBVLC_USED
 static inline char *__var_CreateGetString( vlc_object_t *p_obj,
                                            const char *psz_name )
 {
@@ -489,6 +544,7 @@ static inline char *__var_CreateGetString( vlc_object_t *p_obj,
     return __var_GetString( p_obj, psz_name );
 }
 
+LIBVLC_USED
 static inline char *__var_CreateGetNonEmptyString( vlc_object_t *p_obj,
                                                    const char *psz_name )
 {
@@ -524,6 +580,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
 static inline int __var_CreateGetIntegerCommand( vlc_object_t *p_obj, const char *psz_name )
 {
     __var_Create( p_obj, psz_name, VLC_VAR_INTEGER | VLC_VAR_DOINHERIT
@@ -537,6 +594,7 @@ static inline int __var_CreateGetIntegerCommand( 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
 static inline int __var_CreateGetBoolCommand( vlc_object_t *p_obj, const char *psz_name )
 {
     __var_Create( p_obj, psz_name, VLC_VAR_BOOL | VLC_VAR_DOINHERIT
@@ -550,6 +608,7 @@ static inline int __var_CreateGetBoolCommand( vlc_object_t *p_obj, const char *p
  * \param p_obj The object that holds the variable
  * \param psz_name The name of the variable
  */
+LIBVLC_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
@@ -563,6 +622,7 @@ static inline int64_t __var_CreateGetTimeCommand( vlc_object_t *p_obj, const cha
  * \param p_obj The object that holds the variable
  * \param psz_name The name of the variable
  */
+LIBVLC_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
@@ -576,6 +636,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
 static inline char *__var_CreateGetStringCommand( vlc_object_t *p_obj,
                                            const char *psz_name )
 {
@@ -584,6 +645,7 @@ static inline char *__var_CreateGetStringCommand( vlc_object_t *p_obj,
     return __var_GetString( p_obj, psz_name );
 }
 
+LIBVLC_USED
 static inline char *__var_CreateGetNonEmptyStringCommand( vlc_object_t *p_obj,
                                                    const char *psz_name )
 {