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 "atspi/atspi.h"
30 #include "accessible-stateset.h"
32 #include "introspection.h"
35 impl_get_Name (DBusMessageIter * iter, void *user_data)
37 AtkObject *object = (AtkObject *) user_data;
39 g_return_val_if_fail (ATK_IS_OBJECT (user_data), FALSE);
41 return droute_return_v_string (iter, atk_object_get_name (object));
45 impl_get_Description (DBusMessageIter * iter, void *user_data)
47 AtkObject *object = (AtkObject *) user_data;
49 g_return_val_if_fail (ATK_IS_OBJECT (user_data), FALSE);
51 return droute_return_v_string (iter, atk_object_get_description (object));
55 impl_get_Locale (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_object_locale (object));
65 impl_get_Parent (DBusMessageIter * iter, void *user_data)
67 AtkObject *obj = (AtkObject *) user_data;
69 DBusMessageIter iter_variant;
72 g_return_val_if_fail (ATK_IS_OBJECT (user_data), FALSE);
74 role = spi_accessible_role_from_atk_role (atk_object_get_role (obj));
76 dbus_message_iter_open_container (iter, DBUS_TYPE_VARIANT, "(so)",
79 parent = atk_object_get_parent (obj);
82 /* TODO, move in to a 'Plug' wrapper. */
83 if (ATK_IS_PLUG (obj))
85 char *id = g_object_get_data (G_OBJECT (obj), "dbus-plug-parent");
91 bus_parent = g_strdup (id);
92 if (bus_parent && (path_parent = g_utf8_strchr (bus_parent + 1, -1, ':')))
94 DBusMessageIter iter_parent;
95 *(path_parent++) = '\0';
96 dbus_message_iter_open_container (&iter_variant, DBUS_TYPE_STRUCT, NULL,
98 dbus_message_iter_append_basic (&iter_parent, DBUS_TYPE_STRING, &bus_parent);
99 dbus_message_iter_append_basic (&iter_parent, DBUS_TYPE_OBJECT_PATH, &path_parent);
100 dbus_message_iter_close_container (&iter_variant, &iter_parent);
104 spi_object_append_null_reference (&iter_variant);
109 spi_object_append_null_reference (&iter_variant);
112 else if (role != ATSPI_ROLE_APPLICATION)
113 spi_object_append_null_reference (&iter_variant);
115 spi_object_append_desktop_reference (&iter_variant);
119 spi_object_append_reference (&iter_variant, parent);
123 dbus_message_iter_close_container (iter, &iter_variant);
128 impl_get_ChildCount (DBusMessageIter * iter, void *user_data)
130 AtkObject *object = (AtkObject *) user_data;
133 g_return_val_if_fail (ATK_IS_OBJECT (user_data), FALSE);
135 childCount = (ATK_IS_SOCKET (object) && atk_socket_is_occupied (ATK_SOCKET (object)))
137 : atk_object_get_n_accessible_children (object);
138 return droute_return_v_int32 (iter, childCount);
142 impl_GetChildAtIndex (DBusConnection * bus,
143 DBusMessage * message, void *user_data)
145 AtkObject *object = (AtkObject *) user_data;
151 dbus_error_init (&error);
152 g_return_val_if_fail (ATK_IS_OBJECT (user_data),
153 droute_not_yet_handled_error (message));
154 if (!dbus_message_get_args
155 (message, &error, DBUS_TYPE_INT32, &i, DBUS_TYPE_INVALID))
157 return droute_invalid_arguments_error (message);
160 if (ATK_IS_SOCKET (object) && atk_socket_is_occupied (ATK_SOCKET (object)) && i == 0)
162 AtkSocket *socket = ATK_SOCKET (object);
163 gchar *child_name, *child_path;
164 child_name = g_strdup (socket->embedded_plug_id);
165 child_path = g_utf8_strchr (child_name + 1, -1, ':');
168 DBusMessageIter iter, iter_socket;
169 *(child_path++) = '\0';
170 reply = dbus_message_new_method_return (message);
173 dbus_message_iter_init_append (reply, &iter);
174 dbus_message_iter_open_container (&iter, DBUS_TYPE_STRUCT, NULL,
176 dbus_message_iter_append_basic (&iter_socket, DBUS_TYPE_STRING, &child_name);
177 dbus_message_iter_append_basic (&iter_socket, DBUS_TYPE_OBJECT_PATH, &child_path);
178 dbus_message_iter_close_container (&iter, &iter_socket);
183 child = atk_object_ref_accessible_child (object, i);
184 reply = spi_object_return_reference (message, child);
185 g_object_unref (child);
191 impl_GetChildren (DBusConnection * bus,
192 DBusMessage * message, void *user_data)
194 AtkObject *object = (AtkObject *) user_data;
198 DBusMessageIter iter, iter_array;
200 g_return_val_if_fail (ATK_IS_OBJECT (user_data),
201 droute_not_yet_handled_error (message));
202 count = atk_object_get_n_accessible_children (object);
203 reply = dbus_message_new_method_return (message);
206 dbus_message_iter_init_append (reply, &iter);
207 if (!dbus_message_iter_open_container
208 (&iter, DBUS_TYPE_ARRAY, "(so)", &iter_array))
210 for (i = 0; i < count; i++)
212 AtkObject *child = atk_object_ref_accessible_child (object, i);
213 spi_object_append_reference (&iter_array, child);
215 g_object_unref (child);
217 if (!dbus_message_iter_close_container (&iter, &iter_array))
221 // TODO: handle out-of-memory
226 impl_GetIndexInParent (DBusConnection * bus,
227 DBusMessage * message, void *user_data)
229 AtkObject *object = (AtkObject *) user_data;
233 g_return_val_if_fail (ATK_IS_OBJECT (user_data),
234 droute_not_yet_handled_error (message));
236 rv = atk_object_get_index_in_parent (object);
237 reply = dbus_message_new_method_return (message);
238 dbus_message_append_args (reply, DBUS_TYPE_INT32, &rv, DBUS_TYPE_INVALID);
243 spi_init_relation_type_table (AtspiRelationType * types)
247 for (i = 0; i < ATK_RELATION_LAST_DEFINED; i++)
248 types[i] = ATSPI_RELATION_NULL;
250 types[ATK_RELATION_CONTROLLED_BY] = ATSPI_RELATION_CONTROLLED_BY;
251 types[ATK_RELATION_CONTROLLER_FOR] = ATSPI_RELATION_CONTROLLER_FOR;
252 types[ATK_RELATION_LABEL_FOR] = ATSPI_RELATION_LABEL_FOR;
253 types[ATK_RELATION_LABELLED_BY] = ATSPI_RELATION_LABELLED_BY;
254 types[ATK_RELATION_MEMBER_OF] = ATSPI_RELATION_MEMBER_OF;
255 types[ATK_RELATION_NODE_CHILD_OF] = ATSPI_RELATION_NODE_CHILD_OF;
256 types[ATK_RELATION_FLOWS_TO] = ATSPI_RELATION_FLOWS_TO;
257 types[ATK_RELATION_FLOWS_FROM] = ATSPI_RELATION_FLOWS_FROM;
258 types[ATK_RELATION_SUBWINDOW_OF] = ATSPI_RELATION_SUBWINDOW_OF;
259 types[ATK_RELATION_EMBEDS] = ATSPI_RELATION_EMBEDS;
260 types[ATK_RELATION_EMBEDDED_BY] = ATSPI_RELATION_EMBEDDED_BY;
261 types[ATK_RELATION_POPUP_FOR] = ATSPI_RELATION_POPUP_FOR;
262 types[ATK_RELATION_PARENT_WINDOW_OF] =
263 ATSPI_RELATION_PARENT_WINDOW_OF;
264 types[ATK_RELATION_DESCRIPTION_FOR] =
265 ATSPI_RELATION_DESCRIPTION_FOR;
266 types[ATK_RELATION_DESCRIBED_BY] = ATSPI_RELATION_DESCRIBED_BY;
267 types[ATK_RELATION_NODE_PARENT_OF] = ATSPI_RELATION_NODE_PARENT_OF;
272 static AtspiRelationType
273 spi_relation_type_from_atk_relation_type (AtkRelationType type)
275 static gboolean is_initialized = FALSE;
276 static AtspiRelationType
277 spi_relation_type_table[ATK_RELATION_LAST_DEFINED];
278 AtspiRelationType spi_type;
281 is_initialized = spi_init_relation_type_table (spi_relation_type_table);
283 if (type > ATK_RELATION_NULL && type < ATK_RELATION_LAST_DEFINED)
284 spi_type = spi_relation_type_table[type];
286 spi_type = ATSPI_RELATION_EXTENDED;
291 impl_GetRelationSet (DBusConnection * bus,
292 DBusMessage * message, void *user_data)
294 AtkObject *object = (AtkObject *) user_data;
297 DBusMessageIter iter, iter_array, iter_struct, iter_targets;
301 g_return_val_if_fail (ATK_IS_OBJECT (user_data),
302 droute_not_yet_handled_error (message));
303 reply = dbus_message_new_method_return (message);
306 set = atk_object_ref_relation_set (object);
307 dbus_message_iter_init_append (reply, &iter);
308 if (!dbus_message_iter_open_container
309 (&iter, DBUS_TYPE_ARRAY, "(ua(so))", &iter_array))
315 count = atk_relation_set_get_n_relations (set);
316 for (i = 0; i < count; i++)
318 AtkRelation *r = atk_relation_set_get_relation (set, i);
324 rt = atk_relation_get_relation_type (r);
325 type = spi_relation_type_from_atk_relation_type (rt);
326 target = atk_relation_get_target (r);
327 if (!dbus_message_iter_open_container
328 (&iter_array, DBUS_TYPE_STRUCT, NULL, &iter_struct))
332 dbus_message_iter_append_basic (&iter_struct, DBUS_TYPE_UINT32, &type);
333 if (!dbus_message_iter_open_container
334 (&iter_struct, DBUS_TYPE_ARRAY, "(so)", &iter_targets))
338 for (j = 0; j < target->len; j++)
340 AtkObject *obj = target->pdata[j];
343 spi_object_append_reference (&iter_targets, obj);
345 dbus_message_iter_close_container (&iter_struct, &iter_targets);
346 dbus_message_iter_close_container (&iter_array, &iter_struct);
348 dbus_message_iter_close_container (&iter, &iter_array);
351 g_object_unref (set);
352 // TODO: handle out of memory */
357 impl_GetRole (DBusConnection * bus, DBusMessage * message, void *user_data)
359 AtkObject *object = (AtkObject *) user_data;
364 g_return_val_if_fail (ATK_IS_OBJECT (user_data),
365 droute_not_yet_handled_error (message));
366 role = atk_object_get_role (object);
367 rv = spi_accessible_role_from_atk_role (role);
368 reply = dbus_message_new_method_return (message);
371 dbus_message_append_args (reply, DBUS_TYPE_UINT32, &rv,
378 impl_GetRoleName (DBusConnection * bus,
379 DBusMessage * message, void *user_data)
381 AtkObject *object = (AtkObject *) user_data;
383 const char *role_name;
386 g_return_val_if_fail (ATK_IS_OBJECT (user_data),
387 droute_not_yet_handled_error (message));
388 role = atk_object_get_role (object);
389 role_name = atk_role_get_name (role);
392 reply = dbus_message_new_method_return (message);
395 dbus_message_append_args (reply, DBUS_TYPE_STRING, &role_name,
402 impl_GetLocalizedRoleName (DBusConnection * bus,
403 DBusMessage * message, void *user_data)
405 AtkObject *object = (AtkObject *) user_data;
407 const char *role_name;
410 g_return_val_if_fail (ATK_IS_OBJECT (user_data),
411 droute_not_yet_handled_error (message));
412 role = atk_object_get_role (object);
413 role_name = atk_role_get_localized_name (role);
416 reply = dbus_message_new_method_return (message);
419 dbus_message_append_args (reply, DBUS_TYPE_STRING, &role_name,
426 impl_GetState (DBusConnection * bus, DBusMessage * message, void *user_data)
428 AtkObject *object = (AtkObject *) user_data;
430 DBusMessage *reply = NULL;
431 DBusMessageIter iter, iter_array;
433 dbus_uint32_t states[2];
437 g_return_val_if_fail (ATK_IS_OBJECT (user_data),
438 droute_not_yet_handled_error (message));
440 reply = dbus_message_new_method_return (message);
441 dbus_message_iter_init_append (reply, &iter);
443 spi_atk_state_to_dbus_array (object, states);
444 dbus_message_iter_open_container (&iter, DBUS_TYPE_ARRAY, "u", &iter_array);
445 for (count = 0; count < 2; count++)
447 dbus_message_iter_append_basic (&iter_array, DBUS_TYPE_UINT32,
450 dbus_message_iter_close_container (&iter, &iter_array);
455 impl_GetAttributes (DBusConnection * bus,
456 DBusMessage * message, void *user_data)
458 AtkObject *object = (AtkObject *) user_data;
459 AtkAttributeSet *attributes;
460 DBusMessage *reply = NULL;
461 DBusMessageIter iter;
463 g_return_val_if_fail (ATK_IS_OBJECT (user_data),
464 droute_not_yet_handled_error (message));
466 attributes = atk_object_get_attributes (object);
468 reply = dbus_message_new_method_return (message);
469 dbus_message_iter_init_append (reply, &iter);
470 spi_object_append_attribute_set (&iter, attributes);
472 atk_attribute_set_free (attributes);
478 impl_GetApplication (DBusConnection * bus,
479 DBusMessage * message, void *user_data)
481 return spi_object_return_reference (message, atk_get_root ());
485 impl_GetInterfaces (DBusConnection * bus,
486 DBusMessage * message, void *user_data)
488 AtkObject *object = (AtkObject *) user_data;
490 DBusMessageIter iter, iter_array;
492 g_return_val_if_fail (ATK_IS_OBJECT (user_data),
493 droute_not_yet_handled_error (message));
494 reply = dbus_message_new_method_return (message);
497 dbus_message_iter_init_append (reply, &iter);
498 dbus_message_iter_open_container (&iter, DBUS_TYPE_ARRAY, "s",
500 spi_object_append_interfaces (&iter_array, object);
501 dbus_message_iter_close_container (&iter, &iter_array);
506 static DRouteMethod methods[] = {
507 {impl_GetChildAtIndex, "GetChildAtIndex"},
508 {impl_GetChildren, "GetChildren"},
509 {impl_GetIndexInParent, "GetIndexInParent"},
510 {impl_GetRelationSet, "GetRelationSet"},
511 {impl_GetRole, "GetRole"},
512 {impl_GetRoleName, "GetRoleName"},
513 {impl_GetLocalizedRoleName, "GetLocalizedRoleName"},
514 {impl_GetState, "GetState"},
515 {impl_GetAttributes, "GetAttributes"},
516 {impl_GetApplication, "GetApplication"},
517 {impl_GetInterfaces, "GetInterfaces"},
521 static DRouteProperty properties[] = {
522 {impl_get_Name, NULL, "Name"},
523 {impl_get_Description, NULL, "Description"},
524 {impl_get_Locale, NULL, "Locale"},
525 {impl_get_Parent, NULL, "Parent"},
526 {impl_get_ChildCount, NULL, "ChildCount"},
531 spi_initialize_accessible (DRoutePath * path)
533 droute_path_add_interface (path,
534 ATSPI_DBUS_INTERFACE_ACCESSIBLE,
535 spi_org_a11y_atspi_Accessible,
536 methods, properties);