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 "common/spi-dbus.h"
29 #include "common/spi-stateset.h"
31 #include "introspection.h"
34 impl_get_Name (DBusMessageIter * iter, void *user_data)
36 AtkObject *object = (AtkObject *) user_data;
38 g_return_val_if_fail (ATK_IS_OBJECT (user_data), FALSE);
40 return droute_return_v_string (iter, atk_object_get_name (object));
44 impl_set_Name (DBusMessageIter * iter, void *user_data)
46 AtkObject *object = (AtkObject *) user_data;
47 const char *name = droute_get_v_string (iter);
49 g_return_val_if_fail (ATK_IS_OBJECT (user_data), FALSE);
51 atk_object_set_name (object, name);
56 impl_get_Description (DBusMessageIter * iter, void *user_data)
58 AtkObject *object = (AtkObject *) user_data;
60 g_return_val_if_fail (ATK_IS_OBJECT (user_data), FALSE);
62 return droute_return_v_string (iter, atk_object_get_description (object));
66 impl_set_Description (DBusMessageIter * iter, void *user_data)
68 AtkObject *object = (AtkObject *) user_data;
69 const char *description = droute_get_v_string (iter);
71 g_return_val_if_fail (ATK_IS_OBJECT (user_data), FALSE);
73 atk_object_set_description (object, description);
78 impl_get_Parent (DBusMessageIter * iter, void *user_data)
80 AtkObject *obj = (AtkObject *) user_data;
82 DBusMessageIter iter_variant;
85 g_return_val_if_fail (ATK_IS_OBJECT (user_data), FALSE);
87 role = spi_accessible_role_from_atk_role (atk_object_get_role (obj));
89 dbus_message_iter_open_container (iter, DBUS_TYPE_VARIANT, "(so)",
92 parent = atk_object_get_parent (obj);
95 /* TODO, move in to a 'Plug' wrapper. */
96 if (ATK_IS_PLUG (obj))
98 char *id = g_object_get_data (G_OBJECT (obj), "dbus-plug-parent");
104 bus_parent = g_strdup (id);
105 if (bus_parent && (path_parent = g_utf8_strchr (bus_parent + 1, -1, ':')))
107 DBusMessageIter iter_parent;
108 *(path_parent++) = '\0';
109 dbus_message_iter_open_container (&iter_variant, DBUS_TYPE_STRUCT, NULL,
111 dbus_message_iter_append_basic (&iter_parent, DBUS_TYPE_STRING, &bus_parent);
112 dbus_message_iter_append_basic (&iter_parent, DBUS_TYPE_OBJECT_PATH, &path_parent);
113 dbus_message_iter_close_container (&iter_variant, &iter_parent);
117 spi_object_append_null_reference (&iter_variant);
122 spi_object_append_null_reference (&iter_variant);
125 else if (role != Accessibility_ROLE_APPLICATION)
126 spi_object_append_null_reference (&iter_variant);
128 spi_object_append_desktop_reference (&iter_variant);
132 spi_object_append_reference (&iter_variant, parent);
136 dbus_message_iter_close_container (iter, &iter_variant);
141 impl_get_ChildCount (DBusMessageIter * iter, void *user_data)
143 AtkObject *object = (AtkObject *) user_data;
146 g_return_val_if_fail (ATK_IS_OBJECT (user_data), FALSE);
148 childCount = (ATK_IS_SOCKET (object) && atk_socket_is_occupied (ATK_SOCKET (object)))
150 : atk_object_get_n_accessible_children (object);
151 return droute_return_v_int32 (iter, childCount);
155 impl_GetChildAtIndex (DBusConnection * bus,
156 DBusMessage * message, void *user_data)
158 AtkObject *object = (AtkObject *) user_data;
164 dbus_error_init (&error);
165 g_return_val_if_fail (ATK_IS_OBJECT (user_data),
166 droute_not_yet_handled_error (message));
167 if (!dbus_message_get_args
168 (message, &error, DBUS_TYPE_INT32, &i, DBUS_TYPE_INVALID))
170 return droute_invalid_arguments_error (message);
173 if (ATK_IS_SOCKET (object) && atk_socket_is_occupied (ATK_SOCKET (object)) && i == 0)
175 AtkSocket *socket = ATK_SOCKET (object);
176 gchar *child_name, *child_path;
177 child_name = g_strdup (socket->embedded_plug_id);
178 child_path = g_utf8_strchr (child_name + 1, -1, ':');
181 DBusMessageIter iter, iter_socket;
182 *(child_path++) = '\0';
183 reply = dbus_message_new_method_return (message);
186 dbus_message_iter_init_append (reply, &iter);
187 dbus_message_iter_open_container (&iter, DBUS_TYPE_STRUCT, NULL,
189 dbus_message_iter_append_basic (&iter_socket, DBUS_TYPE_STRING, &child_name);
190 dbus_message_iter_append_basic (&iter_socket, DBUS_TYPE_OBJECT_PATH, &child_path);
191 dbus_message_iter_close_container (&iter, &iter_socket);
196 child = atk_object_ref_accessible_child (object, i);
197 reply = spi_object_return_reference (message, child);
198 g_object_unref (child);
204 impl_GetChildren (DBusConnection * bus,
205 DBusMessage * message, void *user_data)
207 AtkObject *object = (AtkObject *) user_data;
211 DBusMessageIter iter, iter_array;
213 g_return_val_if_fail (ATK_IS_OBJECT (user_data),
214 droute_not_yet_handled_error (message));
215 count = atk_object_get_n_accessible_children (object);
216 reply = dbus_message_new_method_return (message);
219 dbus_message_iter_init_append (reply, &iter);
220 if (!dbus_message_iter_open_container
221 (&iter, DBUS_TYPE_ARRAY, "(so)", &iter_array))
223 for (i = 0; i < count; i++)
225 AtkObject *child = atk_object_ref_accessible_child (object, i);
226 spi_object_append_reference (&iter_array, child);
228 g_object_unref (child);
230 if (!dbus_message_iter_close_container (&iter, &iter_array))
234 // TODO: handle out-of-memory
239 impl_GetIndexInParent (DBusConnection * bus,
240 DBusMessage * message, void *user_data)
242 AtkObject *object = (AtkObject *) user_data;
246 g_return_val_if_fail (ATK_IS_OBJECT (user_data),
247 droute_not_yet_handled_error (message));
249 rv = atk_object_get_index_in_parent (object);
250 reply = dbus_message_new_method_return (message);
251 dbus_message_append_args (reply, DBUS_TYPE_UINT32, &rv, DBUS_TYPE_INVALID);
256 spi_init_relation_type_table (Accessibility_RelationType * types)
260 for (i = 0; i < ATK_RELATION_LAST_DEFINED; i++)
261 types[i] = Accessibility_RELATION_NULL;
263 types[ATK_RELATION_CONTROLLED_BY] = Accessibility_RELATION_CONTROLLED_BY;
264 types[ATK_RELATION_CONTROLLER_FOR] = Accessibility_RELATION_CONTROLLER_FOR;
265 types[ATK_RELATION_LABEL_FOR] = Accessibility_RELATION_LABEL_FOR;
266 types[ATK_RELATION_LABELLED_BY] = Accessibility_RELATION_LABELLED_BY;
267 types[ATK_RELATION_MEMBER_OF] = Accessibility_RELATION_MEMBER_OF;
268 types[ATK_RELATION_NODE_CHILD_OF] = Accessibility_RELATION_NODE_CHILD_OF;
269 types[ATK_RELATION_FLOWS_TO] = Accessibility_RELATION_FLOWS_TO;
270 types[ATK_RELATION_FLOWS_FROM] = Accessibility_RELATION_FLOWS_FROM;
271 types[ATK_RELATION_SUBWINDOW_OF] = Accessibility_RELATION_SUBWINDOW_OF;
272 types[ATK_RELATION_EMBEDS] = Accessibility_RELATION_EMBEDS;
273 types[ATK_RELATION_EMBEDDED_BY] = Accessibility_RELATION_EMBEDDED_BY;
274 types[ATK_RELATION_POPUP_FOR] = Accessibility_RELATION_POPUP_FOR;
275 types[ATK_RELATION_PARENT_WINDOW_OF] =
276 Accessibility_RELATION_PARENT_WINDOW_OF;
277 types[ATK_RELATION_DESCRIPTION_FOR] =
278 Accessibility_RELATION_DESCRIPTION_FOR;
279 types[ATK_RELATION_DESCRIBED_BY] = Accessibility_RELATION_DESCRIBED_BY;
284 static Accessibility_RelationType
285 spi_relation_type_from_atk_relation_type (AtkRelationType type)
287 static gboolean is_initialized = FALSE;
288 static Accessibility_RelationType
289 spi_relation_type_table[ATK_RELATION_LAST_DEFINED];
290 Accessibility_RelationType spi_type;
293 is_initialized = spi_init_relation_type_table (spi_relation_type_table);
295 if (type > ATK_RELATION_NULL && type < ATK_RELATION_LAST_DEFINED)
296 spi_type = spi_relation_type_table[type];
298 spi_type = Accessibility_RELATION_EXTENDED;
303 impl_GetRelationSet (DBusConnection * bus,
304 DBusMessage * message, void *user_data)
306 AtkObject *object = (AtkObject *) user_data;
309 DBusMessageIter iter, iter_array, iter_struct, iter_targets;
313 g_return_val_if_fail (ATK_IS_OBJECT (user_data),
314 droute_not_yet_handled_error (message));
315 reply = dbus_message_new_method_return (message);
318 set = atk_object_ref_relation_set (object);
319 dbus_message_iter_init_append (reply, &iter);
320 if (!dbus_message_iter_open_container
321 (&iter, DBUS_TYPE_ARRAY, "(ua(so))", &iter_array))
327 count = atk_relation_set_get_n_relations (set);
328 for (i = 0; i < count; i++)
330 AtkRelation *r = atk_relation_set_get_relation (set, i);
336 rt = atk_relation_get_relation_type (r);
337 type = spi_relation_type_from_atk_relation_type (rt);
338 target = atk_relation_get_target (r);
339 if (!dbus_message_iter_open_container
340 (&iter_array, DBUS_TYPE_STRUCT, NULL, &iter_struct))
344 dbus_message_iter_append_basic (&iter_struct, DBUS_TYPE_UINT32, &type);
345 if (!dbus_message_iter_open_container
346 (&iter_struct, DBUS_TYPE_ARRAY, "(so)", &iter_targets))
350 for (j = 0; j < target->len; j++)
352 AtkObject *obj = target->pdata[j];
356 spi_object_append_reference (&iter_targets, obj);
358 dbus_message_iter_close_container (&iter_struct, &iter_targets);
359 dbus_message_iter_close_container (&iter_array, &iter_struct);
361 dbus_message_iter_close_container (&iter, &iter_array);
363 // TODO: handle out of memory */
368 impl_GetRole (DBusConnection * bus, DBusMessage * message, void *user_data)
370 AtkObject *object = (AtkObject *) user_data;
375 g_return_val_if_fail (ATK_IS_OBJECT (user_data),
376 droute_not_yet_handled_error (message));
377 role = atk_object_get_role (object);
378 rv = spi_accessible_role_from_atk_role (role);
379 reply = dbus_message_new_method_return (message);
382 dbus_message_append_args (reply, DBUS_TYPE_UINT32, &rv,
389 impl_get_role_str (void *datum)
391 g_return_val_if_fail (ATK_IS_OBJECT (datum), g_strdup (""));
392 return g_strdup_printf ("%d",
393 spi_accessible_role_from_atk_role
394 (atk_object_get_role ((AtkObject *) datum)));
398 impl_GetRoleName (DBusConnection * bus,
399 DBusMessage * message, void *user_data)
401 AtkObject *object = (AtkObject *) user_data;
403 const char *role_name;
406 g_return_val_if_fail (ATK_IS_OBJECT (user_data),
407 droute_not_yet_handled_error (message));
408 role = atk_object_get_role (object);
409 role_name = atk_role_get_name (role);
412 reply = dbus_message_new_method_return (message);
415 dbus_message_append_args (reply, DBUS_TYPE_STRING, &role_name,
422 impl_GetLocalizedRoleName (DBusConnection * bus,
423 DBusMessage * message, void *user_data)
425 AtkObject *object = (AtkObject *) user_data;
427 const char *role_name;
430 g_return_val_if_fail (ATK_IS_OBJECT (user_data),
431 droute_not_yet_handled_error (message));
432 role = atk_object_get_role (object);
433 role_name = atk_role_get_localized_name (role);
436 reply = dbus_message_new_method_return (message);
439 dbus_message_append_args (reply, DBUS_TYPE_STRING, &role_name,
446 impl_GetState (DBusConnection * bus, DBusMessage * message, void *user_data)
448 AtkObject *object = (AtkObject *) user_data;
450 DBusMessage *reply = NULL;
451 DBusMessageIter iter, iter_array;
453 dbus_uint32_t states[2];
457 g_return_val_if_fail (ATK_IS_OBJECT (user_data),
458 droute_not_yet_handled_error (message));
460 reply = dbus_message_new_method_return (message);
461 dbus_message_iter_init_append (reply, &iter);
463 spi_atk_state_to_dbus_array (object, states);
464 dbus_message_iter_open_container (&iter, DBUS_TYPE_ARRAY, "u", &iter_array);
465 for (count = 0; count < 2; count++)
467 dbus_message_iter_append_basic (&iter_array, DBUS_TYPE_UINT32,
470 dbus_message_iter_close_container (&iter, &iter_array);
475 impl_GetAttributes (DBusConnection * bus,
476 DBusMessage * message, void *user_data)
478 AtkObject *object = (AtkObject *) user_data;
479 AtkAttributeSet *attributes;
480 DBusMessage *reply = NULL;
481 DBusMessageIter iter;
483 g_return_val_if_fail (ATK_IS_OBJECT (user_data),
484 droute_not_yet_handled_error (message));
486 attributes = atk_object_get_attributes (object);
488 reply = dbus_message_new_method_return (message);
489 dbus_message_iter_init_append (reply, &iter);
490 spi_object_append_attribute_set (&iter, attributes);
492 atk_attribute_set_free (attributes);
498 impl_GetApplication (DBusConnection * bus,
499 DBusMessage * message, void *user_data)
501 return spi_object_return_reference (message, atk_get_root ());
505 impl_GetInterfaces (DBusConnection * bus,
506 DBusMessage * message, void *user_data)
508 AtkObject *object = (AtkObject *) user_data;
510 const char *role_name;
512 DBusMessageIter iter, iter_array;
514 g_return_val_if_fail (ATK_IS_OBJECT (user_data),
515 droute_not_yet_handled_error (message));
516 reply = dbus_message_new_method_return (message);
519 dbus_message_iter_init_append (reply, &iter);
520 dbus_message_iter_open_container (&iter, DBUS_TYPE_ARRAY, "s",
522 spi_object_append_interfaces (&iter_array, object);
523 dbus_message_iter_close_container (&iter, &iter_array);
528 static DRouteMethod methods[] = {
529 {impl_GetChildAtIndex, "GetChildAtIndex"},
530 {impl_GetChildren, "GetChildren"},
531 {impl_GetIndexInParent, "GetIndexInParent"},
532 {impl_GetRelationSet, "GetRelationSet"},
533 {impl_GetRole, "GetRole"},
534 {impl_GetRoleName, "GetRoleName"},
535 {impl_GetLocalizedRoleName, "GetLocalizedRoleName"},
536 {impl_GetState, "GetState"},
537 {impl_GetAttributes, "GetAttributes"},
538 {impl_GetApplication, "GetApplication"},
539 {impl_GetInterfaces, "GetInterfaces"},
543 static DRouteProperty properties[] = {
544 {impl_get_Name, impl_set_Name, "Name"},
545 {impl_get_Description, impl_set_Description, "Description"},
546 {impl_get_Parent, NULL, "Parent"},
547 {impl_get_ChildCount, NULL, "ChildCount"},
552 spi_initialize_accessible (DRoutePath * path)
554 droute_path_add_interface (path,
555 SPI_DBUS_INTERFACE_ACCESSIBLE,
556 spi_org_a11y_atspi_Accessible,
557 methods, properties);