* Core: add var_Command function. This is used to execute a command registered on...
[vlc.git] / include / vlc_variables.h
index 6e296b7..991781e 100644 (file)
@@ -26,6 +26,9 @@
   #error You are not libvlc or one of its plugins. You cannot include this file
 #endif
 
   #error You are not libvlc or one of its plugins. You cannot include this file
 #endif
 
+#ifndef _VLC_VARIABLES_H
+#define _VLC_VARIABLES_H 1
+
 /**
  * \defgroup variables Variables
  *
 /**
  * \defgroup variables Variables
  *
@@ -120,6 +123,9 @@ VLC_EXPORT( int, __var_Get, ( vlc_object_t *, const char *, vlc_value_t * ) );
 #define var_OptionParse(a,b) __var_OptionParse( VLC_OBJECT( a ) , b )
 VLC_EXPORT( void, __var_OptionParse, ( vlc_object_t *, const char * ) );
 
 #define var_OptionParse(a,b) __var_OptionParse( VLC_OBJECT( a ) , b )
 VLC_EXPORT( void, __var_OptionParse, ( vlc_object_t *, const char * ) );
 
+#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 ** ) );
+
 /**
  * __var_Create() with automatic casting.
  */
 /**
  * __var_Create() with automatic casting.
  */
@@ -350,6 +356,18 @@ static inline char *__var_GetString( vlc_object_t *p_obj, const char *psz_name )
         return strdup( "" );
 }
 
         return strdup( "" );
 }
 
+static inline char *__var_GetNonEmptyString( vlc_object_t *obj, const char *name )
+{
+    vlc_value_t val;
+    if (__var_Get (obj, name, &val))
+        return NULL;
+    if (*val.psz_string)
+        return val.psz_string;
+    free (val.psz_string);
+    return NULL;
+}
+
+
 /**
  * __var_GetInteger() with automatic casting
  */
 /**
  * __var_GetInteger() with automatic casting
  */
@@ -370,6 +388,7 @@ static inline char *__var_GetString( vlc_object_t *p_obj, const char *psz_name )
  * __var_GetString() with automatic casting
  */
 #define var_GetString(a,b)   __var_GetString( VLC_OBJECT(a),b)
  * __var_GetString() with automatic casting
  */
 #define var_GetString(a,b)   __var_GetString( VLC_OBJECT(a),b)
