Fix a couple of introspection issues
[platform/upstream/at-spi2-core.git] / atspi / atspi-event-listener.c
index 26f1105..752547d 100644 (file)
@@ -23,6 +23,7 @@
  */
 
 #include "atspi-private.h"
+#include "atspi-accessible-private.h"
 #include <string.h>
 #include <ctype.h>
 
@@ -31,9 +32,11 @@ typedef struct
   AtspiEventListenerCB callback;
   void *user_data;
   GDestroyNotify callback_destroyed;
+  char *event_type;
   char *category;
   char *name;
   char *detail;
+  GArray *properties;
 } EventListenerEntry;
 
 G_DEFINE_TYPE (AtspiEventListener, atspi_event_listener, G_TYPE_OBJECT)
@@ -49,7 +52,7 @@ atspi_event_listener_class_init (AtspiEventListenerClass *klass)
 }
 
 static void
-remove_datum (const AtspiEvent *event, void *user_data)
+remove_datum (AtspiEvent *event, void *user_data)
 {
   AtspiEventListenerSimpleCB cb = user_data;
   cb (event);
@@ -116,7 +119,7 @@ callback_unref (gpointer callback)
 
 /**
  * atspi_event_listener_new:
- * @callback: (scope notified): An #AtspiEventListenerSimpleCB to be called
+ * @callback: (scope notified): An #AtspiEventListenerCB to be called
  * when an event is fired.
  * @user_data: (closure): data to pass to the callback.
  * @callback_destroyed: A #GDestroyNotify called when the listener is freed
@@ -140,7 +143,7 @@ atspi_event_listener_new (AtspiEventListenerCB callback,
 }
 
 /**
- * atspi_event_listener_new_simple:
+ * atspi_event_listener_new_simple: (skip)
  * @callback: (scope notified): An #AtspiEventListenerSimpleCB to be called
  * when an event is fired.
  * @callback_destroyed: A #GDestroyNotify called when the listener is freed
@@ -204,21 +207,29 @@ cache_process_children_changed (AtspiEvent *event)
     return;
 
   child = g_value_get_object (&event->any_data);
+  if (child == NULL)
+    return;
 
   if (!strncmp (event->type, "object:children-changed:add", 27))
   {
-    if (g_list_find (event->source->children, child))
+    g_ptr_array_remove (event->source->children, child); /* just to be safe */
+    if (event->detail1 < 0 || event->detail1 > event->source->children->len)
+    {
+      event->source->cached_properties &= ~ATSPI_CACHE_CHILDREN;
       return;
-    event->source->children = g_list_insert (event->source->children,
-                                             g_object_ref (child),
-                                             event->detail1);
+    }
+    /* Unfortunately, there's no g_ptr_array_insert or similar */
+    g_ptr_array_add (event->source->children, NULL);
+    memmove (event->source->children->pdata + event->detail1 + 1,
+             event->source->children->pdata + event->detail1,
+             (event->source->children->len - event->detail1 - 1) * sizeof (gpointer));
+    g_ptr_array_index (event->source->children, event->detail1) = g_object_ref (child);
   }
-  else if (g_list_find (event->source->children, child))
+  else
   {
-    event->source->children = g_list_remove (event->source->children, child);
+    g_ptr_array_remove (event->source->children, child);
     if (child == child->parent.app->root)
       g_object_run_dispose (G_OBJECT (child->parent.app));
-    g_object_unref (child);
   }
 }
 
