#include <string.h>
#include "bridge.h"
+#include "tree-adaptor.h"
#include "accessible-register.h"
-/* TODO
- * Need to add concurrency support.
- */
-
-#define ATK_BRIDGE_OBJECT_PATH_PREFIX "/org/freedesktop/atspi/accessible"
-#define ATK_BRIDGE_OBJECT_REFERENCE_TEMPLATE ATK_BRIDGE_OBJECT_PATH_PREFIX "/%d"
-#define ATK_BRIDGE_PATH_PREFIX_LENGTH 33
-
/*
* This module is responsible for keeping track of all the AtkObjects in
* the application, so that they can be accessed remotely and placed in
*
* To access an AtkObject remotely we need to provide a D-Bus object
* path for it. The D-Bus object paths used have a standard prefix
- * (ATK_BRIDGE_OBJECT_PATH_PREFIX). Appended to this prefix is a string
+ * (SPI_ATK_OBJECT_PATH_PREFIX). Appended to this prefix is a string
* representation of an integer reference. So to access an AtkObject
* remotely we keep a Hashtable that maps the given reference to
* the AtkObject pointer. An object in this hash table is said to be 'registered'.
* the client side cache. This is done using the 'update' signal of the
* org.freedesktop.atspi.Tree interface. The update signal should send out
* all of the cacheable data for an Accessible object.
+ *
+ */
+
+/*
+ * FIXME
+ *
+ * This code seems very brittle.
+ * I would prefer changes to be made to
+ * gail and the ATK interface so that all Accessible
+ * objects are registered with an exporting module.
+ *
+ * This is the same system as Qt has with the QAccessibleBridge
+ * and QAccessibleBridgePlugin. It entails some rather
+ * large structural changes to ATK though:
+ *
+ * Removing infinite spaces (Child access no longer references child).
+ * Removing lazy creation of accessible objects.
*/
-GHashTable *ref2ptr = NULL; /* Used for converting a D-Bus path (Reference) to the object pointer */
+#define SPI_ATK_OBJECT_PATH_PREFIX "/org/freedesktop/atspi/accessible"
+#define SPI_ATK_OBJECT_PATH_DESKTOP "/desktop"
-static guint counter = 1;
+#define SPI_ATK_PATH_PREFIX_LENGTH 33
+#define SPI_ATK_OBJECT_REFERENCE_TEMPLATE SPI_ATK_OBJECT_PATH_PREFIX "/%d"
+
+
+static GHashTable *ref2ptr = NULL; /* Used for converting a D-Bus path (Reference) to the object pointer */
+static GHashTable *objects_with_subrefs = NULL;
+static GHashTable *leased_refs = NULL;
+static int leased_refs_count;
+
+static guint reference_counter = 0;
+
+static GStaticRecMutex registration_mutex = G_STATIC_REC_MUTEX_INIT;
+
+/*---------------------------------------------------------------------------*/
+
+static GStaticMutex recursion_check_guard = G_STATIC_MUTEX_INIT;
+static gboolean recursion_check = FALSE;
+static int last_gc_time;
+
+static void deregister_sub_accessible (gpointer key, gpointer obj_data, gpointer iter);
+
+static void deregister_sub_hyperlink (gpointer key, gpointer obj_data, gpointer iter);
+
+static gboolean
+recursion_check_and_set ()
+{
+ gboolean ret;
+ g_static_mutex_lock (&recursion_check_guard);
+ ret = recursion_check;
+ recursion_check = TRUE;
+ g_static_mutex_unlock (&recursion_check_guard);
+ return ret;
+}
+
+static void
+recursion_check_unset ()
+{
+ g_static_mutex_lock (&recursion_check_guard);
+ recursion_check = FALSE;
+ g_static_mutex_unlock (&recursion_check_guard);
+}
/*---------------------------------------------------------------------------*/
static guint
assign_reference(void)
{
- counter++;
+ reference_counter++;
/* Reference of 0 not allowed as used as direct key in hash table */
- if (counter == 0)
- counter++;
+ if (reference_counter == 0)
+ reference_counter++;
+ /* TODO: If we've wrapped, ensure that two objects don't have the same ref */
+ return reference_counter;
}
-/*---------------------------------------------------------------------------*/
+/*
+ * Returns the reference of the object, or 0 if it is not registered.
+ */
+static guint
+gobject_to_ref (GObject *gobj)
+{
+ return GPOINTER_TO_INT(g_object_get_data (gobj, "dbus-id"));
+}
-void
-atk_dbus_foreach_registered(GHFunc func, gpointer data)
+static guint
+object_to_ref (AtkObject *accessible)
{
- g_hash_table_foreach(ref2ptr, func, data);
+ return gobject_to_ref (G_OBJECT (accessible));
+}
+
+static guint
+hyperlink_to_ref (AtkHyperlink *link)
+{
+ return gobject_to_ref (G_OBJECT (link));
+}
+
+/*
+ * Converts the Accessible object reference to its D-Bus object path
+ */
+gchar *
+atk_dbus_ref_to_path (guint ref)
+{
+ return g_strdup_printf(SPI_ATK_OBJECT_REFERENCE_TEMPLATE, ref);
}
/*---------------------------------------------------------------------------*/
/*
- * Called when a registered AtkObject is deleted.
- * Removes the AtkObject from the reference lookup tables.
- * Sets the client side cache to be updated.
+ * Callback for when a registered AtkObject is destroyed.
+ *
+ * Removes the AtkObject from the reference lookup tables, meaning
+ * it is no longer exposed over D-Bus.
*/
static void
-deregister_accessible(gpointer data, GObject *accessible)
+deregister_object (gpointer data, GObject *gobj)
{
guint ref;
- gchar *path;
+ GHashTable *subrefs_atk;
+ GHashTable *subrefs_hyperlink;
+ g_return_if_fail (ATK_IS_OBJECT (gobj) || ATK_IS_HYPERLINK (gobj));
+
+ subrefs_atk = (GHashTable *) g_object_get_data (gobj, "dbus-subrefs-atk");
+ subrefs_hyperlink = (GHashTable *) g_object_get_data (gobj, "dbus-subrefs-hyperlink");
+
+ if (subrefs_atk)
+ {
+ g_hash_table_foreach (subrefs_atk, deregister_sub_accessible, data);
+ g_hash_table_unref (subrefs_atk);
+ }
+
+ if (subrefs_hyperlink)
+ {
+ g_hash_table_foreach (subrefs_hyperlink, deregister_sub_hyperlink, data);
+ g_hash_table_unref (subrefs_hyperlink);
+ }
+
+ if (subrefs_atk || subrefs_hyperlink)
+ g_hash_table_remove (objects_with_subrefs, gobj);
+
+ if (ATK_IS_OBJECT (gobj))
+ {
+ ref = object_to_ref (ATK_OBJECT (gobj));
+ if (ref != 0)
+ {
+ spi_emit_cache_removal (ref, atk_adaptor_app_data->bus);
+ g_hash_table_remove(ref2ptr, GINT_TO_POINTER(ref));
+ }
+ }
+ }
- g_assert(ATK_IS_OBJECT(accessible));
+static void
+deregister_sub_accessible (gpointer key, gpointer obj_data, gpointer iter)
+{
+ GObject *obj = G_OBJECT (obj_data);
+ deregister_object (NULL, obj);
+ g_hash_table_remove (leased_refs, obj);
+ g_object_unref (obj);
+}
+static void
+deregister_sub_hyperlink (gpointer key, gpointer obj_data, gpointer iter)
+{
+ guint ref;
+ GObject *ghyperlink = G_OBJECT (obj_data);
- ref = atk_dbus_object_to_ref (ATK_OBJECT(accessible));
+ g_return_if_fail (ATK_IS_HYPERLINK (ghyperlink));
+ ref = gobject_to_ref (ghyperlink);
if (ref != 0)
{
g_hash_table_remove(ref2ptr, GINT_TO_POINTER(ref));
- /*
- * TODO
- * Pyatspi client side exceptions have occured indicating
- * that an object has been removed twice.
- * This should not be possible and needs investigation.
- */
- spi_emit_cache_removal (ref, atk_adaptor_app_data->bus);
}
+ g_object_unref (ghyperlink);
}
-/*---------------------------------------------------------------------------*/
+static void
+register_gobject (GObject *gobj, GObject *container)
+{
+ guint ref;
+ g_return_if_fail (G_IS_OBJECT(gobj));
-/* FIXME
- * Horrible hack warning.
- *
- * Problem 1:
- *
- * In an ideal world there would be a signal "Accessible created" that we could
- * use to register all new AtkObjects with D-Bus. The AtkObjects would be
- * created at the time of their implementing widget. This is how things
- * happen in Qt and its damn sensible.
- *
- * In GTK Gail objects are created 'lazily' when they are accessed. This is
- * presumably an optimization to reduce memory. I happen to think its a very
- * very bad one. Anyway, there is no signal, and Gail objects don't get created
- * automatically for each widget, so how do we register AtkObjects with D-Bus?
- *
- * Answer, we have one guaranteed AtkObject, the root. We traverse the tree provided
- * by the root object, registering as we go. When new objects are created we use
- * the children-changed signal of their parent to find out. As we don't know
- * if a new object has any children that have not been registered we must traverse
- * the decendants of every new object to find AtkObjects that have not been registered.
- *
- * Problem 2:
- *
- * For whatever reason events are generated for objects that have not yet been
- * registered with D-Bus. This means that when translating an Atk signal to an
- * AT-SPI one it may be neccessary to register objects first.
- *
- * The caveat is that when registering an object somewhere in the middle of the
- * AtkObject tree there is no guarantee that its parent objects have been registered.
- * So when registering a new object we also need to register its parents back to the
- * root object.
- *
- * Other solutions:
- *
- * The original solution was completely recursive. So when the reference of an AtkObject
- * was requested it would be registered there and then. I didn't like the recursive
- * solution, it was a very very deep stack in some cases.
- *
- */
+ ref = assign_reference();
+
+ g_hash_table_insert (ref2ptr, GINT_TO_POINTER(ref), gobj);
+ g_object_set_data (G_OBJECT(gobj), "dbus-id", GINT_TO_POINTER(ref));
+ g_object_weak_ref(G_OBJECT(gobj), deregister_object, NULL);
+
+ if (container)
+ {
+ GHashTable *subrefs = (GHashTable *) g_object_get_data (G_OBJECT (container), "dbus-subrefs-atk");
+ if (!subrefs)
+ {
+ subrefs = g_hash_table_new(g_direct_hash, g_direct_equal);
+ g_object_set_data (G_OBJECT (container), "dbus-subrefs-atk", subrefs);
+ }
+ g_hash_table_insert (subrefs, GINT_TO_POINTER(ref), gobj);
+ g_hash_table_insert (objects_with_subrefs, gobj, subrefs);
+ }
+
+ if (ATK_IS_HYPERLINK (gobj))
+ g_object_ref (gobj);
+ else if (ATK_IS_OBJECT (gobj))
+ {
+ AtkObject *accessible = ATK_OBJECT (gobj);
+ AtkStateSet *state = atk_object_ref_state_set (accessible);
+ if (atk_state_set_contains_state (state, ATK_STATE_TRANSIENT))
+ {
+ g_object_ref (gobj);
+ }
+ g_object_unref (state);
+ }
+}
/*
- * This function registers the object so that it is exported
- * over D-Bus and schedules an update to client side cache.
+ * Called to register an AtkObject with AT-SPI and expose it over D-Bus.
*/
-static guint
-export (GList **uplist, AtkObject *accessible)
+static void
+register_accessible (AtkObject *accessible, AtkObject *container)
{
- guint ref;
- gchar *path;
+ g_return_if_fail (ATK_IS_OBJECT(accessible));
- g_assert(ATK_IS_OBJECT(accessible));
-
- ref = assign_reference();
+ register_gobject (G_OBJECT (accessible), G_OBJECT (container));
+}
- g_hash_table_insert (ref2ptr, GINT_TO_POINTER(ref), accessible);
- g_object_set_data (G_OBJECT(accessible), "dbus-id", GINT_TO_POINTER(ref));
- g_object_weak_ref(G_OBJECT(accessible), deregister_accessible, NULL);
+static void
+register_hyperlink (AtkHyperlink *hyperlink, AtkObject *container)
+{
+ guint ref;
+ g_return_if_fail (ATK_IS_HYPERLINK (hyperlink));
+ g_return_if_fail (container);
- *uplist = g_list_prepend (*uplist, accessible);
+ ref = assign_reference();
- return ref;
+ g_hash_table_insert (ref2ptr, GINT_TO_POINTER(ref), hyperlink);
+ g_object_set_data (G_OBJECT(hyperlink), "dbus-id", GINT_TO_POINTER(ref));
+ g_object_ref (G_OBJECT (hyperlink));
+
+ GHashTable *subrefs = (GHashTable *) g_object_get_data (G_OBJECT (container), "dbus-subrefs-hyperlink");
+ if (!subrefs)
+ {
+ subrefs = g_hash_table_new(g_direct_hash, g_direct_equal);
+ g_object_set_data (G_OBJECT (container), "dbus-subrefs-hyperlink", GINT_TO_POINTER(ref));
+ }
+ g_hash_table_insert (subrefs, GINT_TO_POINTER(ref), hyperlink);
}
+/*---------------------------------------------------------------------------*/
+
+#ifdef SPI_ATK_DEBUG
/*
- * Exports all the dependencies of an AtkObject.
- * This is the subtree and the ancestors.
+ * This function checks that the ref-count of an accessible
+ * is greater than 1.
*
- * Dependencies are the objects that get included in the
- * cache, and therefore need to be registered before the
- * update signal is sent.
+ * There is not currently any remote reference counting
+ * in AT-SPI D-Bus so objects that are remotely owned are not
+ * allowed.
*
- * This does a depth first traversal of a subtree of AtkObject
- * and exports them as Accessible objects if they are not exported
- * already.
- *
- * It exports all ancestors of the object if they are not
- * exported already.
+ * TODO Add debug wrapper
*/
-static guint
-export_deps (AtkObject *accessible)
+static gboolean
+non_owned_accessible (AtkObject *accessible)
{
- AtkObject *current, *tmp;
- GQueue *stack;
- GList *uplist = NULL;
- guint i, ref;
- gboolean recurse;
-
+ if ((G_OBJECT (accessible))->ref_count <= 1)
+ {
+ g_warning ("AT-SPI: Child referenced that is not owned by its parent");
+ return TRUE;
+ }
+ else
+ {
+ return FALSE;
+ }
+}
+#endif /* SPI_ATK_DEBUG */
- /* Export subtree including object itself */
- /*========================================*/
- ref = atk_dbus_object_to_ref (accessible);
- if (ref)
- return ref;
+/*---------------------------------------------------------------------------*/
- stack = g_queue_new ();
+/* TRUE if we should not keep this object / tell the AT about it
+ * Currently true if TRANSIENT and not SHOWING
+ */
+static gboolean
+object_is_moot (AtkObject *accessible)
+{
+ AtkStateSet *state;
+ gboolean result = FALSE;
+
+ /* This is dangerous, refing the state set
+ * seems to do wierd things to the tree & cause recursion
+ * by modifying the tree alot.
+ */
+ state = atk_object_ref_state_set (accessible);
+ if ( atk_state_set_contains_state (state, ATK_STATE_TRANSIENT) &&
+ !atk_state_set_contains_state (state, ATK_STATE_SHOWING))
+ {
+ result = TRUE;
+ }
+ g_object_unref (state);
+
+ return result;
+}
- current = g_object_ref (accessible);
- ref = export (&uplist, current);
- g_queue_push_head (stack, GINT_TO_POINTER (0));
+static void
+append_children (AtkObject *accessible, GQueue *traversal)
+{
+ AtkObject *current;
+ guint i;
+ gint count = atk_object_get_n_accessible_children (accessible);
- /*
- * The index held on the stack is the next child node
- * that needs processing at the corresponding level in the tree.
- */
- while (!g_queue_is_empty (stack))
+ if (count < 0) count = 0;
+ for (i =0; i < count; i++)
{
- /* This while loop finds the next node that needs processing,
- * if one exists.
- */
- i = GPOINTER_TO_INT(g_queue_peek_head (stack));
- recurse = FALSE;
- while (i < atk_object_get_n_accessible_children (current) &&
- recurse == FALSE)
+ current = atk_object_ref_accessible_child (accessible, i);
+ if (current)
{
- tmp = atk_object_ref_accessible_child (current, i);
- if (!atk_dbus_object_to_ref (tmp))
- {
- recurse = TRUE;
- }
- else
- {
- i++;
- g_object_unref (G_OBJECT (tmp));
- }
+#ifdef SPI_ATK_DEBUG
+ non_owned_accessible (current);
+#endif
+ g_queue_push_tail (traversal, current);
}
- if (recurse)
- {
- /* Still children to process */
- current = tmp;
- export (&uplist, current);
- /* Update parent nodes next child index */
- g_queue_peek_head_link (stack)->data = GINT_TO_POINTER (i+1);
- /* Push a new child index for the current node */
- g_queue_push_head (stack, GINT_TO_POINTER (0));
- }
- else
+ }
+}
+
+/*
+ * Registers a subtree of accessible objects
+ * rooted at the accessible object provided.
+ *
+ * The leaf nodes do not have their children
+ * registered. A node is considered a leaf
+ * if it has the state "manages-descendants"
+ * or if it has already been registered.
+ */
+void
+register_subtree (AtkObject *accessible)
+{
+ AtkObject *current;
+ GQueue *traversal;
+ GQueue *emit_update;
+
+ g_return_if_fail (ATK_IS_OBJECT (accessible));
+
+ traversal = g_queue_new ();
+ emit_update = g_queue_new ();
+
+ g_object_ref (accessible);
+ g_queue_push_tail (traversal, accessible);
+
+ while (!g_queue_is_empty (traversal))
+ {
+ current = g_queue_pop_head (traversal);
+ g_queue_push_tail (emit_update, current);
+ if (!object_to_ref (current))
{
- /* No more children, move to parent */
- tmp = current;
- current = atk_object_get_parent (current);
- g_object_unref (G_OBJECT (tmp));
- g_queue_pop_head (stack);
+ register_accessible (current, NULL);
+#ifdef SPI_ATK_DEBUG
+ g_debug ("REG - %s - %d - %s", atk_object_get_name (current),
+ atk_object_get_role (current),
+ atk_dbus_object_to_path (current));
+#endif
+ append_children (current, traversal);
}
}
- /* Export all neccessary ancestors of the object */
- /*===============================================*/
- current = atk_object_get_parent (accessible);
- while (current && !atk_dbus_object_to_ref (current))
+ while (!g_queue_is_empty (emit_update))
{
- export (&uplist, current);
+ current = g_queue_pop_head (emit_update);
+ spi_emit_cache_update (current, atk_adaptor_app_data->bus);
+ g_object_unref (G_OBJECT (current));
}
- spi_emit_cache_update (uplist, atk_adaptor_app_data->bus);
- g_list_free (uplist);
- return ref;
+ g_queue_free (traversal);
+ g_queue_free (emit_update);
}
/*---------------------------------------------------------------------------*/
-/* Called to register an AtkObject with AT-SPI and expose it over D-Bus. */
-guint
-atk_dbus_register_accessible (AtkObject *accessible)
-{
- guint ref;
- g_assert(ATK_IS_OBJECT(accessible));
-
- return export_deps (accessible);
-}
-
-/* Called when an already registered object is updated in such a
+/*
+ * Called when an already registered object is updated in such a
* way that client side cache needs to be updated.
*/
-guint
-atk_dbus_update_accessible (AtkObject *accessible)
+static void
+update_accessible (AtkObject *accessible)
{
guint ref = 0;
- GList *uplist = NULL;
- g_assert(ATK_IS_OBJECT(accessible));
+ g_return_if_fail (ATK_IS_OBJECT(accessible));
- ref = atk_dbus_object_to_ref (accessible);
+ ref = object_to_ref (accessible);
if (ref)
{
- uplist = g_list_prepend (uplist, accessible);
- spi_emit_cache_update (uplist, atk_adaptor_app_data->bus);
- g_list_free (uplist);
+ spi_emit_cache_update (accessible, atk_adaptor_app_data->bus);
}
- return ref;
}
/*---------------------------------------------------------------------------*/
-/*
- * Returns the reference of the object, or 0 if it is not exported over D-Bus.
- */
-guint
-atk_dbus_object_to_ref (AtkObject *accessible)
-{
- return GPOINTER_TO_INT(g_object_get_data (G_OBJECT (accessible), "dbus-id"));
-}
-
-/*
- * Converts the Accessible object reference to its D-Bus object path
- */
-gchar *
-atk_dbus_ref_to_path (guint ref)
+void
+atk_dbus_foreach_registered(GHFunc func, gpointer data)
{
- return g_strdup_printf(ATK_BRIDGE_OBJECT_REFERENCE_TEMPLATE, ref);
+ g_hash_table_foreach(ref2ptr, func, data);
}
/*
* Used to lookup an AtkObject from its D-Bus path.
*/
-AtkObject *
-atk_dbus_path_to_object (const char *path)
+GObject *
+atk_dbus_path_to_gobject (const char *path)
{
guint index;
void *data;
- g_assert (path);
+ g_return_val_if_fail (path, NULL);
- if (strncmp(path, ATK_BRIDGE_OBJECT_PATH_PREFIX, ATK_BRIDGE_PATH_PREFIX_LENGTH) != 0)
+ if (strncmp(path, SPI_ATK_OBJECT_PATH_PREFIX, SPI_ATK_PATH_PREFIX_LENGTH) != 0)
return NULL;
- path += ATK_BRIDGE_PATH_PREFIX_LENGTH; /* Skip over the prefix */
+ path += SPI_ATK_PATH_PREFIX_LENGTH; /* Skip over the prefix */
- if (path[0] == '\0')
- return atk_get_root();
+ if (!g_strcmp0 (SPI_ATK_OBJECT_PATH_DESKTOP, path))
+ return G_OBJECT (atk_get_root());
if (path[0] != '/')
return NULL;
index = atoi (path);
data = g_hash_table_lookup (ref2ptr, GINT_TO_POINTER(index));
if (data)
- return ATK_OBJECT (data);
+ {
+ GObject *gobj = G_OBJECT (data);
+ g_object_set_data (gobj, "last-ref-time", (gpointer) time (NULL));
+ return gobj;
+ }
else
return NULL;
}
+AtkObject *
+atk_dbus_path_to_object (const char *path)
+{
+ return ATK_OBJECT (atk_dbus_path_to_gobject (path));
+}
+
+/*
+ * TODO WARNING HACK This function is dangerous.
+ * It should only be called before sending an event on an
+ * object that has not already been registered.
+ */
+gchar *
+atk_dbus_object_attempt_registration (AtkObject *accessible)
+{
+ guint ref;
+
+ ref = object_to_ref (accessible);
+ if (!ref)
+ {
+ /* See if the object is attached to the main tree */
+ AtkObject *current, *prev = NULL;
+ guint cref = 0;
+
+ /* This should iterate until it hits a NULL or registered parent */
+ prev = accessible;
+ current = atk_object_get_parent (accessible);
+ if (current)
+ cref = object_to_ref (current);
+ while (current && !cref)
+ {
+ prev = current;
+ current = atk_object_get_parent (current);
+ if (current)
+ cref = object_to_ref (current);
+ }
+
+ /* A registered parent, with non-registered child, has been found */
+ if (current)
+ {
+ register_subtree (prev);
+ }
+
+ /* The object SHOULD be registered now. If it isn't - I give up */
+ ref = object_to_ref (accessible);
+ if (ref)
+ {
+ return atk_dbus_ref_to_path (ref);
+ }
+ else
+ {
+#ifdef SPI_ATK_DEBUG
+ g_debug ("AT-SPI: Could not register a non-attached accessible object");
+#endif
+ return NULL;
+ }
+ }
+ else
+ {
+ return atk_dbus_ref_to_path (ref);
+ }
+}
+
/*
* Used to lookup a D-Bus path from the AtkObject.
*/
+static gchar *
+atk_dbus_gobject_to_path_internal (GObject *gobj, gboolean do_register, GObject *container)
+{
+ guint ref;
+
+ ref = gobject_to_ref (gobj);
+ if (!ref && do_register)
+ {
+ register_gobject (gobj, container);
+ ref = gobject_to_ref (gobj);
+ }
+
+ if (!ref)
+ return NULL;
+ else
+ return atk_dbus_ref_to_path (ref);
+}
+
+gchar *
+atk_dbus_object_to_path (AtkObject *accessible, gboolean do_register)
+{
+ AtkObject *container = (accessible && do_register? atk_object_get_parent (accessible): NULL);
+ return atk_dbus_gobject_to_path_internal (G_OBJECT (accessible), do_register, G_OBJECT (container));
+}
+
+gchar *
+atk_dbus_sub_object_to_path (GObject *gobj, GObject *container)
+{
+ return atk_dbus_gobject_to_path_internal (gobj, TRUE, container);
+}
+
gchar *
-atk_dbus_object_to_path (AtkObject *accessible)
+atk_dbus_hyperlink_to_path (AtkHyperlink *hyperlink, AtkObject *container)
{
guint ref;
- g_assert(ATK_IS_OBJECT(accessible));
- ref = atk_dbus_object_to_ref (accessible);
+ ref = gobject_to_ref (G_OBJECT (hyperlink));
+ if (!ref && container)
+ {
+ register_hyperlink (hyperlink, container);
+ ref = hyperlink_to_ref (hyperlink);
+ }
+
if (!ref)
return NULL;
else
return atk_dbus_ref_to_path (ref);
}
+gchar *
+atk_dbus_desktop_object_path ()
+{
+ return g_strdup (SPI_ATK_OBJECT_PATH_PREFIX SPI_ATK_OBJECT_PATH_DESKTOP);
+}
+
+/*---------------------------------------------------------------------------*/
+
+typedef gboolean (*TreeUpdateAction) (GSignalInvocationHint *signal_hint,
+ guint n_param_values,
+ const GValue *param_values,
+ gpointer data,
+ AtkObject *accessible);
+
+/*
+ * Events are not evaluated for non-registered accessibles.
+ *
+ * When a property change is made on a registered accessible
+ * the client side cache should be updated.
+ *
+ * When a parent is changed the subtree is de-registered
+ * if the parent is not attached to the root accessible.
+ */
+/* TODO Turn this function into a macro? */
+static gboolean
+tree_update_wrapper (GSignalInvocationHint *signal_hint,
+ guint n_param_values,
+ const GValue *param_values,
+ gpointer data,
+ TreeUpdateAction action)
+{
+ AtkObject *accessible;
+
+ g_static_rec_mutex_lock (®istration_mutex);
+
+ /* Ensure that only registered accessibles
+ * have their signals processed.
+ */
+ accessible = ATK_OBJECT(g_value_get_object (¶m_values[0]));
+ g_return_val_if_fail (ATK_IS_OBJECT (accessible), TRUE);
+
+ if (object_to_ref (accessible))
+ {
+#ifdef SPI_ATK_DEBUG
+ if (recursion_check_and_set ())
+ g_warning ("AT-SPI: Recursive use of registration module");
+
+ g_debug ("AT-SPI: Tree update listener");
+#endif
+ action (signal_hint, n_param_values, param_values, data, accessible);
+
+ recursion_check_unset ();
+ }
+
+ g_static_rec_mutex_unlock (®istration_mutex);
+
+ return TRUE;
+}
+
+static gboolean
+maybe_expire_lease (gpointer key, gpointer obj_data, gpointer iter)
+{
+ time_t secs = time (NULL) - (time_t)obj_data;
+
+ if (secs < 30)
+ return FALSE;
+ deregister_sub_accessible (key, obj_data, iter);
+ return TRUE;
+}
+
+static void
+expire_old_leases_in (gpointer key, gpointer obj_data, gpointer iter)
+{
+ g_hash_table_foreach_remove ((GHashTable *)obj_data, maybe_expire_lease, NULL);
+}
+
+static void
+expire_old_leases ()
+{
+ g_hash_table_foreach (objects_with_subrefs, expire_old_leases_in, NULL);
+}
+
+static gboolean
+tree_update_state_action (GSignalInvocationHint *signal_hint,
+ guint n_param_values,
+ const GValue *param_values,
+ gpointer data,
+ AtkObject *accessible)
+{
+ const gchar *name;
+ gboolean state;
+
+ if (n_param_values < 3)
+ {
+ g_warning ("at-spi: Not enough params in state-changed signal");
+ return TRUE;
+ }
+
+ name = g_value_get_string (param_values + 1);
+ state = g_value_get_boolean (param_values + 2);
+ if (!strcmp (name, "visible"))
+ {
+ AtkStateSet *set = atk_object_ref_state_set (accessible);
+ if (atk_state_set_contains_state (set, ATK_STATE_TRANSIENT))
+ {
+ if (state == 0)
+ {
+ g_hash_table_insert (leased_refs, accessible, (gpointer) time (NULL));
+ leased_refs_count++;
+ /* todo: Set to a high number: 5 for dbg. */
+ if (leased_refs_count > 5)
+ expire_old_leases ();
+ }
+ else
+ {
+ g_hash_table_remove (leased_refs, accessible);
+ leased_refs_count--;
+ }
+ }
+ g_object_unref (set);
+ }
+
+ update_accessible (accessible);
+ return TRUE;
+}
+
+static gboolean
+tree_update_state_listener (GSignalInvocationHint *signal_hint,
+ guint n_param_values,
+ const GValue *param_values,
+ gpointer data)
+{
+ tree_update_wrapper (signal_hint, n_param_values, param_values, data, tree_update_state_action);
+ return TRUE;
+}
+
+static gboolean
+tree_update_property_action (GSignalInvocationHint *signal_hint,
+ guint n_param_values,
+ const GValue *param_values,
+ gpointer data,
+ AtkObject *accessible)
+{
+ AtkPropertyValues *values;
+ const gchar *pname = NULL;
+
+ values = (AtkPropertyValues*) g_value_get_pointer (¶m_values[1]);
+ pname = values[0].property_name;
+ if (strcmp (pname, "accessible-name") == 0 ||
+ strcmp (pname, "accessible-description") == 0 ||
+ strcmp (pname, "accessible-parent") == 0 ||
+ strcmp (pname, "accessible-role") == 0)
+ {
+ update_accessible (accessible);
+ }
+ /* Parent value us updated by child-add signal of parent object */
+ return TRUE;
+}
+
+static gboolean
+tree_update_property_listener (GSignalInvocationHint *signal_hint,
+ guint n_param_values,
+ const GValue *param_values,
+ gpointer data)
+{
+ tree_update_wrapper (signal_hint, n_param_values, param_values, data, tree_update_property_action);
+ return TRUE;
+}
+
+static gboolean
+tree_update_children_action (GSignalInvocationHint *signal_hint,
+ guint n_param_values,
+ const GValue *param_values,
+ gpointer data,
+ AtkObject *accessible)
+{
+ const gchar *detail = NULL;
+ AtkObject *child;
+
+ if (signal_hint->detail)
+ detail = g_quark_to_string (signal_hint->detail);
+
+ 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))
+ {
+ child = atk_object_ref_accessible_child (accessible, index);
+#ifdef SPI_ATK_DEBUG
+ non_owned_accessible (child);
+#endif
+ }
+ register_subtree (child);
+ update_accessible (accessible);
+ }
+ return TRUE;
+}
+
+static gboolean
+tree_update_children_listener (GSignalInvocationHint *signal_hint,
+ guint n_param_values,
+ const GValue *param_values,
+ gpointer data)
+{
+ tree_update_wrapper (signal_hint, n_param_values, param_values, data, tree_update_children_action);
+ return TRUE;
+}
+
/*---------------------------------------------------------------------------*/
+static void
+spi_atk_register_toplevel_added (AtkObject *accessible,
+ guint index,
+ AtkObject *child)
+{
+ g_static_rec_mutex_lock (®istration_mutex);
+
+ g_return_if_fail (ATK_IS_OBJECT (accessible));
+
+ if (object_to_ref (accessible))
+ {
+#ifdef SPI_ATK_DEBUG
+ if (recursion_check_and_set ())
+ g_warning ("AT-SPI: Recursive use of registration module");
+
+ g_debug ("AT-SPI: Toplevel added listener");
+#endif
+ if (!ATK_IS_OBJECT (child))
+ {
+ child = atk_object_ref_accessible_child (accessible, index);
+#ifdef SPI_ATK_DEBUG
+ non_owned_accessible (child);
+#endif
+ }
+ register_subtree (child);
+ update_accessible (accessible);
+
+ recursion_check_unset ();
+ }
+
+ g_static_rec_mutex_unlock (®istration_mutex);
+}
+
+static void
+spi_atk_register_toplevel_removed (AtkObject *accessible,
+ guint index,
+ AtkObject *child)
+{
+ g_static_rec_mutex_lock (®istration_mutex);
+
+ g_return_if_fail (ATK_IS_OBJECT (accessible));
+
+ if (object_to_ref (accessible))
+ {
+#ifdef SPI_ATK_DEBUG
+ if (recursion_check_and_set ())
+ g_warning ("AT-SPI: Recursive use of registration module");
+
+ g_debug ("AT-SPI: Toplevel removed listener");
+#endif
+ update_accessible (accessible);
+ recursion_check_unset ();
+ }
+
+ g_static_rec_mutex_unlock (®istration_mutex);
+}
+
/*
* Initializes required global data. The update and removal lists
* and the reference lookup tables.
if (!ref2ptr)
ref2ptr = g_hash_table_new(g_direct_hash, g_direct_equal);
- /* Get the root accessible and add */
- atk_dbus_register_accessible (root);
+ if (!objects_with_subrefs)
+ objects_with_subrefs = g_hash_table_new(g_direct_hash, g_direct_equal);
+
+ if (!leased_refs)
+ leased_refs = g_hash_table_new(g_direct_hash, g_direct_equal);
+
+#ifdef SPI_ATK_DEBUG
+ if (g_thread_supported ())
+ g_message ("AT-SPI: Threads enabled");
+
+ g_debug ("AT-SPI: Initial Atk tree regisration");
+#endif
+
+ register_subtree (root);
+
+ atk_add_global_event_listener (tree_update_property_listener, "Gtk:AtkObject:property-change");
+ atk_add_global_event_listener (tree_update_children_listener, "Gtk:AtkObject:children-changed");
+ atk_add_global_event_listener (tree_update_state_listener, "Gtk:AtkObject:state-change");
+
+ g_signal_connect (root,
+ "children-changed::add",
+ (GCallback) spi_atk_register_toplevel_added,
+ NULL);
+ g_signal_connect (root,
+ "children-changed::remove",
+ (GCallback) spi_atk_register_toplevel_removed,
+ NULL);
}
/*END------------------------------------------------------------------------*/
-