atk-adaptor/accessible-marshaller.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  *
   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.
  11  *
  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.
  16  *
  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.
  21  */
  22
  23 #include <string.h>
  24 #include <droute/droute.h>
  25
  26 #include "common/spi-dbus.h"
  27 #include "common/spi-stateset.h"
  28
  29 #include "accessible-register.h"
  30 #include "accessible-marshaller.h"
  31 #include "bridge.h"
  32
  33 #include "adaptors.h"
  34
  35 /*---------------------------------------------------------------------------*/
  36
  37 void
  38 spi_dbus_append_name_and_path_inner (DBusMessageIter *iter, const char *bus_name, const char *path)
  39 {
  40   DBusMessageIter iter_struct;
  41
  42   if (!bus_name)
  43     bus_name = "";
  44
  45   dbus_message_iter_open_container (iter, DBUS_TYPE_STRUCT, NULL, &iter_struct);
  46   dbus_message_iter_append_basic (&iter_struct, DBUS_TYPE_STRING, &bus_name);
  47   dbus_message_iter_append_basic (&iter_struct, DBUS_TYPE_OBJECT_PATH, &path);
  48   dbus_message_iter_close_container (iter, &iter_struct);
  49 }
  50
  51 void
  52 spi_dbus_append_name_and_path (DBusMessage *message, DBusMessageIter *iter, AtkObject *obj, gboolean do_register, gboolean unref)
  53 {
  54   gchar *path;
  55   DBusMessageIter iter_struct;
  56   const char *bus_name = dbus_bus_get_unique_name (atk_adaptor_app_data->bus);
  57
  58   path = atk_dbus_object_to_path (obj, do_register);
  59
  60   if (!path)
  61     path = g_strdup (SPI_DBUS_PATH_NULL);
  62
  63   spi_dbus_append_name_and_path_inner (iter, bus_name, path);
  64
  65   g_free (path);
  66   if (obj && unref)
  67     g_object_unref (obj);
  68 }
  69
  70 /*
  71  * Marshals the D-Bus path of an AtkObject into a D-Bus message.
  72  *
  73  * Unrefs the AtkObject if unref is true.
  74  */
  75 DBusMessage *
  76 spi_dbus_return_object (DBusMessage *message, AtkObject *obj, gboolean do_register, gboolean unref)
  77 {
  78   DBusMessage *reply;
  79   reply = dbus_message_new_method_return (message);
  80   if (reply)
  81     {
  82       DBusMessageIter iter;
  83       dbus_message_iter_init_append (reply, &iter);
  84       spi_dbus_append_name_and_path (message, &iter, obj, do_register, unref);
  85     }
  86
  87   return reply;
  88 }
  89
  90 DBusMessage *
  91 spi_dbus_return_hyperlink (DBusMessage *message, AtkHyperlink *link, AtkObject *container, gboolean unref)
  92 {
  93   return spi_dbus_return_sub_object (message, G_OBJECT (link), G_OBJECT (container), unref);
  94 }
  95
  96 DBusMessage *
  97 spi_dbus_return_sub_object (DBusMessage *message, GObject *sub, GObject *container, gboolean unref)
  98 {
  99   DBusMessage *reply;
 100   gchar *path;
 101
 102   path = atk_dbus_sub_object_to_path (sub, container);
 103
 104   if (sub && unref)
 105     g_object_unref (sub);
 106
 107   if (!path)
 108     path = g_strdup (SPI_DBUS_PATH_NULL);
 109
 110   reply = dbus_message_new_method_return (message);
 111   if (reply)
 112     {
 113       dbus_message_append_args (reply, DBUS_TYPE_OBJECT_PATH, &path,
 114                                 DBUS_TYPE_INVALID);
 115     }
 116
 117   g_free (path);
 118
 119   return reply;
 120 }
 121
 122 /*---------------------------------------------------------------------------*/
 123
 124 /*
 125  * Marshals a variant containing the D-Bus path of an AtkObject into a D-Bus
 126  * message.
 127  *
 128  * Unrefs the object if unref is true.
 129  */
 130 dbus_bool_t
 131 spi_dbus_return_v_object (DBusMessageIter *iter, AtkObject *obj, int unref)
 132 {
 133   DBusMessageIter iter_variant;
 134   char *path;
 135
 136   path = atk_dbus_object_to_path (obj, FALSE);
 137
 138   if (!path)
 139     path = g_strdup (SPI_DBUS_PATH_NULL);
 140
 141   if (unref)
 142     g_object_unref (obj);
 143
 144   dbus_message_iter_open_container (iter, DBUS_TYPE_VARIANT, "(so)", &iter_variant);
 145   spi_dbus_append_name_and_path_inner (&iter_variant, NULL, path);
 146   dbus_message_iter_close_container (iter, &iter_variant);
 147 }
 148
 149 /*---------------------------------------------------------------------------*/
 150
 151 void
 152 append_atk_object_interfaces (AtkObject *object, DBusMessageIter *iter)
 153 {
 154   const gchar *itf;
 155
 156   itf = SPI_DBUS_INTERFACE_ACCESSIBLE;
 157   dbus_message_iter_append_basic (iter, DBUS_TYPE_STRING, &itf);
 158
 159   if (ATK_IS_ACTION (object))
 160     {
 161       itf = SPI_DBUS_INTERFACE_ACTION;
 162       dbus_message_iter_append_basic (iter, DBUS_TYPE_STRING, &itf);
 163     }
 164
 165   if (ATK_IS_COMPONENT (object))
 166     {
 167       itf = SPI_DBUS_INTERFACE_COMPONENT;
 168       dbus_message_iter_append_basic (iter, DBUS_TYPE_STRING, &itf);
 169     }
 170
 171   if (ATK_IS_EDITABLE_TEXT (object))
 172     {
 173       itf = SPI_DBUS_INTERFACE_EDITABLE_TEXT;
 174       dbus_message_iter_append_basic (iter, DBUS_TYPE_STRING, &itf);
 175     }
 176
 177   if (ATK_IS_TEXT (object))
 178     {
 179       itf = SPI_DBUS_INTERFACE_TEXT;
 180       dbus_message_iter_append_basic (iter, DBUS_TYPE_STRING, &itf);
 181     }
 182
 183   if (ATK_IS_HYPERTEXT (object))
 184     {
 185       itf = SPI_DBUS_INTERFACE_HYPERTEXT;
 186       dbus_message_iter_append_basic (iter, DBUS_TYPE_STRING, &itf);
 187     }
 188
 189   if (ATK_IS_IMAGE (object))
 190     {
 191       itf = SPI_DBUS_INTERFACE_IMAGE;
 192       dbus_message_iter_append_basic (iter, DBUS_TYPE_STRING, &itf);
 193     }
 194
 195   if (ATK_IS_SELECTION (object))
 196     {
 197       itf = SPI_DBUS_INTERFACE_SELECTION;
 198       dbus_message_iter_append_basic (iter, DBUS_TYPE_STRING, &itf);
 199     }
 200
 201   if (ATK_IS_TABLE (object))
 202     {
 203       itf = SPI_DBUS_INTERFACE_TABLE;
 204       dbus_message_iter_append_basic (iter, DBUS_TYPE_STRING, &itf);
 205     }
 206
 207   if (ATK_IS_VALUE (object))
 208     {
 209       itf = SPI_DBUS_INTERFACE_VALUE;
 210       dbus_message_iter_append_basic (iter, DBUS_TYPE_STRING, &itf);
 211     }
 212
 213   if (ATK_IS_STREAMABLE_CONTENT (object))
 214     {
 215       itf = "org.freedesktop.atspi.StreamableContent";
 216       dbus_message_iter_append_basic (iter, DBUS_TYPE_STRING, &itf);
 217     }
 218
 219   if (ATK_IS_DOCUMENT (object))
 220     {
 221       itf = "org.freedesktop.atspi.Collection";
 222       dbus_message_iter_append_basic (iter, DBUS_TYPE_STRING, &itf);
 223       itf = SPI_DBUS_INTERFACE_DOCUMENT;
 224       dbus_message_iter_append_basic (iter, DBUS_TYPE_STRING, &itf);
 225     }
 226
 227   if (ATK_IS_HYPERLINK_IMPL (object))
 228     {
 229       itf = SPI_DBUS_INTERFACE_HYPERLINK;
 230       dbus_message_iter_append_basic (iter, DBUS_TYPE_STRING, &itf);
 231     }
 232 }
 233
 234 /*---------------------------------------------------------------------------*/
 235
 236 /*
 237  * Marshals the given AtkObject into the provided D-Bus iterator.
 238  *
 239  * The object is marshalled including all its client side cache data.
 240  * The format of the structure is (o(so)a(so)assusau).
 241  * This is used in the updateTree signal and the GetTree method
 242  * of the org.freedesktop.atspi.Tree interface.
 243  *
 244  * To marshal an object its parent, and all its children must already
 245  * be registered with D-Bus and have been given a D-Bus object path.
 246  */
 247 void
 248 spi_atk_append_accessible(AtkObject *obj, gpointer data)
 249 {
 250   DBusMessageIter iter_struct, iter_sub_array;
 251   dbus_uint32_t states [2];
 252   int count;
 253   AtkStateSet *set;
 254   DBusMessageIter *iter_array = (DBusMessageIter *)data;
 255
 256   const char *name, *desc;
 257   dbus_uint32_t role;
 258
 259   set = atk_object_ref_state_set (obj);
 260   dbus_message_iter_open_container (iter_array, DBUS_TYPE_STRUCT, NULL, &iter_struct);
 261     {
 262       AtkObject *parent;
 263       gchar *path, *path_parent;
 264
 265       /* Marshall object path */
 266       path = atk_dbus_object_to_path (obj, FALSE);
 267
 268       /* Marshall parent */
 269       parent = atk_object_get_parent(obj);
 270       if (parent == NULL)
 271         {
 272           path_parent = atk_dbus_desktop_object_path ();
 273         }
 274       else
 275         {
 276           path_parent = atk_dbus_object_to_path (parent, FALSE);
 277           if (!path_parent)
 278             {
 279               /* This should only happen if a widget is re-parented to
 280                * an AtkObject that has not been registered and is then
 281                * updated. Ideally objects would be de-registered when
 282                * they are removed from a registered tree object, but
 283                * this would invalidate a huge amount of cache when
 284                * re-parenting.
 285                */
 286 #if SPI_ATK_DEBUG
 287               g_warning ("AT-SPI: Registered accessible marshalled when parent not registered");
 288 #endif
 289               path_parent = atk_dbus_desktop_object_path ();
 290             }
 291         }
 292
 293       dbus_message_iter_append_basic (&iter_struct, DBUS_TYPE_OBJECT_PATH, &path);
 294       spi_dbus_append_name_and_path_inner (&iter_struct, NULL, path_parent);
 295       g_free(path_parent);
 296
 297       /* Marshall children */
 298       dbus_message_iter_open_container (&iter_struct, DBUS_TYPE_ARRAY, "(so)", &iter_sub_array);
 299       if (!atk_state_set_contains_state (set, ATK_STATE_MANAGES_DESCENDANTS))
 300         {
 301           gint childcount, i;
 302
 303           childcount = atk_object_get_n_accessible_children (obj);
 304           for (i = 0; i < childcount; i++)
 305             {
 306               AtkObject *child;
 307               gchar *child_path;
 308
 309               child = atk_object_ref_accessible_child (obj, i);
 310               child_path = atk_dbus_object_to_path (child, FALSE);
 311               if (child_path)
 312                 {
 313                   spi_dbus_append_name_and_path_inner (&iter_sub_array, NULL, child_path);
 314                   g_free (child_path);
 315                 }
 316               g_object_unref(G_OBJECT(child));
 317             }
 318         }
 319 #ifdef __ATK_PLUG_H__
 320       if (ATK_IS_SOCKET (obj) && atk_socket_is_occupied (ATK_SOCKET(obj)))
 321         {
 322           AtkSocket *socket = ATK_SOCKET(obj);
 323           gchar *child_name, *child_path;
 324           child_name = g_strdup (socket->embedded_plug_id);
 325           child_path = strchr (child_name + 1, ':');
 326           if (child_path)
 327             {
 328               *(child_path++) = '\0';
 329               spi_dbus_append_name_and_path_inner (&iter_sub_array, child_name, child_path);
 330             }
 331           g_free (child_name);
 332         }
 333 #endif
 334
 335       dbus_message_iter_close_container (&iter_struct, &iter_sub_array);
 336
 337       /* Marshall interfaces */
 338       dbus_message_iter_open_container (&iter_struct, DBUS_TYPE_ARRAY, "s", &iter_sub_array);
 339       append_atk_object_interfaces (obj, &iter_sub_array);
 340       dbus_message_iter_close_container (&iter_struct, &iter_sub_array);
 341
 342       /* Marshall name */
 343       name = atk_object_get_name (obj);
 344       if (!name)
 345         name = "";
 346       dbus_message_iter_append_basic (&iter_struct, DBUS_TYPE_STRING, &name);
 347
 348       /* Marshall role */
 349       role = spi_accessible_role_from_atk_role (atk_object_get_role (obj));
 350       dbus_message_iter_append_basic (&iter_struct, DBUS_TYPE_UINT32, &role);
 351
 352       /* Marshall description */
 353       desc = atk_object_get_description (obj);
 354       if (!desc)
 355         desc = "";
 356       dbus_message_iter_append_basic (&iter_struct, DBUS_TYPE_STRING, &desc);
 357
 358       g_free(path);
 359
 360       /* Marshall state set */
 361       spi_atk_state_set_to_dbus_array (set, states);
 362       dbus_message_iter_open_container (&iter_struct, DBUS_TYPE_ARRAY, "u", &iter_sub_array);
 363       for (count = 0; count < 2; count++)
 364         {
 365           dbus_message_iter_append_basic (&iter_sub_array, DBUS_TYPE_UINT32, &states[count]);
 366         }
 367       dbus_message_iter_close_container (&iter_struct, &iter_sub_array);
 368     }
 369   dbus_message_iter_close_container (iter_array, &iter_struct);
 370   g_object_unref (set);
 371 }
 372
 373 void
 374 spi_atk_append_attribute_set (DBusMessageIter *iter, AtkAttributeSet *attr)
 375 {
 376   DBusMessageIter dictIter;
 377
 378   dbus_message_iter_open_container (iter, DBUS_TYPE_ARRAY, "{ss}", &dictIter);
 379   spi_atk_append_attribute_set_inner (&dictIter, attr);
 380   dbus_message_iter_close_container (iter, &dictIter);
 381 }
 382
 383 void
 384 spi_atk_append_attribute_set_inner (DBusMessageIter *iter, AtkAttributeSet *attr)
 385 {
 386   DBusMessageIter dictEntryIter;
 387
 388   while (attr)
 389     {
 390       AtkAttribute *attribute = (AtkAttribute *) attr->data;
 391       dbus_message_iter_open_container (iter, DBUS_TYPE_DICT_ENTRY, NULL, &dictEntryIter);
 392       dbus_message_iter_append_basic (&dictEntryIter, DBUS_TYPE_STRING, &attribute->name);
 393       dbus_message_iter_append_basic (&dictEntryIter, DBUS_TYPE_STRING, &attribute->value);
 394       dbus_message_iter_close_container (iter, &dictEntryIter);
 395       attr = g_slist_next (attr);
 396     }
 397 }
 398
 399 /*END------------------------------------------------------------------------*/
 400