]> git.sesse.net Git - vlc/blobdiff - src/interface/interaction.c
Add support for config chain for interface modules
[vlc] / src / interface / interaction.c
index 25bfda005354128b181d41bf69af1582cfe11142..82bd8ca429fca9f2121a54e1010960a35da33da9 100644 (file)
 # include "config.h"
 #endif
 
-#include <vlc/vlc.h>
+#include <vlc_common.h>
 
 #include <vlc_interface.h>
 #include "interface.h"
+#include "libvlc.h"
+
+#include <assert.h>
 
 /*****************************************************************************
  * Local prototypes
  *****************************************************************************/
+
+/**
+ * This structure contains the active interaction dialogs, and is
+ * used by the manager
+ */
+struct interaction_t
+{
+    VLC_COMMON_MEMBERS
+
+    vlc_thread_t thread;
+    vlc_cond_t wait;
+
+    int                         i_dialogs;      ///< Number of dialogs
+    interaction_dialog_t      **pp_dialogs;     ///< Dialogs
+    intf_thread_t              *p_intf;         ///< Interface to use
+    int                         i_last_id;      ///< Last attributed ID
+};
+
 static interaction_t *          InteractionGet( vlc_object_t * );
-static void                     InteractionSearchInterface( interaction_t * );
-static void                     InteractionLoop( vlc_object_t * );
+static intf_thread_t *          SearchInterface( interaction_t * );
+static void*                    InteractionLoop( void * );
 static void                     InteractionManage( interaction_t * );
 
 static interaction_dialog_t    *DialogGetById( interaction_t* , int );
@@ -53,13 +74,13 @@ static void                     DialogDestroy( interaction_dialog_t * );
 static int DialogSend( vlc_object_t *, interaction_dialog_t * );
 
 #define DIALOG_INIT( type ) \
-        DECMALLOC_ERR( p_new, interaction_dialog_t );       \
-        memset( p_new, 0, sizeof( interaction_dialog_t ) ); \
-        p_new->b_cancelled = VLC_FALSE;                     \
-        p_new->i_status = NEW_DIALOG;                       \
-        p_new->i_flags = 0;                                 \
-        p_new->i_type = INTERACT_DIALOG_##type;             \
-        p_new->psz_returned[0] = NULL;                      \
+        interaction_dialog_t* p_new = calloc( 1, sizeof( interaction_dialog_t ) ); \
+        if( !p_new ) return VLC_EGENERIC;               \
+        p_new->b_cancelled = false;                     \
+        p_new->i_status = NEW_DIALOG;                   \
+        p_new->i_flags = 0;                             \
+        p_new->i_type = INTERACT_DIALOG_##type;         \
+        p_new->psz_returned[0] = NULL;                  \
         p_new->psz_returned[1] = NULL
 
 #define FORMAT_DESC \
@@ -77,7 +98,7 @@ static int DialogSend( vlc_object_t *, interaction_dialog_t * );
  * \param psz_format The message to display
  * \return           VLC_SUCCESS or VLC_EGENERIC
  */
