2 * AT-SPI - Assistive Technology Service Provider Interface
3 * (Gnome Accessibility Project; http://developer.gnome.org/projects/gap)
5 * Copyright 2008 Novell, Inc.
6 * Copyright 2008, 2009, 2010 Codethink Ltd.
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.
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.
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.
25 * This module contains utility functions for exporting AT-SPI
26 * objects based upon an ATK object.
28 * It incudes functions for marshalling object references
29 * and supported interfaces to a D-Bus message.
33 #include <common/spi-types.h>
34 #include <common/spi-dbus.h>
36 #include "accessible-register.h"
37 #include "accessible-cache.h"
38 #include "accessible-leasing.h"
42 /*---------------------------------------------------------------------------*/
45 * This is the all important function that decides whether an object should
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.
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.
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.
59 spi_object_lease_if_needed (GObject *obj)
61 if (!spi_cache_in (spi_global_cache, obj))
63 spi_leasing_take (spi_global_leasing, obj);
67 /*---------------------------------------------------------------------------*/
70 * It is assumed that all of these functions are returning an accessible
71 * object to the client side.
73 * All of them will lease the AtkObject if it is deemed neccessary.
77 spi_object_append_null_reference (DBusMessageIter * iter)
79 DBusMessageIter iter_struct;
81 const char *path = SPI_DBUS_PATH_NULL;
83 name = dbus_bus_get_unique_name (spi_global_app_data->bus);
85 dbus_message_iter_open_container (iter, DBUS_TYPE_STRUCT, NULL,
87 dbus_message_iter_append_basic (&iter_struct, DBUS_TYPE_STRING, &name);
88 dbus_message_iter_append_basic (&iter_struct, DBUS_TYPE_OBJECT_PATH, &path);
89 dbus_message_iter_close_container (iter, &iter_struct);
93 spi_object_append_reference (DBusMessageIter * iter, AtkObject * obj)
95 DBusMessageIter iter_struct;
100 spi_object_append_null_reference (iter);
104 spi_object_lease_if_needed (G_OBJECT (obj));
106 name = dbus_bus_get_unique_name (spi_global_app_data->bus);
107 path = spi_register_object_to_path (spi_global_register, G_OBJECT (obj));
110 path = g_strdup (SPI_DBUS_PATH_NULL);
112 dbus_message_iter_open_container (iter, DBUS_TYPE_STRUCT, NULL,
114 dbus_message_iter_append_basic (&iter_struct, DBUS_TYPE_STRING, &name);
115 dbus_message_iter_append_basic (&iter_struct, DBUS_TYPE_OBJECT_PATH, &path);
116 dbus_message_iter_close_container (iter, &iter_struct);
121 /* TODO: Perhaps combine with spi_object_append_reference. Leaving separate
122 * for now in case we want to use a different path for hyperlinks. */
124 spi_hyperlink_append_reference (DBusMessageIter * iter, AtkHyperlink * obj)
126 DBusMessageIter iter_struct;
131 spi_object_append_null_reference (iter);
135 spi_object_lease_if_needed (G_OBJECT (obj));
137 name = dbus_bus_get_unique_name (spi_global_app_data->bus);
138 path = spi_register_object_to_path (spi_global_register, G_OBJECT (obj));
141 path = g_strdup (SPI_DBUS_PATH_NULL);
143 dbus_message_iter_open_container (iter, DBUS_TYPE_STRUCT, NULL,
145 dbus_message_iter_append_basic (&iter_struct, DBUS_TYPE_STRING, &name);
146 dbus_message_iter_append_basic (&iter_struct, DBUS_TYPE_OBJECT_PATH, &path);
147 dbus_message_iter_close_container (iter, &iter_struct);
153 spi_object_append_v_reference (DBusMessageIter * iter, AtkObject * obj)
155 DBusMessageIter iter_variant;
157 dbus_message_iter_open_container (iter, DBUS_TYPE_VARIANT, "(so)",
159 spi_object_append_reference (&iter_variant, obj);
160 dbus_message_iter_close_container (iter, &iter_variant);
164 spi_object_append_desktop_reference (DBusMessageIter * iter)
166 DBusMessageIter iter_struct;
167 const char *name = spi_global_app_data->desktop_name;
168 const char *path = spi_global_app_data->desktop_path;
170 dbus_message_iter_open_container (iter, DBUS_TYPE_STRUCT, NULL,
172 dbus_message_iter_append_basic (&iter_struct, DBUS_TYPE_STRING, &name);
173 dbus_message_iter_append_basic (&iter_struct, DBUS_TYPE_OBJECT_PATH, &path);
174 dbus_message_iter_close_container (iter, &iter_struct);
178 spi_object_return_reference (DBusMessage * msg, AtkObject * obj, gboolean unref)
182 reply = dbus_message_new_method_return (msg);
185 DBusMessageIter iter;
186 dbus_message_iter_init_append (reply, &iter);
187 spi_object_append_reference (&iter, obj);
190 g_object_unref (G_OBJECT (obj));
196 spi_hyperlink_return_reference (DBusMessage * msg, AtkHyperlink * obj)
200 reply = dbus_message_new_method_return (msg);
203 DBusMessageIter iter;
204 dbus_message_iter_init_append (reply, &iter);
205 spi_hyperlink_append_reference (&iter, obj);
208 g_object_unref (G_OBJECT (obj));
213 /*---------------------------------------------------------------------------*/
216 spi_object_append_interfaces (DBusMessageIter * iter, AtkObject * obj)
220 itf = SPI_DBUS_INTERFACE_ACCESSIBLE;
221 dbus_message_iter_append_basic (iter, DBUS_TYPE_STRING, &itf);
223 if (ATK_IS_ACTION (obj))
225 itf = SPI_DBUS_INTERFACE_ACTION;
226 dbus_message_iter_append_basic (iter, DBUS_TYPE_STRING, &itf);
229 if (atk_object_get_role (obj) == ATK_ROLE_APPLICATION)
231 itf = SPI_DBUS_INTERFACE_APPLICATION;
232 dbus_message_iter_append_basic (iter, DBUS_TYPE_STRING, &itf);
235 if (ATK_IS_COMPONENT (obj))
237 itf = SPI_DBUS_INTERFACE_COMPONENT;
238 dbus_message_iter_append_basic (iter, DBUS_TYPE_STRING, &itf);
241 if (ATK_IS_EDITABLE_TEXT (obj))
243 itf = SPI_DBUS_INTERFACE_EDITABLE_TEXT;
244 dbus_message_iter_append_basic (iter, DBUS_TYPE_STRING, &itf);
247 if (ATK_IS_TEXT (obj))
249 itf = SPI_DBUS_INTERFACE_TEXT;
250 dbus_message_iter_append_basic (iter, DBUS_TYPE_STRING, &itf);
253 if (ATK_IS_HYPERTEXT (obj))
255 itf = SPI_DBUS_INTERFACE_HYPERTEXT;
256 dbus_message_iter_append_basic (iter, DBUS_TYPE_STRING, &itf);
259 if (ATK_IS_IMAGE (obj))
261 itf = SPI_DBUS_INTERFACE_IMAGE;
262 dbus_message_iter_append_basic (iter, DBUS_TYPE_STRING, &itf);
265 if (ATK_IS_SELECTION (obj))
267 itf = SPI_DBUS_INTERFACE_SELECTION;
268 dbus_message_iter_append_basic (iter, DBUS_TYPE_STRING, &itf);
271 if (ATK_IS_TABLE (obj))
273 itf = SPI_DBUS_INTERFACE_TABLE;
274 dbus_message_iter_append_basic (iter, DBUS_TYPE_STRING, &itf);
277 if (ATK_IS_VALUE (obj))
279 itf = SPI_DBUS_INTERFACE_VALUE;
280 dbus_message_iter_append_basic (iter, DBUS_TYPE_STRING, &itf);
284 if (ATK_IS_STREAMABLE_CONTENT (obj))
286 itf = "org.a11y.atspi.StreamableContent";
287 dbus_message_iter_append_basic (iter, DBUS_TYPE_STRING, &itf);
291 if (ATK_IS_DOCUMENT (obj))
293 itf = "org.a11y.atspi.Collection";
294 dbus_message_iter_append_basic (iter, DBUS_TYPE_STRING, &itf);
295 itf = SPI_DBUS_INTERFACE_DOCUMENT;
296 dbus_message_iter_append_basic (iter, DBUS_TYPE_STRING, &itf);
299 if (ATK_IS_HYPERLINK_IMPL (obj))
301 itf = SPI_DBUS_INTERFACE_HYPERLINK;
302 dbus_message_iter_append_basic (iter, DBUS_TYPE_STRING, &itf);
306 /*---------------------------------------------------------------------------*/
309 spi_object_append_attribute_set (DBusMessageIter * iter, AtkAttributeSet * attr)
311 DBusMessageIter dictIter;
313 dbus_message_iter_open_container (iter, DBUS_TYPE_ARRAY, "{ss}", &dictIter);
316 DBusMessageIter dictEntryIter;
317 AtkAttribute *attribute = (AtkAttribute *) attr->data;
318 const char *key = attribute->name;
319 const char *value = attribute->value;
326 dbus_message_iter_open_container (&dictIter, DBUS_TYPE_DICT_ENTRY, NULL,
328 dbus_message_iter_append_basic (&dictEntryIter, DBUS_TYPE_STRING,
330 dbus_message_iter_append_basic (&dictEntryIter, DBUS_TYPE_STRING,
332 dbus_message_iter_close_container (&dictIter, &dictEntryIter);
333 attr = g_slist_next (attr);
335 dbus_message_iter_close_container (iter, &dictIter);
338 /*---------------------------------------------------------------------------*/
341 init_role_lookup_table (Accessibility_Role * role_table)
344 /* if it's not in the list below, dunno what it is */
345 for (i = 0; i < ATK_ROLE_LAST_DEFINED; ++i)
347 role_table[i] = Accessibility_ROLE_UNKNOWN;
350 role_table[ATK_ROLE_INVALID] = Accessibility_ROLE_INVALID;
351 role_table[ATK_ROLE_ACCEL_LABEL] = Accessibility_ROLE_ACCELERATOR_LABEL;
352 role_table[ATK_ROLE_ALERT] = Accessibility_ROLE_ALERT;
353 role_table[ATK_ROLE_ANIMATION] = Accessibility_ROLE_ANIMATION;
354 role_table[ATK_ROLE_ARROW] = Accessibility_ROLE_ARROW;
355 role_table[ATK_ROLE_CALENDAR] = Accessibility_ROLE_CALENDAR;
356 role_table[ATK_ROLE_CANVAS] = Accessibility_ROLE_CANVAS;
357 role_table[ATK_ROLE_CHECK_BOX] = Accessibility_ROLE_CHECK_BOX;
358 role_table[ATK_ROLE_CHECK_MENU_ITEM] = Accessibility_ROLE_CHECK_MENU_ITEM;
359 role_table[ATK_ROLE_COLOR_CHOOSER] = Accessibility_ROLE_COLOR_CHOOSER;
360 role_table[ATK_ROLE_COLUMN_HEADER] = Accessibility_ROLE_COLUMN_HEADER;
361 role_table[ATK_ROLE_COMBO_BOX] = Accessibility_ROLE_COMBO_BOX;
362 role_table[ATK_ROLE_DATE_EDITOR] = Accessibility_ROLE_DATE_EDITOR;
363 role_table[ATK_ROLE_DESKTOP_ICON] = Accessibility_ROLE_DESKTOP_ICON;
364 role_table[ATK_ROLE_DESKTOP_FRAME] = Accessibility_ROLE_DESKTOP_FRAME;
365 role_table[ATK_ROLE_DIAL] = Accessibility_ROLE_DIAL;
366 role_table[ATK_ROLE_DIALOG] = Accessibility_ROLE_DIALOG;
367 role_table[ATK_ROLE_DIRECTORY_PANE] = Accessibility_ROLE_DIRECTORY_PANE;
368 role_table[ATK_ROLE_DRAWING_AREA] = Accessibility_ROLE_DRAWING_AREA;
369 role_table[ATK_ROLE_FILE_CHOOSER] = Accessibility_ROLE_FILE_CHOOSER;
370 role_table[ATK_ROLE_FILLER] = Accessibility_ROLE_FILLER;
371 role_table[ATK_ROLE_FONT_CHOOSER] = Accessibility_ROLE_FONT_CHOOSER;
372 role_table[ATK_ROLE_FRAME] = Accessibility_ROLE_FRAME;
373 role_table[ATK_ROLE_GLASS_PANE] = Accessibility_ROLE_GLASS_PANE;
374 role_table[ATK_ROLE_HTML_CONTAINER] = Accessibility_ROLE_HTML_CONTAINER;
375 role_table[ATK_ROLE_ICON] = Accessibility_ROLE_ICON;
376 role_table[ATK_ROLE_IMAGE] = Accessibility_ROLE_IMAGE;
377 role_table[ATK_ROLE_INTERNAL_FRAME] = Accessibility_ROLE_INTERNAL_FRAME;
378 role_table[ATK_ROLE_LABEL] = Accessibility_ROLE_LABEL;
379 role_table[ATK_ROLE_LAYERED_PANE] = Accessibility_ROLE_LAYERED_PANE;
380 role_table[ATK_ROLE_LIST] = Accessibility_ROLE_LIST;
381 role_table[ATK_ROLE_LIST_ITEM] = Accessibility_ROLE_LIST_ITEM;
382 role_table[ATK_ROLE_MENU] = Accessibility_ROLE_MENU;
383 role_table[ATK_ROLE_MENU_BAR] = Accessibility_ROLE_MENU_BAR;
384 role_table[ATK_ROLE_MENU_ITEM] = Accessibility_ROLE_MENU_ITEM;
385 role_table[ATK_ROLE_OPTION_PANE] = Accessibility_ROLE_OPTION_PANE;
386 role_table[ATK_ROLE_PAGE_TAB] = Accessibility_ROLE_PAGE_TAB;
387 role_table[ATK_ROLE_PAGE_TAB_LIST] = Accessibility_ROLE_PAGE_TAB_LIST;
388 role_table[ATK_ROLE_PANEL] = Accessibility_ROLE_PANEL;
389 role_table[ATK_ROLE_PASSWORD_TEXT] = Accessibility_ROLE_PASSWORD_TEXT;
390 role_table[ATK_ROLE_POPUP_MENU] = Accessibility_ROLE_POPUP_MENU;
391 role_table[ATK_ROLE_PROGRESS_BAR] = Accessibility_ROLE_PROGRESS_BAR;
392 role_table[ATK_ROLE_PUSH_BUTTON] = Accessibility_ROLE_PUSH_BUTTON;
393 role_table[ATK_ROLE_RADIO_BUTTON] = Accessibility_ROLE_RADIO_BUTTON;
394 role_table[ATK_ROLE_RADIO_MENU_ITEM] = Accessibility_ROLE_RADIO_MENU_ITEM;
395 role_table[ATK_ROLE_ROOT_PANE] = Accessibility_ROLE_ROOT_PANE;
396 role_table[ATK_ROLE_ROW_HEADER] = Accessibility_ROLE_ROW_HEADER;
397 role_table[ATK_ROLE_SCROLL_BAR] = Accessibility_ROLE_SCROLL_BAR;
398 role_table[ATK_ROLE_SCROLL_PANE] = Accessibility_ROLE_SCROLL_PANE;
399 role_table[ATK_ROLE_SEPARATOR] = Accessibility_ROLE_SEPARATOR;
400 role_table[ATK_ROLE_SLIDER] = Accessibility_ROLE_SLIDER;
401 role_table[ATK_ROLE_SPIN_BUTTON] = Accessibility_ROLE_SPIN_BUTTON;
402 role_table[ATK_ROLE_SPLIT_PANE] = Accessibility_ROLE_SPLIT_PANE;
403 role_table[ATK_ROLE_STATUSBAR] = Accessibility_ROLE_STATUS_BAR;
404 role_table[ATK_ROLE_TABLE] = Accessibility_ROLE_TABLE;
405 role_table[ATK_ROLE_TABLE_CELL] = Accessibility_ROLE_TABLE_CELL;
406 role_table[ATK_ROLE_TABLE_COLUMN_HEADER] =
407 Accessibility_ROLE_TABLE_COLUMN_HEADER;
408 role_table[ATK_ROLE_TABLE_ROW_HEADER] = Accessibility_ROLE_TABLE_ROW_HEADER;
409 role_table[ATK_ROLE_TEAR_OFF_MENU_ITEM] =
410 Accessibility_ROLE_TEAROFF_MENU_ITEM;
411 role_table[ATK_ROLE_TERMINAL] = Accessibility_ROLE_TERMINAL;
412 role_table[ATK_ROLE_TEXT] = Accessibility_ROLE_TEXT;
413 role_table[ATK_ROLE_TOGGLE_BUTTON] = Accessibility_ROLE_TOGGLE_BUTTON;
414 role_table[ATK_ROLE_TOOL_BAR] = Accessibility_ROLE_TOOL_BAR;
415 role_table[ATK_ROLE_TOOL_TIP] = Accessibility_ROLE_TOOL_TIP;
416 role_table[ATK_ROLE_TREE] = Accessibility_ROLE_TREE;
417 role_table[ATK_ROLE_TREE_TABLE] = Accessibility_ROLE_TREE_TABLE;
418 role_table[ATK_ROLE_UNKNOWN] = Accessibility_ROLE_UNKNOWN;
419 role_table[ATK_ROLE_VIEWPORT] = Accessibility_ROLE_VIEWPORT;
420 role_table[ATK_ROLE_WINDOW] = Accessibility_ROLE_WINDOW;
421 role_table[ATK_ROLE_HEADER] = Accessibility_ROLE_HEADER;
422 role_table[ATK_ROLE_FOOTER] = Accessibility_ROLE_FOOTER;
423 role_table[ATK_ROLE_PARAGRAPH] = Accessibility_ROLE_PARAGRAPH;
424 role_table[ATK_ROLE_RULER] = Accessibility_ROLE_RULER;
425 role_table[ATK_ROLE_APPLICATION] = Accessibility_ROLE_APPLICATION;
426 role_table[ATK_ROLE_AUTOCOMPLETE] = Accessibility_ROLE_AUTOCOMPLETE;
427 role_table[ATK_ROLE_EDITBAR] = Accessibility_ROLE_EDITBAR;
428 role_table[ATK_ROLE_EMBEDDED] = Accessibility_ROLE_EMBEDDED;
429 role_table[ATK_ROLE_ENTRY] = Accessibility_ROLE_ENTRY;
430 role_table[ATK_ROLE_CHART] = Accessibility_ROLE_CHART;
431 role_table[ATK_ROLE_CAPTION] = Accessibility_ROLE_CAPTION;
432 role_table[ATK_ROLE_DOCUMENT_FRAME] = Accessibility_ROLE_DOCUMENT_FRAME;
433 role_table[ATK_ROLE_HEADING] = Accessibility_ROLE_HEADING;
434 role_table[ATK_ROLE_PAGE] = Accessibility_ROLE_PAGE;
435 role_table[ATK_ROLE_SECTION] = Accessibility_ROLE_SECTION;
436 role_table[ATK_ROLE_FORM] = Accessibility_ROLE_FORM;
437 role_table[ATK_ROLE_REDUNDANT_OBJECT] = Accessibility_ROLE_REDUNDANT_OBJECT;
438 role_table[ATK_ROLE_LINK] = Accessibility_ROLE_LINK;
439 role_table[ATK_ROLE_INPUT_METHOD_WINDOW] =
440 Accessibility_ROLE_INPUT_METHOD_WINDOW;
445 spi_accessible_role_from_atk_role (AtkRole role)
447 static gboolean is_initialized = FALSE;
448 static Accessibility_Role spi_role_table[ATK_ROLE_LAST_DEFINED];
449 Accessibility_Role spi_role;
453 is_initialized = init_role_lookup_table (spi_role_table);
456 if (role >= 0 && role < ATK_ROLE_LAST_DEFINED)
458 spi_role = spi_role_table[role];
462 spi_role = Accessibility_ROLE_EXTENDED;
467 /*END------------------------------------------------------------------------*/