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   g_return_if_fail (ATK_IS_OBJECT (accessible));
 274
 275   traversal = g_queue_new ();
 276   emit_update = g_queue_new ();
 277
 278   g_object_ref (accessible);
 279   g_queue_push_tail (traversal, accessible);
 280
 281   while (!g_queue_is_empty (traversal))
 282     {
 283       current = g_queue_pop_head (traversal);
 284       g_queue_push_tail (emit_update, current);
 285       if (!object_to_ref (current))
 286         {
 287           register_accessible (current);
 288 #ifdef SPI_ATK_DEBUG
 289           g_debug ("REG  - %s - %d - %s", atk_object_get_name     (current),
 290                                           atk_object_get_role     (current),
 291                                           atk_dbus_object_to_path (current));
 292 #endif
 293           append_children (current, traversal);
 294         }
 295     }
 296
 297   while (!g_queue_is_empty (emit_update))
 298     {
 299       current = g_queue_pop_head (emit_update);
 300       spi_emit_cache_update (current, atk_adaptor_app_data->bus);
 301       g_object_unref (G_OBJECT (current));
 302     }
 303
 304   g_queue_free (traversal);
 305   g_queue_free (emit_update);
 306 }
 307
 308 /*---------------------------------------------------------------------------*/
 309
 310 /*
 311  * Called when an already registered object is updated in such a
 312  * way that client side cache needs to be updated.
 313  */
 314 static void
 315 update_accessible (AtkObject *accessible)
 316 {
 317   guint  ref = 0;
 318   g_return_if_fail (ATK_IS_OBJECT(accessible));
 319
 320   ref = object_to_ref (accessible);
 321   if (ref)
 322     {
 323       spi_emit_cache_update (accessible, atk_adaptor_app_data->bus);
 324     }
 325 }
 326
 327 /*---------------------------------------------------------------------------*/
 328
 329 void
 330 atk_dbus_foreach_registered(GHFunc func, gpointer data)
 331 {
 332   g_hash_table_foreach(ref2ptr, func, data);
 333 }
 334
 335 /*
 336  * Used to lookup an AtkObject from its D-Bus path.
 337  */
 338 AtkObject *
 339 atk_dbus_path_to_object (const char *path)
 340 {
 341   guint index;
 342   void *data;
 343
 344   g_return_val_if_fail (path, NULL);
 345
 346   if (strncmp(path, SPI_ATK_OBJECT_PATH_PREFIX, SPI_ATK_PATH_PREFIX_LENGTH) != 0)
 347     return NULL;
 348
 349   path += SPI_ATK_PATH_PREFIX_LENGTH; /* Skip over the prefix */
 350
 351   if (!g_strcmp0 (SPI_ATK_OBJECT_PATH_DESKTOP, path))
 352      return atk_get_root();
 353   if (path[0] != '/')
 354      return NULL;
 355
 356   path++;
 357   index = atoi (path);
 358   data = g_hash_table_lookup (ref2ptr, GINT_TO_POINTER(index));
 359   if (data)
 360     return ATK_OBJECT (data);
 361   else
 362     return NULL;
 363 }
 364
 365 /*
 366  * Used to lookup a D-Bus path from the AtkObject.
 367  */
 368 gchar *
 369 atk_dbus_object_to_path (AtkObject *accessible)
 370 {
 371   guint ref;
 372
 373   ref = object_to_ref (accessible);
 374   if (!ref)
 375       return NULL;
 376   else
 377       return ref_to_path (ref);
 378 }
 379
 380 gchar *
 381 atk_dbus_desktop_object_path ()
 382 {
 383   return g_strdup (SPI_ATK_OBJECT_PATH_PREFIX SPI_ATK_OBJECT_PATH_DESKTOP);
 384 }
 385
 386 /*---------------------------------------------------------------------------*/
 387
 388 typedef gboolean (*TreeUpdateAction) (GSignalInvocationHint *signal_hint,
 389                                       guint                  n_param_values,
 390                                       const GValue          *param_values,
 391                                       gpointer               data,
 392                                       AtkObject             *accessible);
 393
 394 /*
 395  * Events are not evaluated for non-registered accessibles.
 396  *
 397  * When a property change is made on a registered accessible
 398  * the client side cache should be updated.
 399  *
 400  * When a parent is changed the subtree is de-registered
 401  * if the parent is not attached to the root accessible.
 402  */
 403 /* TODO Turn this function into a macro? */
 404 static gboolean
 405 tree_update_wrapper (GSignalInvocationHint *signal_hint,
 406                      guint                  n_param_values,
 407                      const GValue          *param_values,
 408                      gpointer               data,
 409                      TreeUpdateAction       action)
 410 {
 411   AtkObject *accessible;
 412
 413   g_static_rec_mutex_lock (&registration_mutex);
 414
 415   /* Ensure that only registered accessibles
 416    * have their signals processed.
 417    */
 418   accessible = ATK_OBJECT(g_value_get_object (&param_values[0]));
 419   g_return_val_if_fail (ATK_IS_OBJECT (accessible), TRUE);
 420
 421   if (object_to_ref (accessible))
 422     {
 423 #ifdef SPI_ATK_DEBUG
 424       if (recursion_check_and_set ())
 425           g_warning ("AT-SPI: Recursive use of registration module");
 426
 427       g_debug ("AT-SPI: Tree update listener");
 428 #endif
 429       action (signal_hint, n_param_values, param_values, data, accessible);
 430
 431       recursion_check_unset ();
 432     }
 433
 434   g_static_rec_mutex_unlock (&registration_mutex);
 435
 436   return TRUE;
 437 }
 438
 439 static gboolean
 440 tree_update_state_action (GSignalInvocationHint *signal_hint,
 441                           guint                  n_param_values,
 442                           const GValue          *param_values,
 443                           gpointer               data,
 444                           AtkObject             *accessible)
 445 {
 446       update_accessible (accessible);
 447 }
 448
 449 static gboolean
 450 tree_update_state_listener (GSignalInvocationHint *signal_hint,
 451                             guint                  n_param_values,
 452                             const GValue          *param_values,
 453                             gpointer               data)
 454 {
 455       tree_update_wrapper (signal_hint, n_param_values, param_values, data, tree_update_state_action);
 456 }
 457
 458 static gboolean
 459 tree_update_property_action (GSignalInvocationHint *signal_hint,
 460                              guint                  n_param_values,
 461                              const GValue          *param_values,
 462                              gpointer               data,
 463                              AtkObject             *accessible)
 464 {
 465       AtkPropertyValues *values;
 466       const gchar *pname = NULL;
 467
 468       values = (AtkPropertyValues*) g_value_get_pointer (&param_values[1]);
 469       pname = values[0].property_name;
 470       if (strcmp (pname, "accessible-name") == 0 ||
 471           strcmp (pname, "accessible-description") == 0 ||
 472           strcmp (pname, "accessible-parent") == 0)
 473         {
 474           update_accessible (accessible);
 475         }
 476       /* Parent value us updated by child-add signal of parent object */
 477 }
 478
 479 static gboolean
 480 tree_update_property_listener (GSignalInvocationHint *signal_hint,
 481                                guint                  n_param_values,
 482                                const GValue          *param_values,
 483                                gpointer               data)
 484 {
 485       tree_update_wrapper (signal_hint, n_param_values, param_values, data, tree_update_property_action);
 486 }
 487
 488 static gboolean
 489 tree_update_children_action (GSignalInvocationHint *signal_hint,
 490                              guint                  n_param_values,
 491                              const GValue          *param_values,
 492                              gpointer               data,
 493                              AtkObject             *accessible)
 494 {
 495       const gchar *detail = NULL;
 496       AtkObject *child;
 497
 498       if (signal_hint->detail)
 499           detail = g_quark_to_string (signal_hint->detail);
 500
 501       if (!strcmp (detail, "add"))
 502         {
 503           gpointer child;
 504           int index = g_value_get_uint (param_values + 1);
 505           child = g_value_get_pointer (param_values + 2);
 506
 507           if (!ATK_IS_OBJECT (child))
 508             {
 509               child = atk_object_ref_accessible_child (accessible, index);
 510 #ifdef SPI_ATK_DEBUG
 511               non_owned_accessible (child);
 512 #endif
 513             }
 514           register_subtree (child);
 515           update_accessible (accessible);
 516         }
 517 }
 518
 519 static gboolean
 520 tree_update_children_listener (GSignalInvocationHint *signal_hint,
 521                                guint                  n_param_values,
 522                                const GValue          *param_values,
 523                                gpointer               data)
 524 {
 525       tree_update_wrapper (signal_hint, n_param_values, param_values, data, tree_update_children_action);
 526 }
 527
 528 /*---------------------------------------------------------------------------*/
 529
 530 static void
 531 spi_atk_register_toplevel_added (AtkObject *accessible,
 532                                  guint     index,
 533                                  AtkObject *child)
 534 {
 535   g_static_rec_mutex_lock (&registration_mutex);
 536
 537   g_return_if_fail (ATK_IS_OBJECT (accessible));
 538
 539   if (object_to_ref (accessible))
 540     {
 541 #ifdef SPI_ATK_DEBUG
 542       if (recursion_check_and_set ())
 543           g_warning ("AT-SPI: Recursive use of registration module");
 544
 545       g_debug ("AT-SPI: Toplevel added listener");
 546 #endif
 547       if (!ATK_IS_OBJECT (child))
 548         {
 549           child = atk_object_ref_accessible_child (accessible, index);
 550 #ifdef SPI_ATK_DEBUG
 551           non_owned_accessible (child);
 552 #endif
 553         }
 554       register_subtree (child);
 555       update_accessible (accessible);
 556
 557       recursion_check_unset ();
 558     }
 559
 560   g_static_rec_mutex_unlock (&registration_mutex);
 561 }
 562
 563 static void
 564 spi_atk_register_toplevel_removed (AtkObject *accessible,
 565                                    guint     index,
 566                                    AtkObject *child)
 567 {
 568   g_static_rec_mutex_lock (&registration_mutex);
 569
 570   g_return_if_fail (ATK_IS_OBJECT (accessible));
 571
 572   if (object_to_ref (accessible))
 573     {
 574 #ifdef SPI_ATK_DEBUG
 575       if (recursion_check_and_set ())
 576           g_warning ("AT-SPI: Recursive use of registration module");
 577
 578       g_debug ("AT-SPI: Toplevel removed listener");
 579 #endif
 580       update_accessible (accessible);
 581       recursion_check_unset ();
 582     }
 583
 584   g_static_rec_mutex_unlock (&registration_mutex);
 585 }
 586
 587 /*
 588  * Initializes required global data. The update and removal lists
 589  * and the reference lookup tables.
 590  *
 591  * Initializes all of the required D-Bus interfaces.
 592  */
 593 void
 594 atk_dbus_initialize (AtkObject *root)
 595 {
 596   if (!ref2ptr)
 597     ref2ptr = g_hash_table_new(g_direct_hash, g_direct_equal);
 598
 599 #ifdef SPI_ATK_DEBUG
 600   if (g_thread_supported ())
 601       g_message ("AT-SPI: Threads enabled");
 602
 603   g_debug ("AT-SPI: Initial Atk tree regisration");
 604 #endif
 605
 606   register_subtree (root);
 607
 608   atk_add_global_event_listener (tree_update_property_listener, "Gtk:AtkObject:property-change");
 609   atk_add_global_event_listener (tree_update_children_listener, "Gtk:AtkObject:children-changed");
 610   atk_add_global_event_listener (tree_update_state_listener, "Gtk:AtkObject:state-change");
 611
 612   g_signal_connect (root,
 613                     "children-changed::add",
 614                     (GCallback) spi_atk_register_toplevel_added,
 615                     NULL);
 616   g_signal_connect (root,
 617                     "children-changed::remove",
 618                     (GCallback) spi_atk_register_toplevel_removed,
 619                     NULL);
 620 }
 621
 622 /*END------------------------------------------------------------------------*/