+#define var_GetNonEmptyString(a,b)   __var_GetNonEmptyString( VLC_OBJECT(a),b)
 
 
 
 
 
 
@@ -405,13 +424,8 @@ static inline void __var_DecInteger( vlc_object_t *p_obj, const char *psz_name )
  */
 static inline int __var_CreateGetInteger( vlc_object_t *p_obj, const char *psz_name )
 {
  */
 static inline int __var_CreateGetInteger( vlc_object_t *p_obj, const char *psz_name )
 {
-    vlc_value_t val;
-
     __var_Create( p_obj, psz_name, VLC_VAR_INTEGER | VLC_VAR_DOINHERIT );
     __var_Create( p_obj, psz_name, VLC_VAR_INTEGER | VLC_VAR_DOINHERIT );
-    if( !__var_Get( p_obj, psz_name, &val ) )
-        return val.i_int;
-    else
-        return 0;
+    return __var_GetInteger( p_obj, psz_name );
 }
 
 /**
 }
 
 /**
@@ -422,13 +436,8 @@ static inline int __var_CreateGetInteger( vlc_object_t *p_obj, const char *psz_n
  */
 static inline int __var_CreateGetBool( vlc_object_t *p_obj, const char *psz_name )
 {
  */
 static inline int __var_CreateGetBool( vlc_object_t *p_obj, const char *psz_name )
 {
-    vlc_value_t val;
-
     __var_Create( p_obj, psz_name, VLC_VAR_BOOL | VLC_VAR_DOINHERIT );
     __var_Create( p_obj, psz_name, VLC_VAR_BOOL | VLC_VAR_DOINHERIT );
-    if( !__var_Get( p_obj, psz_name, &val ) )
-        return val.b_bool;
-    else
-        return VLC_FALSE;
+    return __var_GetBool( p_obj, psz_name );
 }
 
 /**
 }
 
 /**
@@ -439,13 +448,8 @@ static inline int __var_CreateGetBool( vlc_object_t *p_obj, const char *psz_name
  */
 static inline int64_t __var_CreateGetTime( vlc_object_t *p_obj, const char *psz_name )
 {
  */
 static inline int64_t __var_CreateGetTime( vlc_object_t *p_obj, const char *psz_name )
 {
-    vlc_value_t val;
-
     __var_Create( p_obj, psz_name, VLC_VAR_TIME | VLC_VAR_DOINHERIT );
     __var_Create( p_obj, psz_name, VLC_VAR_TIME | VLC_VAR_DOINHERIT );
-    if( !__var_Get( p_obj, psz_name, &val ) )
-        return val.i_time;
-    else
-        return 0;
+    return __var_GetTime( p_obj, psz_name );
 }
 
 /**
 }
 
 /**
@@ -456,13 +460,8 @@ static inline int64_t __var_CreateGetTime( vlc_object_t *p_obj, const char *psz_
  */
 static inline float __var_CreateGetFloat( vlc_object_t *p_obj, const char *psz_name )
 {
  */
 static inline float __var_CreateGetFloat( vlc_object_t *p_obj, const char *psz_name )
 {
-    vlc_value_t val;
-
     __var_Create( p_obj, psz_name, VLC_VAR_FLOAT | VLC_VAR_DOINHERIT );
     __var_Create( p_obj, psz_name, VLC_VAR_FLOAT | VLC_VAR_DOINHERIT );
-    if( !__var_Get( p_obj, psz_name, &val ) )
-        return val.f_float;
-    else
-        return 0.0;
+    return __var_GetFloat( p_obj, psz_name );
 }
 
 /**
 }
 
 /**
@@ -471,15 +470,18 @@ 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
  */
  * \param p_obj The object that holds the variable
  * \param psz_name The name of the variable
  */
-static inline char *__var_CreateGetString( vlc_object_t *p_obj, const char *psz_name )
+static inline char *__var_CreateGetString( vlc_object_t *p_obj,
+                                           const char *psz_name )
 {
 {
-    vlc_value_t val;
+    __var_Create( p_obj, psz_name, VLC_VAR_STRING | VLC_VAR_DOINHERIT );
+    return __var_GetString( p_obj, psz_name );
+}
 
 
+static inline char *__var_CreateGetNonEmptyString( vlc_object_t *p_obj,
+                                                   const char *psz_name )
+{
     __var_Create( p_obj, psz_name, VLC_VAR_STRING | VLC_VAR_DOINHERIT );
     __var_Create( p_obj, psz_name, VLC_VAR_STRING | VLC_VAR_DOINHERIT );
-    if( !__var_Get( p_obj, psz_name, &val ) )
-        return val.psz_string;
-    else
-        return strdup( "" );
+    return __var_GetNonEmptyString( p_obj, psz_name );
 }
 
 /**
 }
 
 /**
@@ -502,8 +504,104 @@ static inline char *__var_CreateGetString( vlc_object_t *p_obj, const char *psz_
  * __var_CreateGetString() with automatic casting
  */
 #define var_CreateGetString(a,b)   __var_CreateGetString( VLC_OBJECT(a),b)
  * __var_CreateGetString() with automatic casting
  */
 #define var_CreateGetString(a,b)   __var_CreateGetString( VLC_OBJECT(a),b)
+#define var_CreateGetNonEmptyString(a,b)   __var_CreateGetNonEmptyString( VLC_OBJECT(a),b)
 
 /**
 
 /**
- * @}
+ * Create a integer command variable with inherit and get its value.
+ *
+ * \param p_obj The object that holds the variable
+ * \param psz_name The name of the variable
+ */
+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
+                                   | VLC_VAR_ISCOMMAND );
+    return __var_GetInteger( p_obj, psz_name );
+}
+
+/**
+ * Create a boolean command variable with inherit and get its value.
+ *
+ * \param p_obj The object that holds the variable
+ * \param psz_name The name of the variable
+ */
+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
+                                   | VLC_VAR_ISCOMMAND );
+    return __var_GetBool( p_obj, psz_name );
+}
+
+/**
+ * Create a time command variable with inherit and get its value.
+ *
+ * \param p_obj The object that holds the variable
+ * \param psz_name The name of the variable
+ */
+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
+                                   | VLC_VAR_ISCOMMAND );
+    return __var_GetTime( p_obj, psz_name );
+}
+
+/**
+ * Create a float command variable with inherit and get its value.
+ *
+ * \param p_obj The object that holds the variable
+ * \param psz_name The name of the variable
+ */
+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
+                                   | VLC_VAR_ISCOMMAND );
+    return __var_GetFloat( p_obj, psz_name );
+}
+
+/**
+ * Create a string command variable with inherit and get its value.
+ *
+ * \param p_obj The object that holds the variable
+ * \param psz_name The name of the variable
  */
  */
+static inline char *__var_CreateGetStringCommand( vlc_object_t *p_obj,
+                                           const char *psz_name )
+{
+    __var_Create( p_obj, psz_name, VLC_VAR_STRING | VLC_VAR_DOINHERIT
+                                   | VLC_VAR_ISCOMMAND );
+    return __var_GetString( p_obj, psz_name );
+}
 
 
+static inline char *__var_CreateGetNonEmptyStringCommand( vlc_object_t *p_obj,
+                                                   const char *psz_name )
+{
+    __var_Create( p_obj, psz_name, VLC_VAR_STRING | VLC_VAR_DOINHERIT
+                                   | VLC_VAR_ISCOMMAND );
+    return __var_GetNonEmptyString( p_obj, psz_name );
+}
+
+/**
+ * __var_CreateGetInteger() with automatic casting
+ */
+#define var_CreateGetIntegerCommand(a,b)   __var_CreateGetIntegerCommand( VLC_OBJECT(a),b)
+/**
+ * __var_CreateGetBoolCommand() with automatic casting
+ */
+#define var_CreateGetBoolCommand(a,b)   __var_CreateGetBoolCommand( VLC_OBJECT(a),b)
+/**
+ * __var_CreateGetTimeCommand() with automatic casting
+ */
+#define var_CreateGetTimeCommand(a,b)   __var_CreateGetTimeCommand( VLC_OBJECT(a),b)
+/**
+ * __var_CreateGetFloat() with automatic casting
+ */
+#define var_CreateGetFloatCommand(a,b)   __var_CreateGetFloatCommand( VLC_OBJECT(a),b)
+/**
+ * __var_CreateGetStringCommand() with automatic casting
+ */
+#define var_CreateGetStringCommand(a,b)   __var_CreateGetStringCommand( VLC_OBJECT(a),b)
+#define var_CreateGetNonEmptyStringCommand(a,b)   __var_CreateGetNonEmptyStringCommand( VLC_OBJECT(a),b)
+/**
+ * @}
+ */
+#endif /*  _VLC_VARIABLES_H */