atk-adaptor/accessible-register.c

   1 /*
   2  * AT-SPI - Assistive Technology Service Provider Interface
   3  * (Gnome Accessibility Project; http://developer.gnome.org/projects/gap)
   4  *
   5  * Copyright 2008 Novell, Inc.
   6  * Copyright 2008, 2009 Codethink Ltd.
   7  *
   8  * This library is free software; you can redistribute it and/or
   9  * modify it under the terms of the GNU Library General Public
  10  * License as published by the Free Software Foundation; either
  11  * version 2 of the License, or (at your option) any later version.
  12  *
  13  * This library is distributed in the hope that it will be useful,
  14  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  15  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  16  * Library General Public License for more details.
  17  *
  18  * You should have received a copy of the GNU Library General Public
  19  * License along with this library; if not, write to the
  20  * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
  21  * Boston, MA 02111-1307, USA.
  22  */
  23
  24 #include <stdio.h>
  25 #include <stdlib.h>
  26 #include <string.h>
  27
  28 #include "bridge.h"
  29 #include "accessible-register.h"
  30
  31 /*
  32  * This module is responsible for keeping track of all the AtkObjects in
  33  * the application, so that they can be accessed remotely and placed in
  34  * a client side cache.
  35  *
  36  * To access an AtkObject remotely we need to provide a D-Bus object
  37  * path for it. The D-Bus object paths used have a standard prefix
  38  * (SPI_ATK_OBJECT_PATH_PREFIX). Appended to this prefix is a string
  39  * representation of an integer reference. So to access an AtkObject
  40  * remotely we keep a Hashtable that maps the given reference to
  41  * the AtkObject pointer. An object in this hash table is said to be 'registered'.
  42  *
  43  * The architecture of AT-SPI dbus is such that AtkObjects are not
  44  * remotely reference counted. This means that we need to keep track of
  45  * object destruction. When an object is destroyed it must be 'deregistered'
  46  * To do this lookup we keep a dbus-id attribute on each AtkObject.
  47  *
  48  * In addition to accessing the objects remotely we must be able to update
  49  * the client side cache. This is done using the 'update' signal of the
  50  * org.freedesktop.atspi.Tree interface. The update signal should send out
  51  * all of the cacheable data for an Accessible object.
  52  *
  53  */
  54
  55 /*
  56  * FIXME
  57  *
  58  * This code seems very brittle.
  59  * I would prefer changes to be made to
  60  * gail and the ATK interface so that all Accessible
  61  * objects are registered with an exporting module.
  62  *
  63  * This is the same system as Qt has with the QAccessibleBridge
  64  * and QAccessibleBridgePlugin. It entails some rather
  65  * large structural changes to ATK though:
  66  *
  67  * Removing infinite spaces (Child access no longer references child).
  68  * Removing lazy creation of accessible objects.
  69  */
  70
  71 #define SPI_ATK_OBJECT_PATH_PREFIX  "/org/freedesktop/atspi/accessible"
  72 #define SPI_ATK_OBJECT_PATH_DESKTOP "/root"
  73
  74 #define SPI_ATK_PATH_PREFIX_LENGTH 33
  75 #define SPI_ATK_OBJECT_REFERENCE_TEMPLATE SPI_ATK_OBJECT_PATH_PREFIX "/%d"
  76
  77
  78 static GHashTable *ref2ptr = NULL; /* Used for converting a D-Bus path (Reference) to the object pointer */
  79
  80 static guint reference_counter = 0;
  81
  82 static GStaticRecMutex registration_mutex = G_STATIC_REC_MUTEX_INIT;
  83
  84 /*---------------------------------------------------------------------------*/
  85
  86 static GStaticMutex   recursion_check_guard = G_STATIC_MUTEX_INIT;
  87 static gboolean       recursion_check = FALSE;
  88
  89 static gboolean
  90 recursion_check_and_set ()
  91 {
  92   gboolean ret;
  93   g_static_mutex_lock   (&recursion_check_guard);
  94   ret = recursion_check;
  95   recursion_check = TRUE;
  96   g_static_mutex_unlock (&recursion_check_guard);
  97   return ret;
  98 }
  99
 100 static void
 101 recursion_check_unset ()
 102 {
 103   g_static_mutex_lock   (&recursion_check_guard);
 104   recursion_check = FALSE;
 105   g_static_mutex_unlock (&recursion_check_guard);
 106 }
 107
 108 /*---------------------------------------------------------------------------*/
 109
 110 /*
 111  * Each AtkObject must be asssigned a D-Bus path (Reference)
 112  *
 113  * This function provides an integer reference for a new
 114  * AtkObject.
 115  */
 116 static guint
 117 assign_reference(void)
 118 {
 119   reference_counter++;
 120   /* Reference of 0 not allowed as used as direct key in hash table */
 121   if (reference_counter == 0)
 122     reference_counter++;
 123   return reference_counter;
 124 }
 125
 126 /*
 127  * Returns the reference of the object, or 0 if it is not registered.
 128  */
 129 static guint
 130 object_to_ref (AtkObject *accessible)
 131 {
 132   return GPOINTER_TO_INT(g_object_get_data (G_OBJECT (accessible), "dbus-id"));
 133 }
 134
 135 /*
 136  * Converts the Accessible object reference to its D-Bus object path
 137  */
 138 static gchar *
 139 ref_to_path (guint ref)
 140 {
 141   return g_strdup_printf(SPI_ATK_OBJECT_REFERENCE_TEMPLATE, ref);
 142 }
 143
 144 /*---------------------------------------------------------------------------*/
 145
 146 /*
 147  * Callback for when a registered AtkObject is destroyed.
 148  *
 149  * Removes the AtkObject from the reference lookup tables, meaning
 150  * it is no longer exposed over D-Bus.
 151  */
 152 static void
 153 deregister_accessible (gpointer data, GObject *accessible)
 154 {
 155   guint ref;
 156   g_return_if_fail (ATK_IS_OBJECT (accessible));
 157
 158   ref = object_to_ref (ATK_OBJECT(accessible));
 159   if (ref != 0)
 160     {
 161       g_hash_table_remove(ref2ptr, GINT_TO_POINTER(ref));
 162     }
 163 }
 164
 165 /*
 166  * Called to register an AtkObject with AT-SPI and expose it over D-Bus.
 167  */
 168 static void
 169 register_accessible (AtkObject *accessible)
 170 {
 171   guint ref;
 172   g_return_if_fail (ATK_IS_OBJECT(accessible));
 173
 174   ref = assign_reference();
 175
 176   g_hash_table_insert (ref2ptr, GINT_TO_POINTER(ref), accessible);
 177   g_object_set_data (G_OBJECT(accessible), "dbus-id", GINT_TO_POINTER(ref));
 178   g_object_weak_ref(G_OBJECT(accessible), deregister_accessible, NULL);
 179 }
 180
 181 /*---------------------------------------------------------------------------*/
 182
 183 #ifdef SPI_ATK_DEBUG
 184 /*
 185  * This function checks that the ref-count of an accessible
 186  * is greater than 1.
 187  *
 188  * There is not currently any remote reference counting
 189  * in AT-SPI D-Bus so objects that are remotely owned are not
 190  * allowed.
 191  *
 192  * TODO Add debug wrapper
 193  */
 194 static gboolean
 195 non_owned_accessible (AtkObject *accessible)
 196 {
 197    if ((G_OBJECT (accessible))->ref_count <= 1)
 198      {
 199        g_warning ("AT-SPI: Child referenced that is not owned by its parent");
 200        return TRUE;
 201      }
 202    else
 203      {
 204        return FALSE;
 205      }
 206 }
 207 #endif /* SPI_ATK_DEBUG */
 208
 209 /*---------------------------------------------------------------------------*/
 210
 211 static gboolean
 212 has_manages_descendants (AtkObject *accessible)
 213 {
 214    AtkStateSet *state;
 215    gboolean result = FALSE;
 216
 217    /* This is dangerous, refing the state set
 218     * seems to do wierd things to the tree & cause recursion
 219     * by modifying the tree alot.
 220     */
 221    state = atk_object_ref_state_set (accessible);
 222    if (atk_state_set_contains_state (state, ATK_STATE_MANAGES_DESCENDANTS))
 223      {
 224 #ifdef SPI_ATK_DEBUG
 225        g_warning ("AT-SPI: Object with 'Manages descendants' states not currently handled by AT-SPI");
 226 #endif
 227        result = TRUE;
 228      }
 229    g_object_unref (state);
 230
 231    return result;
 232 }
 233
 234 static void
 235 append_children (AtkObject *accessible, GQueue *traversal)
 236 {
 237   AtkObject *current;
 238   guint i;
 239
 240   for (i =0; i < atk_object_get_n_accessible_children (accessible); i++)
 241     {
 242       current = atk_object_ref_accessible_child (accessible, i);
 243 #ifdef SPI_ATK_DEBUG
 244       non_owned_accessible (current);
 245 #endif
 246       if (!has_manages_descendants (current))
 247         {
 248           g_queue_push_tail (traversal, current);
 249         }
 250       else
 251         {
 252           g_object_unref (G_OBJECT (current));
 253         }
 254     }
 255 }
 256
 257 /*
 258  * Registers a subtree of accessible objects
 259  * rooted at the accessible object provided.
 260  *
 261  * The leaf nodes do not have their children
 262  * registered. A node is considered a leaf
 263  * if it has the state "manages-descendants"
 264  * or if it has already been registered.
 265  */
 266 void
 267 register_subtree (AtkObject *accessible)
 268 {
 269   AtkObject *current;
 270   GQueue    *traversal;
 271   GQueue    *emit_update;
 272
 273   traversal = g_queue_new ();
 274   emit_update = g_queue_new ();
 275
 276   g_object_ref (accessible);
 277   g_queue_push_tail (traversal, accessible);
 278
 279   while (!g_queue_is_empty (traversal))
 280     {
 281       current = g_queue_pop_head (traversal);
 282       g_queue_push_tail (emit_update, current);
 283       if (!object_to_ref (current))
 284         {
 285           register_accessible (current);
 286 #ifdef SPI_ATK_DEBUG
 287           g_debug ("REG  - %s - %d - %s", atk_object_get_name     (current),
 288                                           atk_object_get_role     (current),
 289                                           atk_dbus_object_to_path (current));
 290 #endif
 291           append_children (current, traversal);
 292         }
 293     }
 294
 295   while (!g_queue_is_empty (emit_update))
 296     {
 297       current = g_queue_pop_head (emit_update);
 298       spi_emit_cache_update (current, atk_adaptor_app_data->bus);
 299       g_object_unref (G_OBJECT (current));
 300     }
 301
 302   g_queue_free (traversal);
 303   g_queue_free (emit_update);
 304 }
 305
 306 /*---------------------------------------------------------------------------*/
 307
 308 /*
 309  * Called when an already registered object is updated in such a
 310  * way that client side cache needs to be updated.
 311  */
 312 static void
 313 update_accessible (AtkObject *accessible)
 314 {
 315   guint  ref = 0;
 316   g_return_if_fail (ATK_IS_OBJECT(accessible));
 317
 318   ref = object_to_ref (accessible);
 319   if (ref)
 320     {
 321       spi_emit_cache_update (accessible, atk_adaptor_app_data->bus);
 322     }
 323 }
 324
 325 /*---------------------------------------------------------------------------*/
 326
 327 void
 328 atk_dbus_foreach_registered(GHFunc func, gpointer data)
 329 {
 330   g_hash_table_foreach(ref2ptr, func, data);
 331 }
 332
 333 /*
 334  * Used to lookup an AtkObject from its D-Bus path.
 335  */
 336 AtkObject *
 337 atk_dbus_path_to_object (const char *path)
 338 {
 339   guint index;
 340   void *data;
 341
 342   g_return_val_if_fail (path, NULL);
 343
 344   if (strncmp(path, SPI_ATK_OBJECT_PATH_PREFIX, SPI_ATK_PATH_PREFIX_LENGTH) != 0)
 345     return NULL;
 346
 347   path += SPI_ATK_PATH_PREFIX_LENGTH; /* Skip over the prefix */
 348
 349   if (!g_strcmp0 (SPI_ATK_OBJECT_PATH_DESKTOP, path))
 350      return atk_get_root();
 351   if (path[0] != '/')
 352      return NULL;
 353
 354   path++;
 355   index = atoi (path);
 356   data = g_hash_table_lookup (ref2ptr, GINT_TO_POINTER(index));
 357   if (data)
 358     return ATK_OBJECT (data);
 359   else
 360     return NULL;
 361 }
 362
 363 /*
 364  * Used to lookup a D-Bus path from the AtkObject.
 365  */
 366 gchar *
 367 atk_dbus_object_to_path (AtkObject *accessible)
 368 {
 369   guint ref;
 370
 371   ref = object_to_ref (accessible);
 372   if (!ref)
 373       return NULL;
 374   else
 375       return ref_to_path (ref);
 376 }
 377
 378 gchar *
 379 atk_dbus_desktop_object_path ()
 380 {
 381   return g_strdup (SPI_ATK_OBJECT_PATH_PREFIX SPI_ATK_OBJECT_PATH_DESKTOP);
 382 }
 383
 384 /*---------------------------------------------------------------------------*/
 385
 386 /*
 387  * Events are not evaluated for non-registered accessibles.
 388  *
 389  * When a property change is made on a registered accessible
 390  * the client side cache should be updated.
 391  *
 392  * When a parent is changed the subtree is de-registered
 393  * if the parent is not attached to the root accessible.
 394  */
 395 static gboolean
 396 tree_update_listener (GSignalInvocationHint *signal_hint,
 397                       guint                  n_param_values,
 398                       const GValue          *param_values,
 399                       gpointer               data)
 400 {
 401   AtkObject *accessible;
 402   AtkPropertyValues *values;
 403   const gchar *pname = NULL;
 404
 405   g_static_rec_mutex_lock (&registration_mutex);
 406
 407   /* Ensure that only registered accessibles
 408    * have their signals processed.
 409    */
 410   accessible = g_value_get_object (&param_values[0]);
 411   g_return_val_if_fail (ATK_IS_OBJECT (accessible), TRUE);
 412
 413   if (object_to_ref (accessible))
 414     {
 415 #ifdef SPI_ATK_DEBUG
 416       if (recursion_check_and_set ())
 417           g_warning ("AT-SPI: Recursive use of registration module");
 418
 419       g_debug ("AT-SPI: Tree update listener");
 420 #endif
 421
 422
 423       values = (AtkPropertyValues*) g_value_get_pointer (&param_values[1]);
 424       pname = values[0].property_name;
 425       if (strcmp (pname, "accessible-name") == 0 ||
 426           strcmp (pname, "accessible-description") == 0)
 427         {
 428           update_accessible (accessible);
 429         }
 430       /* Parent value us updated by child-add signal of parent object */
 431
 432       recursion_check_unset ();
 433     }
 434
 435   g_static_rec_mutex_unlock (&registration_mutex);
 436
 437   return TRUE;
 438 }
 439
 440 /*
 441  * Events are not evaluated for non registered accessibles.
 442  *
 443  * When the children of a registered accessible are changed
 444  * the subtree, rooted at the child is registered.
 445  */
 446 static gboolean
 447 tree_update_children_listener (GSignalInvocationHint *signal_hint,
 448                                guint                  n_param_values,
 449                                const GValue          *param_values,
 450                                gpointer               data)
 451 {
 452   AtkObject *accessible;
 453   const gchar *detail = NULL;
 454   AtkObject *child;
 455
 456   g_static_rec_mutex_lock (&registration_mutex);
 457
 458   /* Ensure that only registered accessibles
 459    * have their signals processed.
 460    */
 461   accessible = g_value_get_object (&param_values[0]);
 462   g_return_val_if_fail (ATK_IS_OBJECT (accessible), TRUE);
 463
 464   if (object_to_ref (accessible))
 465     {
 466 #ifdef SPI_ATK_DEBUG
 467       if (recursion_check_and_set ())
 468           g_warning ("AT-SPI: Recursive use of registration module");
 469
 470       g_debug ("AT-SPI: Tree update children listener");
 471 #endif
 472
 473       if (signal_hint->detail)
 474           detail = g_quark_to_string (signal_hint->detail);
 475
 476       if (!strcmp (detail, "add"))
 477         {
 478           gpointer child;
 479           int index = g_value_get_uint (param_values + 1);
 480           child = g_value_get_pointer (param_values + 2);
 481
 482           if (!ATK_IS_OBJECT (child))
 483             {
 484               child = atk_object_ref_accessible_child (accessible, index);
 485 #ifdef SPI_ATK_DEBUG
 486               non_owned_accessible (child);
 487 #endif
 488             }
 489           register_subtree (child);
 490         }
 491
 492       recursion_check_unset ();
 493     }
 494
 495   g_static_rec_mutex_unlock (&registration_mutex);
 496
 497   return TRUE;
 498 }
 499
 500 /*
 501  * Initializes required global data. The update and removal lists
 502  * and the reference lookup tables.
 503  *
 504  * Initializes all of the required D-Bus interfaces.
 505  */
 506 void
 507 atk_dbus_initialize (AtkObject *root)
 508 {
 509   if (!ref2ptr)
 510     ref2ptr = g_hash_table_new(g_direct_hash, g_direct_equal);
 511
 512 #ifdef SPI_ATK_DEBUG
 513   if (g_thread_supported ())
 514       g_message ("AT-SPI: Threads enabled");
 515
 516   g_debug ("AT-SPI: Initial Atk tree regisration");
 517 #endif
 518
 519   register_subtree (root);
 520
 521   atk_add_global_event_listener (tree_update_listener, "Gtk:AtkObject:property-change");
 522   atk_add_global_event_listener (tree_update_children_listener, "Gtk:AtkObject:children-changed");
 523 }
 524
 525 /*END------------------------------------------------------------------------*/
 526