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 maybe_lease (AtkObject *obj)
61 if (!spi_cache_in (spi_global_cache, G_OBJECT (obj)))
63 spi_leasing_take (spi_global_leasing, G_OBJECT (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);
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);
122 spi_object_append_v_reference (DBusMessageIter * iter, AtkObject * obj)
124 DBusMessageIter iter_variant;
126 dbus_message_iter_open_container (iter, DBUS_TYPE_VARIANT, "(so)",
128 spi_object_append_reference (&iter_variant, obj);
129 dbus_message_iter_close_container (iter, &iter_variant);
133 spi_object_append_desktop_reference (DBusMessageIter * iter)
135 DBusMessageIter iter_struct;
136 const char *name = spi_global_app_data->desktop_name;
137 const char *path = spi_global_app_data->desktop_path;
139 dbus_message_iter_open_container (iter, DBUS_TYPE_STRUCT, NULL,
141 dbus_message_iter_append_basic (&iter_struct, DBUS_TYPE_STRING, &name);
142 dbus_message_iter_append_basic (&iter_struct, DBUS_TYPE_OBJECT_PATH, &path);
143 dbus_message_iter_close_container (iter, &iter_struct);
147 spi_object_return_reference (DBusMessage * msg, AtkObject * obj)
151 reply = dbus_message_new_method_return (msg);
154 DBusMessageIter iter;
155 dbus_message_iter_init_append (reply, &iter);
156 spi_object_append_reference (&iter, obj);
158 g_object_unref (G_OBJECT (obj));
163 /*---------------------------------------------------------------------------*/
166 spi_object_append_interfaces (DBusMessageIter * iter, AtkObject * obj)
170 itf = SPI_DBUS_INTERFACE_ACCESSIBLE;
171 dbus_message_iter_append_basic (iter, DBUS_TYPE_STRING, &itf);
173 if (ATK_IS_ACTION (obj))
175 itf = SPI_DBUS_INTERFACE_ACTION;
176 dbus_message_iter_append_basic (iter, DBUS_TYPE_STRING, &itf);
179 if (atk_object_get_role (obj) == ATK_ROLE_APPLICATION)
181 itf = SPI_DBUS_INTERFACE_APPLICATION;
182 dbus_message_iter_append_basic (iter, DBUS_TYPE_STRING, &itf);
185 if (ATK_IS_COMPONENT (obj))
187 itf = SPI_DBUS_INTERFACE_COMPONENT;
188 dbus_message_iter_append_basic (iter, DBUS_TYPE_STRING, &itf);
191 if (ATK_IS_EDITABLE_TEXT (obj))
193 itf = SPI_DBUS_INTERFACE_EDITABLE_TEXT;
194 dbus_message_iter_append_basic (iter, DBUS_TYPE_STRING, &itf);
197 if (ATK_IS_TEXT (obj))
199 itf = SPI_DBUS_INTERFACE_TEXT;
200 dbus_message_iter_append_basic (iter, DBUS_TYPE_STRING, &itf);
203 if (ATK_IS_HYPERTEXT (obj))
205 itf = SPI_DBUS_INTERFACE_HYPERTEXT;
206 dbus_message_iter_append_basic (iter, DBUS_TYPE_STRING, &itf);
209 if (ATK_IS_IMAGE (obj))
211 itf = SPI_DBUS_INTERFACE_IMAGE;
212 dbus_message_iter_append_basic (iter, DBUS_TYPE_STRING, &itf);
215 if (ATK_IS_SELECTION (obj))
217 itf = SPI_DBUS_INTERFACE_SELECTION;
218 dbus_message_iter_append_basic (iter, DBUS_TYPE_STRING, &itf);
221 if (ATK_IS_TABLE (obj))
223 itf = SPI_DBUS_INTERFACE_TABLE;
224 dbus_message_iter_append_basic (iter, DBUS_TYPE_STRING, &itf);
227 if (ATK_IS_VALUE (obj))
229 itf = SPI_DBUS_INTERFACE_VALUE;
230 dbus_message_iter_append_basic (iter, DBUS_TYPE_STRING, &itf);
234 if (ATK_IS_STREAMABLE_CONTENT (obj))
236 itf = "org.a11y.atspi.StreamableContent";
237 dbus_message_iter_append_basic (iter, DBUS_TYPE_STRING, &itf);
241 if (ATK_IS_DOCUMENT (obj))
243 itf = "org.a11y.atspi.Collection";
244 dbus_message_iter_append_basic (iter, DBUS_TYPE_STRING, &itf);
245 itf = SPI_DBUS_INTERFACE_DOCUMENT;
246 dbus_message_iter_append_basic (iter, DBUS_TYPE_STRING, &itf);
249 if (ATK_IS_HYPERLINK_IMPL (obj))
251 itf = SPI_DBUS_INTERFACE_HYPERLINK;
252 dbus_message_iter_append_basic (iter, DBUS_TYPE_STRING, &itf);
256 /*---------------------------------------------------------------------------*/
259 spi_object_append_attribute_set (DBusMessageIter * iter, AtkAttributeSet * attr)
261 DBusMessageIter dictIter;
263 dbus_message_iter_open_container (iter, DBUS_TYPE_ARRAY, "{ss}", &dictIter);
266 DBusMessageIter dictEntryIter;
267 AtkAttribute *attribute = (AtkAttribute *) attr->data;
268 const char *key = attribute->name;
269 const char *value = attribute->value;
276 dbus_message_iter_open_container (&dictIter, DBUS_TYPE_DICT_ENTRY, NULL,
278 dbus_message_iter_append_basic (&dictEntryIter, DBUS_TYPE_STRING,
280 dbus_message_iter_append_basic (&dictEntryIter, DBUS_TYPE_STRING,
282 dbus_message_iter_close_container (&dictIter, &dictEntryIter);
283 attr = g_slist_next (attr);
285 dbus_message_iter_close_container (iter, &dictIter);
288 /*---------------------------------------------------------------------------*/
291 init_role_lookup_table (Accessibility_Role * role_table)
294 /* if it's not in the list below, dunno what it is */
295 for (i = 0; i < ATK_ROLE_LAST_DEFINED; ++i)
297 role_table[i] = Accessibility_ROLE_UNKNOWN;
300 role_table[ATK_ROLE_INVALID] = Accessibility_ROLE_INVALID;
301 role_table[ATK_ROLE_ACCEL_LABEL] = Accessibility_ROLE_ACCELERATOR_LABEL;
302 role_table[ATK_ROLE_ALERT] = Accessibility_ROLE_ALERT;
303 role_table[ATK_ROLE_ANIMATION] = Accessibility_ROLE_ANIMATION;
304 role_table[ATK_ROLE_ARROW] = Accessibility_ROLE_ARROW;
305 role_table[ATK_ROLE_CALENDAR] = Accessibility_ROLE_CALENDAR;
306 role_table[ATK_ROLE_CANVAS] = Accessibility_ROLE_CANVAS;
307 role_table[ATK_ROLE_CHECK_BOX] = Accessibility_ROLE_CHECK_BOX;
308 role_table[ATK_ROLE_CHECK_MENU_ITEM] = Accessibility_ROLE_CHECK_MENU_ITEM;
309 role_table[ATK_ROLE_COLOR_CHOOSER] = Accessibility_ROLE_COLOR_CHOOSER;
310 role_table[ATK_ROLE_COLUMN_HEADER] = Accessibility_ROLE_COLUMN_HEADER;
311 role_table[ATK_ROLE_COMBO_BOX] = Accessibility_ROLE_COMBO_BOX;
312 role_table[ATK_ROLE_DATE_EDITOR] = Accessibility_ROLE_DATE_EDITOR;
313 role_table[ATK_ROLE_DESKTOP_ICON] = Accessibility_ROLE_DESKTOP_ICON;
314 role_table[ATK_ROLE_DESKTOP_FRAME] = Accessibility_ROLE_DESKTOP_FRAME;
315 role_table[ATK_ROLE_DIAL] = Accessibility_ROLE_DIAL;
316 role_table[ATK_ROLE_DIALOG] = Accessibility_ROLE_DIALOG;
317 role_table[ATK_ROLE_DIRECTORY_PANE] = Accessibility_ROLE_DIRECTORY_PANE;
318 role_table[ATK_ROLE_DRAWING_AREA] = Accessibility_ROLE_DRAWING_AREA;
319 role_table[ATK_ROLE_FILE_CHOOSER] = Accessibility_ROLE_FILE_CHOOSER;
320 role_table[ATK_ROLE_FILLER] = Accessibility_ROLE_FILLER;
321 role_table[ATK_ROLE_FONT_CHOOSER] = Accessibility_ROLE_FONT_CHOOSER;
322 role_table[ATK_ROLE_FRAME] = Accessibility_ROLE_FRAME;
323 role_table[ATK_ROLE_GLASS_PANE] = Accessibility_ROLE_GLASS_PANE;
324 role_table[ATK_ROLE_HTML_CONTAINER] = Accessibility_ROLE_HTML_CONTAINER;
325 role_table[ATK_ROLE_ICON] = Accessibility_ROLE_ICON;
326 role_table[ATK_ROLE_IMAGE] = Accessibility_ROLE_IMAGE;
327 role_table[ATK_ROLE_INTERNAL_FRAME] = Accessibility_ROLE_INTERNAL_FRAME;
328 role_table[ATK_ROLE_LABEL] = Accessibility_ROLE_LABEL;
329 role_table[ATK_ROLE_LAYERED_PANE] = Accessibility_ROLE_LAYERED_PANE;
330 role_table[ATK_ROLE_LIST] = Accessibility_ROLE_LIST;
331 role_table[ATK_ROLE_LIST_ITEM] = Accessibility_ROLE_LIST_ITEM;
332 role_table[ATK_ROLE_MENU] = Accessibility_ROLE_MENU;
333 role_table[ATK_ROLE_MENU_BAR] = Accessibility_ROLE_MENU_BAR;
334 role_table[ATK_ROLE_MENU_ITEM] = Accessibility_ROLE_MENU_ITEM;
335 role_table[ATK_ROLE_OPTION_PANE] = Accessibility_ROLE_OPTION_PANE;
336 role_table[ATK_ROLE_PAGE_TAB] = Accessibility_ROLE_PAGE_TAB;
337 role_table[ATK_ROLE_PAGE_TAB_LIST] = Accessibility_ROLE_PAGE_TAB_LIST;
338 role_table[ATK_ROLE_PANEL] = Accessibility_ROLE_PANEL;
339 role_table[ATK_ROLE_PASSWORD_TEXT] = Accessibility_ROLE_PASSWORD_TEXT;
340 role_table[ATK_ROLE_POPUP_MENU] = Accessibility_ROLE_POPUP_MENU;
341 role_table[ATK_ROLE_PROGRESS_BAR] = Accessibility_ROLE_PROGRESS_BAR;
342 role_table[ATK_ROLE_PUSH_BUTTON] = Accessibility_ROLE_PUSH_BUTTON;
343 role_table[ATK_ROLE_RADIO_BUTTON] = Accessibility_ROLE_RADIO_BUTTON;
344 role_table[ATK_ROLE_RADIO_MENU_ITEM] = Accessibility_ROLE_RADIO_MENU_ITEM;
345 role_table[ATK_ROLE_ROOT_PANE] = Accessibility_ROLE_ROOT_PANE;
346 role_table[ATK_ROLE_ROW_HEADER] = Accessibility_ROLE_ROW_HEADER;
347 role_table[ATK_ROLE_SCROLL_BAR] = Accessibility_ROLE_SCROLL_BAR;
348 role_table[ATK_ROLE_SCROLL_PANE] = Accessibility_ROLE_SCROLL_PANE;
349 role_table[ATK_ROLE_SEPARATOR] = Accessibility_ROLE_SEPARATOR;
350 role_table[ATK_ROLE_SLIDER] = Accessibility_ROLE_SLIDER;
351 role_table[ATK_ROLE_SPIN_BUTTON] = Accessibility_ROLE_SPIN_BUTTON;
352 role_table[ATK_ROLE_SPLIT_PANE] = Accessibility_ROLE_SPLIT_PANE;
353 role_table[ATK_ROLE_STATUSBAR] = Accessibility_ROLE_STATUS_BAR;
354 role_table[ATK_ROLE_TABLE] = Accessibility_ROLE_TABLE;
355 role_table[ATK_ROLE_TABLE_CELL] = Accessibility_ROLE_TABLE_CELL;
356 role_table[ATK_ROLE_TABLE_COLUMN_HEADER] =
357 Accessibility_ROLE_TABLE_COLUMN_HEADER;
358 role_table[ATK_ROLE_TABLE_ROW_HEADER] = Accessibility_ROLE_TABLE_ROW_HEADER;
359 role_table[ATK_ROLE_TEAR_OFF_MENU_ITEM] =
360 Accessibility_ROLE_TEAROFF_MENU_ITEM;
361 role_table[ATK_ROLE_TERMINAL] = Accessibility_ROLE_TERMINAL;
362 role_table[ATK_ROLE_TEXT] = Accessibility_ROLE_TEXT;
363 role_table[ATK_ROLE_TOGGLE_BUTTON] = Accessibility_ROLE_TOGGLE_BUTTON;
364 role_table[ATK_ROLE_TOOL_BAR] = Accessibility_ROLE_TOOL_BAR;
365 role_table[ATK_ROLE_TOOL_TIP] = Accessibility_ROLE_TOOL_TIP;
366 role_table[ATK_ROLE_TREE] = Accessibility_ROLE_TREE;
367 role_table[ATK_ROLE_TREE_TABLE] = Accessibility_ROLE_TREE_TABLE;
368 role_table[ATK_ROLE_UNKNOWN] = Accessibility_ROLE_UNKNOWN;
369 role_table[ATK_ROLE_VIEWPORT] = Accessibility_ROLE_VIEWPORT;
370 role_table[ATK_ROLE_WINDOW] = Accessibility_ROLE_WINDOW;
371 role_table[ATK_ROLE_HEADER] = Accessibility_ROLE_HEADER;
372 role_table[ATK_ROLE_FOOTER] = Accessibility_ROLE_FOOTER;
373 role_table[ATK_ROLE_PARAGRAPH] = Accessibility_ROLE_PARAGRAPH;
374 role_table[ATK_ROLE_RULER] = Accessibility_ROLE_RULER;
375 role_table[ATK_ROLE_APPLICATION] = Accessibility_ROLE_APPLICATION;
376 role_table[ATK_ROLE_AUTOCOMPLETE] = Accessibility_ROLE_AUTOCOMPLETE;
377 role_table[ATK_ROLE_EDITBAR] = Accessibility_ROLE_EDITBAR;
378 role_table[ATK_ROLE_EMBEDDED] = Accessibility_ROLE_EMBEDDED;
379 role_table[ATK_ROLE_ENTRY] = Accessibility_ROLE_ENTRY;
380 role_table[ATK_ROLE_CHART] = Accessibility_ROLE_CHART;
381 role_table[ATK_ROLE_CAPTION] = Accessibility_ROLE_CAPTION;
382 role_table[ATK_ROLE_DOCUMENT_FRAME] = Accessibility_ROLE_DOCUMENT_FRAME;
383 role_table[ATK_ROLE_HEADING] = Accessibility_ROLE_HEADING;
384 role_table[ATK_ROLE_PAGE] = Accessibility_ROLE_PAGE;
385 role_table[ATK_ROLE_SECTION] = Accessibility_ROLE_SECTION;
386 role_table[ATK_ROLE_FORM] = Accessibility_ROLE_FORM;
387 role_table[ATK_ROLE_REDUNDANT_OBJECT] = Accessibility_ROLE_REDUNDANT_OBJECT;
388 role_table[ATK_ROLE_LINK] = Accessibility_ROLE_LINK;
389 role_table[ATK_ROLE_INPUT_METHOD_WINDOW] =
390 Accessibility_ROLE_INPUT_METHOD_WINDOW;
395 spi_accessible_role_from_atk_role (AtkRole role)
397 static gboolean is_initialized = FALSE;
398 static Accessibility_Role spi_role_table[ATK_ROLE_LAST_DEFINED];
399 Accessibility_Role spi_role;
403 is_initialized = init_role_lookup_table (spi_role_table);
406 if (role >= 0 && role < ATK_ROLE_LAST_DEFINED)
408 spi_role = spi_role_table[role];
412 spi_role = Accessibility_ROLE_EXTENDED;
417 /*END------------------------------------------------------------------------*/