Partial re-refactor of the accessibles registration code.
[platform/core/uifw/at-spi2-atk.git] / atk-adaptor / event.c
index 73e13a0..4f108d3 100644 (file)
@@ -2,7 +2,7 @@
  * AT-SPI - Assistive Technology Service Provider Interface
  * (Gnome Accessibility Project; http://developer.gnome.org/projects/gap)
  *
- * Copyright 2008, Codethink Ltd.
+ * Copyright 2008, 2009, Codethink Ltd.
  * Copyright 2001, 2002, 2003 Sun Microsystems Inc.,
  * Copyright 2001, 2002, 2003 Ximian, Inc.
  *
  * Boston, MA 02111-1307, USA.
  */
 
-#include <atk/atk.h>
 #include <string.h>
-#include "accessible.h"
+
+#include <atk/atk.h>
+#include <droute/droute.h>
+
 #include "bridge.h"
-#include "atk-dbus.h"
+#include "accessible-register.h"
 
-extern SpiAppData *app_data;
+#include "spi-common/spi-dbus.h"
 
 static GArray *listener_ids = NULL;
 
 static gint atk_bridge_key_event_listener_id;
 static gint atk_bridge_focus_tracker_id;
 
-
 /*---------------------------------------------------------------------------*/
 
 #define ITF_EVENT_OBJECT   "org.freedesktop.atspi.Event.Object"
@@ -45,6 +46,21 @@ static gint atk_bridge_focus_tracker_id;
 
 /*---------------------------------------------------------------------------*/
 
+/* When sending events it is safe to register an accessible object if
+ * one does not already exist for a given AtkObject.
+ * This is because the cache update signal should then be send before
+ * the event signal is sent.
+ */
+static gchar *
+get_object_path (AtkObject *accessible)
+{
+    guint ref;
+
+    return atk_dbus_ref_to_path (ref);
+}
+
+/*---------------------------------------------------------------------------*/
+
 static gboolean
 Accessibility_DeviceEventController_notifyListenersSync(const Accessibility_DeviceEvent *key_event)
 {
@@ -61,7 +77,7 @@ Accessibility_DeviceEventController_notifyListenersSync(const Accessibility_Devi
   dbus_error_init(&error);
   if (spi_dbus_marshal_deviceEvent(message, key_event))
   {
-    DBusMessage *reply = dbus_connection_send_with_reply_and_block(app_data->droute.bus, message, 1000, &error);
+    DBusMessage *reply = dbus_connection_send_with_reply_and_block(atk_adaptor_app_data->bus, message, 1000, &error);
     if (reply)
     {
       DBusError error;
@@ -170,14 +186,6 @@ provide_defaults(const gint type,
     }
 }
 
-
-/* TODO Should we bother emiting events for objects that have not yet
- * been added to the tree?
- * 
- * This gets difficult. Its entirely possible that an Accessible would have been
- * added to the tree, but not yet reached the clients.
- * In this case we would be wrongly surpressing an event.
- */
 static void 
 emit(AtkObject  *accessible,
      const char *klass,
@@ -192,6 +200,15 @@ emit(AtkObject  *accessible,
   DBusMessageIter iter, sub;
   gchar *path, *cname, *t;
 
+  path = get_object_path (accessible);
+
+  /* Tough decision here
+   * We won't send events from accessible
+   * objects that have not yet been added to the accessible tree.
+   */
+  if (path == NULL)
+      return;
+
   if (!klass) klass = "";
   if (!major) major = "";
   if (!minor) minor = "";
@@ -204,7 +221,6 @@ emit(AtkObject  *accessible,
   cname = g_strdup(major);
   while ((t = strchr(cname, '-')) != NULL) *t = '_';
 
-  path = atk_dbus_get_path(accessible);
   sig = dbus_message_new_signal(path, klass, cname);
   g_free(cname);
   g_free(path);
@@ -226,7 +242,7 @@ emit(AtkObject  *accessible,
   dbus_message_iter_append_basic(&sub, (int) *type, &val);
   dbus_message_iter_close_container(&iter, &sub);
 
-  dbus_connection_send(app_data->droute.bus, sig, NULL);
+  dbus_connection_send(atk_adaptor_app_data->bus, sig, NULL);
   dbus_message_unref(sig);
 }
 
@@ -248,6 +264,15 @@ emit_rect(AtkObject  *accessible,
   gchar *path, *cname, *t;
   dbus_int32_t dummy = 0;
 
+  path = get_object_path (accessible);
+
+  /* Tough decision here
+   * We won't send events from accessible
+   * objects that have not yet been added to the accessible tree.
+   */
+  if (path == NULL)
+      return;
+
   if (!klass) klass = "";
   if (!major) major = "";
   if (!minor) minor = "";
@@ -260,7 +285,6 @@ emit_rect(AtkObject  *accessible,
   cname = g_strdup(major);
   while ((t = strchr(cname, '-')) != NULL) *t = '_';
 
-  path = atk_dbus_get_path(accessible);
   sig = dbus_message_new_signal(path, klass, cname);
   g_free(path);
   g_free(cname);
@@ -279,96 +303,7 @@ emit_rect(AtkObject  *accessible,
     dbus_message_iter_close_container (&variant, &sub);
   dbus_message_iter_close_container (&iter, &variant);
 
-  dbus_connection_send(app_data->droute.bus, sig, NULL);
-}
-
-/*---------------------------------------------------------------------------*/
-
-/*
- * The tree update listener handles the following Atk signals:
- *
- * Gtk:AtkObject:property-change
- * 
- * With the folowing property names:
- *
- * accessible-name
- * accessible-description
- * accessible-parent
- *
- * It updates the server side accessible-object database, which
- * will then syncronize with the client-side accessible cache.
- * 
- */
-static gboolean
-tree_update_listener (GSignalInvocationHint *signal_hint,
-                     guint                  n_param_values,
-                     const GValue          *param_values,
-                     gpointer               data)
-{
-  AtkObject *accessible;
-  AtkPropertyValues *values;
-  const gchar *pname = NULL;
-
-  accessible = g_value_get_object (&param_values[0]);
-  values = (AtkPropertyValues*) g_value_get_pointer (&param_values[1]);
-
-  pname = values[0].property_name;
-
-  if (strcmp (pname, "accessible-name") == 0)
-    {
-      atk_dbus_notify_change(accessible);
-    }
-  else if (strcmp (pname, "accessible-description") == 0)
-    {
-      atk_dbus_notify_change(accessible);
-    }
-  else if (strcmp (pname, "accessible-parent") == 0)
-    {
-      atk_dbus_notify_change(accessible);
-    }
-  return TRUE;
-}
-
-/* 
- * Handles the ATK signal 'Gtk:AtkObject:children-changed'.
- *
- * It updates the server side accessible-object database, which
- * will then syncronize with the client-side accessible cache.
- *
- */
-static gboolean
-tree_update_children_listener (GSignalInvocationHint *signal_hint,
-                              guint                  n_param_values,
-                              const GValue          *param_values,
-                              gpointer               data)
-{
-  AtkObject *accessible;
-  const gchar *detail = NULL;
-  AtkObject *child;
-  gboolean child_needs_unref = FALSE;
-
-  if (signal_hint->detail)
-    detail = g_quark_to_string (signal_hint->detail);
-
-  accessible = g_value_get_object (&param_values[0]);
-  if (!strcmp (detail, "add"))
-    {
-      gpointer child;
-      int index = g_value_get_uint (param_values + 1);
-      child = g_value_get_pointer (param_values + 2);
-      if (ATK_IS_OBJECT (child))
-       g_object_ref (child);
-      else
-       child = atk_object_ref_accessible_child (accessible, index);
-      if (ATK_IS_OBJECT (child))
-       {
-         atk_dbus_register_subtree (child);
-         g_object_unref (child);
-       }
-      else
-       atk_dbus_register_subtree(accessible);
-    }
-  return TRUE;
+  dbus_connection_send(atk_adaptor_app_data->bus, sig, NULL);
 }
 
 /*---------------------------------------------------------------------------*/
@@ -421,21 +356,21 @@ property_event_listener (GSignalInvocationHint *signal_hint,
   if (strcmp (pname, "accessible-table-summary") == 0)
     {
       otemp = atk_table_get_summary(ATK_TABLE (accessible));
-      stemp = atk_dbus_get_path(otemp);
+      stemp = get_object_path (otemp);
       emit(accessible, ITF_EVENT_OBJECT, PCHANGE, pname, 0, 0, DBUS_TYPE_OBJECT_PATH_AS_STRING, stemp);
     }
   else if (strcmp (pname, "accessible-table-column-header") == 0)
     {
       i = g_value_get_int (&(values->new_value));
       otemp = atk_table_get_column_header(ATK_TABLE (accessible), i);
-      stemp = atk_dbus_get_path(otemp);
+      stemp = get_object_path (otemp);
       emit(accessible, ITF_EVENT_OBJECT, PCHANGE, pname, 0, 0, DBUS_TYPE_OBJECT_PATH_AS_STRING, stemp);
     }
   else if (strcmp (pname, "accessible-table-row-header") == 0)
     {
       i = g_value_get_int (&(values->new_value));
       otemp = atk_table_get_row_header(ATK_TABLE (accessible), i);
-      stemp = atk_dbus_get_path(otemp);
+      stemp = get_object_path (otemp);
       emit(accessible, ITF_EVENT_OBJECT, PCHANGE, pname, 0, 0, DBUS_TYPE_OBJECT_PATH_AS_STRING, stemp);
     }
   else if (strcmp (pname, "accessible-table-row-description") == 0)
@@ -615,7 +550,7 @@ active_descendant_event_listener (GSignalInvocationHint *signal_hint,
   minor = g_quark_to_string (signal_hint->detail);
 
   detail1 = atk_object_get_index_in_parent (child);
-  s = atk_dbus_get_path(child);
+  s = get_object_path (child);
 
   emit(accessible, ITF_EVENT_OBJECT, name, "", detail1, 0, DBUS_TYPE_OBJECT_PATH_AS_STRING, s);
   g_free(s);
@@ -793,9 +728,6 @@ spi_atk_register_event_listeners (void)
 
   atk_bridge_focus_tracker_id = atk_add_focus_tracker (focus_tracker);
 
-  add_signal_listener (tree_update_listener,          "Gtk:AtkObject:property-change");
-  add_signal_listener (tree_update_children_listener, "Gtk:AtkObject:children-changed");
-
   add_signal_listener (property_event_listener,               "Gtk:AtkObject:property-change");
   add_signal_listener (window_event_listener,                 "window:create");
   add_signal_listener (window_event_listener,                 "window:destroy");