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