atk-adaptor/adaptors/cache-adaptor.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 2001, 2002 Sun Microsystems Inc.,
   7  * Copyright 2001, 2002 Ximian, Inc.
   8  * Copyright 2008, 2009 Codethink Ltd.
   9  *
  10  * This library is free software; you can redistribute it and/or
  11  * modify it under the terms of the GNU Library General Public
  12  * License as published by the Free Software Foundation; either
  13  * version 2 of the License, or (at your option) any later version.
  14  *
  15  * This library is distributed in the hope that it will be useful,
  16  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  17  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  18  * Library General Public License for more details.
  19  *
  20  * You should have received a copy of the GNU Library General Public
  21  * License along with this library; if not, write to the
  22  * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
  23  * Boston, MA 02111-1307, USA.
  24  */
  25
  26 #include <string.h>
  27
  28 #include <atk/atk.h>
  29 #include <droute/droute.h>
  30
  31 #include "common/spi-dbus.h"
  32 #include "accessible-cache.h"
  33 #include "bridge.h"
  34 #include "object.h"
  35
  36 /* TODO - This should possibly be a common define */
  37 #define SPI_OBJECT_PREFIX "/org/at_spi"
  38 #define SPI_CACHE_OBJECT_SUFFIX "/cache"
  39 #define SPI_CACHE_OBJECT_PATH SPI_OBJECT_PREFIX SPI_CACHE_OBJECT_SUFFIX
  40
  41 #define SPI_OBJECT_REFERENCE_SIGNATURE "(" \
  42                                           DBUS_TYPE_STRING_AS_STRING \
  43                                           DBUS_TYPE_OBJECT_PATH_AS_STRING \
  44                                        ")"
  45
  46 #define SPI_CACHE_ITEM_SIGNATURE "(" \
  47                                    DBUS_TYPE_OBJECT_PATH_AS_STRING \
  48                                    SPI_OBJECT_REFERENCE_SIGNATURE \
  49                                    SPI_OBJECT_REFERENCE_SIGNATURE \
  50                                    DBUS_TYPE_ARRAY_AS_STRING \
  51                                      SPI_OBJECT_REFERENCE_SIGNATURE \
  52                                    DBUS_TYPE_ARRAY_AS_STRING \
  53                                      DBUS_TYPE_STRING_AS_STRING \
  54                                    DBUS_TYPE_STRING_AS_STRING \
  55                                    DBUS_TYPE_UINT32_AS_STRING \
  56                                    DBUS_TYPE_STRING_AS_STRING \
  57                                    DBUS_TYPE_ARRAY_AS_STRING \
  58                                      DBUS_TYPE_UINT32_AS_STRING \
  59                                  ")"
  60
  61 /*---------------------------------------------------------------------------*/
  62
  63 /*
  64  * Marshals the given AtkObject into the provided D-Bus iterator.
  65  *
  66  * The object is marshalled including all its client side cache data.
  67  * The format of the structure is (o(so)a(so)assusau).
  68  */
  69 static void
  70 append_cache_item (AtkObject * obj, gpointer data)
  71 {
  72   DBusMessageIter iter_struct, iter_sub_array;
  73   dbus_uint32_t states[2];
  74   int count;
  75   AtkStateSet *set;
  76   DBusMessageIter *iter_array = (DBusMessageIter *) data;
  77
  78   const char *name, *desc;
  79   dbus_uint32_t role;
  80
  81   set = atk_object_ref_state_set (obj);
  82   {
  83     AtkObject *application, *parent;
  84
  85     dbus_message_iter_open_container (iter_array, DBUS_TYPE_STRUCT, NULL,
  86                                       &iter_struct);
  87
  88     /* Marshall object path */
  89     spi_object_append_reference (&iter_struct, obj);
  90
  91     role = spi_accessible_role_from_atk_role (atk_object_get_role (obj));
  92
  93     /* Marshall application */
  94     application = spi_global_app_data->root;
  95     spi_object_append_reference (&iter_struct, application);
  96
  97     /* Marshall parent */
  98     parent = atk_object_get_parent (obj);
  99     if (parent == NULL)
 100       {
 101 #ifdef SPI_ATK_PLUG_SOCKET
 102         /* TODO, move in to a 'Plug' wrapper. */
 103         if (ATK_IS_PLUG (obj))
 104           {
 105             char *id = g_object_get_data (G_OBJECT (obj), "dbus-plug-parent");
 106             char *bus_parent;
 107             char *path_parent;
 108
 109             if (id)
 110               {
 111                 bus_parent = g_strdup (id);
 112               if (bus_parent && (path_parent = g_utf8_strchr (bus_parent + 1, -1, ':')))
 113                 {
 114                   DBusMessageIter iter_parent;
 115                   *(path_parent++) = '\0';
 116                   dbus_message_iter_open_container (&iter_struct, DBUS_TYPE_STRUCT, NULL,
 117                                                     &iter_parent);
 118                   dbus_message_iter_append_basic (&iter_parent, DBUS_TYPE_STRING, &bus_parent);
 119                   dbus_message_iter_append_basic (&iter_parent, DBUS_TYPE_OBJECT_PATH, &path_parent);
 120                   dbus_message_iter_close_container (&iter_struct, &iter_parent);
 121                 }
 122               }
 123           }
 124         else if (role != Accessibility_ROLE_APPLICATION)
 125 #else
 126         if (role != Accessibility_ROLE_APPLICATION)
 127 #endif
 128           spi_object_append_null_reference (&iter_struct);
 129         else
 130           spi_object_append_desktop_reference (&iter_struct);
 131       }
 132     else
 133       {
 134         spi_object_append_reference (&iter_struct, parent);
 135       }
 136
 137     /* Marshall children */
 138     dbus_message_iter_open_container (&iter_struct, DBUS_TYPE_ARRAY, "(so)",
 139                                       &iter_sub_array);
 140     if (!atk_state_set_contains_state (set, ATK_STATE_MANAGES_DESCENDANTS))
 141       {
 142         gint childcount, i;
 143
 144         childcount = atk_object_get_n_accessible_children (obj);
 145         for (i = 0; i < childcount; i++)
 146           {
 147             AtkObject *child;
 148             gchar *child_path;
 149
 150             child = atk_object_ref_accessible_child (obj, i);
 151             spi_object_append_reference (&iter_sub_array, child);
 152             g_object_unref (G_OBJECT (child));
 153           }
 154       }
 155 #ifdef SPI_ATK_PLUG_SOCKET
 156     if (ATK_IS_SOCKET (obj) && atk_socket_is_occupied (ATK_SOCKET (obj)))
 157       {
 158         AtkSocket *socket = ATK_SOCKET (obj);
 159         gchar *child_name, *child_path;
 160         child_name = g_strdup (socket->embedded_plug_id);
 161         child_path = g_utf8_strchr (child_name + 1, -1, ':');
 162         if (child_path)
 163           {
 164             DBusMessageIter iter_socket;
 165             *(child_path++) = '\0';
 166             dbus_message_iter_open_container (&iter_sub_array, DBUS_TYPE_STRUCT, NULL,
 167                                               &iter_socket);
 168             dbus_message_iter_append_basic (&iter_socket, DBUS_TYPE_STRING, &child_name);
 169             dbus_message_iter_append_basic (&iter_socket, DBUS_TYPE_OBJECT_PATH, &child_path);
 170             dbus_message_iter_close_container (&iter_sub_array, &iter_socket);
 171           }
 172         g_free (child_name);
 173       }
 174 #endif
 175
 176     dbus_message_iter_close_container (&iter_struct, &iter_sub_array);
 177
 178     /* Marshall interfaces */
 179     dbus_message_iter_open_container (&iter_struct, DBUS_TYPE_ARRAY, "s",
 180                                       &iter_sub_array);
 181     spi_object_append_interfaces (&iter_sub_array, obj);
 182     dbus_message_iter_close_container (&iter_struct, &iter_sub_array);
 183
 184     /* Marshall name */
 185     name = atk_object_get_name (obj);
 186     if (!name)
 187       name = "";
 188     dbus_message_iter_append_basic (&iter_struct, DBUS_TYPE_STRING, &name);
 189
 190     /* Marshall role */
 191     dbus_message_iter_append_basic (&iter_struct, DBUS_TYPE_UINT32, &role);
 192
 193     /* Marshall description */
 194     desc = atk_object_get_description (obj);
 195     if (!desc)
 196       desc = "";
 197     dbus_message_iter_append_basic (&iter_struct, DBUS_TYPE_STRING, &desc);
 198
 199     /* Marshall state set */
 200     spi_atk_state_set_to_dbus_array (set, states);
 201     dbus_message_iter_open_container (&iter_struct, DBUS_TYPE_ARRAY, "u",
 202                                       &iter_sub_array);
 203     for (count = 0; count < 2; count++)
 204       {
 205         dbus_message_iter_append_basic (&iter_sub_array, DBUS_TYPE_UINT32,
 206                                         &states[count]);
 207       }
 208     dbus_message_iter_close_container (&iter_struct, &iter_sub_array);
 209   }
 210   dbus_message_iter_close_container (iter_array, &iter_struct);
 211   g_object_unref (set);
 212 }
 213
 214 /*---------------------------------------------------------------------------*/
 215
 216 /* For use as a GHFunc */
 217 static void
 218 append_accessible_hf (gpointer key, gpointer obj_data, gpointer data)
 219 {
 220   /* Make sure it isn't a hyperlink */
 221   if (ATK_IS_OBJECT (obj_data))
 222     append_cache_item (ATK_OBJECT (obj_data), data);
 223 }
 224
 225 /*---------------------------------------------------------------------------*/
 226
 227 static void
 228 emit_cache_remove (SpiCache *cache, GObject * obj)
 229 {
 230   DBusMessage *message;
 231
 232   if ((message = dbus_message_new_signal (SPI_CACHE_OBJECT_PATH,
 233                                           SPI_DBUS_INTERFACE_CACHE,
 234                                           "RemoveAccessible")))
 235     {
 236       DBusMessageIter iter;
 237       gchar *path;
 238
 239       dbus_message_iter_init_append (message, &iter);
 240
 241       spi_object_append_reference (&iter, ATK_OBJECT (obj));
 242
 243       dbus_connection_send (spi_global_app_data->bus, message, NULL);
 244
 245       dbus_message_unref (message);
 246     }
 247 }
 248
 249 static void
 250 emit_cache_add (SpiCache *cache, GObject * obj)
 251 {
 252   AtkObject *accessible = ATK_OBJECT (obj);
 253   DBusMessage *message;
 254
 255   if ((message = dbus_message_new_signal (SPI_CACHE_OBJECT_PATH,
 256                                           SPI_DBUS_INTERFACE_CACHE,
 257                                           "AddAccessible")))
 258     {
 259       DBusMessageIter iter;
 260
 261       dbus_message_iter_init_append (message, &iter);
 262       append_cache_item (accessible, &iter);
 263
 264       dbus_connection_send (spi_global_app_data->bus, message, NULL);
 265
 266       dbus_message_unref (message);
 267     }
 268 }
 269
 270
 271 /*---------------------------------------------------------------------------*/
 272
 273 static DBusMessage *
 274 impl_GetRoot (DBusConnection * bus, DBusMessage * message, void *user_data)
 275 {
 276   return spi_object_return_reference (message,
 277                                       g_object_ref (G_OBJECT (spi_global_app_data->root)));
 278 }
 279
 280 /*---------------------------------------------------------------------------*/
 281
 282 static DBusMessage *
 283 impl_GetItems (DBusConnection * bus, DBusMessage * message, void *user_data)
 284 {
 285   DBusMessage *reply;
 286   DBusMessageIter iter, iter_array;
 287
 288   reply = dbus_message_new_method_return (message);
 289
 290   dbus_message_iter_init_append (reply, &iter);
 291   dbus_message_iter_open_container (&iter, DBUS_TYPE_ARRAY,
 292                                     SPI_CACHE_ITEM_SIGNATURE, &iter_array);
 293   spi_cache_foreach (spi_global_cache, append_accessible_hf, &iter_array);
 294   dbus_message_iter_close_container (&iter, &iter_array);
 295   return reply;
 296 }
 297
 298 /*---------------------------------------------------------------------------*/
 299
 300 static DRouteMethod methods[] = {
 301   {impl_GetRoot, "GetRoot"},
 302   {impl_GetItems, "GetItems"},
 303   {NULL, NULL}
 304 };
 305
 306 void
 307 spi_initialize_cache (DRoutePath * path)
 308 {
 309   droute_path_add_interface (path, SPI_DBUS_INTERFACE_CACHE, methods, NULL);
 310
 311   g_signal_connect (spi_global_cache,
 312                     "object-added",
 313                     (GCallback) emit_cache_add,
 314                     NULL);
 315
 316   g_signal_connect (spi_global_cache,
 317                     "object-removed",
 318                     (GCallback) emit_cache_remove,
 319                     NULL);
 320 };
 321
 322 /*END------------------------------------------------------------------------*/