Add navigation helper functions for screen-reader and friends
[platform/upstream/at-spi2-core.git] / atspi / atspi-misc.c
index 0492b3f..e9a5a80 100644 (file)
@@ -110,7 +110,7 @@ _atspi_get_iface_num (const char *iface)
 GHashTable *
 _atspi_get_live_refs (void)
 {
-  if (!live_refs) 
+  if (!live_refs)
     {
       live_refs = g_hash_table_new (g_direct_hash, g_direct_equal);
     }
@@ -124,7 +124,7 @@ _atspi_bus ()
   if (!bus)
     atspi_init ();
   if (!bus)
-    g_error ("AT-SPI: COuldn't connect to accessibility bus. Is at-spi-bus-launcher running?");
+    g_error ("AT-SPI: Couldn't connect to accessibility bus. Is at-spi-bus-launcher running?");
   return bus;
 }
 
@@ -215,9 +215,11 @@ handle_get_bus_address (DBusPendingCall *pending, void *user_data)
                                           "/org/a11y/atspi/cache",
                                           atspi_interface_cache, "GetItems");
 
-   dbus_connection_send_with_reply (app->bus, message, &new_pending, 2000);
-  dbus_pending_call_set_notify (new_pending, handle_get_items, app, NULL);
+  dbus_connection_send_with_reply (app->bus, message, &new_pending, 2000);
   dbus_message_unref (message);
+  if (!new_pending)
+    return;
+  dbus_pending_call_set_notify (new_pending, handle_get_items, app, NULL);
 }
 
 static AtspiApplication *
@@ -247,9 +249,14 @@ get_application (const char *bus_name)
   message = dbus_message_new_method_call (bus_name, atspi_path_root,
                                           atspi_interface_application, "GetApplicationBusAddress");
 
-   dbus_connection_send_with_reply (app->bus, message, &pending, 2000);
-  dbus_pending_call_set_notify (pending, handle_get_bus_address, app, NULL);
+  dbus_connection_send_with_reply (app->bus, message, &pending, 2000);
   dbus_message_unref (message);
+  if (!pending)
+  {
+    g_hash_table_remove (app_hash, bus_name_dup);
+    return NULL;
+  }
+  dbus_pending_call_set_notify (pending, handle_get_bus_address, app, NULL);
   return app;
 }
 
@@ -377,17 +384,11 @@ handle_name_owner_changed (DBusConnection *bus, DBusMessage *message, void *user
     else if (!new[0])
       registry_lost = TRUE;
   }
-  else
+  else if (app_hash)
   {
-    AtspiAccessible *desktop = atspi_get_desktop (0);
-    GList *l;
-    for (l = desktop->children; l; l = l->next)
-    {
-      AtspiAccessible *child = l->data;
-      if (!strcmp (child->parent.app->bus_name, old))
-        g_object_run_dispose (G_OBJECT (child->parent.app));
-    }
-    g_object_unref (desktop);
+    AtspiApplication *app = g_hash_table_lookup (app_hash, old);
+    if (app && app->bus_name && !strcmp(app->bus_name, name))
+      g_object_run_dispose (G_OBJECT (app));
   }
   return DBUS_HANDLER_RESULT_HANDLED;
 }
@@ -597,31 +598,54 @@ _atspi_ref_accessible (const char *app, const char *path)
   return ref_accessible (app, path);
 }
 
-AtspiAccessible *
-_atspi_dbus_return_accessible_from_message (DBusMessage *message)
+static AtspiAccessible *
+_atspi_dbus_return_accessible_and_recurse_info_from_message_impl (DBusMessage *message, unsigned char *recurse)
 {
   DBusMessageIter iter;
   AtspiAccessible *retval = NULL;
   const char *signature;
+  const char *expected_signature = recurse ? "(so)y" : "(so)";
 
-  if (!message)
-    return NULL;
+  if (!message) return NULL;
 
   signature = dbus_message_get_signature (message);
-  if (!strcmp (signature, "(so)"))
+  if (!strcmp (signature, expected_signature))
   {
     dbus_message_iter_init (message, &iter);
     retval =  _atspi_dbus_return_accessible_from_iter (&iter);
+    if (recurse) {
+      unsigned char value = 0;
+      dbus_message_iter_get_basic (&iter, &value);
+      dbus_message_iter_next (&iter);
+      *recurse = (value != 0);
+    }
   }
   else
   {
-    g_warning ("AT-SPI: Called _atspi_dbus_return_accessible_from_message with strange signature %s", signature);
+    g_warning ("AT-SPI: Called _atspi_dbus_return_accessible_from_message with unexpected signature %s", signature);
   }
   dbus_message_unref (message);
   return retval;
 }
 
 AtspiAccessible *
