atk-adaptor/object.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 /*
  25  * This module contains utility functions for exporting AT-SPI
  26  * objects based upon an ATK object.
  27  *
  28  * It incudes functions for marshalling object references
  29  * and supported interfaces to a D-Bus message.
  30  */
  31
  32 #include <atk/atk.h>
  33 #include <common/spi-types.h>
  34 #include <common/spi-dbus.h>
  35
  36 #include "accessible-register.h"
  37 #include "accessible-cache.h"
  38 #include "accessible-leasing.h"
  39
  40 #include "bridge.h"
  41
  42 /*---------------------------------------------------------------------------*/
  43
  44 /*
  45  * This is the all important function that decides whether an object should
  46  * be leased or not.
  47  *
  48  * The choice of algorithm for this is somewhat vuage. We want ideally to lease
  49  * all atk objects that are not owned by their parent.
  50  *
  51  * The 'cache' object attempts to cache all objects that are owned by their
  52  * parent by traversing the tree of accessibles, ignoring the children of
  53  * manages-descendants and transient objects.
  54  *
  55  * This function will simply look for all the accessibles that the cache object
  56  * has not found and assume that they need to be leased.
  57  */
  58 static void
  59 maybe_lease (AtkObject *obj)
  60 {
  61   if (!spi_cache_in (spi_global_cache, G_OBJECT (obj)))
  62     {
  63       spi_leasing_take (spi_global_leasing, G_OBJECT (obj));
  64     }
  65 }
  66
  67 /*---------------------------------------------------------------------------*/
  68
  69 /*
  70  * It is assumed that all of these functions are returning an accessible
  71  * object to the client side.
  72  *
  73  * All of them will lease the AtkObject if it is deemed neccessary.
  74  */
  75
  76 void
  77 spi_object_append_reference (DBusMessageIter * iter, AtkObject * obj)
  78 {
  79   DBusMessageIter iter_struct;
  80   const gchar *name;
  81   gchar *path;
  82
  83   if (!obj)
  84     return spi_object_append_null_reference (iter);
  85
  86   maybe_lease (obj);
  87
  88   name = dbus_bus_get_unique_name (spi_global_app_data->bus);
  89   path = spi_register_object_to_path (spi_global_register, G_OBJECT (obj));
  90
  91   if (!path)
  92     path = g_strdup (SPI_DBUS_PATH_NULL);
  93
  94   dbus_message_iter_open_container (iter, DBUS_TYPE_STRUCT, NULL,
  95                                     &iter_struct);
  96   dbus_message_iter_append_basic (&iter_struct, DBUS_TYPE_STRING, &name);
  97   dbus_message_iter_append_basic (&iter_struct, DBUS_TYPE_OBJECT_PATH, &path);
  98   dbus_message_iter_close_container (iter, &iter_struct);
  99
 100   g_free (path);
 101 }
 102
 103 void
 104 spi_object_append_v_reference (DBusMessageIter * iter, AtkObject * obj)
 105 {
 106   DBusMessageIter iter_variant;
 107
 108   dbus_message_iter_open_container (iter, DBUS_TYPE_VARIANT, "(so)",
 109                                     &iter_variant);
 110      spi_object_append_reference (&iter_variant, obj);
 111   dbus_message_iter_close_container (iter, &iter_variant);
 112 }
 113
 114 void
 115 spi_object_append_desktop_reference (DBusMessageIter * iter)
 116 {
 117   DBusMessageIter iter_struct;
 118   const char *name = spi_global_app_data->desktop_name;
 119   const char *path = spi_global_app_data->desktop_path;
 120
 121   dbus_message_iter_open_container (iter, DBUS_TYPE_STRUCT, NULL,
 122                                     &iter_struct);
 123   dbus_message_iter_append_basic (&iter_struct, DBUS_TYPE_STRING, &name);
 124   dbus_message_iter_append_basic (&iter_struct, DBUS_TYPE_OBJECT_PATH, &path);
 125   dbus_message_iter_close_container (iter, &iter_struct);
 126 }
 127
 128 void
 129 spi_object_append_null_reference (DBusMessageIter * iter)
 130 {
 131   DBusMessageIter iter_struct;
 132   const char *name;
 133   const char *path = "/org/at_spi/null";
 134
 135   name = dbus_bus_get_unique_name (spi_global_app_data->bus);
 136
 137   dbus_message_iter_open_container (iter, DBUS_TYPE_STRUCT, NULL,
 138                                     &iter_struct);
 139   dbus_message_iter_append_basic (&iter_struct, DBUS_TYPE_STRING, &name);
 140   dbus_message_iter_append_basic (&iter_struct, DBUS_TYPE_OBJECT_PATH, &path);
 141   dbus_message_iter_close_container (iter, &iter_struct);
 142 }
 143
 144 DBusMessage *
 145 spi_object_return_reference (DBusMessage * msg, AtkObject * obj)
 146 {
 147   DBusMessage *reply;
 148
 149   reply = dbus_message_new_method_return (msg);
 150   if (reply)
 151     {
 152       DBusMessageIter iter;
 153       dbus_message_iter_init_append (reply, &iter);
 154       spi_object_append_reference (&iter, obj);
 155     }
 156   g_object_unref (G_OBJECT (obj));
 157
 158   return reply;
 159 }
 160
 161 /*---------------------------------------------------------------------------*/
 162
 163 void
 164 spi_object_append_interfaces (DBusMessageIter * iter, AtkObject * obj)
 165 {
 166   const gchar *itf;
 167
 168   itf = SPI_DBUS_INTERFACE_ACCESSIBLE;
 169   dbus_message_iter_append_basic (iter, DBUS_TYPE_STRING, &itf);
 170
 171   if (ATK_IS_ACTION (obj))
 172     {
 173       itf = SPI_DBUS_INTERFACE_ACTION;
 174       dbus_message_iter_append_basic (iter, DBUS_TYPE_STRING, &itf);
 175     }
 176
 177   if (ATK_IS_COMPONENT (obj))
 178     {
 179       itf = SPI_DBUS_INTERFACE_COMPONENT;
 180       dbus_message_iter_append_basic (iter, DBUS_TYPE_STRING, &itf);
 181     }
 182
 183   if (ATK_IS_EDITABLE_TEXT (obj))
 184     {
 185       itf = SPI_DBUS_INTERFACE_EDITABLE_TEXT;
 186       dbus_message_iter_append_basic (iter, DBUS_TYPE_STRING, &itf);
 187     }
 188
 189   if (ATK_IS_TEXT (obj))
 190     {
 191       itf = SPI_DBUS_INTERFACE_TEXT;
 192       dbus_message_iter_append_basic (iter, DBUS_TYPE_STRING, &itf);
 193     }
 194
 195   if (ATK_IS_HYPERTEXT (obj))
 196     {
 197       itf = SPI_DBUS_INTERFACE_HYPERTEXT;
 198       dbus_message_iter_append_basic (iter, DBUS_TYPE_STRING, &itf);
 199     }
 200
 201   if (ATK_IS_IMAGE (obj))
 202     {
 203       itf = SPI_DBUS_INTERFACE_IMAGE;
 204       dbus_message_iter_append_basic (iter, DBUS_TYPE_STRING, &itf);
 205     }
 206
 207   if (ATK_IS_SELECTION (obj))
 208     {
 209       itf = SPI_DBUS_INTERFACE_SELECTION;
 210       dbus_message_iter_append_basic (iter, DBUS_TYPE_STRING, &itf);
 211     }
 212
 213   if (ATK_IS_TABLE (obj))
 214     {
 215       itf = SPI_DBUS_INTERFACE_TABLE;
 216       dbus_message_iter_append_basic (iter, DBUS_TYPE_STRING, &itf);
 217     }
 218
 219   if (ATK_IS_VALUE (obj))
 220     {
 221       itf = SPI_DBUS_INTERFACE_VALUE;
 222       dbus_message_iter_append_basic (iter, DBUS_TYPE_STRING, &itf);
 223     }
 224
 225 #if 0
 226   if (ATK_IS_STREAMABLE_CONTENT (obj))
 227     {
 228       itf = "org.freedesktop.atspi.StreamableContent";
 229       dbus_message_iter_append_basic (iter, DBUS_TYPE_STRING, &itf);
 230     }
 231 #endif
 232
 233   if (ATK_IS_DOCUMENT (obj))
 234     {
 235       itf = "org.freedesktop.atspi.Collection";
 236       dbus_message_iter_append_basic (iter, DBUS_TYPE_STRING, &itf);
 237       itf = SPI_DBUS_INTERFACE_DOCUMENT;
 238       dbus_message_iter_append_basic (iter, DBUS_TYPE_STRING, &itf);
 239     }
 240
 241   if (ATK_IS_HYPERLINK_IMPL (obj))
 242     {
 243       itf = SPI_DBUS_INTERFACE_HYPERLINK;
 244       dbus_message_iter_append_basic (iter, DBUS_TYPE_STRING, &itf);
 245     }
 246 }
 247
 248 /*---------------------------------------------------------------------------*/
 249
 250 void
 251 spi_object_append_attribute_set (DBusMessageIter * iter, AtkAttributeSet * attr)
 252 {
 253   DBusMessageIter dictIter;
 254
 255   dbus_message_iter_open_container (iter, DBUS_TYPE_ARRAY, "{ss}", &dictIter);
 256   while (attr)
 257     {
 258       DBusMessageIter dictEntryIter;
 259       AtkAttribute *attribute = (AtkAttribute *) attr->data;
 260       const char *key = attribute->name;
 261       const char *value = attribute->value;
 262
 263       if (key == NULL)
 264         key = "";
 265       if (value == NULL)
 266         value = "";
 267
 268       dbus_message_iter_open_container (&dictIter, DBUS_TYPE_DICT_ENTRY, NULL,
 269                                         &dictEntryIter);
 270       dbus_message_iter_append_basic (&dictEntryIter, DBUS_TYPE_STRING,
 271                                       &key);
 272       dbus_message_iter_append_basic (&dictEntryIter, DBUS_TYPE_STRING,
 273                                       &value);
 274       dbus_message_iter_close_container (&dictIter, &dictEntryIter);
 275       attr = g_slist_next (attr);
 276     }
 277   dbus_message_iter_close_container (iter, &dictIter);
 278 }
 279
 280 /*---------------------------------------------------------------------------*/
 281
 282 static gboolean
 283 init_role_lookup_table (Accessibility_Role * role_table)
 284 {
 285   int i;
 286   /* if it's not in the list below, dunno what it is */
 287   for (i = 0; i < ATK_ROLE_LAST_DEFINED; ++i)
 288     {
 289       role_table[i] = Accessibility_ROLE_UNKNOWN;
 290     }
 291
 292   role_table[ATK_ROLE_INVALID] = Accessibility_ROLE_INVALID;
 293   role_table[ATK_ROLE_ACCEL_LABEL] = Accessibility_ROLE_ACCELERATOR_LABEL;
 294   role_table[ATK_ROLE_ALERT] = Accessibility_ROLE_ALERT;
 295   role_table[ATK_ROLE_ANIMATION] = Accessibility_ROLE_ANIMATION;
 296   role_table[ATK_ROLE_ARROW] = Accessibility_ROLE_ARROW;
 297   role_table[ATK_ROLE_CALENDAR] = Accessibility_ROLE_CALENDAR;
 298   role_table[ATK_ROLE_CANVAS] = Accessibility_ROLE_CANVAS;
 299   role_table[ATK_ROLE_CHECK_BOX] = Accessibility_ROLE_CHECK_BOX;
 300   role_table[ATK_ROLE_CHECK_MENU_ITEM] = Accessibility_ROLE_CHECK_MENU_ITEM;
 301   role_table[ATK_ROLE_COLOR_CHOOSER] = Accessibility_ROLE_COLOR_CHOOSER;
 302   role_table[ATK_ROLE_COLUMN_HEADER] = Accessibility_ROLE_COLUMN_HEADER;
 303   role_table[ATK_ROLE_COMBO_BOX] = Accessibility_ROLE_COMBO_BOX;
 304   role_table[ATK_ROLE_DATE_EDITOR] = Accessibility_ROLE_DATE_EDITOR;
 305   role_table[ATK_ROLE_DESKTOP_ICON] = Accessibility_ROLE_DESKTOP_ICON;
 306   role_table[ATK_ROLE_DESKTOP_FRAME] = Accessibility_ROLE_DESKTOP_FRAME;
 307   role_table[ATK_ROLE_DIAL] = Accessibility_ROLE_DIAL;
 308   role_table[ATK_ROLE_DIALOG] = Accessibility_ROLE_DIALOG;
 309   role_table[ATK_ROLE_DIRECTORY_PANE] = Accessibility_ROLE_DIRECTORY_PANE;
 310   role_table[ATK_ROLE_DRAWING_AREA] = Accessibility_ROLE_DRAWING_AREA;
 311   role_table[ATK_ROLE_FILE_CHOOSER] = Accessibility_ROLE_FILE_CHOOSER;
 312   role_table[ATK_ROLE_FILLER] = Accessibility_ROLE_FILLER;
 313   role_table[ATK_ROLE_FONT_CHOOSER] = Accessibility_ROLE_FONT_CHOOSER;
 314   role_table[ATK_ROLE_FRAME] = Accessibility_ROLE_FRAME;
 315   role_table[ATK_ROLE_GLASS_PANE] = Accessibility_ROLE_GLASS_PANE;
 316   role_table[ATK_ROLE_HTML_CONTAINER] = Accessibility_ROLE_HTML_CONTAINER;
 317   role_table[ATK_ROLE_ICON] = Accessibility_ROLE_ICON;
 318   role_table[ATK_ROLE_IMAGE] = Accessibility_ROLE_IMAGE;
 319   role_table[ATK_ROLE_INTERNAL_FRAME] = Accessibility_ROLE_INTERNAL_FRAME;
 320   role_table[ATK_ROLE_LABEL] = Accessibility_ROLE_LABEL;
 321   role_table[ATK_ROLE_LAYERED_PANE] = Accessibility_ROLE_LAYERED_PANE;
 322   role_table[ATK_ROLE_LIST] = Accessibility_ROLE_LIST;
 323   role_table[ATK_ROLE_LIST_ITEM] = Accessibility_ROLE_LIST_ITEM;
 324   role_table[ATK_ROLE_MENU] = Accessibility_ROLE_MENU;
 325   role_table[ATK_ROLE_MENU_BAR] = Accessibility_ROLE_MENU_BAR;
 326   role_table[ATK_ROLE_MENU_ITEM] = Accessibility_ROLE_MENU_ITEM;
 327   role_table[ATK_ROLE_OPTION_PANE] = Accessibility_ROLE_OPTION_PANE;
 328   role_table[ATK_ROLE_PAGE_TAB] = Accessibility_ROLE_PAGE_TAB;
 329   role_table[ATK_ROLE_PAGE_TAB_LIST] = Accessibility_ROLE_PAGE_TAB_LIST;
 330   role_table[ATK_ROLE_PANEL] = Accessibility_ROLE_PANEL;
 331   role_table[ATK_ROLE_PASSWORD_TEXT] = Accessibility_ROLE_PASSWORD_TEXT;
 332   role_table[ATK_ROLE_POPUP_MENU] = Accessibility_ROLE_POPUP_MENU;
 333   role_table[ATK_ROLE_PROGRESS_BAR] = Accessibility_ROLE_PROGRESS_BAR;
 334   role_table[ATK_ROLE_PUSH_BUTTON] = Accessibility_ROLE_PUSH_BUTTON;
 335   role_table[ATK_ROLE_RADIO_BUTTON] = Accessibility_ROLE_RADIO_BUTTON;
 336   role_table[ATK_ROLE_RADIO_MENU_ITEM] = Accessibility_ROLE_RADIO_MENU_ITEM;
 337   role_table[ATK_ROLE_ROOT_PANE] = Accessibility_ROLE_ROOT_PANE;
 338   role_table[ATK_ROLE_ROW_HEADER] = Accessibility_ROLE_ROW_HEADER;
 339   role_table[ATK_ROLE_SCROLL_BAR] = Accessibility_ROLE_SCROLL_BAR;
 340   role_table[ATK_ROLE_SCROLL_PANE] = Accessibility_ROLE_SCROLL_PANE;
 341   role_table[ATK_ROLE_SEPARATOR] = Accessibility_ROLE_SEPARATOR;
 342   role_table[ATK_ROLE_SLIDER] = Accessibility_ROLE_SLIDER;
 343   role_table[ATK_ROLE_SPIN_BUTTON] = Accessibility_ROLE_SPIN_BUTTON;
 344   role_table[ATK_ROLE_SPLIT_PANE] = Accessibility_ROLE_SPLIT_PANE;
 345   role_table[ATK_ROLE_STATUSBAR] = Accessibility_ROLE_STATUS_BAR;
 346   role_table[ATK_ROLE_TABLE] = Accessibility_ROLE_TABLE;
 347   role_table[ATK_ROLE_TABLE_CELL] = Accessibility_ROLE_TABLE_CELL;
 348   role_table[ATK_ROLE_TABLE_COLUMN_HEADER] =
 349     Accessibility_ROLE_TABLE_COLUMN_HEADER;
 350   role_table[ATK_ROLE_TABLE_ROW_HEADER] = Accessibility_ROLE_TABLE_ROW_HEADER;
 351   role_table[ATK_ROLE_TEAR_OFF_MENU_ITEM] =
 352     Accessibility_ROLE_TEAROFF_MENU_ITEM;
 353   role_table[ATK_ROLE_TERMINAL] = Accessibility_ROLE_TERMINAL;
 354   role_table[ATK_ROLE_TEXT] = Accessibility_ROLE_TEXT;
 355   role_table[ATK_ROLE_TOGGLE_BUTTON] = Accessibility_ROLE_TOGGLE_BUTTON;
 356   role_table[ATK_ROLE_TOOL_BAR] = Accessibility_ROLE_TOOL_BAR;
 357   role_table[ATK_ROLE_TOOL_TIP] = Accessibility_ROLE_TOOL_TIP;
 358   role_table[ATK_ROLE_TREE] = Accessibility_ROLE_TREE;
 359   role_table[ATK_ROLE_TREE_TABLE] = Accessibility_ROLE_TREE_TABLE;
 360   role_table[ATK_ROLE_UNKNOWN] = Accessibility_ROLE_UNKNOWN;
 361   role_table[ATK_ROLE_VIEWPORT] = Accessibility_ROLE_VIEWPORT;
 362   role_table[ATK_ROLE_WINDOW] = Accessibility_ROLE_WINDOW;
 363   role_table[ATK_ROLE_HEADER] = Accessibility_ROLE_HEADER;
 364   role_table[ATK_ROLE_FOOTER] = Accessibility_ROLE_FOOTER;
 365   role_table[ATK_ROLE_PARAGRAPH] = Accessibility_ROLE_PARAGRAPH;
 366   role_table[ATK_ROLE_RULER] = Accessibility_ROLE_RULER;
 367   role_table[ATK_ROLE_APPLICATION] = Accessibility_ROLE_APPLICATION;
 368   role_table[ATK_ROLE_AUTOCOMPLETE] = Accessibility_ROLE_AUTOCOMPLETE;
 369   role_table[ATK_ROLE_EDITBAR] = Accessibility_ROLE_EDITBAR;
 370   role_table[ATK_ROLE_EMBEDDED] = Accessibility_ROLE_EMBEDDED;
 371   role_table[ATK_ROLE_ENTRY] = Accessibility_ROLE_ENTRY;
 372   role_table[ATK_ROLE_CHART] = Accessibility_ROLE_CHART;
 373   role_table[ATK_ROLE_CAPTION] = Accessibility_ROLE_CAPTION;
 374   role_table[ATK_ROLE_DOCUMENT_FRAME] = Accessibility_ROLE_DOCUMENT_FRAME;
 375   role_table[ATK_ROLE_HEADING] = Accessibility_ROLE_HEADING;
 376   role_table[ATK_ROLE_PAGE] = Accessibility_ROLE_PAGE;
 377   role_table[ATK_ROLE_SECTION] = Accessibility_ROLE_SECTION;
 378   role_table[ATK_ROLE_FORM] = Accessibility_ROLE_FORM;
 379   role_table[ATK_ROLE_REDUNDANT_OBJECT] = Accessibility_ROLE_REDUNDANT_OBJECT;
 380   role_table[ATK_ROLE_LINK] = Accessibility_ROLE_LINK;
 381   role_table[ATK_ROLE_INPUT_METHOD_WINDOW] =
 382     Accessibility_ROLE_INPUT_METHOD_WINDOW;
 383   return TRUE;
 384 }
 385
 386 Accessibility_Role
 387 spi_accessible_role_from_atk_role (AtkRole role)
 388 {
 389   static gboolean is_initialized = FALSE;
 390   static Accessibility_Role spi_role_table[ATK_ROLE_LAST_DEFINED];
 391   Accessibility_Role spi_role;
 392
 393   if (!is_initialized)
 394     {
 395       is_initialized = init_role_lookup_table (spi_role_table);
 396     }
 397
 398   if (role >= 0 && role < ATK_ROLE_LAST_DEFINED)
 399     {
 400       spi_role = spi_role_table[role];
 401     }
 402   else
 403     {
 404       spi_role = Accessibility_ROLE_EXTENDED;
 405     }
 406   return spi_role;
 407 }
 408
 409 /*END------------------------------------------------------------------------*/