2 * AT-SPI - Assistive Technology Service Provider Interface
3 * (Gnome Accessibility Project; http://developer.gnome.org/projects/gap)
5 * Copyright 2008, 2010 Codethink Ltd.
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.
31 #include "introspection.h"
33 typedef struct event_data event_data;
42 children_added_listener (DBusConnection * bus,
48 children_removed_listener (DBusConnection * bus,
53 /*---------------------------------------------------------------------------*/
55 typedef struct _SpiReference
62 spi_reference_new (const gchar *name, const gchar *path)
66 ref = g_new0 (SpiReference, 1);
67 ref->name = g_strdup (name);
68 ref->path = g_strdup (path);
74 spi_reference_free (SpiReference *ref)
81 /*---------------------------------------------------------------------------*/
83 G_DEFINE_TYPE(SpiRegistry, spi_registry, G_TYPE_OBJECT)
86 spi_registry_class_init (SpiRegistryClass *klass)
88 spi_registry_parent_class = g_type_class_ref (G_TYPE_OBJECT);
92 spi_registry_init (SpiRegistry *registry)
94 registry->apps = g_ptr_array_new_with_free_func ((GDestroyNotify) spi_reference_free);
97 /*---------------------------------------------------------------------------*/
100 return_v_string (DBusMessageIter * iter, const gchar * str)
102 DBusMessageIter variant;
104 if (!dbus_message_iter_open_container (iter, DBUS_TYPE_VARIANT, "s",
108 dbus_message_iter_append_basic (&variant, DBUS_TYPE_STRING, &str);
109 dbus_message_iter_close_container (iter, &variant);
114 append_reference (DBusMessageIter * iter, const char * name, const char * path)
116 DBusMessageIter iter_struct;
118 if (!dbus_message_iter_open_container (iter, DBUS_TYPE_STRUCT, NULL,
121 dbus_message_iter_append_basic (&iter_struct, DBUS_TYPE_STRING, &name);
122 dbus_message_iter_append_basic (&iter_struct, DBUS_TYPE_OBJECT_PATH, &path);
123 dbus_message_iter_close_container (iter, &iter_struct);
127 /*---------------------------------------------------------------------------*/
130 compare_reference (SpiReference *one, SpiReference *two)
132 if (g_strcmp0 (one->name, two->name) == 0 &&
133 g_strcmp0 (one->path, two->path) == 0)
140 find_index_of_reference (GPtrArray *arr, const gchar *name, const gchar * path, guint *index)
143 gboolean found = FALSE;
146 ref = spi_reference_new (name, path);
148 for (i = 0; i < arr->len; i++)
150 if (compare_reference (ref, g_ptr_array_index (arr, i)))
157 spi_reference_free (ref);
164 add_application (SpiRegistry *reg, DBusConnection *bus, const gchar *name, const gchar *path)
166 g_ptr_array_add (reg->apps, spi_reference_new (name, path));
167 children_added_listener (bus, reg->apps->len - 1, name, path);
171 set_id (SpiRegistry *reg, DBusConnection *bus, const gchar *name, const gchar *path)
173 DBusMessage *message;
174 DBusMessageIter iter, iter_variant;
175 const char *iface_application = "org.a11y.atspi.Application";
176 const char *id = "Id";
178 message = dbus_message_new_method_call (name, path,
179 DBUS_INTERFACE_PROPERTIES, "Set");
182 dbus_message_iter_init_append (message, &iter);
183 dbus_message_iter_append_basic (&iter, DBUS_TYPE_STRING, &iface_application);
184 dbus_message_iter_append_basic (&iter, DBUS_TYPE_STRING, &id);
185 dbus_message_iter_open_container (&iter, DBUS_TYPE_VARIANT, "i", &iter_variant);
186 dbus_message_iter_append_basic (&iter_variant, DBUS_TYPE_INT32, ®->id);
187 /* TODO: This will cause problems if we cycle through 2^31 ids */
189 dbus_message_iter_close_container (&iter, &iter_variant);
190 dbus_connection_send (bus, message, NULL);
191 dbus_message_unref (message);
195 remove_application (SpiRegistry *reg, DBusConnection *bus, guint index)
197 SpiReference *ref = g_ptr_array_index (reg->apps, index);
199 spi_remove_device_listeners (reg->dec, ref->name);
200 children_removed_listener (bus, index, ref->name, ref->path);
201 g_ptr_array_remove_index (reg->apps, index);
205 event_is_subtype (gchar **needle, gchar **haystack)
207 while (*haystack && **haystack)
209 if (g_strcmp0 (*needle, *haystack))
218 needs_mouse_poll (char **event)
220 if (g_strcmp0 (event [0], "Mouse") != 0)
222 if (!event [1] || !event [1][0])
224 return (g_strcmp0 (event [1], "Abs") == 0);
228 remove_events (SpiRegistry *registry, const char *bus_name, const char *event)
232 gboolean mouse_found = FALSE;
235 remove_data = g_strsplit (event, ":", 3);
241 for (list = registry->events; list;)
243 event_data *evdata = list->data;
245 if (!g_strcmp0 (evdata->bus_name, bus_name) &&
246 event_is_subtype (evdata->data, remove_data))
248 g_strfreev (evdata->data);
249 g_free (evdata->bus_name);
250 g_slist_free_full (evdata->properties, g_free);
252 registry->events = g_list_remove (registry->events, evdata);
256 if (needs_mouse_poll (evdata->data))
262 spi_device_event_controller_stop_poll_mouse ();
264 g_strfreev (remove_data);
266 signal = dbus_message_new_signal (SPI_DBUS_PATH_REGISTRY,
267 SPI_DBUS_INTERFACE_REGISTRY,
268 "EventListenerDeregistered");
269 dbus_message_append_args (signal, DBUS_TYPE_STRING, &bus_name,
270 DBUS_TYPE_STRING, &event, DBUS_TYPE_INVALID);
271 dbus_connection_send (registry->bus, signal, NULL);
272 dbus_message_unref (signal);
276 handle_disconnection (DBusConnection *bus, DBusMessage *message, void *user_data)
278 char *name, *old, *new;
279 SpiRegistry *reg = SPI_REGISTRY (user_data);
281 if (dbus_message_get_args (message, NULL,
282 DBUS_TYPE_STRING, &name,
283 DBUS_TYPE_STRING, &old,
284 DBUS_TYPE_STRING, &new,
287 if (*old != '\0' && *new == '\0')
289 /* Remove all children with the application name the same as the disconnected application. */
291 for (i = 0; i < reg->apps->len; i++)
293 SpiReference *ref = g_ptr_array_index (reg->apps, i);
294 if (!g_strcmp0 (old, ref->name))
296 remove_application (reg, bus, i);
301 remove_events (reg, old, "");
307 * Converts names of the form "active-descendant-changed" to
308 *" ActiveDescendantChanged"
311 ensure_proper_format (const char *name)
313 gchar *ret = (gchar *) g_malloc (strlen (name) * 2 + 2);
315 gboolean need_upper = TRUE;
323 *p++ = toupper (*name);
326 else if (*name == '-')
328 else if (*name == ':')
341 static DBusHandlerResult
342 signal_filter (DBusConnection *bus, DBusMessage *message, void *user_data)
344 guint res = DBUS_HANDLER_RESULT_HANDLED;
345 const gint type = dbus_message_get_type (message);
346 const char *iface = dbus_message_get_interface (message);
347 const char *member = dbus_message_get_member (message);
349 if (type != DBUS_MESSAGE_TYPE_SIGNAL)
350 return DBUS_HANDLER_RESULT_NOT_YET_HANDLED;
352 if (!g_strcmp0(iface, DBUS_INTERFACE_DBUS) &&
353 !g_strcmp0(member, "NameOwnerChanged"))
354 handle_disconnection (bus, message, user_data);
356 res = DBUS_HANDLER_RESULT_NOT_YET_HANDLED;
361 /* org.at_spi.Socket interface */
362 /*---------------------------------------------------------------------------*/
365 impl_Embed (DBusConnection *bus, DBusMessage *message, void *user_data)
367 SpiRegistry *reg = SPI_REGISTRY (user_data);
368 DBusMessageIter iter, iter_struct;
369 const gchar *app_name, *obj_path;
371 DBusMessage *reply = NULL;
372 DBusMessageIter reply_iter;
374 dbus_message_iter_init (message, &iter);
375 dbus_message_iter_recurse (&iter, &iter_struct);
376 if (!(dbus_message_iter_get_arg_type (&iter_struct) == DBUS_TYPE_STRING))
378 dbus_message_iter_get_basic (&iter_struct, &app_name);
380 app_name = dbus_message_get_sender (message);
381 if (!dbus_message_iter_next (&iter_struct))
383 if (!(dbus_message_iter_get_arg_type (&iter_struct) == DBUS_TYPE_OBJECT_PATH))
385 dbus_message_iter_get_basic (&iter_struct, &obj_path);
387 add_application(reg, bus, app_name, obj_path);
389 set_id (reg, bus, app_name, obj_path);
391 reply = dbus_message_new_method_return (message);
392 dbus_message_iter_init_append (reply, &reply_iter);
393 append_reference (&reply_iter,
394 dbus_bus_get_unique_name (bus),
399 return dbus_message_new_error (message, DBUS_ERROR_FAILED, "Invalid arguments");
403 impl_Unembed (DBusConnection *bus, DBusMessage *message, void *user_data)
405 SpiRegistry *reg = SPI_REGISTRY (user_data);
406 DBusMessageIter iter, iter_struct;
407 gchar *app_name, *obj_path;
410 dbus_message_iter_init (message, &iter);
411 dbus_message_iter_recurse (&iter, &iter_struct);
412 if (!(dbus_message_iter_get_arg_type (&iter_struct) == DBUS_TYPE_STRING))
414 dbus_message_iter_get_basic (&iter_struct, &app_name);
415 if (!dbus_message_iter_next (&iter_struct))
417 if (!(dbus_message_iter_get_arg_type (&iter_struct) == DBUS_TYPE_OBJECT_PATH))
419 dbus_message_iter_get_basic (&iter_struct, &obj_path);
421 if (find_index_of_reference (reg->apps, app_name, obj_path, &index))
422 remove_application(reg, bus, index);
426 return dbus_message_new_error (message, DBUS_ERROR_FAILED, "Invalid arguments");
429 /* org.at_spi.Component interface */
430 /*---------------------------------------------------------------------------*/
433 impl_Contains (DBusConnection * bus, DBusMessage * message, void *user_data)
435 dbus_bool_t retval = FALSE;
438 reply = dbus_message_new_method_return (message);
439 dbus_message_append_args (reply, DBUS_TYPE_BOOLEAN, &retval,
445 impl_GetAccessibleAtPoint (DBusConnection * bus, DBusMessage * message,
448 DBusMessage *reply = NULL;
449 DBusMessageIter iter;
451 reply = dbus_message_new_method_return (message);
452 dbus_message_iter_init_append (reply, &iter);
453 append_reference (&iter,
454 dbus_bus_get_unique_name (bus),
461 impl_GetExtents (DBusConnection * bus, DBusMessage * message, void *user_data)
463 dbus_int32_t x = 0, y = 0, width = 1024, height = 768;
465 DBusMessageIter iter, iter_struct;
467 reply = dbus_message_new_method_return (message);
468 dbus_message_iter_init_append (reply, &iter);
469 dbus_message_iter_open_container (&iter, DBUS_TYPE_STRUCT, NULL,
471 dbus_message_iter_append_basic (&iter_struct, DBUS_TYPE_INT32, &x);
472 dbus_message_iter_append_basic (&iter_struct, DBUS_TYPE_INT32, &y);
473 dbus_message_iter_append_basic (&iter_struct, DBUS_TYPE_INT32, &width);
474 dbus_message_iter_append_basic (&iter_struct, DBUS_TYPE_INT32, &height);
475 dbus_message_iter_close_container (&iter, &iter_struct);
480 impl_GetPosition (DBusConnection * bus, DBusMessage * message,
484 dbus_int32_t x = 0, y = 0;
486 reply = dbus_message_new_method_return (message);
487 dbus_message_append_args (reply, DBUS_TYPE_INT32, &x, DBUS_TYPE_INT32,
488 &y, DBUS_TYPE_INVALID);
493 impl_GetSize (DBusConnection * bus, DBusMessage * message, void *user_data)
495 /* TODO - Get the screen size */
497 dbus_int32_t width = 1024, height = 768;
499 reply = dbus_message_new_method_return (message);
500 dbus_message_append_args (reply, DBUS_TYPE_INT32, &width,
501 DBUS_TYPE_INT32, &height, DBUS_TYPE_INVALID);
505 #define LAYER_WIDGET 3;
508 impl_GetLayer (DBusConnection * bus, DBusMessage * message, void *user_data)
511 dbus_uint32_t rv = LAYER_WIDGET;
513 reply = dbus_message_new_method_return (message);
514 dbus_message_append_args (reply, DBUS_TYPE_UINT32, &rv,
520 impl_GetMDIZOrder (DBusConnection * bus, DBusMessage * message,
526 reply = dbus_message_new_method_return (message);
527 dbus_message_append_args (reply, DBUS_TYPE_INT16, &rv,
533 impl_GrabFocus (DBusConnection * bus, DBusMessage * message, void *user_data)
536 dbus_bool_t retval = FALSE;
538 reply = dbus_message_new_method_return (message);
539 dbus_message_append_args (reply, DBUS_TYPE_BOOLEAN, &retval,
545 impl_ClearHighlight (DBusConnection * bus, DBusMessage * message, void *user_data)
548 dbus_bool_t retval = FALSE;
550 reply = dbus_message_new_method_return (message);
551 dbus_message_append_args (reply, DBUS_TYPE_BOOLEAN, &retval,
557 impl_GrabHighlight (DBusConnection * bus, DBusMessage * message, void *user_data)
560 dbus_bool_t retval = FALSE;
562 reply = dbus_message_new_method_return (message);
563 dbus_message_append_args (reply, DBUS_TYPE_BOOLEAN, &retval,
569 impl_GetAlpha (DBusConnection * bus, DBusMessage * message, void *user_data)
574 reply = dbus_message_new_method_return (message);
575 dbus_message_append_args (reply, DBUS_TYPE_DOUBLE, &rv,
580 /* org.at_spi.Accessible interface */
581 /*---------------------------------------------------------------------------*/
584 impl_get_Name (DBusMessageIter * iter, void *user_data)
586 const gchar *name = "main";
587 return return_v_string (iter, name);
591 impl_get_Description (DBusMessageIter * iter, void *user_data)
593 const gchar *description = "";
594 return return_v_string (iter, description);
598 impl_get_Parent (DBusMessageIter * iter, void *user_data)
600 const gchar *name = "";
601 DBusMessageIter iter_variant;
603 dbus_message_iter_open_container (iter, DBUS_TYPE_VARIANT, "(so)",
605 append_reference (&iter_variant,
608 dbus_message_iter_close_container (iter, &iter_variant);
613 impl_get_ChildCount (DBusMessageIter * iter, void *user_data)
615 SpiRegistry *reg = SPI_REGISTRY (user_data);
616 dbus_int32_t rv = reg->apps->len;
618 DBusMessageIter iter_variant;
620 if (!dbus_message_iter_open_container (iter, DBUS_TYPE_VARIANT, "i",
623 result = dbus_message_iter_append_basic (&iter_variant, DBUS_TYPE_INT32, &rv);
624 dbus_message_iter_close_container (iter, &iter_variant);
629 impl_get_ToolkitName (DBusMessageIter * iter, void *user_data)
631 return return_v_string (iter, "at-spi-registry");
635 impl_get_ToolkitVersion (DBusMessageIter * iter, void *user_data)
637 return return_v_string (iter, "2.0");
641 impl_GetChildAtIndex (DBusConnection * bus,
642 DBusMessage * message, void *user_data)
644 SpiRegistry *reg = SPI_REGISTRY (user_data);
646 DBusMessageIter iter;
651 dbus_error_init (&error);
652 if (!dbus_message_get_args
653 (message, &error, DBUS_TYPE_INT32, &i, DBUS_TYPE_INVALID))
655 return dbus_message_new_error (message, DBUS_ERROR_FAILED, "Invalid arguments");
658 reply = dbus_message_new_method_return (message);
659 dbus_message_iter_init_append (reply, &iter);
661 if (i < 0 || i >= reg->apps->len)
662 append_reference (&iter, SPI_DBUS_NAME_REGISTRY, SPI_DBUS_PATH_NULL);
665 ref = g_ptr_array_index (reg->apps, i);
666 append_reference (&iter, ref->name, ref->path);
673 impl_GetChildren (DBusConnection * bus,
674 DBusMessage * message, void *user_data)
676 DBusMessage *reply = NULL;
677 DBusMessageIter iter, iter_array;
678 SpiRegistry *reg = SPI_REGISTRY (user_data);
681 reply = dbus_message_new_method_return (message);
683 dbus_message_iter_init_append (reply, &iter);
684 dbus_message_iter_open_container(&iter, DBUS_TYPE_ARRAY, "(so)", &iter_array);
685 for (i=0; i < reg->apps->len; i++)
687 SpiReference *current = g_ptr_array_index (reg->apps, i);
688 append_reference (&iter_array, current->name, current->path);
690 dbus_message_iter_close_container(&iter, &iter_array);
695 impl_GetIndexInParent (DBusConnection * bus,
696 DBusMessage * message, void *user_data)
699 dbus_uint32_t rv = 0;
701 reply = dbus_message_new_method_return (message);
702 dbus_message_append_args (reply, DBUS_TYPE_INT32, &rv, DBUS_TYPE_INVALID);
707 impl_GetRelationSet (DBusConnection * bus,
708 DBusMessage * message, void *user_data)
711 DBusMessageIter iter, iter_array;
713 reply = dbus_message_new_method_return (message);
714 dbus_message_iter_init_append (reply, &iter);
715 dbus_message_iter_open_container (&iter, DBUS_TYPE_ARRAY, "(ua(so))", &iter_array);
716 dbus_message_iter_close_container (&iter, &iter_array);
722 impl_GetRole (DBusConnection * bus, DBusMessage * message, void * user_data)
725 dbus_uint32_t rv = 14; /* TODO: Get DESKTOP_FRAME from somewhere */
727 reply = dbus_message_new_method_return (message);
728 dbus_message_append_args (reply, DBUS_TYPE_UINT32, &rv, DBUS_TYPE_INVALID);
733 impl_GetRoleName (DBusConnection * bus,
734 DBusMessage * message, void *user_data)
737 const char *role_name = "desktop frame";
739 reply = dbus_message_new_method_return (message);
740 dbus_message_append_args (reply, DBUS_TYPE_STRING, &role_name,
746 impl_GetLocalizedRoleName (DBusConnection * bus,
747 DBusMessage * message, void *user_data)
749 /* TODO - Localize this */
751 const char *role_name = "desktop frame";
753 reply = dbus_message_new_method_return (message);
754 dbus_message_append_args (reply, DBUS_TYPE_STRING, &role_name,
760 impl_GetState (DBusConnection * bus, DBusMessage * message, void *user_data)
762 DBusMessage *reply = NULL;
763 DBusMessageIter iter, iter_array;
765 dbus_uint32_t states[2] = {0, 0};
768 reply = dbus_message_new_method_return (message);
769 dbus_message_iter_init_append (reply, &iter);
771 dbus_message_iter_open_container (&iter, DBUS_TYPE_ARRAY, "u", &iter_array);
772 for (count = 0; count < 2; count++)
774 dbus_message_iter_append_basic (&iter_array, DBUS_TYPE_UINT32,
777 dbus_message_iter_close_container (&iter, &iter_array);
782 impl_GetAttributes (DBusConnection * bus,
783 DBusMessage * message, void *user_data)
785 DBusMessage *reply = NULL;
786 DBusMessageIter iter, array;
788 reply = dbus_message_new_method_return (message);
789 dbus_message_iter_init_append (reply, &iter);
790 dbus_message_iter_open_container (&iter, DBUS_TYPE_ARRAY, "{ss}", &array);
791 dbus_message_iter_close_container (&iter, &array);
797 impl_GetApplication (DBusConnection * bus,
798 DBusMessage * message, void *user_data)
800 DBusMessage *reply = NULL;
801 DBusMessageIter iter;
803 reply = dbus_message_new_method_return (message);
804 dbus_message_iter_init_append (reply, &iter);
805 append_reference (&iter,
806 dbus_bus_get_unique_name (bus),
813 impl_GetInterfaces (DBusConnection * bus,
814 DBusMessage * message, void *user_data)
817 DBusMessageIter iter, iter_array;
819 const char *acc = SPI_DBUS_INTERFACE_ACCESSIBLE;
820 const char *com = SPI_DBUS_INTERFACE_COMPONENT;
822 reply = dbus_message_new_method_return (message);
824 dbus_message_iter_init_append (reply, &iter);
825 dbus_message_iter_open_container (&iter, DBUS_TYPE_ARRAY, "s",
827 dbus_message_iter_append_basic (&iter_array, DBUS_TYPE_STRING, &acc);
828 dbus_message_iter_append_basic (&iter_array, DBUS_TYPE_STRING, &com);
829 dbus_message_iter_close_container (&iter, &iter_array);
835 impl_GetItems (DBusConnection * bus, DBusMessage * message, void *user_data)
838 DBusMessageIter iter, iter_array;
840 reply = dbus_message_new_method_return (message);
842 dbus_message_iter_init_append (reply, &iter);
843 dbus_message_iter_open_container (&iter, DBUS_TYPE_ARRAY,
844 "((so)(so)(so)a(so)assusau)", &iter_array);
845 dbus_message_iter_close_container (&iter, &iter_array);
849 /* I would rather these two be signals, but I'm not sure that dbus-python
850 * supports emitting signals except for a service, so implementing as both
851 * a method call and signal for now.
854 impl_register_event (DBusConnection *bus, DBusMessage *message, void *user_data)
856 SpiRegistry *registry = SPI_REGISTRY (user_data);
857 const char *orig_name;
862 const char *sender = dbus_message_get_sender (message);
863 DBusMessageIter iter, iter_array;
864 const char *signature = dbus_message_get_signature (message);
866 if (strcmp (signature, "sas") != 0 &&
867 strcmp (signature, "s") != 0)
869 g_warning ("got RegisterEvent with invalid signature '%s'", signature);
873 dbus_message_iter_init (message, &iter);
874 dbus_message_iter_get_basic (&iter, &orig_name);
875 dbus_message_iter_next (&iter);
876 name = ensure_proper_format (orig_name);
878 evdata = g_new0 (event_data, 1);
879 data = g_strsplit (name, ":", 3);
880 evdata->bus_name = g_strdup (sender);
883 if (dbus_message_iter_get_arg_type (&iter) == DBUS_TYPE_ARRAY)
885 dbus_message_iter_recurse (&iter, &iter_array);
886 while (dbus_message_iter_get_arg_type (&iter_array) != DBUS_TYPE_INVALID)
888 const char *property;
889 dbus_message_iter_get_basic (&iter_array, &property);
890 evdata->properties = g_slist_append (evdata->properties,
891 g_strdup (property));
892 dbus_message_iter_next (&iter_array);
895 registry->events = g_list_append (registry->events, evdata);
897 if (needs_mouse_poll (evdata->data))
899 spi_device_event_controller_start_poll_mouse (registry);
902 signal = dbus_message_new_signal (SPI_DBUS_PATH_REGISTRY,
903 SPI_DBUS_INTERFACE_REGISTRY,
904 "EventListenerRegistered");
907 GSList *ls = evdata->properties;
908 dbus_message_iter_init_append (signal, &iter);
909 dbus_message_iter_append_basic (&iter, DBUS_TYPE_STRING, &sender);
910 dbus_message_iter_append_basic (&iter, DBUS_TYPE_STRING, &name);
911 dbus_message_iter_open_container (&iter, DBUS_TYPE_ARRAY, "s", &iter_array);
914 dbus_message_iter_append_basic (&iter_array, DBUS_TYPE_STRING, &ls->data);
915 ls = g_slist_next (ls);
917 dbus_message_iter_close_container (&iter, &iter_array);
918 dbus_connection_send (bus, signal, NULL);
919 dbus_message_unref (signal);
923 return dbus_message_new_method_return (message);
927 impl_deregister_event (DBusConnection *bus, DBusMessage *message, void *user_data)
929 SpiRegistry *registry = SPI_REGISTRY (user_data);
930 const char *orig_name;
932 const char *sender = dbus_message_get_sender (message);
934 if (!dbus_message_get_args (message, NULL, DBUS_TYPE_STRING, &orig_name,
937 name = ensure_proper_format (orig_name);
939 remove_events (registry, sender, name);
942 return dbus_message_new_method_return (message);
946 impl_get_registered_events (DBusConnection *bus, DBusMessage *message, void *user_data)
948 SpiRegistry *registry = SPI_REGISTRY (user_data);
951 DBusMessageIter iter, iter_struct, iter_array;
954 reply = dbus_message_new_method_return (message);
958 dbus_message_iter_init_append (reply, &iter);
959 dbus_message_iter_open_container (&iter, DBUS_TYPE_ARRAY, "(ss)", &iter_array);
960 for (list = registry->events; list; list = list->next)
964 str = g_strconcat (evdata->data [0],
965 ":", (evdata->data [1]? evdata->data [1]: ""),
966 ":", (evdata->data [1] && evdata->data [2]? evdata->data [2]: ""), NULL);
967 dbus_message_iter_open_container (&iter_array, DBUS_TYPE_STRUCT, NULL, &iter_struct);
968 dbus_message_iter_append_basic (&iter_struct, DBUS_TYPE_STRING, &evdata->bus_name);
969 dbus_message_iter_append_basic (&iter_struct, DBUS_TYPE_STRING, &str);
970 dbus_message_iter_close_container (&iter_array, &iter_struct);
973 dbus_message_iter_close_container (&iter, &iter_array);
977 /*---------------------------------------------------------------------------*/
980 emit_Available (DBusConnection * bus)
983 DBusMessageIter iter;
985 sig = dbus_message_new_signal(SPI_DBUS_PATH_ROOT, SPI_DBUS_INTERFACE_SOCKET, "Available");
987 dbus_message_iter_init_append(sig, &iter);
988 append_reference (&iter, SPI_DBUS_NAME_REGISTRY, SPI_DBUS_PATH_ROOT);
990 dbus_connection_send(bus, sig, NULL);
991 dbus_message_unref(sig);
994 /*---------------------------------------------------------------------------*/
996 static const char *introspection_header =
997 "<?xml version=\"1.0\"?>\n";
999 static const char *introspection_node_element =
1000 "<node name=\"%s\">\n";
1002 static const char *introspection_footer =
1005 static DBusMessage *
1006 impl_Introspect_root (DBusConnection * bus,
1007 DBusMessage * message, void *user_data)
1012 const gchar *pathstr = SPI_DBUS_PATH_ROOT;
1016 output = g_string_new(introspection_header);
1018 g_string_append_printf(output, introspection_node_element, pathstr);
1020 g_string_append (output, spi_org_a11y_atspi_Accessible);
1021 g_string_append (output, spi_org_a11y_atspi_Component);
1023 g_string_append(output, introspection_footer);
1024 final = g_string_free(output, FALSE);
1026 reply = dbus_message_new_method_return (message);
1027 dbus_message_append_args(reply, DBUS_TYPE_STRING, &final, DBUS_TYPE_INVALID);
1033 static DBusMessage *
1034 impl_Introspect_registry (DBusConnection * bus,
1035 DBusMessage * message, void *user_data)
1040 const gchar *pathstr = SPI_DBUS_PATH_REGISTRY;
1044 output = g_string_new(introspection_header);
1046 g_string_append_printf(output, introspection_node_element, pathstr);
1048 g_string_append (output, spi_org_a11y_atspi_Registry);
1050 g_string_append(output, introspection_footer);
1051 final = g_string_free(output, FALSE);
1053 reply = dbus_message_new_method_return (message);
1054 dbus_message_append_args(reply, DBUS_TYPE_STRING, &final, DBUS_TYPE_INVALID);
1060 /*---------------------------------------------------------------------------*/
1063 * Emits an AT-SPI event.
1064 * AT-SPI events names are split into three parts:
1066 * This is mapped onto D-Bus events as:
1067 * D-Bus Interface:Signal Name:Detail argument
1069 * Marshals a basic type into the 'any_data' attribute of
1073 emit_event (DBusConnection *bus,
1077 dbus_int32_t detail1,
1078 dbus_int32_t detail2,
1083 DBusMessageIter iter, iter_variant;
1085 sig = dbus_message_new_signal(SPI_DBUS_PATH_ROOT, klass, major);
1087 dbus_message_iter_init_append(sig, &iter);
1089 dbus_message_iter_append_basic(&iter, DBUS_TYPE_STRING, &minor);
1090 dbus_message_iter_append_basic(&iter, DBUS_TYPE_INT32, &detail1);
1091 dbus_message_iter_append_basic(&iter, DBUS_TYPE_INT32, &detail2);
1093 dbus_message_iter_open_container (&iter, DBUS_TYPE_VARIANT, "(so)",
1095 append_reference (&iter_variant, name, path);
1096 dbus_message_iter_close_container (&iter, &iter_variant);
1098 append_reference (&iter,
1099 dbus_bus_get_unique_name (bus),
1100 SPI_DBUS_PATH_ROOT);
1102 dbus_connection_send(bus, sig, NULL);
1103 dbus_message_unref(sig);
1106 /*---------------------------------------------------------------------------*/
1109 * Children changed signal converter and forwarder.
1111 * Klass (Interface) org.a11y.atspi.Event.Object
1112 * Major is the signal name.
1113 * Minor is 'add' or 'remove'
1114 * detail1 is the index.
1116 * any_data is the child reference.
1120 children_added_listener (DBusConnection * bus,
1125 emit_event (bus, SPI_DBUS_INTERFACE_EVENT_OBJECT, "ChildrenChanged", "add", index, 0,
1130 children_removed_listener (DBusConnection * bus,
1135 emit_event (bus, SPI_DBUS_INTERFACE_EVENT_OBJECT, "ChildrenChanged", "remove", index, 0,
1139 /*---------------------------------------------------------------------------*/
1141 static DBusHandlerResult
1142 handle_method_root (DBusConnection *bus, DBusMessage *message, void *user_data)
1144 DBusHandlerResult result = DBUS_HANDLER_RESULT_NOT_YET_HANDLED;
1146 const gchar *iface = dbus_message_get_interface (message);
1147 const gchar *member = dbus_message_get_member (message);
1148 const gint type = dbus_message_get_type (message);
1150 DBusMessage *reply = NULL;
1152 /* Check for basic reasons not to handle */
1153 if (type != DBUS_MESSAGE_TYPE_METHOD_CALL ||
1156 return DBUS_HANDLER_RESULT_NOT_YET_HANDLED;
1158 if (!strcmp (iface, "org.freedesktop.DBus.Properties"))
1160 if (!strcmp (member, "Get"))
1162 const gchar *prop_iface;
1163 const gchar *prop_member;
1166 dbus_error_init (&error);
1167 if (dbus_message_get_args (message,
1175 DBusMessageIter iter;
1177 reply = dbus_message_new_method_return (message);
1178 dbus_message_iter_init_append (reply, &iter);
1181 if (!strcmp (prop_iface, SPI_DBUS_INTERFACE_ACCESSIBLE))
1183 if (!strcmp (prop_member, "Name"))
1184 impl_get_Name (&iter, user_data);
1185 else if (!strcmp (prop_member, "Description"))
1186 impl_get_Description (&iter, user_data);
1187 else if (!strcmp (prop_member, "Parent"))
1188 impl_get_Parent (&iter, user_data);
1189 else if (!strcmp (prop_member, "ChildCount"))
1190 impl_get_ChildCount (&iter, user_data);
1193 dbus_message_unref (reply);
1194 reply = dbus_message_new_error (message, DBUS_ERROR_FAILED, "Property unavailable");
1197 else if (!strcmp (prop_iface, SPI_DBUS_INTERFACE_APPLICATION))
1199 if (!strcmp (prop_member, "ToolkitName"))
1200 impl_get_ToolkitName (&iter, user_data);
1201 else if (!strcmp (prop_member, "ToolkitVersion"))
1202 impl_get_ToolkitVersion (&iter, user_data);
1205 dbus_message_unref (reply);
1206 reply = dbus_message_new_error (message, DBUS_ERROR_FAILED, "Property unavailable");
1211 dbus_message_unref (reply);
1212 reply = dbus_message_new_error (message, DBUS_ERROR_FAILED, "Property unavailable");
1217 reply = dbus_message_new_error (message, DBUS_ERROR_FAILED, error.message);
1219 result = DBUS_HANDLER_RESULT_HANDLED;
1221 else if (!strcmp (member, "GetAll"))
1223 result = DBUS_HANDLER_RESULT_HANDLED;
1227 if (!strcmp (iface, SPI_DBUS_INTERFACE_ACCESSIBLE))
1229 result = DBUS_HANDLER_RESULT_HANDLED;
1230 if (!strcmp (member, "GetChildAtIndex"))
1231 reply = impl_GetChildAtIndex (bus, message, user_data);
1232 else if (!strcmp (member, "GetChildren"))
1233 reply = impl_GetChildren (bus, message, user_data);
1234 else if (!strcmp (member, "GetIndexInParent"))
1235 reply = impl_GetIndexInParent (bus, message, user_data);
1236 else if (!strcmp (member, "GetRelationSet"))
1237 reply = impl_GetRelationSet (bus, message, user_data);
1238 else if (!strcmp (member, "GetRole"))
1239 reply = impl_GetRole (bus, message, user_data);
1240 else if (!strcmp (member, "GetRoleName"))
1241 reply = impl_GetRoleName (bus, message, user_data);
1242 else if (!strcmp (member, "GetLocalizedRoleName"))
1243 reply = impl_GetLocalizedRoleName (bus, message, user_data);
1244 else if (!strcmp (member, "GetState"))
1245 reply = impl_GetState (bus, message, user_data);
1246 else if (!strcmp (member, "GetAttributes"))
1247 reply = impl_GetAttributes (bus, message, user_data);
1248 else if (!strcmp (member, "GetApplication"))
1249 reply = impl_GetApplication (bus, message, user_data);
1250 else if (!strcmp (member, "GetInterfaces"))
1251 reply = impl_GetInterfaces (bus, message, user_data);
1253 result = DBUS_HANDLER_RESULT_NOT_YET_HANDLED;
1256 if (!strcmp (iface, SPI_DBUS_INTERFACE_COMPONENT))
1258 result = DBUS_HANDLER_RESULT_HANDLED;
1259 if (!strcmp (member, "Contains"))
1260 reply = impl_Contains (bus, message, user_data);
1261 else if (!strcmp (member, "GetAccessibleAtPoint"))
1262 reply = impl_GetAccessibleAtPoint (bus, message, user_data);
1263 else if (!strcmp (member, "GetExtents"))
1264 reply = impl_GetExtents (bus, message, user_data);
1265 else if (!strcmp (member, "GetPosition"))
1266 reply = impl_GetPosition (bus, message, user_data);
1267 else if (!strcmp (member, "GetSize"))
1268 reply = impl_GetSize (bus, message, user_data);
1269 else if (!strcmp (member, "GetLayer"))
1270 reply = impl_GetLayer (bus, message, user_data);
1271 else if (!strcmp (member, "GetMDIZOrder"))
1272 reply = impl_GetMDIZOrder (bus, message, user_data);
1273 else if (!strcmp (member, "GrabFocus"))
1274 reply = impl_GrabFocus (bus, message, user_data);
1275 else if (!strcmp (member, "GrabHighlight"))
1276 reply = impl_GrabHighlight (bus, message, user_data);
1277 else if (!strcmp (member, "ClearHighlight"))
1278 reply = impl_ClearHighlight (bus, message, user_data);
1279 else if (!strcmp (member, "GetAlpha"))
1280 reply = impl_GetAlpha (bus, message, user_data);
1282 result = DBUS_HANDLER_RESULT_NOT_YET_HANDLED;
1285 if (!strcmp (iface, SPI_DBUS_INTERFACE_SOCKET))
1287 result = DBUS_HANDLER_RESULT_HANDLED;
1288 if (!strcmp (member, "Embed"))
1289 reply = impl_Embed (bus, message, user_data);
1290 else if (!strcmp (member, "Unembed"))
1291 reply = impl_Unembed (bus, message, user_data);
1293 result = DBUS_HANDLER_RESULT_NOT_YET_HANDLED;
1296 if (!strcmp (iface, "org.freedesktop.DBus.Introspectable"))
1298 result = DBUS_HANDLER_RESULT_HANDLED;
1299 if (!strcmp (member, "Introspect"))
1300 reply = impl_Introspect_root (bus, message, user_data);
1302 result = DBUS_HANDLER_RESULT_NOT_YET_HANDLED;
1305 if (result == DBUS_HANDLER_RESULT_HANDLED)
1309 reply = dbus_message_new_method_return (message);
1312 dbus_connection_send (bus, reply, NULL);
1313 dbus_message_unref (reply);
1318 g_print ("Registry | Unhandled message : %s|%s\n", iface, member);
1325 static DBusHandlerResult
1326 handle_method_cache (DBusConnection *bus, DBusMessage *message, void *user_data)
1328 DBusHandlerResult result = DBUS_HANDLER_RESULT_NOT_YET_HANDLED;
1330 const gchar *iface = dbus_message_get_interface (message);
1331 const gchar *member = dbus_message_get_member (message);
1332 const gint type = dbus_message_get_type (message);
1334 DBusMessage *reply = NULL;
1336 /* Check for basic reasons not to handle */
1337 if (type != DBUS_MESSAGE_TYPE_METHOD_CALL ||
1340 return DBUS_HANDLER_RESULT_NOT_YET_HANDLED;
1342 if (!strcmp (iface, SPI_DBUS_INTERFACE_CACHE))
1344 result = DBUS_HANDLER_RESULT_HANDLED;
1345 if (!strcmp (member, "GetItems"))
1346 reply = impl_GetItems (bus, message, user_data);
1348 result = DBUS_HANDLER_RESULT_NOT_YET_HANDLED;
1351 if (result == DBUS_HANDLER_RESULT_HANDLED)
1355 reply = dbus_message_new_method_return (message);
1358 dbus_connection_send (bus, reply, NULL);
1359 dbus_message_unref (reply);
1364 static DBusHandlerResult
1365 handle_method_registry (DBusConnection *bus, DBusMessage *message, void *user_data)
1367 DBusHandlerResult result = DBUS_HANDLER_RESULT_NOT_YET_HANDLED;
1369 const gchar *iface = dbus_message_get_interface (message);
1370 const gchar *member = dbus_message_get_member (message);
1371 const gint type = dbus_message_get_type (message);
1373 DBusMessage *reply = NULL;
1375 /* Check for basic reasons not to handle */
1376 if (type != DBUS_MESSAGE_TYPE_METHOD_CALL ||
1379 return DBUS_HANDLER_RESULT_NOT_YET_HANDLED;
1381 if (!strcmp (iface, SPI_DBUS_INTERFACE_REGISTRY))
1383 result = DBUS_HANDLER_RESULT_HANDLED;
1384 if (!strcmp(member, "RegisterEvent"))
1385 reply = impl_register_event (bus, message, user_data);
1386 else if (!strcmp(member, "DeregisterEvent"))
1387 reply = impl_deregister_event (bus, message, user_data);
1388 else if (!strcmp(member, "GetRegisteredEvents"))
1389 reply = impl_get_registered_events (bus, message, user_data);
1391 result = DBUS_HANDLER_RESULT_NOT_YET_HANDLED;
1394 if (!strcmp (iface, "org.freedesktop.DBus.Introspectable"))
1396 result = DBUS_HANDLER_RESULT_HANDLED;
1397 if (!strcmp (member, "Introspect"))
1398 reply = impl_Introspect_registry (bus, message, user_data);
1400 result = DBUS_HANDLER_RESULT_NOT_YET_HANDLED;
1403 if (result == DBUS_HANDLER_RESULT_HANDLED)
1407 reply = dbus_message_new_method_return (message);
1410 dbus_connection_send (bus, reply, NULL);
1411 dbus_message_unref (reply);
1416 g_print ("Registry | Unhandled message : %s|%s\n", iface, member);
1423 /*---------------------------------------------------------------------------*/
1425 static DBusObjectPathVTable root_vtable =
1428 &handle_method_root,
1429 NULL, NULL, NULL, NULL
1432 static DBusObjectPathVTable registry_vtable =
1435 &handle_method_registry,
1436 NULL, NULL, NULL, NULL
1439 static DBusObjectPathVTable cache_vtable =
1442 &handle_method_cache,
1443 NULL, NULL, NULL, NULL
1446 static gchar *app_sig_match_name_owner =
1447 "type='signal', interface='org.freedesktop.DBus', member='NameOwnerChanged'";
1450 spi_registry_new (DBusConnection *bus)
1452 SpiRegistry *reg = g_object_new (SPI_REGISTRY_TYPE, NULL);
1456 dbus_bus_add_match (bus, app_sig_match_name_owner, NULL);
1457 dbus_connection_add_filter (bus, signal_filter, reg, NULL);
1459 dbus_connection_register_object_path (bus, SPI_DBUS_PATH_ROOT, &root_vtable, reg);
1461 dbus_connection_register_object_path (bus, SPI_DBUS_PATH_CACHE, &cache_vtable, reg);
1463 dbus_connection_register_object_path (bus, SPI_DBUS_PATH_REGISTRY, ®istry_vtable, reg);
1465 emit_Available (bus);
1472 /*END------------------------------------------------------------------------*/