@@ -400,6 +411,7 @@ static void
 listener_entry_free (EventListenerEntry *e)
 {
   gpointer callback = (e->callback == remove_datum ? (gpointer)e->user_data : (gpointer)e->callback);
+  g_free (e->event_type);
   g_free (e->category);
   g_free (e->name);
   if (e->detail) g_free (e->detail);
@@ -512,6 +524,59 @@ atspi_event_listener_register (AtspiEventListener *listener,
 }
 
 /**
+ * atspi_event_listener_register_full:
+ * @listener: The #AtspiEventListener to register against an event type.
+ * @event_type: a character string indicating the type of events for which
+ *            notification is requested.  See #atspi_event_listener_register
+ * for a description of the format and legal event types.
+* @properties: (element-type gchar*) (transfer none) (allow-none): a list of
+ *             properties that should be sent along with the event. The
+ *             properties are valued for the duration of the event callback.k
+ *             TODO: Document.
+ *
+ * Adds an in-process callback function to an existing #AtspiEventListener.
+ *
+ * Returns: #TRUE if successful, otherwise #FALSE.
+ **/
+gboolean
+atspi_event_listener_register_full (AtspiEventListener *listener,
+                                            const gchar              *event_type,
+                                            GArray *properties,
+                                            GError **error)
+{
+  /* TODO: Keep track of which events have been registered, so that we
+ * deregister all of them when the event listener is destroyed */
+
+  return atspi_event_listener_register_from_callback_full (listener->callback,
+                                                           listener->user_data,
+                                                           listener->cb_destroyed,
+                                                           event_type,
+                                                           properties,
+                                                           error);
+}
+
+static gboolean
+notify_event_registered (EventListenerEntry *e)
+{
+
+  if (e->properties)
+    dbind_method_call_reentrant (_atspi_bus (), atspi_bus_registry,
+                                atspi_path_registry,
+                                atspi_interface_registry,
+                                "RegisterEvent",
+                                NULL, "sas", e->event_type,
+                                 e->properties);
+  else
+    dbind_method_call_reentrant (_atspi_bus (), atspi_bus_registry,
+                                atspi_path_registry,
+                                atspi_interface_registry,
+                                "RegisterEvent",
+                                NULL, "s", e->event_type);
+
+  return TRUE;
+}
+
+/**
  * atspi_event_listener_register_from_callback:
  * @callback: (scope notified): the #AtspiEventListenerCB to be registered 
  * against an event type.
@@ -533,9 +598,52 @@ atspi_event_listener_register_from_callback (AtspiEventListenerCB callback,
                                             const gchar              *event_type,
                                             GError **error)
 {
+  return atspi_event_listener_register_from_callback_full (callback,
+                                                           user_data,
+                                                           callback_destroyed,
+                                                           event_type, NULL,
+                                                           error);
+}
+
+static GArray *
+copy_event_properties (GArray *src)
+{
+  gint i;
+
+  GArray *dst = g_array_new (FALSE, FALSE, sizeof (char *));
+
+  if (!src)
+    return dst;
+  for (i = 0; i < src->len; i++)
+    {
+      gchar *dup = g_strdup (g_array_index (src, char *, i));
+    g_array_append_val (dst, dup);
+    }
+  return dst;
+}
+
+/**
+ * atspi_event_listener_register_from_callback_full:
+ * @callback: (scope async): an #AtspiEventListenerCB function pointer.
+ * @user_data: (closure callback)
+ * @callback_destroyed: (destroy callback)
+ * @event_type:
+ * @properties: (element-type utf8)
+ * @error:
+ *
+ * Returns: #TRUE if successful, otherwise #FALSE.
+ *
+ **/
+gboolean
+atspi_event_listener_register_from_callback_full (AtspiEventListenerCB callback,
+                                                 void *user_data,
+                                                 GDestroyNotify callback_destroyed,
+                                                 const gchar              *event_type,
+                                                 GArray *properties,
+                                                 GError **error)
+{
   EventListenerEntry *e;
   DBusError d_error;
-  DBusMessage *message, *reply;
   GPtrArray *matchrule_array;
   gint i;
 
@@ -551,6 +659,7 @@ atspi_event_listener_register_from_callback (AtspiEventListenerCB callback,
   }
 
   e = g_new (EventListenerEntry, 1);
+  e->event_type = g_strdup (event_type);
   e->callback = callback;
   e->user_data = user_data;
   e->callback_destroyed = callback_destroyed;
@@ -561,6 +670,7 @@ atspi_event_listener_register_from_callback (AtspiEventListenerCB callback,
     g_free (e);
     return FALSE;
   }
+  e->properties = copy_event_properties (properties);
   event_listeners = g_list_prepend (event_listeners, e);
   for (i = 0; i < matchrule_array->len; i++)
   {
@@ -578,22 +688,25 @@ atspi_event_listener_register_from_callback (AtspiEventListenerCB callback,
   }
   g_ptr_array_free (matchrule_array, TRUE);
 
-  message = dbus_message_new_method_call (atspi_bus_registry,
-       atspi_path_registry,
-       atspi_interface_registry,
-       "RegisterEvent");
-  if (!message)
-    return FALSE;
-  dbus_message_append_args (message, DBUS_TYPE_STRING, &event_type, DBUS_TYPE_INVALID);
-  reply = _atspi_dbus_send_with_reply_and_block (message, error);
-  if (reply)
-    dbus_message_unref (reply);
-
+  notify_event_registered (e);
   return TRUE;
 }
 
+void
+_atspi_reregister_event_listeners ()
+{
+  GList *l;
+  EventListenerEntry *e;
+
+  for (l = event_listeners; l; l = l->next)
+    {
+      e = l->data;
+      notify_event_registered (e);
+    }
+}
+
 /**
- * atspi_event_listener_register_no_data:
+ * atspi_event_listener_register_no_data: (skip)
  * @callback: (scope notified): the #AtspiEventListenerSimpleCB to be
  *            registered against an event type.
  * @callback_destroyed: A #GDestroyNotify called when the callback is destroyed.
@@ -728,7 +841,7 @@ atspi_event_listener_deregister_from_callback (AtspiEventListenerCB callback,
 }
 
 /**
- * atspi_event_listener_deregister_no_data:
+ * atspi_event_listener_deregister_no_data: (skip)
  * @callback: (scope call): the #AtspiEventListenerSimpleCB registered against
  *            an event type.
  * @event_type: a string specifying the event type for which this
@@ -777,6 +890,9 @@ detail_matches_listener (const char *event_detail, const char *listener_detail)
   if (!listener_detail)
     return TRUE;
 
+  if (!event_detail)
+    return (listener_detail ? FALSE : TRUE);
+
   return !(listener_detail [strcspn (listener_detail, ":")] == '\0'
                ? strncmp (listener_detail, event_detail,
                           strcspn (event_detail, ":"))
@@ -788,6 +904,7 @@ _atspi_send_event (AtspiEvent *e)
 {
   char *category, *name, *detail;
   GList *l;
+  GList *called_listeners = NULL;
 
   /* Ensure that the value is set to avoid a Python exception */
   /* TODO: Figure out how to do this without using a private field */
@@ -809,12 +926,24 @@ _atspi_send_event (AtspiEvent *e)
         (entry->name == NULL || !strcmp (name, entry->name)) &&
         detail_matches_listener (detail, entry->detail))
     {
+      GList *l2;
+      for (l2 = called_listeners; l2; l2 = l2->next)
+      {
+        EventListenerEntry *e2 = l2->data;
+        if (entry->callback == e2->callback && entry->user_data == e2->user_data)
+          break;
+      }
+      if (!l2)
+      {
         entry->callback (atspi_event_copy (e), entry->user_data);
+        called_listeners = g_list_prepend (called_listeners, entry);
+      }
     }
   }
   if (detail) g_free (detail);
   g_free (name);
   g_free (category);
