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, 2010 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  */
  49
  50 #define SPI_ATK_PATH_PREFIX_LENGTH 27
  51 #define SPI_ATK_OBJECT_PATH_PREFIX  "/org/a11y/atspi/accessible/"
  52 #define SPI_ATK_OBJECT_PATH_ROOT "root"
  53
  54 #define SPI_ATK_OBJECT_REFERENCE_TEMPLATE SPI_ATK_OBJECT_PATH_PREFIX "%d"
  55
  56 #define SPI_DBUS_ID "spi-dbus-id"
  57
  58 SpiRegister *spi_global_register = NULL;
  59
  60 static const gchar * spi_register_root_path = SPI_ATK_OBJECT_PATH_PREFIX SPI_ATK_OBJECT_PATH_ROOT;
  61
  62 enum
  63 {
  64   OBJECT_REGISTERED,
  65   OBJECT_DEREGISTERED,
  66   LAST_SIGNAL
  67 };
  68 static guint register_signals[LAST_SIGNAL] = { 0 };
  69
  70 /*---------------------------------------------------------------------------*/
  71
  72 static void
  73 spi_register_finalize (GObject * object);
  74
  75 static void
  76 spi_register_dispose (GObject * object);
  77
  78 /*---------------------------------------------------------------------------*/
  79
  80 G_DEFINE_TYPE (SpiRegister, spi_register, G_TYPE_OBJECT)
  81
  82 static void spi_register_class_init (SpiRegisterClass * klass)
  83 {
  84   GObjectClass *object_class = (GObjectClass *) klass;
  85
  86   spi_register_parent_class = g_type_class_ref (G_TYPE_OBJECT);
  87
  88   object_class->finalize = spi_register_finalize;
  89   object_class->dispose = spi_register_dispose;
  90
  91   register_signals [OBJECT_REGISTERED] =
  92       g_signal_new ("object-registered",
  93                     SPI_REGISTER_TYPE,
  94                     G_SIGNAL_ACTION,
  95                     0,
  96                     NULL,
  97                     NULL,
  98                     g_cclosure_marshal_VOID__OBJECT,
  99                     G_TYPE_NONE,
 100                     1,
 101                     G_TYPE_OBJECT);
 102
 103   register_signals [OBJECT_DEREGISTERED] =
 104       g_signal_new ("object-deregistered",
 105                     SPI_REGISTER_TYPE,
 106                     G_SIGNAL_ACTION,
 107                     0,
 108                     NULL,
 109                     NULL,
 110                     g_cclosure_marshal_VOID__OBJECT,
 111                     G_TYPE_NONE,
 112                     1,
 113                     G_TYPE_OBJECT);
 114 }
 115
 116 static void
 117 spi_register_init (SpiRegister * reg)
 118 {
 119   reg->ref2ptr = g_hash_table_new (g_direct_hash, g_direct_equal);
 120   reg->reference_counter = 0;
 121 }
 122
 123 static void
 124 spi_register_finalize (GObject * object)
 125 {
 126   SpiRegister *reg = SPI_REGISTER (object);
 127
 128   g_free (reg->ref2ptr);
 129
 130   G_OBJECT_CLASS (spi_register_parent_class)->finalize (object);
 131 }
 132
 133 static void
 134 spi_register_dispose (GObject * object)
 135 {
 136   SpiRegister *reg = SPI_REGISTER (object);
 137
 138   G_OBJECT_CLASS (spi_register_parent_class)->dispose (object);
 139 }
 140
 141 /*---------------------------------------------------------------------------*/
 142
 143 /*
 144  * Each AtkObject must be asssigned a D-Bus path (Reference)
 145  *
 146  * This function provides an integer reference for a new
 147  * AtkObject.
 148  *
 149  * TODO: Make this reference a little more unique, this is shoddy.
 150  */
 151 static guint
 152 assign_reference (SpiRegister * reg)
 153 {
 154   reg->reference_counter++;
 155   /* Reference of 0 not allowed as used as direct key in hash table */
 156   if (reg->reference_counter == 0)
 157     reg->reference_counter++;
 158   return reg->reference_counter;
 159 }
 160
 161 /*---------------------------------------------------------------------------*/
 162
 163 /*
 164  * Returns the reference of the object, or 0 if it is not registered.
 165  */
 166 static guint
 167 object_to_ref (GObject * gobj)
 168 {
 169   return GPOINTER_TO_INT (g_object_get_data (gobj, SPI_DBUS_ID));
 170 }
 171
 172 /*
 173  * Converts the Accessible object reference to its D-Bus object path
 174  */
 175 static gchar *
 176 ref_to_path (guint ref)
 177 {
 178   return g_strdup_printf (SPI_ATK_OBJECT_REFERENCE_TEMPLATE, ref);
 179 }
 180
 181 /*---------------------------------------------------------------------------*/
 182
 183 /*
 184  * Callback for when a registered AtkObject is destroyed.
 185  *
 186  * Removes the AtkObject from the reference lookup tables, meaning
 187  * it is no longer exposed over D-Bus.
 188  */
 189 static void
 190 deregister_object (gpointer data, GObject * gobj)
 191 {
 192   SpiRegister *reg = SPI_REGISTER (data);
 193
 194   spi_register_deregister_object (reg, gobj);
 195 }
 196
 197 void
 198 spi_register_deregister_object (SpiRegister *reg, GObject *gobj)
 199 {
 200   guint ref;
 201
 202   ref = object_to_ref (gobj);
 203   if (ref != 0)
 204     {
 205       g_signal_emit (reg,
 206                      register_signals [OBJECT_DEREGISTERED],
 207                      0,
 208                      gobj);
 209       g_hash_table_remove (reg->ref2ptr, GINT_TO_POINTER (ref));
 210
 211 #ifdef SPI_ATK_DEBUG
 212       g_debug ("DEREG  - %d", ref);
 213 #endif
 214     }
 215 }
 216
 217 static void
 218 register_object (SpiRegister * reg, GObject * gobj)
 219 {
 220   guint ref;
 221   g_return_if_fail (G_IS_OBJECT (gobj));
 222
 223   ref = assign_reference (reg);
 224
 225   g_hash_table_insert (reg->ref2ptr, GINT_TO_POINTER (ref), gobj);
 226   g_object_set_data (G_OBJECT (gobj), SPI_DBUS_ID, GINT_TO_POINTER (ref));
 227   g_object_weak_ref (G_OBJECT (gobj), deregister_object, reg);
 228
 229 #ifdef SPI_ATK_DEBUG
 230   g_debug ("REG  - %d", ref);
 231 #endif
 232
 233   g_signal_emit (reg, register_signals [OBJECT_REGISTERED], 0, gobj);
 234 }
 235
 236 /*---------------------------------------------------------------------------*/
 237
 238 /*
 239  * Used to lookup an GObject from its D-Bus path.
 240  *
 241  * If the D-Bus path is not found this function returns NULL.
 242  */
 243 GObject *
 244 spi_register_path_to_object (SpiRegister * reg, const char *path)
 245 {
 246   guint index;
 247   void *data;
 248
 249   g_return_val_if_fail (path, NULL);
 250
 251   if (strncmp (path, SPI_ATK_OBJECT_PATH_PREFIX, SPI_ATK_PATH_PREFIX_LENGTH)
 252       != 0)
 253     return NULL;
 254
 255   path += SPI_ATK_PATH_PREFIX_LENGTH; /* Skip over the prefix */
 256
 257   /* Map the root path to the root object. */
 258   if (!g_strcmp0 (SPI_ATK_OBJECT_PATH_ROOT, path))
 259     return G_OBJECT (spi_global_app_data->root);
 260
 261   index = atoi (path);
 262   data = g_hash_table_lookup (reg->ref2ptr, GINT_TO_POINTER (index));
 263   if (data)
 264     return G_OBJECT(data);
 265   else
 266     return NULL;
 267 }
 268
 269 GObject *
 270 spi_global_register_path_to_object (const char * path)
 271 {
 272   return spi_register_path_to_object (spi_global_register, path);
 273 }
 274
 275 /*
 276  * Used to lookup a D-Bus path from the GObject.
 277  *
 278  * If the objects is not already registered,
 279  * this function will register it.
 280  */
 281 gchar *
 282 spi_register_object_to_path (SpiRegister * reg, GObject * gobj)
 283 {
 284   guint ref;
 285
 286   if (gobj == NULL)
 287     return NULL;
 288
 289   /* Map the root object to the root path. */
 290   if ((void *)gobj == (void *)spi_global_app_data->root)
 291     return g_strdup (spi_register_root_path);
 292
 293   ref = object_to_ref (gobj);
 294   if (!ref)
 295     {
 296       register_object (reg, gobj);
 297       ref = object_to_ref (gobj);
 298     }
 299
 300   if (!ref)
 301     return NULL;
 302   else
 303     return ref_to_path (ref);
 304 }
 305
 306 guint
 307 spi_register_object_to_ref (GObject * gobj)
 308 {
 309   return object_to_ref (gobj);
 310 }
 311
 312 /*
 313  * Gets the path that indicates the accessible desktop object.
 314  * This object is logically located on the registry daemon and not
 315  * within any particular application.
 316  */
 317 gchar *
 318 spi_register_root_object_path ()
 319 {
 320   return g_strdup (SPI_ATK_OBJECT_PATH_PREFIX SPI_ATK_OBJECT_PATH_ROOT);
 321 }
 322
 323 /*END------------------------------------------------------------------------*/