atk-adaptor/adaptors/accessible-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  *
   9  * This library is free software; you can redistribute it and/or
  10  * modify it under the terms of the GNU Library General Public
  11  * License as published by the Free Software Foundation; either
  12  * version 2 of the License, or (at your option) any later version.
  13  *
  14  * This library is distributed in the hope that it will be useful,
  15  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  16  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  17  * Library General Public License for more details.
  18  *
  19  * You should have received a copy of the GNU Library General Public
  20  * License along with this library; if not, write to the
  21  * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
  22  * Boston, MA 02111-1307, USA.
  23  */
  24
  25 #include <atk/atk.h>
  26 #include <droute/droute.h>
  27
  28 #include "common/spi-dbus.h"
  29 #include "common/spi-stateset.h"
  30 #include "object.h"
  31 #include "introspection.h"
  32
  33 static dbus_bool_t
  34 impl_get_Name (DBusMessageIter * iter, void *user_data)
  35 {
  36   AtkObject *object = (AtkObject *) user_data;
  37
  38   g_return_val_if_fail (ATK_IS_OBJECT (user_data), FALSE);
  39
  40   return droute_return_v_string (iter, atk_object_get_name (object));
  41 }
  42
  43 static dbus_bool_t
  44 impl_set_Name (DBusMessageIter * iter, void *user_data)
  45 {
  46   AtkObject *object = (AtkObject *) user_data;
  47   const char *name = droute_get_v_string (iter);
  48
  49   g_return_val_if_fail (ATK_IS_OBJECT (user_data), FALSE);
  50
  51   atk_object_set_name (object, name);
  52   return TRUE;
  53 }
  54
  55 static dbus_bool_t
  56 impl_get_Description (DBusMessageIter * iter, void *user_data)
  57 {
  58   AtkObject *object = (AtkObject *) user_data;
  59
  60   g_return_val_if_fail (ATK_IS_OBJECT (user_data), FALSE);
  61
  62   return droute_return_v_string (iter, atk_object_get_description (object));
  63 }
  64
  65 static dbus_bool_t
  66 impl_set_Description (DBusMessageIter * iter, void *user_data)
  67 {
  68   AtkObject *object = (AtkObject *) user_data;
  69   const char *description = droute_get_v_string (iter);
  70
  71   g_return_val_if_fail (ATK_IS_OBJECT (user_data), FALSE);
  72
  73   atk_object_set_description (object, description);
  74   return TRUE;
  75 }
  76
  77 static dbus_bool_t
  78 impl_get_Parent (DBusMessageIter * iter, void *user_data)
  79 {
  80   AtkObject *obj = (AtkObject *) user_data;
  81   AtkObject *parent;
  82   DBusMessageIter iter_variant;
  83   dbus_uint32_t role;
  84
  85   g_return_val_if_fail (ATK_IS_OBJECT (user_data), FALSE);
  86
  87   role = spi_accessible_role_from_atk_role (atk_object_get_role (obj));
  88
  89   dbus_message_iter_open_container (iter, DBUS_TYPE_VARIANT, "(so)",
  90                                     &iter_variant);
  91
  92   parent = atk_object_get_parent (obj);
  93   if (parent == NULL)
  94     {
  95       /* TODO, move in to a 'Plug' wrapper. */
  96       if (ATK_IS_PLUG (obj))
  97         {
  98           char *id = g_object_get_data (G_OBJECT (obj), "dbus-plug-parent");
  99           char *bus_parent;
 100           char *path_parent;
 101
 102           if (id)
 103             {
 104               bus_parent = g_strdup (id);
 105               if (bus_parent && (path_parent = g_utf8_strchr (bus_parent + 1, -1, ':')))
 106                 {
 107                   DBusMessageIter iter_parent;
 108                   *(path_parent++) = '\0';
 109                   dbus_message_iter_open_container (&iter_variant, DBUS_TYPE_STRUCT, NULL,
 110                                                     &iter_parent);
 111                   dbus_message_iter_append_basic (&iter_parent, DBUS_TYPE_STRING, &bus_parent);
 112                   dbus_message_iter_append_basic (&iter_parent, DBUS_TYPE_OBJECT_PATH, &path_parent);
 113                   dbus_message_iter_close_container (&iter_variant, &iter_parent);
 114                 }
 115               else
 116                 {
 117                   spi_object_append_null_reference (&iter_variant);
 118                 }
 119             }
 120           else
 121             {
 122               spi_object_append_null_reference (&iter_variant);
 123             }
 124         }
 125       else if (role != Accessibility_ROLE_APPLICATION)
 126          spi_object_append_null_reference (&iter_variant);
 127       else
 128          spi_object_append_desktop_reference (&iter_variant);
 129       }
 130   else
 131     {
 132       spi_object_append_reference (&iter_variant, parent);
 133     }
 134
 135
 136   dbus_message_iter_close_container (iter, &iter_variant);
 137   return TRUE;
 138 }
 139
 140 static dbus_bool_t
 141 impl_get_ChildCount (DBusMessageIter * iter, void *user_data)
 142 {
 143   AtkObject *object = (AtkObject *) user_data;
 144
 145   g_return_val_if_fail (ATK_IS_OBJECT (user_data), FALSE);
 146
 147   return droute_return_v_int32 (iter,
 148                                 atk_object_get_n_accessible_children
 149                                 (object));
 150 }
 151
 152 static DBusMessage *
 153 impl_GetChildAtIndex (DBusConnection * bus,
 154                       DBusMessage * message, void *user_data)
 155 {
 156   AtkObject *object = (AtkObject *) user_data;
 157   DBusError error;
 158   dbus_int32_t i;
 159   AtkObject *child;
 160
 161   dbus_error_init (&error);
 162   g_return_val_if_fail (ATK_IS_OBJECT (user_data),
 163                         droute_not_yet_handled_error (message));
 164   if (!dbus_message_get_args
 165        (message, &error, DBUS_TYPE_INT32, &i, DBUS_TYPE_INVALID))
 166     {
 167       return droute_invalid_arguments_error (message);
 168     }
 169   child = atk_object_ref_accessible_child (object, i);
 170   return spi_object_return_reference (message, child);
 171 }
 172
 173 static DBusMessage *
 174 impl_GetChildren (DBusConnection * bus,
 175                   DBusMessage * message, void *user_data)
 176 {
 177   AtkObject *object = (AtkObject *) user_data;
 178   gint i;
 179   gint count;
 180   DBusMessage *reply;
 181   DBusMessageIter iter, iter_array;
 182
 183   g_return_val_if_fail (ATK_IS_OBJECT (user_data),
 184                         droute_not_yet_handled_error (message));
 185   count = atk_object_get_n_accessible_children (object);
 186   reply = dbus_message_new_method_return (message);
 187   if (!reply)
 188     goto oom;
 189   dbus_message_iter_init_append (reply, &iter);
 190   if (!dbus_message_iter_open_container
 191       (&iter, DBUS_TYPE_ARRAY, "(so)", &iter_array))
 192     goto oom;
 193   for (i = 0; i < count; i++)
 194     {
 195       AtkObject *child = atk_object_ref_accessible_child (object, i);
 196       spi_object_append_reference (&iter_array, child);
 197       if (child)
 198         g_object_unref (child);
 199     }
 200   if (!dbus_message_iter_close_container (&iter, &iter_array))
 201     goto oom;
 202   return reply;
 203 oom:
 204   // TODO: handle out-of-memory
 205   return reply;
 206 }
 207
 208 static DBusMessage *
 209 impl_GetIndexInParent (DBusConnection * bus,
 210                        DBusMessage * message, void *user_data)
 211 {
 212   AtkObject *object = (AtkObject *) user_data;
 213   dbus_uint32_t rv;
 214   DBusMessage *reply;
 215
 216   g_return_val_if_fail (ATK_IS_OBJECT (user_data),
 217                         droute_not_yet_handled_error (message));
 218
 219   rv = atk_object_get_index_in_parent (object);
 220   reply = dbus_message_new_method_return (message);
 221   dbus_message_append_args (reply, DBUS_TYPE_UINT32, &rv, DBUS_TYPE_INVALID);
 222   return reply;
 223 }
 224
 225 static gboolean
 226 spi_init_relation_type_table (Accessibility_RelationType * types)
 227 {
 228   gint i;
 229
 230   for (i = 0; i < ATK_RELATION_LAST_DEFINED; i++)
 231     types[i] = Accessibility_RELATION_NULL;
 232
 233   types[ATK_RELATION_CONTROLLED_BY] = Accessibility_RELATION_CONTROLLED_BY;
 234   types[ATK_RELATION_CONTROLLER_FOR] = Accessibility_RELATION_CONTROLLER_FOR;
 235   types[ATK_RELATION_LABEL_FOR] = Accessibility_RELATION_LABEL_FOR;
 236   types[ATK_RELATION_LABELLED_BY] = Accessibility_RELATION_LABELLED_BY;
 237   types[ATK_RELATION_MEMBER_OF] = Accessibility_RELATION_MEMBER_OF;
 238   types[ATK_RELATION_NODE_CHILD_OF] = Accessibility_RELATION_NODE_CHILD_OF;
 239   types[ATK_RELATION_FLOWS_TO] = Accessibility_RELATION_FLOWS_TO;
 240   types[ATK_RELATION_FLOWS_FROM] = Accessibility_RELATION_FLOWS_FROM;
 241   types[ATK_RELATION_SUBWINDOW_OF] = Accessibility_RELATION_SUBWINDOW_OF;
 242   types[ATK_RELATION_EMBEDS] = Accessibility_RELATION_EMBEDS;
 243   types[ATK_RELATION_EMBEDDED_BY] = Accessibility_RELATION_EMBEDDED_BY;
 244   types[ATK_RELATION_POPUP_FOR] = Accessibility_RELATION_POPUP_FOR;
 245   types[ATK_RELATION_PARENT_WINDOW_OF] =
 246     Accessibility_RELATION_PARENT_WINDOW_OF;
 247   types[ATK_RELATION_DESCRIPTION_FOR] =
 248     Accessibility_RELATION_DESCRIPTION_FOR;
 249   types[ATK_RELATION_DESCRIBED_BY] = Accessibility_RELATION_DESCRIBED_BY;
 250
 251   return TRUE;
 252 }
 253
 254 static Accessibility_RelationType
 255 spi_relation_type_from_atk_relation_type (AtkRelationType type)
 256 {
 257   static gboolean is_initialized = FALSE;
 258   static Accessibility_RelationType
 259     spi_relation_type_table[ATK_RELATION_LAST_DEFINED];
 260   Accessibility_RelationType spi_type;
 261
 262   if (!is_initialized)
 263     is_initialized = spi_init_relation_type_table (spi_relation_type_table);
 264
 265   if (type > ATK_RELATION_NULL && type < ATK_RELATION_LAST_DEFINED)
 266     spi_type = spi_relation_type_table[type];
 267   else
 268     spi_type = Accessibility_RELATION_EXTENDED;
 269   return spi_type;
 270 }
 271
 272 static DBusMessage *
 273 impl_GetRelationSet (DBusConnection * bus,
 274                      DBusMessage * message, void *user_data)
 275 {
 276   AtkObject *object = (AtkObject *) user_data;
 277   DBusMessage *reply;
 278   AtkRelationSet *set;
 279   DBusMessageIter iter, iter_array, iter_struct, iter_targets;
 280   gint count;
 281   gint i, j;
 282
 283   g_return_val_if_fail (ATK_IS_OBJECT (user_data),
 284                         droute_not_yet_handled_error (message));
 285   reply = dbus_message_new_method_return (message);
 286   if (!reply)
 287     return NULL;
 288   set = atk_object_ref_relation_set (object);
 289   dbus_message_iter_init_append (reply, &iter);
 290   if (!dbus_message_iter_open_container
 291       (&iter, DBUS_TYPE_ARRAY, "(ua(so))", &iter_array))
 292     {
 293       goto oom;
 294     }
 295   count = atk_relation_set_get_n_relations (set);
 296   for (i = 0; i < count; i++)
 297     {
 298       AtkRelation *r = atk_relation_set_get_relation (set, i);
 299       AtkRelationType rt;
 300       GPtrArray *target;
 301       dbus_uint32_t type;
 302       if (!r)
 303         continue;
 304       rt = atk_relation_get_relation_type (r);
 305       type = spi_relation_type_from_atk_relation_type (rt);
 306       target = atk_relation_get_target (r);
 307       if (!dbus_message_iter_open_container
 308           (&iter_array, DBUS_TYPE_STRUCT, NULL, &iter_struct))
 309         {
 310           goto oom;
 311         }
 312       dbus_message_iter_append_basic (&iter_struct, DBUS_TYPE_UINT32, &type);
 313       if (!dbus_message_iter_open_container
 314           (&iter_struct, DBUS_TYPE_ARRAY, "(so)", &iter_targets))
 315         {
 316           goto oom;
 317         }
 318       for (j = 0; j < target->len; j++)
 319         {
 320           AtkObject *obj = target->pdata[j];
 321           char *path;
 322           if (!obj)
 323             continue;
 324           spi_object_append_reference (&iter_targets, obj);
 325         }
 326       dbus_message_iter_close_container (&iter_struct, &iter_targets);
 327       dbus_message_iter_close_container (&iter_array, &iter_struct);
 328     }
 329   dbus_message_iter_close_container (&iter, &iter_array);
 330 oom:
 331   // TODO: handle out of memory */
 332   return reply;
 333 }
 334
 335 static DBusMessage *
 336 impl_GetRole (DBusConnection * bus, DBusMessage * message, void *user_data)
 337 {
 338   AtkObject *object = (AtkObject *) user_data;
 339   gint role;
 340   dbus_uint32_t rv;
 341   DBusMessage *reply;
 342
 343   g_return_val_if_fail (ATK_IS_OBJECT (user_data),
 344                         droute_not_yet_handled_error (message));
 345   role = atk_object_get_role (object);
 346   rv = spi_accessible_role_from_atk_role (role);
 347   reply = dbus_message_new_method_return (message);
 348   if (reply)
 349     {
 350       dbus_message_append_args (reply, DBUS_TYPE_UINT32, &rv,
 351                                 DBUS_TYPE_INVALID);
 352     }
 353   return reply;
 354 }
 355
 356 static char *
 357 impl_get_role_str (void *datum)
 358 {
 359   g_return_val_if_fail (ATK_IS_OBJECT (datum), g_strdup (""));
 360   return g_strdup_printf ("%d",
 361                           spi_accessible_role_from_atk_role
 362                           (atk_object_get_role ((AtkObject *) datum)));
 363 }
 364
 365 static DBusMessage *
 366 impl_GetRoleName (DBusConnection * bus,
 367                   DBusMessage * message, void *user_data)
 368 {
 369   AtkObject *object = (AtkObject *) user_data;
 370   gint role;
 371   const char *role_name;
 372   DBusMessage *reply;
 373
 374   g_return_val_if_fail (ATK_IS_OBJECT (user_data),
 375                         droute_not_yet_handled_error (message));
 376   role = atk_object_get_role (object);
 377   role_name = atk_role_get_name (role);
 378   if (!role_name)
 379     role_name = "";
 380   reply = dbus_message_new_method_return (message);
 381   if (reply)
 382     {
 383       dbus_message_append_args (reply, DBUS_TYPE_STRING, &role_name,
 384                                 DBUS_TYPE_INVALID);
 385     }
 386   return reply;
 387 }
 388
 389 static DBusMessage *
 390 impl_GetLocalizedRoleName (DBusConnection * bus,
 391                            DBusMessage * message, void *user_data)
 392 {
 393   AtkObject *object = (AtkObject *) user_data;
 394   gint role;
 395   const char *role_name;
 396   DBusMessage *reply;
 397
 398   g_return_val_if_fail (ATK_IS_OBJECT (user_data),
 399                         droute_not_yet_handled_error (message));
 400   role = atk_object_get_role (object);
 401   role_name = atk_role_get_localized_name (role);
 402   if (!role_name)
 403     role_name = "";
 404   reply = dbus_message_new_method_return (message);
 405   if (reply)
 406     {
 407       dbus_message_append_args (reply, DBUS_TYPE_STRING, &role_name,
 408                                 DBUS_TYPE_INVALID);
 409     }
 410   return reply;
 411 }
 412
 413 static DBusMessage *
 414 impl_GetState (DBusConnection * bus, DBusMessage * message, void *user_data)
 415 {
 416   AtkObject *object = (AtkObject *) user_data;
 417
 418   DBusMessage *reply = NULL;
 419   DBusMessageIter iter, iter_array;
 420
 421   dbus_uint32_t states[2];
 422
 423   guint count;
 424
 425   g_return_val_if_fail (ATK_IS_OBJECT (user_data),
 426                         droute_not_yet_handled_error (message));
 427
 428   reply = dbus_message_new_method_return (message);
 429   dbus_message_iter_init_append (reply, &iter);
 430
 431   spi_atk_state_to_dbus_array (object, states);
 432   dbus_message_iter_open_container (&iter, DBUS_TYPE_ARRAY, "u", &iter_array);
 433   for (count = 0; count < 2; count++)
 434     {
 435       dbus_message_iter_append_basic (&iter_array, DBUS_TYPE_UINT32,
 436                                       &states[count]);
 437     }
 438   dbus_message_iter_close_container (&iter, &iter_array);
 439   return reply;
 440 }
 441
 442 static DBusMessage *
 443 impl_GetAttributes (DBusConnection * bus,
 444                     DBusMessage * message, void *user_data)
 445 {
 446   AtkObject *object = (AtkObject *) user_data;
 447   AtkAttributeSet *attributes;
 448   DBusMessage *reply = NULL;
 449   DBusMessageIter iter;
 450
 451   g_return_val_if_fail (ATK_IS_OBJECT (user_data),
 452                         droute_not_yet_handled_error (message));
 453
 454   attributes = atk_object_get_attributes (object);
 455
 456   reply = dbus_message_new_method_return (message);
 457   dbus_message_iter_init_append (reply, &iter);
 458   spi_object_append_attribute_set (&iter, attributes);
 459
 460   atk_attribute_set_free (attributes);
 461
 462   return reply;
 463 }
 464
 465 static DBusMessage *
 466 impl_GetApplication (DBusConnection * bus,
 467                      DBusMessage * message, void *user_data)
 468 {
 469   AtkObject *root = g_object_ref (atk_get_root ());
 470   return spi_object_return_reference (message, root);
 471 }
 472
 473 static DBusMessage *
 474 impl_GetInterfaces (DBusConnection * bus,
 475                     DBusMessage * message, void *user_data)
 476 {
 477   AtkObject *object = (AtkObject *) user_data;
 478   gint role;
 479   const char *role_name;
 480   DBusMessage *reply;
 481   DBusMessageIter iter, iter_array;
 482
 483   g_return_val_if_fail (ATK_IS_OBJECT (user_data),
 484                         droute_not_yet_handled_error (message));
 485   reply = dbus_message_new_method_return (message);
 486   if (reply)
 487     {
 488       dbus_message_iter_init_append (reply, &iter);
 489       dbus_message_iter_open_container (&iter, DBUS_TYPE_ARRAY, "s",
 490                                         &iter_array);
 491       spi_object_append_interfaces (&iter_array, object);
 492       dbus_message_iter_close_container (&iter, &iter_array);
 493     }
 494   return reply;
 495 }
 496
 497 static DBusMessage *
 498 impl_Embedded (DBusConnection *bus,
 499                     DBusMessage *message,
 500                     void *user_data)
 501 {
 502   AtkObject *object = (AtkObject *) user_data;
 503   char *path;
 504   gchar *id;
 505
 506   if (!dbus_message_get_args (message, NULL, DBUS_TYPE_STRING, &path, DBUS_TYPE_INVALID))
 507     {
 508       return droute_invalid_arguments_error (message);
 509     }
 510   id = g_object_get_data (G_OBJECT (object), "dbus-plug-parent");
 511   if (id)
 512     g_free (id);
 513   id = g_strconcat (dbus_message_get_sender (message), ":", path, NULL);
 514   g_object_set_data (G_OBJECT (object), "dbus-plug-parent", id);
 515   return dbus_message_new_method_return (message);
 516 }
 517
 518 static DRouteMethod methods[] = {
 519   {impl_GetChildAtIndex, "GetChildAtIndex"},
 520   {impl_GetChildren, "GetChildren"},
 521   {impl_GetIndexInParent, "GetIndexInParent"},
 522   {impl_GetRelationSet, "GetRelationSet"},
 523   {impl_GetRole, "GetRole"},
 524   {impl_GetRoleName, "GetRoleName"},
 525   {impl_GetLocalizedRoleName, "GetLocalizedRoleName"},
 526   {impl_GetState, "GetState"},
 527   {impl_GetAttributes, "GetAttributes"},
 528   {impl_GetApplication, "GetApplication"},
 529   {impl_GetInterfaces, "GetInterfaces"},
 530   {impl_Embedded, "Embedded"},
 531   {NULL, NULL}
 532 };
 533
 534 static DRouteProperty properties[] = {
 535   {impl_get_Name, impl_set_Name, "Name"},
 536   {impl_get_Description, impl_set_Description, "Description"},
 537   {impl_get_Parent, NULL, "Parent"},
 538   {impl_get_ChildCount, NULL, "ChildCount"},
 539   {NULL, NULL, NULL}
 540 };
 541
 542 void
 543 spi_initialize_accessible (DRoutePath * path)
 544 {
 545   droute_path_add_interface (path,
 546                              SPI_DBUS_INTERFACE_ACCESSIBLE,
 547                              spi_org_freedesktop_atspi_Accessible,
 548                              methods, properties);
 549 };