-int __intf_UserFatal( vlc_object_t *p_this, vlc_bool_t b_blocking,
+int __intf_UserFatal( vlc_object_t *p_this, bool b_blocking,
                        const char *psz_title,
                        const char *psz_format, ... )
 {
@@ -216,7 +237,7 @@ void __intf_ProgressUpdate( vlc_object_t *p_this, int i_id,
 
     p_dialog->i_status = UPDATED_DIALOG;
 
-    vlc_object_signal_unlocked( p_interaction );
+    vlc_cond_signal( &p_interaction->wait );
     vlc_object_unlock( p_interaction );
     vlc_object_release( p_interaction );
 }
@@ -229,13 +250,13 @@ void __intf_ProgressUpdate( vlc_object_t *p_this, int i_id,
  * \param i_id             Identifier of the dialogue
  * \return                 Either true or false
  */
-vlc_bool_t __intf_UserProgressIsCancelled( vlc_object_t *p_this, int i_id )
+bool __intf_UserProgressIsCancelled( vlc_object_t *p_this, int i_id )
 {
     interaction_t *p_interaction = InteractionGet( p_this );
     interaction_dialog_t *p_dialog;
-    vlc_bool_t b_cancel;
+    bool b_cancel;
 
-    if( !p_interaction ) return VLC_TRUE;
+    if( !p_interaction ) return true;
 
     vlc_object_lock( p_interaction );
     p_dialog  =  DialogGetById( p_interaction, i_id );
@@ -243,7 +264,7 @@ vlc_bool_t __intf_UserProgressIsCancelled( vlc_object_t *p_this, int i_id )
     {
         vlc_object_unlock( p_interaction ) ;
         vlc_object_release( p_interaction );
-        return VLC_TRUE;
+        return true;
     }
 
     b_cancel = p_dialog->b_cancelled;
@@ -273,7 +294,7 @@ int __intf_UserLoginPassword( vlc_object_t *p_this,
     p_new->i_type = INTERACT_DIALOG_TWOWAY;
     p_new->psz_title = strdup( psz_title );
     p_new->psz_description = strdup( psz_description );
-    p_new->psz_default_button = strdup( _("Ok" ) );
+    p_new->psz_default_button = strdup( _("OK" ) );
     p_new->psz_alternate_button = strdup( _("Cancel" ) );
 
     p_new->i_flags = DIALOG_LOGIN_PW_OK_CANCEL;
@@ -340,7 +361,10 @@ void __intf_UserHide( vlc_object_t *p_this, int i_id )
     p_dialog = DialogGetById( p_interaction, i_id );
 
     if( p_dialog )
+    {
         p_dialog->i_status = ANSWERED_DIALOG;
+        vlc_cond_signal( &p_interaction->wait );
+    }
 
     vlc_object_unlock( p_interaction );
     vlc_object_release( p_interaction );
@@ -352,37 +376,90 @@ void __intf_UserHide( vlc_object_t *p_this, int i_id )
  *
  * \return a vlc_object_t that should be freed when done.
  */
-vlc_object_t * interaction_Init( libvlc_int_t *p_libvlc )
+interaction_t * interaction_Init( libvlc_int_t *p_libvlc )
 {
     interaction_t *p_interaction;
 
     /* Make sure we haven't yet created an interaction object */
-    assert( vlc_object_find( p_libvlc, VLC_OBJECT_INTERACTION, FIND_ANYWHERE ) == NULL );
-    
-    p_interaction = vlc_object_create( p_libvlc, VLC_OBJECT_INTERACTION );
+    assert( libvlc_priv(p_libvlc)->p_interaction == NULL );
 
-    if( p_interaction )
+    p_interaction = vlc_custom_create( VLC_OBJECT(p_libvlc),
+                                       sizeof( *p_interaction ),
+                                       VLC_OBJECT_GENERIC, "interaction" );
+    if( !p_interaction )
+        return NULL;
+
+    vlc_object_attach( p_interaction, p_libvlc );
+    p_interaction->i_dialogs = 0;
+    p_interaction->pp_dialogs = NULL;
+    p_interaction->p_intf = NULL;
+    p_interaction->i_last_id = 0;
+
+    vlc_cond_init( &p_interaction->wait );
+
+    if( vlc_clone( &p_interaction->thread, InteractionLoop, p_interaction,
+                   VLC_THREAD_PRIORITY_LOW ) )
     {
-        vlc_object_attach( p_interaction, p_libvlc );
-        
-        p_interaction->i_dialogs = 0;
-        p_interaction->pp_dialogs = NULL;
-        p_interaction->p_intf = NULL;
-        p_interaction->i_last_id = 0;
-
-        if( vlc_thread_create( p_interaction, "Interaction control",
-                                InteractionLoop, VLC_THREAD_PRIORITY_LOW,
-                                VLC_FALSE ) )
-        {
-            msg_Err( p_interaction, "Interaction control thread creation failed"
-                    ", interaction will not be displayed" );
-            vlc_object_detach( p_interaction );
-            vlc_object_release( p_interaction );
-            p_interaction = NULL;
-        }
+        msg_Err( p_interaction, "Interaction control thread creation failed, "
+                 "interaction will not be displayed" );
+        vlc_object_detach( p_interaction );
+        vlc_object_release( p_interaction );
+        return NULL;
+    }
+
+    return p_interaction;
+}
+
+void interaction_Destroy( interaction_t *p_interaction )
+{
+    if( !p_interaction )
+        return;
+
+    vlc_cancel( p_interaction->thread );
+    vlc_join( p_interaction->thread, NULL );
+    vlc_cond_destroy( &p_interaction->wait );
+
+    /* Remove all dialogs - Interfaces must be able to clean up their data */
+    for( int i = p_interaction->i_dialogs -1 ; i >= 0; i-- )
+    {
+        interaction_dialog_t * p_dialog = p_interaction->pp_dialogs[i];
+        DialogDestroy( p_dialog );
+        REMOVE_ELEM( p_interaction->pp_dialogs, p_interaction->i_dialogs, i );
+    }
+    vlc_object_release( p_interaction );
+}
+
+static vlc_mutex_t intf_lock = VLC_STATIC_MUTEX;
+
+int interaction_Register( intf_thread_t *intf )
+{
+    libvlc_priv_t *priv = libvlc_priv( intf->p_libvlc );
+    int ret = VLC_EGENERIC;
+
+    vlc_mutex_lock( &intf_lock );
+    if( priv->p_interaction_intf == NULL )
+    {   /* Since the interface is responsible for unregistering itself before
+         * it terminates, an object reference is not needed. */
+        priv->p_interaction_intf = intf;
+        ret = VLC_SUCCESS;
     }
-    
-    return VLC_OBJECT( p_interaction );
+    vlc_mutex_unlock( &intf_lock );
+    return ret;
+}
+
+int interaction_Unregister( intf_thread_t *intf )
+{
+    libvlc_priv_t *priv = libvlc_priv( intf->p_libvlc );
+    int ret = VLC_EGENERIC;
+
+    vlc_mutex_lock( &intf_lock );
+    if( priv->p_interaction_intf == intf )
+    {
+        priv->p_interaction_intf = NULL;
+        ret = VLC_SUCCESS;
+    }
+    vlc_mutex_unlock( &intf_lock );
+    return ret;
 }
 
 /**********************************************************************
@@ -392,36 +469,26 @@ vlc_object_t * interaction_Init( libvlc_int_t *p_libvlc )
 /* Get the interaction object. Create it if needed */
 static interaction_t * InteractionGet( vlc_object_t *p_this )
 {
-    return vlc_object_find( p_this, VLC_OBJECT_INTERACTION, FIND_ANYWHERE );
+    interaction_t *obj = libvlc_priv(p_this->p_libvlc)->p_interaction;
+    if( obj )
+        vlc_object_hold( obj );
+    return obj;
 }
 
 
-/* Look for an interface suitable for interaction */
-static void InteractionSearchInterface( interaction_t *p_interaction )
+/* Look for an interface suitable for interaction, and hold it. */
+static intf_thread_t *SearchInterface( interaction_t *p_interaction )
 {
-    vlc_list_t  *p_list;
-    int          i_index;
-
-    p_interaction->p_intf = NULL;
+    libvlc_priv_t *priv = libvlc_priv( p_interaction->p_libvlc );
+    intf_thread_t *intf;
 
-    p_list = vlc_list_find( p_interaction, VLC_OBJECT_INTF, FIND_ANYWHERE );
-    if( !p_list )
-    {
-        msg_Err( p_interaction, "unable to create module list" );
-        return;
-    }
+    vlc_mutex_lock( &intf_lock );
+    intf = priv->p_interaction_intf;
+    if( intf != NULL )
+        vlc_object_hold( intf );
+    vlc_mutex_unlock( &intf_lock );
 
-    for( i_index = 0; i_index < p_list->i_count; i_index ++ )
-    {
-        intf_thread_t *p_intf = (intf_thread_t *)
-                                        p_list->p_values[i_index].p_object;
-        if( p_intf->b_interaction )
-        {
-            p_interaction->p_intf = p_intf;
-            break;
-        }
-    }
-    vlc_list_release ( p_list );
+    return intf;
 }
 
 /* Find an interaction dialog by its id */
@@ -454,17 +521,26 @@ static int DialogSend( vlc_object_t *p_this, interaction_dialog_t *p_dialog )
 {
     interaction_t *p_interaction = InteractionGet( p_this );
 
+    if( !p_interaction )
+        return VLC_EGENERIC;
+
     /* Get an id, if we don't already have one */
+    vlc_object_lock( p_interaction );
     if( p_dialog->i_id == 0 )
         p_dialog->i_id = ++p_interaction->i_last_id;
+    vlc_object_unlock( p_interaction );
 
-    if( p_this->i_flags & OBJECT_FLAGS_NOINTERACT ) return VLC_EGENERIC;
+    if( p_this->i_flags & OBJECT_FLAGS_NOINTERACT )
+    {
+        vlc_object_release( p_interaction );
+        return VLC_EGENERIC;
+    }
 
     if( config_GetInt( p_this, "interact" ) ||
         p_dialog->i_flags & DIALOG_BLOCKING_ERROR ||
         p_dialog->i_flags & DIALOG_NONBLOCKING_ERROR )
     {
-        vlc_bool_t b_found = VLC_FALSE;
+        bool b_found = false;
         int i;
         p_dialog->p_interaction = p_interaction;
         p_dialog->p_parent = p_this;
@@ -474,7 +550,7 @@ static int DialogSend( vlc_object_t *p_this, interaction_dialog_t *p_dialog )
         for( i = 0 ; i< p_interaction->i_dialogs; i++ )
         {
             if( p_interaction->pp_dialogs[i]->i_id == p_dialog->i_id )
-                b_found = VLC_TRUE;
+                b_found = true;
         }
         /* Add it to the queue, the main loop will send the orders to the
          * interface */
@@ -490,7 +566,7 @@ static int DialogSend( vlc_object_t *p_this, interaction_dialog_t *p_dialog )
 
         if( p_dialog->i_type == INTERACT_DIALOG_TWOWAY ) /* Wait for answer */
         {
-            vlc_object_signal_unlocked( p_interaction );
+            vlc_cond_signal( &p_interaction->wait );
             while( p_dialog->i_status != ANSWERED_DIALOG &&
                    p_dialog->i_status != HIDING_DIALOG &&
                    p_dialog->i_status != HIDDEN_DIALOG &&
@@ -506,7 +582,7 @@ static int DialogSend( vlc_object_t *p_this, interaction_dialog_t *p_dialog )
                 p_dialog->i_status = ANSWERED_DIALOG;
             }
             p_dialog->i_flags |= DIALOG_GOT_ANSWER;
-            vlc_object_signal_unlocked( p_interaction );
+            vlc_cond_signal( &p_interaction->wait );
             vlc_object_unlock( p_interaction );
             vlc_object_release( p_interaction );
             return p_dialog->i_return;
@@ -515,7 +591,7 @@ static int DialogSend( vlc_object_t *p_this, interaction_dialog_t *p_dialog )
         {
             /* Pretend we already retrieved the "answer" */
             p_dialog->i_flags |=  DIALOG_GOT_ANSWER;
-            vlc_object_signal_unlocked( p_interaction );
+            vlc_cond_signal( &p_interaction->wait );
             vlc_object_unlock( p_interaction );
             vlc_object_release( p_interaction );
             return VLC_SUCCESS;
@@ -528,30 +604,22 @@ static int DialogSend( vlc_object_t *p_this, interaction_dialog_t *p_dialog )
     }
 }
 
-static void InteractionLoop( vlc_object_t *p_this )
+static void* InteractionLoop( void *p_this )
 {
-    int i;
-    interaction_t *p_interaction = (interaction_t*) p_this;
+    interaction_t *p_interaction = p_this;
 
-    while( !p_this->b_die )
+    vlc_object_lock( p_interaction );
+    mutex_cleanup_push( &(vlc_internals(p_interaction)->lock) );
+    for( ;; )
     {
-        vlc_object_lock( p_this );
-        if( vlc_object_wait( p_this ) )
-        {
-            vlc_object_unlock( p_this );
-            break;
-        }
+        int canc = vlc_savecancel();
         InteractionManage( p_interaction );
-        vlc_object_unlock( p_this );
-    }
+        vlc_restorecancel( canc );
 
-    /* Remove all dialogs - Interfaces must be able to clean up their data */
-    for( i = p_interaction->i_dialogs -1 ; i >= 0; i-- )
-    {
-        interaction_dialog_t * p_dialog = p_interaction->pp_dialogs[i];
-        DialogDestroy( p_dialog );
-        REMOVE_ELEM( p_interaction->pp_dialogs, p_interaction->i_dialogs, i );
+        vlc_cond_wait( &p_interaction->wait, &(vlc_internals(p_interaction)->lock) );
     }
+    vlc_cleanup_pop( );
+    assert( 0 );
 }
 
 /**
@@ -569,7 +637,7 @@ static void InteractionManage( interaction_t *p_interaction )
     /* Nothing to do */
     if( p_interaction->i_dialogs == 0 ) return;
 
-    InteractionSearchInterface( p_interaction );
+    p_interaction->p_intf = SearchInterface( p_interaction );
     if( !p_interaction->p_intf )
     {
         /* We mark all dialogs as answered with their "default" answer */
@@ -585,8 +653,6 @@ static void InteractionManage( interaction_t *p_interaction )
                 p_dialog->i_status = HIDING_DIALOG;
         }
     }
-    else
-        vlc_object_yield( p_interaction->p_intf );
 
     for( i_index = 0 ; i_index < p_interaction->i_dialogs; i_index ++ )
     {