misc/events.c: Fix event debugging.

[vlc] / src / misc / events.c

diff --git a/src/misc/events.c b/src/misc/events.c
index 3a0a4a0b633944b44802f9ed56d8923fff6e46c6..3a7d9d2acfed4380e6656056a5639828dd48d061 100644 (file)
--- a/src/misc/events.c
+++ b/src/misc/events.c
@@ -1,3 +1,26 @@
+/*****************************************************************************
+ * events.c: events interface
+ * This library provides an interface to the send and receive events.
+ * It is more lightweight than variable based callback.
+ * Methode
+ *****************************************************************************
+ * Copyright (C) 1998-2005 the VideoLAN team
+ * $Id$
+ *
+ * Authors: Pierre d'Herbemont <pdherbemont # videolan.org >
+ *
+ * This program is free software; you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation; either version 2 of the License, or
+ * (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program; if not, write to the Free Software
  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
  *****************************************************************************/
 
@@ -16,6 +39,8 @@
  * Documentation : Read vlc_events.h
  *****************************************************************************/
 
+//#define DEBUG_EVENT
+
 /*****************************************************************************
  *  Private types.
  *****************************************************************************/
@@ -24,6 +49,9 @@ typedef struct vlc_event_listener_t
 {
     void *               p_user_data;
     vlc_event_callback_t pf_callback;
+#ifdef DEBUG_EVENT
+    char *               psz_debug_name;
+#endif
 } vlc_event_listener_t;
 
 typedef struct vlc_event_listeners_group_t
@@ -32,6 +60,16 @@ typedef struct vlc_event_listeners_group_t
     DECL_ARRAY(struct vlc_event_listener_t *) listeners;
 } vlc_event_listeners_group_t;
 
+#ifdef DEBUG_EVENT
+static const char * ppsz_event_type_to_name[] = 
+{
+    [vlc_InputItemMetaChanged]          = "vlc_InputItemMetaChanged",
+    [vlc_InputItemSubItemAdded]         = "vlc_InputItemSubItemAdded",
+    [vlc_ServicesDiscoveryItemAdded]    = "vlc_ServicesDiscoveryItemAdded",
+    [vlc_ServicesDiscoveryItemRemoved]  = "vlc_ServicesDiscoveryItemRemoved"
+};
+#endif
+
 /*****************************************************************************
  * 
  *****************************************************************************/
@@ -47,6 +85,7 @@ int vlc_event_manager_init( vlc_event_manager_t * p_em, void * p_obj,
                             vlc_object_t * p_parent_obj )
 {
     p_em->p_obj = p_obj;
+    p_em->p_parent_object = p_parent_obj;
     vlc_mutex_init( p_parent_obj, &p_em->object_lock );
     ARRAY_INIT( p_em->listeners_groups );
     return VLC_SUCCESS;
@@ -115,6 +154,13 @@ void vlc_event_send( vlc_event_manager_t * p_em,
             FOREACH_ARRAY( listener, listeners_group->listeners )
                 func = listener->pf_callback;
                 user_data = listener->p_user_data;
+#ifdef DEBUG_EVENT
+                msg_Dbg( p_em->p_parent_object,
+                    "Calling '%s' with a '%s' event (data %p)",
+                    listener->psz_debug_name,
+                    ppsz_event_type_to_name[p_event->type],
+                    listener->p_user_data );
+#endif
                 /* This is safe to do that because we are sure 
                  * that there will be no object owned references
                  * used after the lock. */
@@ -131,10 +177,11 @@ void vlc_event_send( vlc_event_manager_t * p_em,
 /**
  * Add a callback for an event.
  */
-int vlc_event_attach( vlc_event_manager_t * p_em,
-                      vlc_event_type_t event_type,
-                      vlc_event_callback_t pf_callback,
-                      void *p_user_data )
+int __vlc_event_attach( vlc_event_manager_t * p_em,
+                        vlc_event_type_t event_type,
+                        vlc_event_callback_t pf_callback,
+                        void *p_user_data,
+                        const char * psz_debug_name )
 {
     vlc_event_listeners_group_t * listeners_group;
     vlc_event_listener_t * listener;
@@ -144,18 +191,31 @@ int vlc_event_attach( vlc_event_manager_t * p_em,
     
     listener->p_user_data = p_user_data;
     listener->pf_callback = pf_callback;
+#ifdef DEBUG_EVENT
+    listener->psz_debug_name = strdup( psz_debug_name );
+#else
+    (void)psz_debug_name;
+#endif
 
     vlc_mutex_lock( &p_em->object_lock );
     FOREACH_ARRAY( listeners_group, p_em->listeners_groups )
         if( listeners_group->event_type == event_type )
         {
             ARRAY_APPEND( listeners_group->listeners, listener );
+#ifdef DEBUG_EVENT
+                msg_Dbg( p_em->p_parent_object,
+                    "Listening to '%s' event with '%s' (data %p)",
+                    ppsz_event_type_to_name[event_type],
+                    listener->psz_debug_name,
+                    listener->p_user_data );
+#endif
             vlc_mutex_unlock( &p_em->object_lock );
             return VLC_SUCCESS;
         }
     FOREACH_END()
     vlc_mutex_unlock( &p_em->object_lock );
 
+    msg_Err( p_em->p_parent_object, "Can't attach to an object event manager event" );
     free(listener);
     return VLC_EGENERIC;
 }
@@ -183,6 +243,15 @@ int vlc_event_detach( vlc_event_manager_t *p_em,
                     ARRAY_REMOVE( listeners_group->listeners,
                         fe_idx /* This comes from the macro (and that's why
                                   I hate macro) */ );
+#ifdef DEBUG_EVENT
+                    msg_Dbg( p_em->p_parent_object,
+                        "Detaching '%s' from '%s' event (data %p)\n",
+                        listener->psz_debug_name,
+                        ppsz_event_type_to_name[event_type],
+                        listener->p_user_data );
+
+                    free( listener->psz_debug_name );
+#endif
                     free( listener );
                     vlc_mutex_unlock( &p_em->object_lock );
                     return VLC_SUCCESS;
@@ -192,7 +261,7 @@ int vlc_event_detach( vlc_event_manager_t *p_em,
     FOREACH_END()
     vlc_mutex_unlock( &p_em->object_lock );
 
+    msg_Warn( p_em->p_parent_object, "Can't detach to an object event manager event" );
+
     return VLC_EGENERIC;
 }
-
-