+  g_list_free (called_listeners);
 }
 
 DBusHandlerResult
@@ -831,8 +960,10 @@ _atspi_dbus_handle_event (DBusConnection *bus, DBusMessage *message, void *data)
   AtspiEvent e;
   dbus_int32_t detail1, detail2;
   char *p;
+  GHashTable *cache = NULL;
 
-  if (strcmp (signature, "siiv(so)") != 0)
+  if (strcmp (signature, "siiv(so)") != 0 &&
+      strcmp (signature, "siiva{sv}") != 0)
   {
     g_warning ("Got invalid signature %s for signal %s from interface %s\n", signature, member, category);
     return DBUS_HANDLER_RESULT_HANDLED;
@@ -884,6 +1015,14 @@ _atspi_dbus_handle_event (DBusConnection *bus, DBusMessage *message, void *data)
   }
   e.type = converted_type;
   e.source = _atspi_ref_accessible (dbus_message_get_sender(message), dbus_message_get_path(message));
+  if (e.source == NULL)
+  {
+    g_warning ("Got no valid source accessible for signal for signal %s from interface %s\n", member, category);
+    g_free (converted_type);
+    g_free (name);
+    g_free (detail);
+    return DBUS_HANDLER_RESULT_HANDLED;
+  }
 
   dbus_message_iter_recurse (&iter, &iter_variant);
   switch (dbus_message_iter_get_arg_type (&iter_variant))
@@ -918,6 +1057,13 @@ _atspi_dbus_handle_event (DBusConnection *bus, DBusMessage *message, void *data)
     break;
   }
 
+  dbus_message_iter_next (&iter);
+  if (dbus_message_iter_get_arg_type (&iter) == DBUS_TYPE_ARRAY)
+  {
+    /* new form -- parse properties sent with event */
+    cache = _atspi_dbus_update_cache_from_dict (e.source, &iter);
+  }
+
   if (!strncmp (e.type, "object:children-changed", 23))
   {
     cache_process_children_changed (&e);
@@ -938,6 +1084,9 @@ _atspi_dbus_handle_event (DBusConnection *bus, DBusMessage *message, void *data)
 
   _atspi_send_event (&e);
 
+  if (cache)
+    _atspi_accessible_unref_cache (e.source);
+
   g_free (converted_type);
   g_free (name);
   g_free (detail);