2 * AT-SPI - Assistive Technology Service Provider Interface
3 * (Gnome Accessibility Project; http://developer.gnome.org/projects/gap)
5 * Copyright 2009, 2010 Codethink Ltd.
7 * This library is free software; you can redistribute it and/or
8 * modify it under the terms of the GNU Library General Public
9 * License as published by the Free Software Foundation; either
10 * version 2 of the License, or (at your option) any later version.
12 * This library is distributed in the hope that it will be useful,
13 * but WITHOUT ANY WARRANTY; without even the implied warranty of
14 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
15 * Library General Public License for more details.
17 * You should have received a copy of the GNU Library General Public
18 * License along with this library; if not, write to the
19 * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
20 * Boston, MA 02111-1307, USA.
26 #include "accessible-cache.h"
27 #include "accessible-register.h"
30 SpiCache *spi_global_cache = NULL;
33 child_added_listener (GSignalInvocationHint * signal_hint,
35 const GValue * param_values, gpointer data);
38 toplevel_added_listener (AtkObject * accessible,
39 guint index, AtkObject * child);
42 remove_object (GObject * source, GObject * gobj, gpointer data);
45 add_object (SpiCache * cache, GObject * gobj);
48 add_subtree (SpiCache *cache, AtkObject * accessible);
51 add_pending_items (gpointer data);
53 /*---------------------------------------------------------------------------*/
56 spi_cache_finalize (GObject * object);
58 /*---------------------------------------------------------------------------*/
66 static guint cache_signals[LAST_SIGNAL] = { 0 };
68 /*---------------------------------------------------------------------------*/
70 G_DEFINE_TYPE (SpiCache, spi_cache, G_TYPE_OBJECT)
72 static void spi_cache_class_init (SpiCacheClass * klass)
74 GObjectClass *object_class = (GObjectClass *) klass;
76 spi_cache_parent_class = g_type_class_ref (G_TYPE_OBJECT);
78 object_class->finalize = spi_cache_finalize;
80 cache_signals [OBJECT_ADDED] = \
81 g_signal_new ("object-added",
87 g_cclosure_marshal_VOID__OBJECT,
92 cache_signals [OBJECT_REMOVED] = \
93 g_signal_new ("object-removed",
99 g_cclosure_marshal_VOID__OBJECT,
106 spi_cache_init (SpiCache * cache)
108 cache->objects = g_hash_table_new (g_direct_hash, g_direct_equal);
109 cache->add_traversal = g_queue_new ();
112 if (g_thread_supported ())
113 g_message ("AT-SPI: Threads enabled");
115 g_debug ("AT-SPI: Initial Atk tree regisration");
118 g_signal_connect (spi_global_register,
119 "object-deregistered",
120 (GCallback) remove_object, cache);
122 add_subtree (cache, spi_global_app_data->root);
124 cache->child_added_listener = atk_add_global_event_listener (child_added_listener,
125 "Gtk:AtkObject:children-changed");
127 g_signal_connect (G_OBJECT (spi_global_app_data->root),
128 "children-changed::add",
129 (GCallback) toplevel_added_listener, NULL);
133 spi_cache_finalize (GObject * object)
135 SpiCache *cache = SPI_CACHE (object);
137 while (!g_queue_is_empty (cache->add_traversal))
138 g_object_unref (G_OBJECT (g_queue_pop_head (cache->add_traversal)));
139 g_queue_free (cache->add_traversal);
140 g_hash_table_unref (cache->objects);
142 g_signal_handlers_disconnect_by_func (spi_global_register,
143 (GCallback) remove_object, cache);
145 g_signal_handlers_disconnect_by_func (G_OBJECT (spi_global_app_data->root),
146 (GCallback) toplevel_added_listener, NULL);
148 atk_remove_global_event_listener (cache->child_added_listener);
150 G_OBJECT_CLASS (spi_cache_parent_class)->finalize (object);
153 /*---------------------------------------------------------------------------*/
156 remove_object (GObject * source, GObject * gobj, gpointer data)
158 SpiCache *cache = SPI_CACHE (data);
160 if (spi_cache_in (cache, gobj))
163 g_debug ("CACHE REM - %s - %d - %s\n", atk_object_get_name (ATK_OBJECT (gobj)),
164 atk_object_get_role (ATK_OBJECT (gobj)),
165 spi_register_object_to_path (spi_global_register, gobj));
167 g_signal_emit (cache, cache_signals [OBJECT_REMOVED], 0, gobj);
168 g_hash_table_remove (cache->objects, gobj);
170 else if (g_queue_remove (cache->add_traversal, gobj))
172 g_object_unref (gobj);
177 add_object (SpiCache * cache, GObject * gobj)
179 g_return_if_fail (G_IS_OBJECT (gobj));
181 g_hash_table_insert (cache->objects, gobj, NULL);
184 g_debug ("CACHE ADD - %s - %d - %s\n", atk_object_get_name (ATK_OBJECT (gobj)),
185 atk_object_get_role (ATK_OBJECT (gobj)),
186 spi_register_object_to_path (spi_global_register, gobj));
189 g_signal_emit (cache, cache_signals [OBJECT_ADDED], 0, gobj);
192 /*---------------------------------------------------------------------------*/
194 static GStaticRecMutex cache_mutex = G_STATIC_REC_MUTEX_INIT;
195 static GStaticMutex recursion_check_guard = G_STATIC_MUTEX_INIT;
197 static gboolean recursion_check = FALSE;
200 recursion_check_and_set ()
203 g_static_mutex_lock (&recursion_check_guard);
204 ret = recursion_check;
205 recursion_check = TRUE;
206 g_static_mutex_unlock (&recursion_check_guard);
211 recursion_check_unset ()
213 g_static_mutex_lock (&recursion_check_guard);
214 recursion_check = FALSE;
215 g_static_mutex_unlock (&recursion_check_guard);
218 /*---------------------------------------------------------------------------*/
221 append_children (AtkObject * accessible, GQueue * traversal)
225 gint count = atk_object_get_n_accessible_children (accessible);
229 for (i = 0; i < count; i++)
231 current = atk_object_ref_accessible_child (accessible, i);
234 g_queue_push_tail (traversal, current);
240 * Adds a subtree of accessible objects
241 * to the cache at the accessible object provided.
243 * The leaf nodes do not have their children
244 * registered. A node is considered a leaf
245 * if it has the state "manages-descendants"
246 * or if it has already been registered.
249 add_subtree (SpiCache *cache, AtkObject * accessible)
251 g_return_if_fail (ATK_IS_OBJECT (accessible));
253 g_object_ref (accessible);
254 g_queue_push_tail (cache->add_traversal, accessible);
255 add_pending_items (cache);
259 add_pending_items (gpointer data)
261 SpiCache *cache = SPI_CACHE (data);
265 to_add = g_queue_new ();
267 while (!g_queue_is_empty (cache->add_traversal))
271 /* cache->add_traversal holds a ref to current */
272 current = g_queue_pop_head (cache->add_traversal);
273 set = atk_object_ref_state_set (current);
275 if (set && !atk_state_set_contains_state (set, ATK_STATE_TRANSIENT))
277 /* transfer the ref into to_add */
278 g_queue_push_tail (to_add, current);
279 if (!spi_cache_in (cache, G_OBJECT (current)) &&
280 !atk_state_set_contains_state (set, ATK_STATE_MANAGES_DESCENDANTS) &&
281 !atk_state_set_contains_state (set, ATK_STATE_DEFUNCT))
283 append_children (current, cache->add_traversal);
288 /* drop the ref for the removed object */
289 g_object_unref (current);
293 g_object_unref (set);
296 while (!g_queue_is_empty (to_add))
298 current = g_queue_pop_head (to_add);
300 /* Make sure object is registerd so we are notified if it goes away */
301 g_free (spi_register_object_to_path (spi_global_register,
302 G_OBJECT (current)));
304 add_object (cache, G_OBJECT(current));
305 g_object_unref (G_OBJECT (current));
308 g_queue_free (to_add);
309 cache->add_pending_idle = 0;
313 /*---------------------------------------------------------------------------*/
316 child_added_listener (GSignalInvocationHint * signal_hint,
317 guint n_param_values,
318 const GValue * param_values, gpointer data)
320 SpiCache *cache = spi_global_cache;
321 AtkObject *accessible;
323 const gchar *detail = NULL;
325 g_static_rec_mutex_lock (&cache_mutex);
328 * Ensure that only accessibles already in the cache
329 * have their signals processed.
331 accessible = ATK_OBJECT (g_value_get_object (¶m_values[0]));
332 g_return_val_if_fail (ATK_IS_OBJECT (accessible), TRUE);
334 if (spi_cache_in (cache, G_OBJECT(accessible)))
337 if (recursion_check_and_set ())
338 g_warning ("AT-SPI: Recursive use of cache module");
340 g_debug ("AT-SPI: Tree update listener");
342 if (signal_hint->detail)
343 detail = g_quark_to_string (signal_hint->detail);
345 if (detail && !strncmp (detail, "add", 3))
348 int index = g_value_get_uint (param_values + 1);
349 child = g_value_get_pointer (param_values + 2);
352 g_static_rec_mutex_unlock (&cache_mutex);
356 g_object_ref (child);
357 g_queue_push_tail (cache->add_traversal, child);
359 if (cache->add_pending_idle == 0)
360 cache->add_pending_idle = g_idle_add (add_pending_items, cache);
363 recursion_check_unset ();
367 g_static_rec_mutex_unlock (&cache_mutex);
372 /*---------------------------------------------------------------------------*/
375 toplevel_added_listener (AtkObject * accessible,
376 guint index, AtkObject * child)
378 SpiCache *cache = spi_global_cache;
380 g_static_rec_mutex_lock (&cache_mutex);
382 g_return_if_fail (ATK_IS_OBJECT (accessible));
384 if (spi_cache_in (cache, G_OBJECT(accessible)))
387 if (recursion_check_and_set ())
388 g_warning ("AT-SPI: Recursive use of registration module");
390 g_debug ("AT-SPI: Toplevel added listener");
392 if (!ATK_IS_OBJECT (child))
394 child = atk_object_ref_accessible_child (accessible, index);
397 g_object_ref (child);
399 g_queue_push_tail (cache->add_traversal, child);
401 if (cache->add_pending_idle == 0)
402 cache->add_pending_idle = g_idle_add (add_pending_items, cache);
404 recursion_check_unset ();
408 g_static_rec_mutex_unlock (&cache_mutex);
411 /*---------------------------------------------------------------------------*/
414 spi_cache_foreach (SpiCache * cache, GHFunc func, gpointer data)
416 g_hash_table_foreach (cache->objects, func, data);
420 spi_cache_in (SpiCache * cache, GObject * object)
425 if (g_hash_table_lookup_extended (cache->objects,
436 spi_cache_print_info (GObject * obj)
438 char * path = spi_register_object_to_path (spi_global_register, obj);
440 if (spi_cache_in (spi_global_cache, obj))
441 g_printf ("%s IC\n", path);
443 g_printf ("%s NC\n", path);
450 /*END------------------------------------------------------------------------*/