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",
107 dbus_message_iter_append_basic (&variant, DBUS_TYPE_STRING, &str);
108 dbus_message_iter_close_container (iter, &variant);
113 append_reference (DBusMessageIter * iter, const char * name, const char * path)
115 DBusMessageIter iter_struct;
117 if (!dbus_message_iter_open_container (iter, DBUS_TYPE_STRUCT, NULL,
120 dbus_message_iter_append_basic (&iter_struct, DBUS_TYPE_STRING, &name);
121 dbus_message_iter_append_basic (&iter_struct, DBUS_TYPE_OBJECT_PATH, &path);
122 dbus_message_iter_close_container (iter, &iter_struct);
126 /*---------------------------------------------------------------------------*/
129 compare_reference (SpiReference *one, SpiReference *two)
131 if (g_strcmp0 (one->name, two->name) == 0 &&
132 g_strcmp0 (one->path, two->path) == 0)
139 find_index_of_reference (GPtrArray *arr, const gchar *name, const gchar * path, guint *index)
142 gboolean found = FALSE;
145 ref = spi_reference_new (name, path);
147 for (i = 0; i < arr->len; i++)
149 if (compare_reference (ref, g_ptr_array_index (arr, i)));
156 spi_reference_free (ref);
163 add_application (SpiRegistry *reg, DBusConnection *bus, const gchar *name, const gchar *path)
165 g_ptr_array_add (reg->apps, spi_reference_new (name, path));
166 children_added_listener (bus, reg->apps->len - 1, name, path);
170 set_id (SpiRegistry *reg, DBusConnection *bus, const gchar *name, const gchar *path)
172 DBusMessage *message;
173 DBusMessageIter iter, iter_variant;
174 const char *iface_application = "org.a11y.atspi.Application";
175 const char *id = "Id";
177 message = dbus_message_new_method_call (name, path,
178 DBUS_INTERFACE_PROPERTIES, "Set");
181 dbus_message_iter_init_append (message, &iter);
182 dbus_message_iter_append_basic (&iter, DBUS_TYPE_STRING, &iface_application);
183 dbus_message_iter_append_basic (&iter, DBUS_TYPE_STRING, &id);
184 dbus_message_iter_open_container (&iter, DBUS_TYPE_VARIANT, "i", &iter_variant);
185 dbus_message_iter_append_basic (&iter_variant, DBUS_TYPE_INT32, ®->id);
186 /* TODO: This will cause problems if we cycle through 2^31 ids */
188 dbus_message_iter_close_container (&iter, &iter_variant);
189 dbus_connection_send (bus, message, NULL);
190 dbus_message_unref (message);
194 remove_application (SpiRegistry *reg, DBusConnection *bus, guint index)
196 SpiReference *ref = g_ptr_array_index (reg->apps, index);
198 spi_remove_device_listeners (reg->dec, ref->name);
199 children_removed_listener (bus, index, ref->name, ref->path);
200 g_ptr_array_remove_index (reg->apps, index);
204 event_is_subtype (gchar **needle, gchar **haystack)
206 while (*haystack && **haystack)
208 if (g_strcmp0 (*needle, *haystack))
217 needs_mouse_poll (char **event)
219 if (g_strcmp0 (event [0], "Mouse") != 0)
221 if (!event [1] || !event [1][0])
223 return (g_strcmp0 (event [1], "Abs") == 0);
227 remove_events (SpiRegistry *registry, const char *bus_name, const char *event)
231 gboolean mouse_found = FALSE;
234 remove_data = g_strsplit (event, ":", 3);
240 for (list = registry->events; list;)
242 event_data *evdata = list->data;
244 if (!g_strcmp0 (evdata->bus_name, bus_name) &&
245 event_is_subtype (evdata->data, remove_data))
247 g_strfreev (evdata->data);
248 g_free (evdata->bus_name);
249 g_slist_free_full (evdata->properties, g_free);
251 registry->events = g_list_remove (registry->events, evdata);
255 if (needs_mouse_poll (evdata->data))
261 spi_device_event_controller_stop_poll_mouse ();
263 g_strfreev (remove_data);
265 signal = dbus_message_new_signal (SPI_DBUS_PATH_REGISTRY,
266 SPI_DBUS_INTERFACE_REGISTRY,
267 "EventListenerDeregistered");
268 dbus_message_append_args (signal, DBUS_TYPE_STRING, &bus_name,
269 DBUS_TYPE_STRING, &event, DBUS_TYPE_INVALID);
270 dbus_connection_send (registry->bus, signal, NULL);
271 dbus_message_unref (signal);
275 handle_disconnection (DBusConnection *bus, DBusMessage *message, void *user_data)
277 char *name, *old, *new;
278 SpiRegistry *reg = SPI_REGISTRY (user_data);
280 if (dbus_message_get_args (message, NULL,
281 DBUS_TYPE_STRING, &name,
282 DBUS_TYPE_STRING, &old,
283 DBUS_TYPE_STRING, &new,
286 if (*old != '\0' && *new == '\0')
288 /* Remove all children with the application name the same as the disconnected application. */
290 for (i = 0; i < reg->apps->len; i++)
292 SpiReference *ref = g_ptr_array_index (reg->apps, i);
293 if (!g_strcmp0 (old, ref->name))
295 remove_application (reg, bus, i);
300 remove_events (reg, old, "");
306 * Converts names of the form "active-descendant-changed" to
307 *" ActiveDescendantChanged"
310 ensure_proper_format (const char *name)
312 gchar *ret = (gchar *) g_malloc (strlen (name) * 2 + 2);
314 gboolean need_upper = TRUE;
322 *p++ = toupper (*name);
325 else if (*name == '-')
327 else if (*name == ':')
340 static DBusHandlerResult
341 signal_filter (DBusConnection *bus, DBusMessage *message, void *user_data)
343 guint res = DBUS_HANDLER_RESULT_HANDLED;
344 const gint type = dbus_message_get_type (message);
345 const char *iface = dbus_message_get_interface (message);
346 const char *member = dbus_message_get_member (message);
348 if (type != DBUS_MESSAGE_TYPE_SIGNAL)
349 return DBUS_HANDLER_RESULT_NOT_YET_HANDLED;
351 if (!g_strcmp0(iface, DBUS_INTERFACE_DBUS) &&
352 !g_strcmp0(member, "NameOwnerChanged"))
353 handle_disconnection (bus, message, user_data);
355 res = DBUS_HANDLER_RESULT_NOT_YET_HANDLED;
360 /* org.at_spi.Socket interface */
361 /*---------------------------------------------------------------------------*/
364 impl_Embed (DBusConnection *bus, DBusMessage *message, void *user_data)
366 SpiRegistry *reg = SPI_REGISTRY (user_data);
367 DBusMessageIter iter, iter_struct;
368 const gchar *app_name, *obj_path;
370 DBusMessage *reply = NULL;
371 DBusMessageIter reply_iter;
373 dbus_message_iter_init (message, &iter);
374 dbus_message_iter_recurse (&iter, &iter_struct);
375 if (!(dbus_message_iter_get_arg_type (&iter_struct) == DBUS_TYPE_STRING))
377 dbus_message_iter_get_basic (&iter_struct, &app_name);
379 app_name = dbus_message_get_sender (message);
380 if (!dbus_message_iter_next (&iter_struct))
382 if (!(dbus_message_iter_get_arg_type (&iter_struct) == DBUS_TYPE_OBJECT_PATH))
384 dbus_message_iter_get_basic (&iter_struct, &obj_path);
386 add_application(reg, bus, app_name, obj_path);
388 set_id (reg, bus, app_name, obj_path);
390 reply = dbus_message_new_method_return (message);
391 dbus_message_iter_init_append (reply, &reply_iter);
392 append_reference (&reply_iter,
393 dbus_bus_get_unique_name (bus),
398 return dbus_message_new_error (message, DBUS_ERROR_FAILED, "Invalid arguments");
402 impl_Unembed (DBusConnection *bus, DBusMessage *message, void *user_data)
404 SpiRegistry *reg = SPI_REGISTRY (user_data);
405 DBusMessageIter iter, iter_struct;
406 gchar *app_name, *obj_path;
409 dbus_message_iter_init (message, &iter);
410 dbus_message_iter_recurse (&iter, &iter_struct);
411 if (!(dbus_message_iter_get_arg_type (&iter_struct) == DBUS_TYPE_STRING))
413 dbus_message_iter_get_basic (&iter_struct, &app_name);
414 if (!dbus_message_iter_next (&iter_struct))
416 if (!(dbus_message_iter_get_arg_type (&iter_struct) == DBUS_TYPE_OBJECT_PATH))
418 dbus_message_iter_get_basic (&iter_struct, &obj_path);
420 if (find_index_of_reference (reg->apps, app_name, obj_path, &index))
421 remove_application(reg, bus, index);
425 return dbus_message_new_error (message, DBUS_ERROR_FAILED, "Invalid arguments");
428 /* org.at_spi.Component interface */
429 /*---------------------------------------------------------------------------*/
432 impl_Contains (DBusConnection * bus, DBusMessage * message, void *user_data)
434 dbus_bool_t retval = FALSE;
437 reply = dbus_message_new_method_return (message);
438 dbus_message_append_args (reply, DBUS_TYPE_BOOLEAN, &retval,
444 impl_GetAccessibleAtPoint (DBusConnection * bus, DBusMessage * message,
447 DBusMessage *reply = NULL;
448 DBusMessageIter iter;
450 reply = dbus_message_new_method_return (message);
451 dbus_message_iter_init_append (reply, &iter);
452 append_reference (&iter,
453 dbus_bus_get_unique_name (bus),
460 impl_GetExtents (DBusConnection * bus, DBusMessage * message, void *user_data)
462 dbus_int32_t x = 0, y = 0, width = 1024, height = 768;
464 DBusMessageIter iter, iter_struct;
466 reply = dbus_message_new_method_return (message);
467 dbus_message_iter_init_append (reply, &iter);
468 dbus_message_iter_open_container (&iter, DBUS_TYPE_STRUCT, NULL,
470 dbus_message_iter_append_basic (&iter_struct, DBUS_TYPE_INT32, &x);
471 dbus_message_iter_append_basic (&iter_struct, DBUS_TYPE_INT32, &y);
472 dbus_message_iter_append_basic (&iter_struct, DBUS_TYPE_INT32, &width);
473 dbus_message_iter_append_basic (&iter_struct, DBUS_TYPE_INT32, &height);
474 dbus_message_iter_close_container (&iter, &iter_struct);
479 impl_GetPosition (DBusConnection * bus, DBusMessage * message,
483 dbus_int32_t x = 0, y = 0;
485 reply = dbus_message_new_method_return (message);
486 dbus_message_append_args (reply, DBUS_TYPE_INT32, &x, DBUS_TYPE_INT32,
487 &y, DBUS_TYPE_INVALID);
492 impl_GetSize (DBusConnection * bus, DBusMessage * message, void *user_data)
494 /* TODO - Get the screen size */
496 dbus_int32_t width = 1024, height = 768;
498 reply = dbus_message_new_method_return (message);
499 dbus_message_append_args (reply, DBUS_TYPE_INT32, &width,
500 DBUS_TYPE_INT32, &height, DBUS_TYPE_INVALID);
504 #define LAYER_WIDGET 3;
507 impl_GetLayer (DBusConnection * bus, DBusMessage * message, void *user_data)
510 dbus_uint32_t rv = LAYER_WIDGET;
512 reply = dbus_message_new_method_return (message);
513 dbus_message_append_args (reply, DBUS_TYPE_UINT32, &rv,
519 impl_GetMDIZOrder (DBusConnection * bus, DBusMessage * message,
525 reply = dbus_message_new_method_return (message);
526 dbus_message_append_args (reply, DBUS_TYPE_INT16, &rv,
532 impl_GrabFocus (DBusConnection * bus, DBusMessage * message, void *user_data)
535 dbus_bool_t retval = FALSE;
537 reply = dbus_message_new_method_return (message);
538 dbus_message_append_args (reply, DBUS_TYPE_BOOLEAN, &retval,
544 impl_ClearHighlight (DBusConnection * bus, DBusMessage * message, void *user_data)
547 dbus_bool_t retval = FALSE;
549 reply = dbus_message_new_method_return (message);
550 dbus_message_append_args (reply, DBUS_TYPE_BOOLEAN, &retval,
556 impl_GrabHighlight (DBusConnection * bus, DBusMessage * message, void *user_data)
559 dbus_bool_t retval = FALSE;
561 reply = dbus_message_new_method_return (message);
562 dbus_message_append_args (reply, DBUS_TYPE_BOOLEAN, &retval,
568 impl_GetAlpha (DBusConnection * bus, DBusMessage * message, void *user_data)
573 reply = dbus_message_new_method_return (message);
574 dbus_message_append_args (reply, DBUS_TYPE_DOUBLE, &rv,
579 /* org.at_spi.Accessible interface */
580 /*---------------------------------------------------------------------------*/
583 impl_get_Name (DBusMessageIter * iter, void *user_data)
585 const gchar *name = "main";
586 return return_v_string (iter, name);
590 impl_get_Description (DBusMessageIter * iter, void *user_data)
592 const gchar *description = "";
593 return return_v_string (iter, description);
597 impl_get_Parent (DBusMessageIter * iter, void *user_data)
599 const gchar *name = "";
600 DBusMessageIter iter_variant;
602 dbus_message_iter_open_container (iter, DBUS_TYPE_VARIANT, "(so)",
604 append_reference (&iter_variant,
607 dbus_message_iter_close_container (iter, &iter_variant);
612 impl_get_ChildCount (DBusMessageIter * iter, void *user_data)
614 SpiRegistry *reg = SPI_REGISTRY (user_data);
615 dbus_int32_t rv = reg->apps->len;
617 DBusMessageIter iter_variant;
619 if (!dbus_message_iter_open_container (iter, DBUS_TYPE_VARIANT, "i",
622 result = dbus_message_iter_append_basic (&iter_variant, DBUS_TYPE_INT32, &rv);
623 dbus_message_iter_close_container (iter, &iter_variant);
628 impl_get_ToolkitName (DBusMessageIter * iter, void *user_data)
630 return return_v_string (iter, "at-spi-registry");
634 impl_get_ToolkitVersion (DBusMessageIter * iter, void *user_data)
636 return return_v_string (iter, "2.0");
640 impl_GetChildAtIndex (DBusConnection * bus,
641 DBusMessage * message, void *user_data)
643 SpiRegistry *reg = SPI_REGISTRY (user_data);
645 DBusMessageIter iter;
650 dbus_error_init (&error);
651 if (!dbus_message_get_args
652 (message, &error, DBUS_TYPE_INT32, &i, DBUS_TYPE_INVALID))
654 return dbus_message_new_error (message, DBUS_ERROR_FAILED, "Invalid arguments");
657 reply = dbus_message_new_method_return (message);
658 dbus_message_iter_init_append (reply, &iter);
660 if (i < 0 || i >= reg->apps->len)
661 append_reference (&iter, SPI_DBUS_NAME_REGISTRY, SPI_DBUS_PATH_NULL);
664 ref = g_ptr_array_index (reg->apps, i);
665 append_reference (&iter, ref->name, ref->path);
672 impl_GetChildren (DBusConnection * bus,
673 DBusMessage * message, void *user_data)
675 DBusMessage *reply = NULL;
676 DBusMessageIter iter, iter_array;
677 SpiRegistry *reg = SPI_REGISTRY (user_data);
680 reply = dbus_message_new_method_return (message);
682 dbus_message_iter_init_append (reply, &iter);
683 dbus_message_iter_open_container(&iter, DBUS_TYPE_ARRAY, "(so)", &iter_array);
684 for (i=0; i < reg->apps->len; i++)
686 SpiReference *current = g_ptr_array_index (reg->apps, i);
687 append_reference (&iter_array, current->name, current->path);
689 dbus_message_iter_close_container(&iter, &iter_array);
694 impl_GetIndexInParent (DBusConnection * bus,
695 DBusMessage * message, void *user_data)
698 dbus_uint32_t rv = 0;
700 reply = dbus_message_new_method_return (message);
701 dbus_message_append_args (reply, DBUS_TYPE_INT32, &rv, DBUS_TYPE_INVALID);
706 impl_GetRelationSet (DBusConnection * bus,
707 DBusMessage * message, void *user_data)
710 DBusMessageIter iter, iter_array;
712 reply = dbus_message_new_method_return (message);
713 dbus_message_iter_init_append (reply, &iter);
714 dbus_message_iter_open_container (&iter, DBUS_TYPE_ARRAY, "(ua(so))", &iter_array);
715 dbus_message_iter_close_container (&iter, &iter_array);
721 impl_GetRole (DBusConnection * bus, DBusMessage * message, void * user_data)
724 dbus_uint32_t rv = 14; /* TODO: Get DESKTOP_FRAME from somewhere */
726 reply = dbus_message_new_method_return (message);
727 dbus_message_append_args (reply, DBUS_TYPE_UINT32, &rv, DBUS_TYPE_INVALID);
732 impl_GetRoleName (DBusConnection * bus,
733 DBusMessage * message, void *user_data)
736 const char *role_name = "desktop frame";
738 reply = dbus_message_new_method_return (message);
739 dbus_message_append_args (reply, DBUS_TYPE_STRING, &role_name,
745 impl_GetLocalizedRoleName (DBusConnection * bus,
746 DBusMessage * message, void *user_data)
748 /* TODO - Localize this */
750 const char *role_name = "desktop frame";
752 reply = dbus_message_new_method_return (message);
753 dbus_message_append_args (reply, DBUS_TYPE_STRING, &role_name,
759 impl_GetState (DBusConnection * bus, DBusMessage * message, void *user_data)
761 DBusMessage *reply = NULL;
762 DBusMessageIter iter, iter_array;
764 dbus_uint32_t states[2] = {0, 0};
767 reply = dbus_message_new_method_return (message);
768 dbus_message_iter_init_append (reply, &iter);
770 dbus_message_iter_open_container (&iter, DBUS_TYPE_ARRAY, "u", &iter_array);
771 for (count = 0; count < 2; count++)
773 dbus_message_iter_append_basic (&iter_array, DBUS_TYPE_UINT32,
776 dbus_message_iter_close_container (&iter, &iter_array);
781 impl_GetAttributes (DBusConnection * bus,
782 DBusMessage * message, void *user_data)
784 DBusMessage *reply = NULL;
785 DBusMessageIter iter, array;
787 reply = dbus_message_new_method_return (message);
788 dbus_message_iter_init_append (reply, &iter);
789 dbus_message_iter_open_container (&iter, DBUS_TYPE_ARRAY, "{ss}", &array);
790 dbus_message_iter_close_container (&iter, &array);
796 impl_GetApplication (DBusConnection * bus,
797 DBusMessage * message, void *user_data)
799 DBusMessage *reply = NULL;
800 DBusMessageIter iter;
802 reply = dbus_message_new_method_return (message);
803 dbus_message_iter_init_append (reply, &iter);
804 append_reference (&iter,
805 dbus_bus_get_unique_name (bus),
812 impl_GetInterfaces (DBusConnection * bus,
813 DBusMessage * message, void *user_data)
816 DBusMessageIter iter, iter_array;
818 const char *acc = SPI_DBUS_INTERFACE_ACCESSIBLE;
819 const char *com = SPI_DBUS_INTERFACE_COMPONENT;
821 reply = dbus_message_new_method_return (message);
823 dbus_message_iter_init_append (reply, &iter);
824 dbus_message_iter_open_container (&iter, DBUS_TYPE_ARRAY, "s",
826 dbus_message_iter_append_basic (&iter_array, DBUS_TYPE_STRING, &acc);
827 dbus_message_iter_append_basic (&iter_array, DBUS_TYPE_STRING, &com);
828 dbus_message_iter_close_container (&iter, &iter_array);
834 impl_GetItems (DBusConnection * bus, DBusMessage * message, void *user_data)
837 DBusMessageIter iter, iter_array;
839 reply = dbus_message_new_method_return (message);
841 dbus_message_iter_init_append (reply, &iter);
842 dbus_message_iter_open_container (&iter, DBUS_TYPE_ARRAY,
843 "((so)(so)(so)a(so)assusau)", &iter_array);
844 dbus_message_iter_close_container (&iter, &iter_array);
848 /* I would rather these two be signals, but I'm not sure that dbus-python
849 * supports emitting signals except for a service, so implementing as both
850 * a method call and signal for now.
853 impl_register_event (DBusConnection *bus, DBusMessage *message, void *user_data)
855 SpiRegistry *registry = SPI_REGISTRY (user_data);
856 const char *orig_name;
861 const char *sender = dbus_message_get_sender (message);
862 DBusMessageIter iter, iter_array;
863 const char *signature = dbus_message_get_signature (message);
865 if (strcmp (signature, "sas") != 0 &&
866 strcmp (signature, "s") != 0)
868 g_warning ("got RegisterEvent with invalid signature '%s'", signature);
872 dbus_message_iter_init (message, &iter);
873 dbus_message_iter_get_basic (&iter, &orig_name);
874 dbus_message_iter_next (&iter);
875 name = ensure_proper_format (orig_name);
877 evdata = g_new0 (event_data, 1);
878 data = g_strsplit (name, ":", 3);
879 evdata->bus_name = g_strdup (sender);
882 if (dbus_message_iter_get_arg_type (&iter) == DBUS_TYPE_ARRAY)
884 dbus_message_iter_recurse (&iter, &iter_array);
885 while (dbus_message_iter_get_arg_type (&iter_array) != DBUS_TYPE_INVALID)
887 const char *property;
888 dbus_message_iter_get_basic (&iter_array, &property);
889 evdata->properties = g_slist_append (evdata->properties,
890 g_strdup (property));
891 dbus_message_iter_next (&iter_array);
894 registry->events = g_list_append (registry->events, evdata);
896 if (needs_mouse_poll (evdata->data))
898 spi_device_event_controller_start_poll_mouse (registry);
901 signal = dbus_message_new_signal (SPI_DBUS_PATH_REGISTRY,
902 SPI_DBUS_INTERFACE_REGISTRY,
903 "EventListenerRegistered");
906 GSList *ls = evdata->properties;
907 dbus_message_iter_init_append (signal, &iter);
908 dbus_message_iter_append_basic (&iter, DBUS_TYPE_STRING, &sender);
909 dbus_message_iter_append_basic (&iter, DBUS_TYPE_STRING, &name);
910 dbus_message_iter_open_container (&iter, DBUS_TYPE_ARRAY, "s", &iter_array);
913 dbus_message_iter_append_basic (&iter_array, DBUS_TYPE_STRING, &ls->data);
914 ls = g_slist_next (ls);
916 dbus_message_iter_close_container (&iter, &iter_array);
917 dbus_connection_send (bus, signal, NULL);
918 dbus_message_unref (signal);
922 return dbus_message_new_method_return (message);
926 impl_deregister_event (DBusConnection *bus, DBusMessage *message, void *user_data)
928 SpiRegistry *registry = SPI_REGISTRY (user_data);
929 const char *orig_name;
931 const char *sender = dbus_message_get_sender (message);
933 if (!dbus_message_get_args (message, NULL, DBUS_TYPE_STRING, &orig_name,
936 name = ensure_proper_format (orig_name);
938 remove_events (registry, sender, name);
941 return dbus_message_new_method_return (message);
945 impl_get_registered_events (DBusConnection *bus, DBusMessage *message, void *user_data)
947 SpiRegistry *registry = SPI_REGISTRY (user_data);
950 DBusMessageIter iter, iter_struct, iter_array;
953 reply = dbus_message_new_method_return (message);
957 dbus_message_iter_init_append (reply, &iter);
958 dbus_message_iter_open_container (&iter, DBUS_TYPE_ARRAY, "(ss)", &iter_array);
959 for (list = registry->events; list; list = list->next)
963 str = g_strconcat (evdata->data [0],
964 ":", (evdata->data [1]? evdata->data [1]: ""),
965 ":", (evdata->data [1] && evdata->data [2]? evdata->data [2]: ""), NULL);
966 dbus_message_iter_open_container (&iter_array, DBUS_TYPE_STRUCT, NULL, &iter_struct);
967 dbus_message_iter_append_basic (&iter_struct, DBUS_TYPE_STRING, &evdata->bus_name);
968 dbus_message_iter_append_basic (&iter_struct, DBUS_TYPE_STRING, &str);
969 dbus_message_iter_close_container (&iter_array, &iter_struct);
972 dbus_message_iter_close_container (&iter, &iter_array);
976 /*---------------------------------------------------------------------------*/
979 emit_Available (DBusConnection * bus)
982 DBusMessageIter iter;
984 sig = dbus_message_new_signal(SPI_DBUS_PATH_ROOT, SPI_DBUS_INTERFACE_SOCKET, "Available");
986 dbus_message_iter_init_append(sig, &iter);
987 append_reference (&iter, SPI_DBUS_NAME_REGISTRY, SPI_DBUS_PATH_ROOT);
989 dbus_connection_send(bus, sig, NULL);
990 dbus_message_unref(sig);
993 /*---------------------------------------------------------------------------*/
995 static const char *introspection_header =
996 "<?xml version=\"1.0\"?>\n";
998 static const char *introspection_node_element =
999 "<node name=\"%s\">\n";
1001 static const char *introspection_footer =
1004 static DBusMessage *
1005 impl_Introspect_root (DBusConnection * bus,
1006 DBusMessage * message, void *user_data)
1011 const gchar *pathstr = SPI_DBUS_PATH_ROOT;
1015 output = g_string_new(introspection_header);
1017 g_string_append_printf(output, introspection_node_element, pathstr);
1019 g_string_append (output, spi_org_a11y_atspi_Accessible);
1020 g_string_append (output, spi_org_a11y_atspi_Component);
1022 g_string_append(output, introspection_footer);
1023 final = g_string_free(output, FALSE);
1025 reply = dbus_message_new_method_return (message);
1026 dbus_message_append_args(reply, DBUS_TYPE_STRING, &final, DBUS_TYPE_INVALID);
1032 static DBusMessage *
1033 impl_Introspect_registry (DBusConnection * bus,
1034 DBusMessage * message, void *user_data)
1039 const gchar *pathstr = SPI_DBUS_PATH_REGISTRY;
1043 output = g_string_new(introspection_header);
1045 g_string_append_printf(output, introspection_node_element, pathstr);
1047 g_string_append (output, spi_org_a11y_atspi_Registry);
1049 g_string_append(output, introspection_footer);
1050 final = g_string_free(output, FALSE);
1052 reply = dbus_message_new_method_return (message);
1053 dbus_message_append_args(reply, DBUS_TYPE_STRING, &final, DBUS_TYPE_INVALID);
1059 /*---------------------------------------------------------------------------*/
1062 * Emits an AT-SPI event.
1063 * AT-SPI events names are split into three parts:
1065 * This is mapped onto D-Bus events as:
1066 * D-Bus Interface:Signal Name:Detail argument
1068 * Marshals a basic type into the 'any_data' attribute of
1072 emit_event (DBusConnection *bus,
1076 dbus_int32_t detail1,
1077 dbus_int32_t detail2,
1082 DBusMessageIter iter, iter_variant;
1084 sig = dbus_message_new_signal(SPI_DBUS_PATH_ROOT, klass, major);
1086 dbus_message_iter_init_append(sig, &iter);
1088 dbus_message_iter_append_basic(&iter, DBUS_TYPE_STRING, &minor);
1089 dbus_message_iter_append_basic(&iter, DBUS_TYPE_INT32, &detail1);
1090 dbus_message_iter_append_basic(&iter, DBUS_TYPE_INT32, &detail2);
1092 dbus_message_iter_open_container (&iter, DBUS_TYPE_VARIANT, "(so)",
1094 append_reference (&iter_variant, name, path);
1095 dbus_message_iter_close_container (&iter, &iter_variant);
1097 append_reference (&iter,
1098 dbus_bus_get_unique_name (bus),
1099 SPI_DBUS_PATH_ROOT);
1101 dbus_connection_send(bus, sig, NULL);
1102 dbus_message_unref(sig);
1105 /*---------------------------------------------------------------------------*/
1108 * Children changed signal converter and forwarder.
1110 * Klass (Interface) org.a11y.atspi.Event.Object
1111 * Major is the signal name.
1112 * Minor is 'add' or 'remove'
1113 * detail1 is the index.
1115 * any_data is the child reference.
1119 children_added_listener (DBusConnection * bus,
1124 emit_event (bus, SPI_DBUS_INTERFACE_EVENT_OBJECT, "ChildrenChanged", "add", index, 0,
1129 children_removed_listener (DBusConnection * bus,
1134 emit_event (bus, SPI_DBUS_INTERFACE_EVENT_OBJECT, "ChildrenChanged", "remove", index, 0,
1138 /*---------------------------------------------------------------------------*/
1140 static DBusHandlerResult
1141 handle_method_root (DBusConnection *bus, DBusMessage *message, void *user_data)
1143 DBusHandlerResult result = DBUS_HANDLER_RESULT_NOT_YET_HANDLED;
1145 const gchar *iface = dbus_message_get_interface (message);
1146 const gchar *member = dbus_message_get_member (message);
1147 const gint type = dbus_message_get_type (message);
1149 DBusMessage *reply = NULL;
1151 /* Check for basic reasons not to handle */
1152 if (type != DBUS_MESSAGE_TYPE_METHOD_CALL ||
1155 return DBUS_HANDLER_RESULT_NOT_YET_HANDLED;
1157 if (!strcmp (iface, "org.freedesktop.DBus.Properties"))
1159 if (!strcmp (member, "Get"))
1161 const gchar *prop_iface;
1162 const gchar *prop_member;
1165 dbus_error_init (&error);
1166 if (dbus_message_get_args (message,
1174 DBusMessageIter iter;
1176 reply = dbus_message_new_method_return (message);
1177 dbus_message_iter_init_append (reply, &iter);
1180 if (!strcmp (prop_iface, SPI_DBUS_INTERFACE_ACCESSIBLE))
1182 if (!strcmp (prop_member, "Name"))
1183 impl_get_Name (&iter, user_data);
1184 else if (!strcmp (prop_member, "Description"))
1185 impl_get_Description (&iter, user_data);
1186 else if (!strcmp (prop_member, "Parent"))
1187 impl_get_Parent (&iter, user_data);
1188 else if (!strcmp (prop_member, "ChildCount"))
1189 impl_get_ChildCount (&iter, user_data);
1192 dbus_message_unref (reply);
1193 reply = dbus_message_new_error (message, DBUS_ERROR_FAILED, "Property unavailable");
1196 else if (!strcmp (prop_iface, SPI_DBUS_INTERFACE_APPLICATION))
1198 if (!strcmp (prop_member, "ToolkitName"))
1199 impl_get_ToolkitName (&iter, user_data);
1200 else if (!strcmp (prop_member, "ToolkitVersion"))
1201 impl_get_ToolkitVersion (&iter, user_data);
1204 dbus_message_unref (reply);
1205 reply = dbus_message_new_error (message, DBUS_ERROR_FAILED, "Property unavailable");
1210 dbus_message_unref (reply);
1211 reply = dbus_message_new_error (message, DBUS_ERROR_FAILED, "Property unavailable");
1216 reply = dbus_message_new_error (message, DBUS_ERROR_FAILED, error.message);
1218 result = DBUS_HANDLER_RESULT_HANDLED;
1220 else if (!strcmp (member, "GetAll"))
1222 result = DBUS_HANDLER_RESULT_HANDLED;
1226 if (!strcmp (iface, SPI_DBUS_INTERFACE_ACCESSIBLE))
1228 result = DBUS_HANDLER_RESULT_HANDLED;
1229 if (!strcmp (member, "GetChildAtIndex"))
1230 reply = impl_GetChildAtIndex (bus, message, user_data);
1231 else if (!strcmp (member, "GetChildren"))
1232 reply = impl_GetChildren (bus, message, user_data);
1233 else if (!strcmp (member, "GetIndexInParent"))
1234 reply = impl_GetIndexInParent (bus, message, user_data);
1235 else if (!strcmp (member, "GetRelationSet"))
1236 reply = impl_GetRelationSet (bus, message, user_data);
1237 else if (!strcmp (member, "GetRole"))
1238 reply = impl_GetRole (bus, message, user_data);
1239 else if (!strcmp (member, "GetRoleName"))
1240 reply = impl_GetRoleName (bus, message, user_data);
1241 else if (!strcmp (member, "GetLocalizedRoleName"))
1242 reply = impl_GetLocalizedRoleName (bus, message, user_data);
1243 else if (!strcmp (member, "GetState"))
1244 reply = impl_GetState (bus, message, user_data);
1245 else if (!strcmp (member, "GetAttributes"))
1246 reply = impl_GetAttributes (bus, message, user_data);
1247 else if (!strcmp (member, "GetApplication"))
1248 reply = impl_GetApplication (bus, message, user_data);
1249 else if (!strcmp (member, "GetInterfaces"))
1250 reply = impl_GetInterfaces (bus, message, user_data);
1252 result = DBUS_HANDLER_RESULT_NOT_YET_HANDLED;
1255 if (!strcmp (iface, SPI_DBUS_INTERFACE_COMPONENT))
1257 result = DBUS_HANDLER_RESULT_HANDLED;
1258 if (!strcmp (member, "Contains"))
1259 reply = impl_Contains (bus, message, user_data);
1260 else if (!strcmp (member, "GetAccessibleAtPoint"))
1261 reply = impl_GetAccessibleAtPoint (bus, message, user_data);
1262 else if (!strcmp (member, "GetExtents"))
1263 reply = impl_GetExtents (bus, message, user_data);
1264 else if (!strcmp (member, "GetPosition"))
1265 reply = impl_GetPosition (bus, message, user_data);
1266 else if (!strcmp (member, "GetSize"))
1267 reply = impl_GetSize (bus, message, user_data);
1268 else if (!strcmp (member, "GetLayer"))
1269 reply = impl_GetLayer (bus, message, user_data);
1270 else if (!strcmp (member, "GetMDIZOrder"))
1271 reply = impl_GetMDIZOrder (bus, message, user_data);
1272 else if (!strcmp (member, "GrabFocus"))
1273 reply = impl_GrabFocus (bus, message, user_data);
1274 else if (!strcmp (member, "GrabHighlight"))
1275 reply = impl_GrabHighlight (bus, message, user_data);
1276 else if (!strcmp (member, "ClearHighlight"))
1277 reply = impl_ClearHighlight (bus, message, user_data);
1278 else if (!strcmp (member, "GetAlpha"))
1279 reply = impl_GetAlpha (bus, message, user_data);
1281 result = DBUS_HANDLER_RESULT_NOT_YET_HANDLED;
1284 if (!strcmp (iface, SPI_DBUS_INTERFACE_SOCKET))
1286 result = DBUS_HANDLER_RESULT_HANDLED;
1287 if (!strcmp (member, "Embed"))
1288 reply = impl_Embed (bus, message, user_data);
1289 else if (!strcmp (member, "Unembed"))
1290 reply = impl_Unembed (bus, message, user_data);
1292 result = DBUS_HANDLER_RESULT_NOT_YET_HANDLED;
1295 if (!strcmp (iface, "org.freedesktop.DBus.Introspectable"))
1297 result = DBUS_HANDLER_RESULT_HANDLED;
1298 if (!strcmp (member, "Introspect"))
1299 reply = impl_Introspect_root (bus, message, user_data);
1301 result = DBUS_HANDLER_RESULT_NOT_YET_HANDLED;
1304 if (result == DBUS_HANDLER_RESULT_HANDLED)
1308 reply = dbus_message_new_method_return (message);
1311 dbus_connection_send (bus, reply, NULL);
1312 dbus_message_unref (reply);
1317 g_print ("Registry | Unhandled message : %s|%s\n", iface, member);
1324 static DBusHandlerResult
1325 handle_method_cache (DBusConnection *bus, DBusMessage *message, void *user_data)
1327 DBusHandlerResult result = DBUS_HANDLER_RESULT_NOT_YET_HANDLED;
1329 const gchar *iface = dbus_message_get_interface (message);
1330 const gchar *member = dbus_message_get_member (message);
1331 const gint type = dbus_message_get_type (message);
1333 DBusMessage *reply = NULL;
1335 /* Check for basic reasons not to handle */
1336 if (type != DBUS_MESSAGE_TYPE_METHOD_CALL ||
1339 return DBUS_HANDLER_RESULT_NOT_YET_HANDLED;
1341 if (!strcmp (iface, SPI_DBUS_INTERFACE_CACHE))
1343 result = DBUS_HANDLER_RESULT_HANDLED;
1344 if (!strcmp (member, "GetItems"))
1345 reply = impl_GetItems (bus, message, user_data);
1347 result = DBUS_HANDLER_RESULT_NOT_YET_HANDLED;
1350 if (result == DBUS_HANDLER_RESULT_HANDLED)
1354 reply = dbus_message_new_method_return (message);
1357 dbus_connection_send (bus, reply, NULL);
1358 dbus_message_unref (reply);
1363 static DBusHandlerResult
1364 handle_method_registry (DBusConnection *bus, DBusMessage *message, void *user_data)
1366 DBusHandlerResult result = DBUS_HANDLER_RESULT_NOT_YET_HANDLED;
1368 const gchar *iface = dbus_message_get_interface (message);
1369 const gchar *member = dbus_message_get_member (message);
1370 const gint type = dbus_message_get_type (message);
1372 DBusMessage *reply = NULL;
1374 /* Check for basic reasons not to handle */
1375 if (type != DBUS_MESSAGE_TYPE_METHOD_CALL ||
1378 return DBUS_HANDLER_RESULT_NOT_YET_HANDLED;
1380 if (!strcmp (iface, SPI_DBUS_INTERFACE_REGISTRY))
1382 result = DBUS_HANDLER_RESULT_HANDLED;
1383 if (!strcmp(member, "RegisterEvent"))
1384 reply = impl_register_event (bus, message, user_data);
1385 else if (!strcmp(member, "DeregisterEvent"))
1386 reply = impl_deregister_event (bus, message, user_data);
1387 else if (!strcmp(member, "GetRegisteredEvents"))
1388 reply = impl_get_registered_events (bus, message, user_data);
1390 result = DBUS_HANDLER_RESULT_NOT_YET_HANDLED;
1393 if (!strcmp (iface, "org.freedesktop.DBus.Introspectable"))
1395 result = DBUS_HANDLER_RESULT_HANDLED;
1396 if (!strcmp (member, "Introspect"))
1397 reply = impl_Introspect_registry (bus, message, user_data);
1399 result = DBUS_HANDLER_RESULT_NOT_YET_HANDLED;
1402 if (result == DBUS_HANDLER_RESULT_HANDLED)
1406 reply = dbus_message_new_method_return (message);
1409 dbus_connection_send (bus, reply, NULL);
1410 dbus_message_unref (reply);
1415 g_print ("Registry | Unhandled message : %s|%s\n", iface, member);
1422 /*---------------------------------------------------------------------------*/
1424 static DBusObjectPathVTable root_vtable =
1427 &handle_method_root,
1428 NULL, NULL, NULL, NULL
1431 static DBusObjectPathVTable registry_vtable =
1434 &handle_method_registry,
1435 NULL, NULL, NULL, NULL
1438 static DBusObjectPathVTable cache_vtable =
1441 &handle_method_cache,
1442 NULL, NULL, NULL, NULL
1445 static gchar *app_sig_match_name_owner =
1446 "type='signal', interface='org.freedesktop.DBus', member='NameOwnerChanged'";
1449 spi_registry_new (DBusConnection *bus)
1451 SpiRegistry *reg = g_object_new (SPI_REGISTRY_TYPE, NULL);
1455 dbus_bus_add_match (bus, app_sig_match_name_owner, NULL);
1456 dbus_connection_add_filter (bus, signal_filter, reg, NULL);
1458 dbus_connection_register_object_path (bus, SPI_DBUS_PATH_ROOT, &root_vtable, reg);
1460 dbus_connection_register_object_path (bus, SPI_DBUS_PATH_CACHE, &cache_vtable, reg);
1462 dbus_connection_register_object_path (bus, SPI_DBUS_PATH_REGISTRY, ®istry_vtable, reg);
1464 emit_Available (bus);
1471 /*END------------------------------------------------------------------------*/