+_atspi_dbus_return_accessible_from_message (DBusMessage *message)
+{
+  return _atspi_dbus_return_accessible_and_recurse_info_from_message_impl(message, NULL);
+}
+
+AtspiAccessible *
+_atspi_dbus_return_accessible_and_recurse_info_from_message(DBusMessage *message, unsigned char *recurse)
+{
+  if (recurse == NULL) {
+    g_error("AT-SPI: Called _atspi_dbus_return_accessible_and_recurse_info_from_message with NULL argument recurse");
+    dbus_message_unref (message);
+    return NULL;
+  }
+  return _atspi_dbus_return_accessible_and_recurse_info_from_message_impl(message, recurse);
+}
+
+AtspiAccessible *
 _atspi_dbus_return_accessible_from_iter (DBusMessageIter *iter)
 {
   const char *app_name, *path;
@@ -636,7 +660,7 @@ _atspi_dbus_return_hyperlink_from_message (DBusMessage *message)
   DBusMessageIter iter;
   AtspiHyperlink *retval = NULL;
   const char *signature;
-   
+
   if (!message)
     return NULL;
 
@@ -849,7 +873,7 @@ spi_display_name (void)
  *
  * Connects to the accessibility registry and initializes the SPI.
  *
- * Returns: 0 on success, 1 if already initialized, or an integer error code.  
+ * Returns: 0 on success, 1 if already initialized, or an integer error code.
  **/
 int
 atspi_init (void)
@@ -946,7 +970,7 @@ atspi_event_quit (void)
 /**
  * atspi_exit:
  *
- * Disconnects from #AtspiRegistry instances and releases 
+ * Disconnects from #AtspiRegistry instances and releases
  * any floating resources. Call only once at exit.
  *
  * Returns: 0 if there were no leaks, otherwise other integer values.
@@ -1121,9 +1145,9 @@ _atspi_dbus_call_partial_va (gpointer obj,
 {
   AtspiObject *aobj = ATSPI_OBJECT (obj);
   DBusError err;
-    DBusMessage *msg = NULL, *reply = NULL;
-    DBusMessageIter iter;
-    const char *p;
+  DBusMessage *msg = NULL, *reply = NULL;
+  DBusMessageIter iter;
+  const char *p;
 
   dbus_error_init (&err);
 
@@ -1450,7 +1474,7 @@ get_accessibility_bus_address_x11 (void)
       g_warning ("Could not open X display");
       return NULL;
     }
-      
+
   AT_SPI_BUS = XInternAtom (bridge_display, "AT_SPI_BUS", False);
   XGetWindowProperty (bridge_display,
                      XDefaultRootWindow (bridge_display),
@@ -1498,7 +1522,7 @@ get_accessibility_bus_address_dbus (void)
     dbus_error_free (&error);
     return NULL;
   }
-  
+
   {
     const char *tmp_address;
     if (!dbus_message_get_args (reply,
@@ -1513,7 +1537,7 @@ get_accessibility_bus_address_dbus (void)
     address = g_strdup (tmp_address);
     dbus_message_unref (reply);
   }
-  
+
   return address;
 }
 
@@ -1576,7 +1600,7 @@ atspi_get_a11y_bus (void)
          return NULL;
        }
     }
-  
+
   /* Simulate a weak ref on the bus */
   dbus_connection_set_data (a11y_bus, a11y_dbus_slot, a11y_bus, a11y_bus_free);
 
@@ -1585,23 +1609,23 @@ atspi_get_a11y_bus (void)
 
 /**
  * atspi_set_timeout:
- *  @val: The timeout value, in milliseconds, or -1 to disable the timeout.
- *  @startup_time: The amount of time, in milliseconds, to allow to pass
- *  before enforcing timeouts on an application. Can be used to prevent
- *  timeout exceptions if an application is likely to block for an extended
- *  period of time on initialization. -1 can be passed to disable this
- *  behavior.
+ * @val: The timeout value, in milliseconds, or -1 to disable the timeout.
+ * @startup_time: The amount of time, in milliseconds, to allow to pass
+ * before enforcing timeouts on an application. Can be used to prevent
+ * timeout exceptions if an application is likely to block for an extended
+ * period of time on initialization. -1 can be passed to disable this
+ * behavior.
  *
- *  Set the timeout used for method calls. If this is not set explicitly,
- *  a default of 0.8 ms is used.
- *  Note that at-spi2-registryd currently uses a timeout of 3 seconds when
- *  sending a keyboard event notification. This means that, if an AT makes
- *  a call in response to the keyboard notification and the application
- *  being called does not respond before the timeout is reached,
- *  at-spi2-registryd will time out on the keyboard event notification and
- *  pass the key onto the application (ie, reply to indicate that the key
- *  was not consumed), so this may make it undesirable to set a timeout
- *  larger than 3 seconds.
+ * Set the timeout used for method calls. If this is not set explicitly,
+ * a default of 0.8 ms is used.
+ * Note that at-spi2-registryd currently uses a timeout of 3 seconds when
+ * sending a keyboard event notification. This means that, if an AT makes
+ * a call in response to the keyboard notification and the application
+ * being called does not respond before the timeout is reached,
+ * at-spi2-registryd will time out on the keyboard event notification and
+ * pass the key onto the application (ie, reply to indicate that the key
+ * was not consumed), so this may make it undesirable to set a timeout
+ * larger than 3 seconds.
  *
  * By default, the normal timeout is set to 800 ms, and the application startup
  * timeout is set to 15 seconds.
@@ -1705,7 +1729,7 @@ atspi_role_get_name (AtspiRole role)
   return NULL;
 }
 
-void
+GHashTable *
 _atspi_dbus_update_cache_from_dict (AtspiAccessible *accessible, DBusMessageIter *iter)
 {
   GHashTable *cache = _atspi_accessible_ref_cache (accessible);
@@ -1765,9 +1789,11 @@ _atspi_dbus_update_cache_from_dict (AtspiAccessible *accessible, DBusMessageIter
       g_value_set_boxed (val, &extents);
     }
     if (val)
-      g_hash_table_insert (cache, g_strdup (key), val); 
+      g_hash_table_insert (cache, g_strdup (key), val);
     dbus_message_iter_next (&iter_dict);
   }
+
+  return cache;
 }
 
 gboolean