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 2001, 2002 Sun Microsystems Inc.,
7 * Copyright 2001, 2002 Ximian, Inc.
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.
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.
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.
26 #include <droute/droute.h>
28 #include "spi-common/spi-dbus.h"
29 #include "accessible-marshaller.h"
30 #include "accessible-register.h"
33 impl_get_name (DBusMessageIter *iter, void *user_data)
35 AtkObject *object = (AtkObject *) user_data;
37 g_return_val_if_fail (ATK_IS_OBJECT (user_data), FALSE);
39 return droute_return_v_string (iter, atk_object_get_name (object));
43 impl_set_name (DBusMessageIter *iter, void *user_data)
45 AtkObject *object = (AtkObject *) user_data;
46 const char *name = droute_get_v_string (iter);
48 g_return_val_if_fail (ATK_IS_OBJECT (user_data), FALSE);
50 atk_object_set_name (object, name);
55 impl_get_description (DBusMessageIter *iter, void *user_data)
57 AtkObject *object = (AtkObject *) user_data;
59 g_return_val_if_fail (ATK_IS_OBJECT (user_data), FALSE);
61 return droute_return_v_string (iter, atk_object_get_description (object));
65 impl_set_description (DBusMessageIter *iter, void *user_data)
67 AtkObject *object = (AtkObject *) user_data;
68 const char *description = droute_get_v_string (iter);
70 g_return_val_if_fail (ATK_IS_OBJECT (user_data), FALSE);
72 atk_object_set_description (object, description);
77 impl_get_parent (DBusMessageIter *iter, void *user_data)
79 AtkObject *object = (AtkObject *) user_data;
81 g_return_val_if_fail (ATK_IS_OBJECT (user_data), FALSE);
83 return spi_dbus_return_v_object (iter,
84 atk_object_get_parent (object),
89 impl_get_childCount (DBusMessageIter *iter, void *user_data)
91 AtkObject *object = (AtkObject *) user_data;
93 g_return_val_if_fail (ATK_IS_OBJECT (user_data), FALSE);
95 return droute_return_v_int32 (iter,
96 atk_object_get_n_accessible_children
101 impl_getChildAtIndex (DBusConnection *bus,
102 DBusMessage *message,
105 AtkObject *object = (AtkObject *) user_data;
110 dbus_error_init (&error);
111 g_return_val_if_fail (ATK_IS_OBJECT (user_data),
112 droute_not_yet_handled_error (message));
113 if (!dbus_message_get_args (message, &error, DBUS_TYPE_INT32, &i, DBUS_TYPE_INVALID))
114 return spi_dbus_general_error (message);
115 child = atk_object_ref_accessible_child (object, i);
116 return spi_dbus_return_object (message, child, FALSE);
120 impl_getChildren (DBusConnection *bus,
121 DBusMessage *message,
124 AtkObject *object = (AtkObject *) user_data;
128 DBusMessageIter iter, iter_array;
130 g_return_val_if_fail (ATK_IS_OBJECT (user_data),
131 droute_not_yet_handled_error (message));
132 count = atk_object_get_n_accessible_children (object);
133 reply = dbus_message_new_method_return (message);
134 if (!reply) goto oom;
135 dbus_message_iter_init_append (reply, &iter);
136 if (!dbus_message_iter_open_container
137 (&iter, DBUS_TYPE_ARRAY, "o", &iter_array))
139 for (i = 0; i < count; i++)
141 AtkObject *child = atk_object_ref_accessible_child (object, i);
142 char *path = atk_dbus_object_to_path (child);
145 dbus_message_iter_append_basic (&iter_array, DBUS_TYPE_OBJECT_PATH,
150 g_object_unref (child);
152 if (!dbus_message_iter_close_container (&iter, &iter_array))
156 // TODO: handle out-of-memory
161 impl_getIndexInParent (DBusConnection *bus,
162 DBusMessage *message,
165 AtkObject *object = (AtkObject *) user_data;
169 g_return_val_if_fail (ATK_IS_OBJECT (user_data),
170 droute_not_yet_handled_error (message));
171 rv = atk_object_get_index_in_parent (object);
172 reply = dbus_message_new_method_return (message);
175 dbus_message_append_args (reply, DBUS_TYPE_UINT32, &rv,
182 spi_init_relation_type_table (Accessibility_RelationType *types)
186 for (i = 0; i < ATK_RELATION_LAST_DEFINED; i++)
187 types[i] = Accessibility_RELATION_NULL;
189 types[ATK_RELATION_CONTROLLED_BY] = Accessibility_RELATION_CONTROLLED_BY;
190 types[ATK_RELATION_CONTROLLER_FOR] = Accessibility_RELATION_CONTROLLER_FOR;
191 types[ATK_RELATION_LABEL_FOR] = Accessibility_RELATION_LABEL_FOR;
192 types[ATK_RELATION_LABELLED_BY] = Accessibility_RELATION_LABELLED_BY;
193 types[ATK_RELATION_MEMBER_OF] = Accessibility_RELATION_MEMBER_OF;
194 types[ATK_RELATION_NODE_CHILD_OF] = Accessibility_RELATION_NODE_CHILD_OF;
195 types[ATK_RELATION_FLOWS_TO] = Accessibility_RELATION_FLOWS_TO;
196 types[ATK_RELATION_FLOWS_FROM] = Accessibility_RELATION_FLOWS_FROM;
197 types[ATK_RELATION_SUBWINDOW_OF] = Accessibility_RELATION_SUBWINDOW_OF;
198 types[ATK_RELATION_EMBEDS] = Accessibility_RELATION_EMBEDS;
199 types[ATK_RELATION_EMBEDDED_BY] = Accessibility_RELATION_EMBEDDED_BY;
200 types[ATK_RELATION_POPUP_FOR] = Accessibility_RELATION_POPUP_FOR;
201 types[ATK_RELATION_PARENT_WINDOW_OF] = Accessibility_RELATION_PARENT_WINDOW_OF;
202 types[ATK_RELATION_DESCRIPTION_FOR] = Accessibility_RELATION_DESCRIPTION_FOR;
203 types[ATK_RELATION_DESCRIBED_BY] = Accessibility_RELATION_DESCRIBED_BY;
208 static Accessibility_RelationType
209 spi_relation_type_from_atk_relation_type (AtkRelationType type)
211 static gboolean is_initialized = FALSE;
212 static Accessibility_RelationType spi_relation_type_table [ATK_RELATION_LAST_DEFINED];
213 Accessibility_RelationType spi_type;
216 is_initialized = spi_init_relation_type_table (spi_relation_type_table);
218 if (type > ATK_RELATION_NULL && type < ATK_RELATION_LAST_DEFINED)
219 spi_type = spi_relation_type_table[type];
221 spi_type = Accessibility_RELATION_EXTENDED;
226 impl_getRelationSet (DBusConnection *bus,
227 DBusMessage *message,
230 AtkObject *object = (AtkObject *) user_data;
233 DBusMessageIter iter, iter_array, iter_struct, iter_targets;
237 g_return_val_if_fail (ATK_IS_OBJECT (user_data),
238 droute_not_yet_handled_error (message));
239 reply = dbus_message_new_method_return (message);
240 if (!reply) return NULL;
241 set = atk_object_ref_relation_set (object);
242 dbus_message_iter_init_append (reply, &iter);
243 if (!dbus_message_iter_open_container (&iter, DBUS_TYPE_ARRAY, "(uao)", &iter_array))
247 count = atk_relation_set_get_n_relations (set);
248 for (i = 0; i < count; i++)
250 AtkRelation *r = atk_relation_set_get_relation (set, i);
255 rt= atk_relation_get_relation_type (r);
256 type = spi_relation_type_from_atk_relation_type (rt);
257 target = atk_relation_get_target (r);
258 if (!dbus_message_iter_open_container (&iter_array, DBUS_TYPE_STRUCT, NULL, &iter_struct))
262 dbus_message_iter_append_basic (&iter_struct, DBUS_TYPE_UINT32, &type);
263 if (!dbus_message_iter_open_container (&iter_struct, DBUS_TYPE_ARRAY, "o", &iter_targets))
267 for (j = 0; j < target->len; j++)
269 AtkObject *obj = target->pdata[j];
272 path = atk_dbus_object_to_path (obj);
273 dbus_message_iter_append_basic (&iter_targets, DBUS_TYPE_OBJECT_PATH, &path);
275 dbus_message_iter_close_container (&iter_struct, &iter_targets);
276 dbus_message_iter_close_container (&iter_array, &iter_struct);
278 dbus_message_iter_close_container (&iter, &iter_array);
280 // TODO: handle out of memory */
285 spi_init_role_lookup_table (Accessibility_Role * role_table)
288 /* if it's not in the list below, dunno what it is */
289 for (i = 0; i < ATK_ROLE_LAST_DEFINED; ++i)
291 role_table[i] = Accessibility_ROLE_UNKNOWN;
294 role_table[ATK_ROLE_INVALID] = Accessibility_ROLE_INVALID;
295 role_table[ATK_ROLE_ACCEL_LABEL] = Accessibility_ROLE_ACCELERATOR_LABEL;
296 role_table[ATK_ROLE_ALERT] = Accessibility_ROLE_ALERT;
297 role_table[ATK_ROLE_ANIMATION] = Accessibility_ROLE_ANIMATION;
298 role_table[ATK_ROLE_ARROW] = Accessibility_ROLE_ARROW;
299 role_table[ATK_ROLE_CALENDAR] = Accessibility_ROLE_CALENDAR;
300 role_table[ATK_ROLE_CANVAS] = Accessibility_ROLE_CANVAS;
301 role_table[ATK_ROLE_CHECK_BOX] = Accessibility_ROLE_CHECK_BOX;
302 role_table[ATK_ROLE_CHECK_MENU_ITEM] = Accessibility_ROLE_CHECK_MENU_ITEM;
303 role_table[ATK_ROLE_COLOR_CHOOSER] = Accessibility_ROLE_COLOR_CHOOSER;
304 role_table[ATK_ROLE_COLUMN_HEADER] = Accessibility_ROLE_COLUMN_HEADER;
305 role_table[ATK_ROLE_COMBO_BOX] = Accessibility_ROLE_COMBO_BOX;
306 role_table[ATK_ROLE_DATE_EDITOR] = Accessibility_ROLE_DATE_EDITOR;
307 role_table[ATK_ROLE_DESKTOP_ICON] = Accessibility_ROLE_DESKTOP_ICON;
308 role_table[ATK_ROLE_DESKTOP_FRAME] = Accessibility_ROLE_DESKTOP_FRAME;
309 role_table[ATK_ROLE_DIAL] = Accessibility_ROLE_DIAL;
310 role_table[ATK_ROLE_DIALOG] = Accessibility_ROLE_DIALOG;
311 role_table[ATK_ROLE_DIRECTORY_PANE] = Accessibility_ROLE_DIRECTORY_PANE;
312 role_table[ATK_ROLE_DRAWING_AREA] = Accessibility_ROLE_DRAWING_AREA;
313 role_table[ATK_ROLE_FILE_CHOOSER] = Accessibility_ROLE_FILE_CHOOSER;
314 role_table[ATK_ROLE_FILLER] = Accessibility_ROLE_FILLER;
315 role_table[ATK_ROLE_FONT_CHOOSER] = Accessibility_ROLE_FONT_CHOOSER;
316 role_table[ATK_ROLE_FRAME] = Accessibility_ROLE_FRAME;
317 role_table[ATK_ROLE_GLASS_PANE] = Accessibility_ROLE_GLASS_PANE;
318 role_table[ATK_ROLE_HTML_CONTAINER] = Accessibility_ROLE_HTML_CONTAINER;
319 role_table[ATK_ROLE_ICON] = Accessibility_ROLE_ICON;
320 role_table[ATK_ROLE_IMAGE] = Accessibility_ROLE_IMAGE;
321 role_table[ATK_ROLE_INTERNAL_FRAME] = Accessibility_ROLE_INTERNAL_FRAME;
322 role_table[ATK_ROLE_LABEL] = Accessibility_ROLE_LABEL;
323 role_table[ATK_ROLE_LAYERED_PANE] = Accessibility_ROLE_LAYERED_PANE;
324 role_table[ATK_ROLE_LIST] = Accessibility_ROLE_LIST;
325 role_table[ATK_ROLE_LIST_ITEM] = Accessibility_ROLE_LIST_ITEM;
326 role_table[ATK_ROLE_MENU] = Accessibility_ROLE_MENU;
327 role_table[ATK_ROLE_MENU_BAR] = Accessibility_ROLE_MENU_BAR;
328 role_table[ATK_ROLE_MENU_ITEM] = Accessibility_ROLE_MENU_ITEM;
329 role_table[ATK_ROLE_OPTION_PANE] = Accessibility_ROLE_OPTION_PANE;
330 role_table[ATK_ROLE_PAGE_TAB] = Accessibility_ROLE_PAGE_TAB;
331 role_table[ATK_ROLE_PAGE_TAB_LIST] = Accessibility_ROLE_PAGE_TAB_LIST;
332 role_table[ATK_ROLE_PANEL] = Accessibility_ROLE_PANEL;
333 role_table[ATK_ROLE_PASSWORD_TEXT] = Accessibility_ROLE_PASSWORD_TEXT;
334 role_table[ATK_ROLE_POPUP_MENU] = Accessibility_ROLE_POPUP_MENU;
335 role_table[ATK_ROLE_PROGRESS_BAR] = Accessibility_ROLE_PROGRESS_BAR;
336 role_table[ATK_ROLE_PUSH_BUTTON] = Accessibility_ROLE_PUSH_BUTTON;
337 role_table[ATK_ROLE_RADIO_BUTTON] = Accessibility_ROLE_RADIO_BUTTON;
338 role_table[ATK_ROLE_RADIO_MENU_ITEM] = Accessibility_ROLE_RADIO_MENU_ITEM;
339 role_table[ATK_ROLE_ROOT_PANE] = Accessibility_ROLE_ROOT_PANE;
340 role_table[ATK_ROLE_ROW_HEADER] = Accessibility_ROLE_ROW_HEADER;
341 role_table[ATK_ROLE_SCROLL_BAR] = Accessibility_ROLE_SCROLL_BAR;
342 role_table[ATK_ROLE_SCROLL_PANE] = Accessibility_ROLE_SCROLL_PANE;
343 role_table[ATK_ROLE_SEPARATOR] = Accessibility_ROLE_SEPARATOR;
344 role_table[ATK_ROLE_SLIDER] = Accessibility_ROLE_SLIDER;
345 role_table[ATK_ROLE_SPIN_BUTTON] = Accessibility_ROLE_SPIN_BUTTON;
346 role_table[ATK_ROLE_SPLIT_PANE] = Accessibility_ROLE_SPLIT_PANE;
347 role_table[ATK_ROLE_STATUSBAR] = Accessibility_ROLE_STATUS_BAR;
348 role_table[ATK_ROLE_TABLE] = Accessibility_ROLE_TABLE;
349 role_table[ATK_ROLE_TABLE_CELL] = Accessibility_ROLE_TABLE_CELL;
350 role_table[ATK_ROLE_TABLE_COLUMN_HEADER] =
351 Accessibility_ROLE_TABLE_COLUMN_HEADER;
352 role_table[ATK_ROLE_TABLE_ROW_HEADER] = Accessibility_ROLE_TABLE_ROW_HEADER;
353 role_table[ATK_ROLE_TEAR_OFF_MENU_ITEM] =
354 Accessibility_ROLE_TEAROFF_MENU_ITEM;
355 role_table[ATK_ROLE_TERMINAL] = Accessibility_ROLE_TERMINAL;
356 role_table[ATK_ROLE_TEXT] = Accessibility_ROLE_TEXT;
357 role_table[ATK_ROLE_TOGGLE_BUTTON] = Accessibility_ROLE_TOGGLE_BUTTON;
358 role_table[ATK_ROLE_TOOL_BAR] = Accessibility_ROLE_TOOL_BAR;
359 role_table[ATK_ROLE_TOOL_TIP] = Accessibility_ROLE_TOOL_TIP;
360 role_table[ATK_ROLE_TREE] = Accessibility_ROLE_TREE;
361 role_table[ATK_ROLE_TREE_TABLE] = Accessibility_ROLE_TREE_TABLE;
362 role_table[ATK_ROLE_UNKNOWN] = Accessibility_ROLE_UNKNOWN;
363 role_table[ATK_ROLE_VIEWPORT] = Accessibility_ROLE_VIEWPORT;
364 role_table[ATK_ROLE_WINDOW] = Accessibility_ROLE_WINDOW;
365 role_table[ATK_ROLE_HEADER] = Accessibility_ROLE_HEADER;
366 role_table[ATK_ROLE_FOOTER] = Accessibility_ROLE_FOOTER;
367 role_table[ATK_ROLE_PARAGRAPH] = Accessibility_ROLE_PARAGRAPH;
368 role_table[ATK_ROLE_RULER] = Accessibility_ROLE_RULER;
369 role_table[ATK_ROLE_APPLICATION] = Accessibility_ROLE_APPLICATION;
370 role_table[ATK_ROLE_AUTOCOMPLETE] = Accessibility_ROLE_AUTOCOMPLETE;
371 role_table[ATK_ROLE_EDITBAR] = Accessibility_ROLE_EDITBAR;
372 role_table[ATK_ROLE_EMBEDDED] = Accessibility_ROLE_EMBEDDED;
373 role_table[ATK_ROLE_ENTRY] = Accessibility_ROLE_ENTRY;
374 role_table[ATK_ROLE_CHART] = Accessibility_ROLE_CHART;
375 role_table[ATK_ROLE_CAPTION] = Accessibility_ROLE_CAPTION;
376 role_table[ATK_ROLE_DOCUMENT_FRAME] = Accessibility_ROLE_DOCUMENT_FRAME;
377 role_table[ATK_ROLE_HEADING] = Accessibility_ROLE_HEADING;
378 role_table[ATK_ROLE_PAGE] = Accessibility_ROLE_PAGE;
379 role_table[ATK_ROLE_SECTION] = Accessibility_ROLE_SECTION;
380 role_table[ATK_ROLE_FORM] = Accessibility_ROLE_FORM;
381 role_table[ATK_ROLE_REDUNDANT_OBJECT] = Accessibility_ROLE_REDUNDANT_OBJECT;
382 role_table[ATK_ROLE_LINK] = Accessibility_ROLE_LINK;
383 role_table[ATK_ROLE_INPUT_METHOD_WINDOW] =
384 Accessibility_ROLE_INPUT_METHOD_WINDOW;
389 spi_accessible_role_from_atk_role (AtkRole role)
391 static gboolean is_initialized = FALSE;
392 static Accessibility_Role spi_role_table[ATK_ROLE_LAST_DEFINED];
393 Accessibility_Role spi_role;
397 is_initialized = spi_init_role_lookup_table (spi_role_table);
400 if (role >= 0 && role < ATK_ROLE_LAST_DEFINED)
402 spi_role = spi_role_table[role];
406 spi_role = Accessibility_ROLE_EXTENDED;
412 impl_getRole (DBusConnection *bus, DBusMessage *message, void *user_data)
414 AtkObject *object = (AtkObject *) user_data;
419 g_return_val_if_fail (ATK_IS_OBJECT (user_data),
420 droute_not_yet_handled_error (message));
421 role = atk_object_get_role (object);
422 rv = spi_accessible_role_from_atk_role (role);
423 reply = dbus_message_new_method_return (message);
426 dbus_message_append_args (reply, DBUS_TYPE_UINT32, &rv,
433 impl_get_role_str (void *datum)
435 g_assert (ATK_IS_OBJECT (datum));
436 return g_strdup_printf ("%d",
437 spi_accessible_role_from_atk_role
438 (atk_object_get_role ((AtkObject *) datum)));
442 impl_getRoleName (DBusConnection *bus,
443 DBusMessage *message,
446 AtkObject *object = (AtkObject *) user_data;
448 const char *role_name;
451 g_return_val_if_fail (ATK_IS_OBJECT (user_data),
452 droute_not_yet_handled_error (message));
453 role = atk_object_get_role (object);
454 role_name = atk_role_get_name (role);
457 reply = dbus_message_new_method_return (message);
460 dbus_message_append_args (reply, DBUS_TYPE_STRING, &role_name,
467 impl_getLocalizedRoleName (DBusConnection *bus,
468 DBusMessage *message,
471 AtkObject *object = (AtkObject *) user_data;
473 const char *role_name;
476 g_return_val_if_fail (ATK_IS_OBJECT (user_data),
477 droute_not_yet_handled_error (message));
478 role = atk_object_get_role (object);
479 role_name = atk_role_get_localized_name (role);
482 reply = dbus_message_new_method_return (message);
485 dbus_message_append_args (reply, DBUS_TYPE_STRING, &role_name,
492 impl_getState (DBusConnection *bus,
493 DBusMessage *message,
496 AtkObject *object = (AtkObject *) user_data;
498 dbus_uint32_t *array = rv;
501 g_return_val_if_fail (ATK_IS_OBJECT (user_data),
502 droute_not_yet_handled_error (message));
503 spi_atk_state_to_dbus_array (object, rv);
504 reply = dbus_message_new_method_return (message);
507 dbus_message_append_args (reply, DBUS_TYPE_ARRAY, DBUS_TYPE_UINT32, &array,
508 2, DBUS_TYPE_INVALID);
514 impl_getAttributes (DBusConnection *bus,
515 DBusMessage *message,
518 AtkObject *object = (AtkObject *) user_data;
520 AtkAttributeSet *attributes;
521 AtkAttribute *attr = NULL;
523 gint n_attributes = 0;
526 g_return_val_if_fail (ATK_IS_OBJECT (user_data),
527 droute_not_yet_handled_error (message));
529 attributes = atk_object_get_attributes (object);
531 n_attributes = g_slist_length (attributes);
533 retval = (char **) g_malloc (n_attributes * sizeof (char *));
535 for (i = 0; i < n_attributes; ++i)
537 attr = g_slist_nth_data (attributes, i);
538 retval[i] = g_strconcat (attr->name, ":", attr->value, NULL);
541 atk_attribute_set_free (attributes);
542 reply = dbus_message_new_method_return (message);
545 dbus_message_append_args (reply, DBUS_TYPE_ARRAY, DBUS_TYPE_STRING,
546 &retval, n_attributes, DBUS_TYPE_INVALID);
548 for (i = 0; i < n_attributes; i++)
555 impl_getApplication (DBusConnection *bus,
556 DBusMessage *message,
559 AtkObject *root = atk_get_root ();
560 return spi_dbus_return_object (message, root, FALSE);
563 static DRouteMethod methods[] = {
564 {impl_getChildAtIndex, "getChildAtIndex"},
565 {impl_getChildren, "getChildren"},
566 {impl_getIndexInParent, "getIndexInParent"},
567 {impl_getRelationSet, "getRelationSet"},
568 {impl_getRole, "getRole"},
569 {impl_getRoleName, "getRoleName"},
570 {impl_getLocalizedRoleName, "getLocalizedRoleName"},
571 {impl_getState, "getState"},
572 {impl_getAttributes, "getAttributes"},
573 {impl_getApplication, "getApplication"},
577 static DRouteProperty properties[] = {
578 {impl_get_name, impl_set_name, "name"},
579 {impl_get_description, impl_set_description, "description"},
580 {impl_get_parent, NULL, "parent"},
581 {impl_get_childCount, NULL, "childCount"},
586 spi_initialize_accessible (DRoutePath *path)
588 droute_path_add_interface (path,
589 SPI_DBUS_INTERFACE_ACCESSIBLE,