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 "atspi/atspi.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 = ATSPI_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)
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);
194 spi_hyperlink_return_reference (DBusMessage * msg, AtkHyperlink * obj)
198 reply = dbus_message_new_method_return (msg);
201 DBusMessageIter iter;
202 dbus_message_iter_init_append (reply, &iter);
203 spi_hyperlink_append_reference (&iter, obj);
206 g_object_unref (G_OBJECT (obj));
211 /*---------------------------------------------------------------------------*/
214 spi_object_append_interfaces (DBusMessageIter * iter, AtkObject * obj)
218 itf = ATSPI_DBUS_INTERFACE_ACCESSIBLE;
219 dbus_message_iter_append_basic (iter, DBUS_TYPE_STRING, &itf);
221 if (ATK_IS_ACTION (obj))
223 itf = ATSPI_DBUS_INTERFACE_ACTION;
224 dbus_message_iter_append_basic (iter, DBUS_TYPE_STRING, &itf);
227 if (atk_object_get_role (obj) == ATK_ROLE_APPLICATION)
229 itf = ATSPI_DBUS_INTERFACE_APPLICATION;
230 dbus_message_iter_append_basic (iter, DBUS_TYPE_STRING, &itf);
233 if (ATK_IS_COMPONENT (obj))
235 itf = ATSPI_DBUS_INTERFACE_COMPONENT;
236 dbus_message_iter_append_basic (iter, DBUS_TYPE_STRING, &itf);
239 if (ATK_IS_EDITABLE_TEXT (obj))
241 itf = ATSPI_DBUS_INTERFACE_EDITABLE_TEXT;
242 dbus_message_iter_append_basic (iter, DBUS_TYPE_STRING, &itf);
245 if (ATK_IS_TEXT (obj))
247 itf = ATSPI_DBUS_INTERFACE_TEXT;
248 dbus_message_iter_append_basic (iter, DBUS_TYPE_STRING, &itf);
251 if (ATK_IS_HYPERTEXT (obj))
253 itf = ATSPI_DBUS_INTERFACE_HYPERTEXT;
254 dbus_message_iter_append_basic (iter, DBUS_TYPE_STRING, &itf);
257 if (ATK_IS_IMAGE (obj))
259 itf = ATSPI_DBUS_INTERFACE_IMAGE;
260 dbus_message_iter_append_basic (iter, DBUS_TYPE_STRING, &itf);
263 if (ATK_IS_SELECTION (obj))
265 itf = ATSPI_DBUS_INTERFACE_SELECTION;
266 dbus_message_iter_append_basic (iter, DBUS_TYPE_STRING, &itf);
269 if (ATK_IS_TABLE (obj))
271 itf = ATSPI_DBUS_INTERFACE_TABLE;
272 dbus_message_iter_append_basic (iter, DBUS_TYPE_STRING, &itf);
275 if (ATK_IS_VALUE (obj))
277 itf = ATSPI_DBUS_INTERFACE_VALUE;
278 dbus_message_iter_append_basic (iter, DBUS_TYPE_STRING, &itf);
282 if (ATK_IS_STREAMABLE_CONTENT (obj))
284 itf = "org.a11y.atspi.StreamableContent";
285 dbus_message_iter_append_basic (iter, DBUS_TYPE_STRING, &itf);
289 if (ATK_IS_DOCUMENT (obj))
291 itf = "org.a11y.atspi.Collection";
292 dbus_message_iter_append_basic (iter, DBUS_TYPE_STRING, &itf);
293 itf = ATSPI_DBUS_INTERFACE_DOCUMENT;
294 dbus_message_iter_append_basic (iter, DBUS_TYPE_STRING, &itf);
297 if (ATK_IS_HYPERLINK_IMPL (obj))
299 itf = ATSPI_DBUS_INTERFACE_HYPERLINK;
300 dbus_message_iter_append_basic (iter, DBUS_TYPE_STRING, &itf);
304 /*---------------------------------------------------------------------------*/
307 spi_object_append_attribute_set (DBusMessageIter * iter, AtkAttributeSet * attr)
309 DBusMessageIter dictIter;
311 dbus_message_iter_open_container (iter, DBUS_TYPE_ARRAY, "{ss}", &dictIter);
314 DBusMessageIter dictEntryIter;
315 AtkAttribute *attribute = (AtkAttribute *) attr->data;
316 const char *key = attribute->name;
317 const char *value = attribute->value;
324 dbus_message_iter_open_container (&dictIter, DBUS_TYPE_DICT_ENTRY, NULL,
326 dbus_message_iter_append_basic (&dictEntryIter, DBUS_TYPE_STRING,
328 dbus_message_iter_append_basic (&dictEntryIter, DBUS_TYPE_STRING,
330 dbus_message_iter_close_container (&dictIter, &dictEntryIter);
331 attr = g_slist_next (attr);
333 dbus_message_iter_close_container (iter, &dictIter);
336 /*---------------------------------------------------------------------------*/
339 init_role_lookup_table (AtspiRole * role_table)
342 /* if it's not in the list below, dunno what it is */
343 for (i = 0; i < ATK_ROLE_LAST_DEFINED; ++i)
345 role_table[i] = ATSPI_ROLE_UNKNOWN;
348 role_table[ATK_ROLE_INVALID] = ATSPI_ROLE_INVALID;
349 role_table[ATK_ROLE_ACCEL_LABEL] = ATSPI_ROLE_ACCELERATOR_LABEL;
350 role_table[ATK_ROLE_ALERT] = ATSPI_ROLE_ALERT;
351 role_table[ATK_ROLE_ANIMATION] = ATSPI_ROLE_ANIMATION;
352 role_table[ATK_ROLE_ARROW] = ATSPI_ROLE_ARROW;
353 role_table[ATK_ROLE_CALENDAR] = ATSPI_ROLE_CALENDAR;
354 role_table[ATK_ROLE_CANVAS] = ATSPI_ROLE_CANVAS;
355 role_table[ATK_ROLE_CHECK_BOX] = ATSPI_ROLE_CHECK_BOX;
356 role_table[ATK_ROLE_CHECK_MENU_ITEM] = ATSPI_ROLE_CHECK_MENU_ITEM;
357 role_table[ATK_ROLE_COLOR_CHOOSER] = ATSPI_ROLE_COLOR_CHOOSER;
358 role_table[ATK_ROLE_COLUMN_HEADER] = ATSPI_ROLE_COLUMN_HEADER;
359 role_table[ATK_ROLE_COMBO_BOX] = ATSPI_ROLE_COMBO_BOX;
360 role_table[ATK_ROLE_DATE_EDITOR] = ATSPI_ROLE_DATE_EDITOR;
361 role_table[ATK_ROLE_DESKTOP_ICON] = ATSPI_ROLE_DESKTOP_ICON;
362 role_table[ATK_ROLE_DESKTOP_FRAME] = ATSPI_ROLE_DESKTOP_FRAME;
363 role_table[ATK_ROLE_DIAL] = ATSPI_ROLE_DIAL;
364 role_table[ATK_ROLE_DIALOG] = ATSPI_ROLE_DIALOG;
365 role_table[ATK_ROLE_DIRECTORY_PANE] = ATSPI_ROLE_DIRECTORY_PANE;
366 role_table[ATK_ROLE_DRAWING_AREA] = ATSPI_ROLE_DRAWING_AREA;
367 role_table[ATK_ROLE_FILE_CHOOSER] = ATSPI_ROLE_FILE_CHOOSER;
368 role_table[ATK_ROLE_FILLER] = ATSPI_ROLE_FILLER;
369 role_table[ATK_ROLE_FONT_CHOOSER] = ATSPI_ROLE_FONT_CHOOSER;
370 role_table[ATK_ROLE_FRAME] = ATSPI_ROLE_FRAME;
371 role_table[ATK_ROLE_GLASS_PANE] = ATSPI_ROLE_GLASS_PANE;
372 role_table[ATK_ROLE_HTML_CONTAINER] = ATSPI_ROLE_HTML_CONTAINER;
373 role_table[ATK_ROLE_ICON] = ATSPI_ROLE_ICON;
374 role_table[ATK_ROLE_IMAGE] = ATSPI_ROLE_IMAGE;
375 role_table[ATK_ROLE_INTERNAL_FRAME] = ATSPI_ROLE_INTERNAL_FRAME;
376 role_table[ATK_ROLE_LABEL] = ATSPI_ROLE_LABEL;
377 role_table[ATK_ROLE_LAYERED_PANE] = ATSPI_ROLE_LAYERED_PANE;
378 role_table[ATK_ROLE_LIST] = ATSPI_ROLE_LIST;
379 role_table[ATK_ROLE_LIST_ITEM] = ATSPI_ROLE_LIST_ITEM;
380 role_table[ATK_ROLE_MENU] = ATSPI_ROLE_MENU;
381 role_table[ATK_ROLE_MENU_BAR] = ATSPI_ROLE_MENU_BAR;
382 role_table[ATK_ROLE_MENU_ITEM] = ATSPI_ROLE_MENU_ITEM;
383 role_table[ATK_ROLE_OPTION_PANE] = ATSPI_ROLE_OPTION_PANE;
384 role_table[ATK_ROLE_PAGE_TAB] = ATSPI_ROLE_PAGE_TAB;
385 role_table[ATK_ROLE_PAGE_TAB_LIST] = ATSPI_ROLE_PAGE_TAB_LIST;
386 role_table[ATK_ROLE_PANEL] = ATSPI_ROLE_PANEL;
387 role_table[ATK_ROLE_PASSWORD_TEXT] = ATSPI_ROLE_PASSWORD_TEXT;
388 role_table[ATK_ROLE_POPUP_MENU] = ATSPI_ROLE_POPUP_MENU;
389 role_table[ATK_ROLE_PROGRESS_BAR] = ATSPI_ROLE_PROGRESS_BAR;
390 role_table[ATK_ROLE_PUSH_BUTTON] = ATSPI_ROLE_PUSH_BUTTON;
391 role_table[ATK_ROLE_RADIO_BUTTON] = ATSPI_ROLE_RADIO_BUTTON;
392 role_table[ATK_ROLE_RADIO_MENU_ITEM] = ATSPI_ROLE_RADIO_MENU_ITEM;
393 role_table[ATK_ROLE_ROOT_PANE] = ATSPI_ROLE_ROOT_PANE;
394 role_table[ATK_ROLE_ROW_HEADER] = ATSPI_ROLE_ROW_HEADER;
395 role_table[ATK_ROLE_SCROLL_BAR] = ATSPI_ROLE_SCROLL_BAR;
396 role_table[ATK_ROLE_SCROLL_PANE] = ATSPI_ROLE_SCROLL_PANE;
397 role_table[ATK_ROLE_SEPARATOR] = ATSPI_ROLE_SEPARATOR;
398 role_table[ATK_ROLE_SLIDER] = ATSPI_ROLE_SLIDER;
399 role_table[ATK_ROLE_SPIN_BUTTON] = ATSPI_ROLE_SPIN_BUTTON;
400 role_table[ATK_ROLE_SPLIT_PANE] = ATSPI_ROLE_SPLIT_PANE;
401 role_table[ATK_ROLE_STATUSBAR] = ATSPI_ROLE_STATUS_BAR;
402 role_table[ATK_ROLE_TABLE] = ATSPI_ROLE_TABLE;
403 role_table[ATK_ROLE_TABLE_CELL] = ATSPI_ROLE_TABLE_CELL;
404 role_table[ATK_ROLE_TABLE_COLUMN_HEADER] =
405 ATSPI_ROLE_TABLE_COLUMN_HEADER;
406 role_table[ATK_ROLE_TABLE_ROW_HEADER] = ATSPI_ROLE_TABLE_ROW_HEADER;
407 role_table[ATK_ROLE_TEAR_OFF_MENU_ITEM] =
408 ATSPI_ROLE_TEAROFF_MENU_ITEM;
409 role_table[ATK_ROLE_TERMINAL] = ATSPI_ROLE_TERMINAL;
410 role_table[ATK_ROLE_TEXT] = ATSPI_ROLE_TEXT;
411 role_table[ATK_ROLE_TOGGLE_BUTTON] = ATSPI_ROLE_TOGGLE_BUTTON;
412 role_table[ATK_ROLE_TOOL_BAR] = ATSPI_ROLE_TOOL_BAR;
413 role_table[ATK_ROLE_TOOL_TIP] = ATSPI_ROLE_TOOL_TIP;
414 role_table[ATK_ROLE_TREE] = ATSPI_ROLE_TREE;
415 role_table[ATK_ROLE_TREE_TABLE] = ATSPI_ROLE_TREE_TABLE;
416 role_table[ATK_ROLE_UNKNOWN] = ATSPI_ROLE_UNKNOWN;
417 role_table[ATK_ROLE_VIEWPORT] = ATSPI_ROLE_VIEWPORT;
418 role_table[ATK_ROLE_WINDOW] = ATSPI_ROLE_WINDOW;
419 role_table[ATK_ROLE_HEADER] = ATSPI_ROLE_HEADER;
420 role_table[ATK_ROLE_FOOTER] = ATSPI_ROLE_FOOTER;
421 role_table[ATK_ROLE_PARAGRAPH] = ATSPI_ROLE_PARAGRAPH;
422 role_table[ATK_ROLE_RULER] = ATSPI_ROLE_RULER;
423 role_table[ATK_ROLE_APPLICATION] = ATSPI_ROLE_APPLICATION;
424 role_table[ATK_ROLE_AUTOCOMPLETE] = ATSPI_ROLE_AUTOCOMPLETE;
425 role_table[ATK_ROLE_EDITBAR] = ATSPI_ROLE_EDITBAR;
426 role_table[ATK_ROLE_EMBEDDED] = ATSPI_ROLE_EMBEDDED;
427 role_table[ATK_ROLE_ENTRY] = ATSPI_ROLE_ENTRY;
428 role_table[ATK_ROLE_CHART] = ATSPI_ROLE_CHART;
429 role_table[ATK_ROLE_CAPTION] = ATSPI_ROLE_CAPTION;
430 role_table[ATK_ROLE_DOCUMENT_FRAME] = ATSPI_ROLE_DOCUMENT_FRAME;
431 role_table[ATK_ROLE_HEADING] = ATSPI_ROLE_HEADING;
432 role_table[ATK_ROLE_PAGE] = ATSPI_ROLE_PAGE;
433 role_table[ATK_ROLE_SECTION] = ATSPI_ROLE_SECTION;
434 role_table[ATK_ROLE_FORM] = ATSPI_ROLE_FORM;
435 role_table[ATK_ROLE_REDUNDANT_OBJECT] = ATSPI_ROLE_REDUNDANT_OBJECT;
436 role_table[ATK_ROLE_LINK] = ATSPI_ROLE_LINK;
437 role_table[ATK_ROLE_INPUT_METHOD_WINDOW] =
438 ATSPI_ROLE_INPUT_METHOD_WINDOW;
439 role_table[ATK_ROLE_TABLE_ROW] = ATSPI_ROLE_TABLE_ROW;
440 role_table[ATK_ROLE_TREE_ITEM] = ATSPI_ROLE_TREE_ITEM;
441 role_table[ATK_ROLE_DOCUMENT_SPREADSHEET] =
442 ATSPI_ROLE_DOCUMENT_SPREADSHEET;
443 role_table[ATK_ROLE_DOCUMENT_PRESENTATION] =
444 ATSPI_ROLE_DOCUMENT_PRESENTATION;
445 role_table[ATK_ROLE_DOCUMENT_TEXT] = ATSPI_ROLE_DOCUMENT_TEXT;
446 role_table[ATK_ROLE_DOCUMENT_WEB] = ATSPI_ROLE_DOCUMENT_WEB;
447 role_table[ATK_ROLE_DOCUMENT_EMAIL] = ATSPI_ROLE_DOCUMENT_EMAIL;
448 role_table[ATK_ROLE_COMMENT] = ATSPI_ROLE_COMMENT;
449 role_table[ATK_ROLE_LIST_BOX] = ATSPI_ROLE_LIST_BOX;
450 role_table[ATK_ROLE_GROUPING] = ATSPI_ROLE_GROUPING;
451 role_table[ATK_ROLE_IMAGE_MAP] = ATSPI_ROLE_IMAGE_MAP;
452 role_table[ATK_ROLE_NOTIFICATION] = ATSPI_ROLE_NOTIFICATION;
453 role_table[ATK_ROLE_INFO_BAR] = ATSPI_ROLE_INFO_BAR;
458 spi_accessible_role_from_atk_role (AtkRole role)
460 static gboolean is_initialized = FALSE;
461 static AtspiRole spi_role_table[ATK_ROLE_LAST_DEFINED];
466 is_initialized = init_role_lookup_table (spi_role_table);
469 if (role >= 0 && role < ATK_ROLE_LAST_DEFINED)
471 spi_role = spi_role_table[role];
475 spi_role = ATSPI_ROLE_EXTENDED;
480 /*END------------------------------------------------------------------------*/