2 * AT-SPI - Assistive Technology Service Provider Interface
3 * (Gnome Accessibility Project; http://developer.gnome.org/projects/gap)
5 * Copyright 2008, 2009 Codethink Ltd.
6 * Copyright 2001, 2002, 2003 Sun Microsystems Inc.,
7 * Copyright 2001, 2002, 2003 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 "dbus/dbus-glib-lowlevel.h"
29 #include <X11/Xatom.h>
37 #include <droute/droute.h>
44 #include "accessible-register.h"
45 #include "accessible-leasing.h"
46 #include "accessible-cache.h"
48 #include "common/spi-dbus.h"
50 /*---------------------------------------------------------------------------*/
52 SpiBridge *spi_global_app_data = NULL;
54 static const AtkMisc *atk_misc = NULL;
56 /*static Display *bridge_display = NULL;*/
58 /*---------------------------------------------------------------------------*/
61 * Returns a 'canonicalized' value for DISPLAY,
62 * with the screen number stripped off if present.
66 spi_display_name (void)
68 static const char *canonical_display_name = NULL;
69 if (!canonical_display_name)
71 const gchar *display_env = g_getenv ("AT_SPI_DISPLAY");
74 display_env = g_getenv ("DISPLAY");
75 if (!display_env || !display_env[0])
76 canonical_display_name = ":0";
79 gchar *display_p, *screen_p;
80 canonical_display_name = g_strdup (display_env);
81 display_p = strrchr (canonical_display_name, ':');
82 screen_p = strrchr (canonical_display_name, '.');
83 if (screen_p && display_p && (screen_p > display_p))
91 canonical_display_name = display_env;
94 return canonical_display_name;
97 /*---------------------------------------------------------------------------*/
100 * Gets the IOR from the XDisplay.
101 * Not currently used in D-Bus version, but something similar
102 * may be employed in the future for accessing the registry daemon
106 static DBusConnection *
107 spi_atk_bridge_get_bus (void)
111 Display *bridge_display;
113 unsigned char *data = NULL;
114 unsigned long nitems;
115 unsigned long leftover;
117 DBusConnection *bus = NULL;
120 bridge_display = XOpenDisplay (spi_display_name ());
123 g_warning ("AT_SPI: Could not get the display\n");
127 AT_SPI_BUS = XInternAtom (bridge_display, "AT_SPI_BUS", False);
128 XGetWindowProperty (bridge_display,
129 XDefaultRootWindow (bridge_display),
131 (long) BUFSIZ, False,
132 (Atom) 31, &actual_type, &actual_format,
133 &nitems, &leftover, &data);
135 dbus_error_init (&error);
140 ("AT-SPI: Accessibility bus not found - Using session bus.\n");
141 bus = dbus_bus_get (DBUS_BUS_SESSION, &error);
144 g_warning ("AT-SPI: Couldn't connect to bus: %s\n", error.message);
150 bus = dbus_connection_open (data, &error);
153 g_warning ("AT-SPI: Couldn't connect to bus: %s\n", error.message);
158 if (!dbus_bus_register (bus, &error))
160 g_warning ("AT-SPI: Couldn't register with bus: %s\n", error.message);
170 set_reply (DBusPendingCall *pending, void *user_data)
172 void **replyptr = (void **)user_data;
174 *replyptr = dbus_pending_call_steal_reply (pending);
178 send_and_allow_reentry (DBusConnection *bus, DBusMessage *message, DBusError *error)
180 DBusPendingCall *pending;
181 DBusMessage *reply = NULL;
183 if (!dbus_connection_send_with_reply (bus, message, &pending, -1))
187 dbus_pending_call_set_notify (pending, set_reply, (void *)&reply, NULL);
190 if (!dbus_connection_read_write_dispatch (bus, -1)) return NULL;
194 /*---------------------------------------------------------------------------*/
197 add_event (const char *bus_name, const char *event)
203 evdata = (event_data *) g_malloc (sizeof (*evdata));
206 data = g_strsplit (event, ":", 3);
212 evdata->bus_name = g_strdup (bus_name);
214 new_list = g_list_append (spi_global_app_data->events, evdata);
216 spi_global_app_data->events = new_list;
220 get_registered_event_listeners (SpiBridge *app)
222 DBusMessage *message, *reply;
223 DBusMessageIter iter, iter_array, iter_struct;
225 message = dbus_message_new_method_call (SPI_DBUS_NAME_REGISTRY,
226 SPI_DBUS_PATH_REGISTRY,
227 SPI_DBUS_INTERFACE_REGISTRY,
228 "GetRegisteredEvents");
232 reply = dbus_connection_send_with_reply_and_block (app->bus, message, 5000, NULL);
233 dbus_message_unref (message);
236 if (strcmp (dbus_message_get_signature (reply), "a(ss)") != 0)
238 /* TODO: Add a warning when it's okay to add strings */
239 dbus_message_unref (reply);
242 dbus_message_iter_init (reply, &iter);
243 dbus_message_iter_recurse (&iter, &iter_array);
244 /* TODO: This is bad. Need to determine that the array is non-empty,
245 so that we don't initially read a value rom it in that case, but using
246 a deprecated function. */
247 if (dbus_message_iter_get_array_len (&iter_array) > 0) do
249 char *bus_name, *event;
250 dbus_message_iter_recurse (&iter_array, &iter_struct);
251 dbus_message_iter_get_basic (&iter_struct, &bus_name);
252 dbus_message_iter_next (&iter_struct);
253 dbus_message_iter_get_basic (&iter_struct, &event);
254 add_event (bus_name, event);
256 while (dbus_message_iter_next (&iter_array));
257 dbus_message_unref (reply);
261 register_reply (DBusPendingCall *pending, void *user_data)
264 SpiBridge *app = user_data;
265 DBusMessage *message;
267 reply = dbus_pending_call_steal_reply (pending);
270 gchar *app_name, *obj_path;
272 if (strcmp (dbus_message_get_signature (reply), "(so)") != 0)
274 g_warning ("AT-SPI: Could not obtain desktop path or name\n");
275 printf("sig: %s\n", dbus_message_get_signature(reply));
279 DBusMessageIter iter, iter_struct;
280 dbus_message_iter_init (reply, &iter);
281 dbus_message_iter_recurse (&iter, &iter_struct);
282 dbus_message_iter_get_basic (&iter_struct, &app_name);
283 dbus_message_iter_next (&iter_struct);
284 dbus_message_iter_get_basic (&iter_struct, &obj_path);
286 app->desktop_name = g_strdup (app_name);
287 app->desktop_path = g_strdup (obj_path);
292 g_warning ("AT-SPI: Could not embed inside desktop");
295 dbus_message_unref (reply);
297 get_registered_event_listeners (spi_global_app_data);
301 register_application (SpiBridge * app)
303 DBusMessage *message, *reply;
304 DBusMessageIter iter;
306 DBusPendingCall *pending;
308 dbus_error_init (&error);
310 /* These will be overridden when we get a reply, but in practice these
311 defaults should always be correct */
312 app->desktop_name = SPI_DBUS_NAME_REGISTRY;
313 app->desktop_path = SPI_DBUS_PATH_ROOT;
315 message = dbus_message_new_method_call (SPI_DBUS_NAME_REGISTRY,
317 SPI_DBUS_INTERFACE_SOCKET,
320 dbus_message_iter_init_append (message, &iter);
321 spi_object_append_reference (&iter, app->root);
323 if (!dbus_connection_send_with_reply (app->bus, message, &pending, -1))
328 dbus_pending_call_set_notify (pending, register_reply, app, NULL);
331 dbus_message_unref (message);
336 /*---------------------------------------------------------------------------*/
339 deregister_application (SpiBridge * app)
341 DBusMessage *message;
342 DBusMessageIter iter;
346 dbus_error_init (&error);
348 message = dbus_message_new_method_call (SPI_DBUS_NAME_REGISTRY,
349 SPI_DBUS_PATH_REGISTRY,
350 SPI_DBUS_INTERFACE_REGISTRY,
351 "DeregisterApplication");
352 dbus_message_set_no_reply (message, TRUE);
354 uname = dbus_bus_get_unique_name (app->bus);
356 dbus_message_iter_init_append (message, &iter);
357 dbus_message_iter_append_basic (&iter, DBUS_TYPE_STRING, &uname);
358 dbus_connection_send (app->bus, message, NULL);
360 dbus_message_unref (message);
363 /*---------------------------------------------------------------------------*/
368 if (!spi_global_app_data)
373 spi_atk_tidy_windows ();
374 spi_atk_deregister_event_listeners ();
375 deregister_application (spi_global_app_data);
377 g_free (spi_global_app_data);
378 spi_global_app_data = NULL;
380 /* Not currently creating an XDisplay */
383 XCloseDisplay (bridge_display);
387 /*---------------------------------------------------------------------------*/
389 static AtkPlugClass *plug_class;
390 static AtkSocketClass *socket_class;
393 get_plug_id (AtkPlug * plug)
395 const char *uname = dbus_bus_get_unique_name (spi_global_app_data->bus);
397 GString *str = g_string_new (NULL);
399 path = spi_register_object_to_path (spi_global_register, G_OBJECT (plug));
400 g_string_printf (str, "%s:%s", uname, path);
402 return g_string_free (str, FALSE);
406 socket_ref_state_set (AtkObject *accessible)
408 char *child_name, *child_path;
409 AtkSocket *socket = ATK_SOCKET (accessible);
413 DBusMessage *message, *reply;
414 DBusMessageIter iter, iter_array;
417 if (!socket->embedded_plug_id)
420 child_name = g_strdup (socket->embedded_plug_id);
423 child_path = g_utf8_strchr (child_name + 1, -1, ':');
429 *(child_path++) = '\0';
430 message = dbus_message_new_method_call (child_name, child_path, SPI_DBUS_INTERFACE_ACCESSIBLE, "GetState");
432 reply = dbus_connection_send_with_reply_and_block (spi_global_app_data->bus, message, 1, NULL);
433 dbus_message_unref (message);
436 if (strcmp (dbus_message_get_signature (reply), "au") != 0)
438 dbus_message_unref (reply);
441 set = atk_state_set_new ();
444 dbus_message_iter_init (reply, &iter);
445 dbus_message_iter_recurse (&iter, &iter_array);
448 dbus_message_iter_get_basic (&iter_array, &v);
449 for (j = 0; j < 32; j++)
453 AtkState state = spi_atk_state_from_spi_state ((count << 5) + j);
454 atk_state_set_add_state (set, state);
459 while (dbus_message_iter_next (&iter_array));
460 dbus_message_unref (reply);
465 socket_embed_hook (AtkSocket * socket, gchar * plug_id)
467 AtkObject *accessible = ATK_OBJECT(socket);
468 gchar *plug_name, *plug_path;
469 AtkObjectClass *klass;
471 /* Force registration */
472 gchar *path = spi_register_object_to_path (spi_global_register, G_OBJECT (accessible));
473 /* Let the plug know that it has been embedded */
474 plug_name = g_strdup (plug_id);
480 plug_path = g_utf8_strchr (plug_name + 1, -1, ':');
483 DBusMessage *message;
484 *(plug_path++) = '\0';
485 message = dbus_message_new_method_call (plug_name, plug_path, SPI_DBUS_INTERFACE_SOCKET, "Embedded");
486 dbus_message_append_args (message, DBUS_TYPE_STRING, &path, DBUS_TYPE_INVALID);
487 dbus_connection_send (spi_global_app_data->bus, message, NULL);
492 klass = ATK_OBJECT_GET_CLASS (accessible);
493 klass->ref_state_set = socket_ref_state_set;
497 install_plug_hooks ()
501 data = g_type_class_ref (ATK_TYPE_PLUG);
502 plug_class = ATK_PLUG_CLASS (data);
503 data = g_type_class_ref (ATK_TYPE_SOCKET);
504 socket_class = ATK_SOCKET_CLASS (data);
505 plug_class->get_object_id = get_plug_id;
506 socket_class->embed = socket_embed_hook;
509 gchar *atspi_dbus_name = NULL;
510 static gboolean atspi_no_register = FALSE;
512 static GOptionEntry atspi_option_entries[] = {
513 {"atspi-dbus-name", 0, 0, G_OPTION_ARG_STRING, &atspi_dbus_name,
514 "D-Bus bus name to register as", NULL},
515 {"atspi-no-register", 0, 0, G_OPTION_ARG_NONE, &atspi_no_register,
516 "Do not register with Registry Daemon", NULL},
521 introspect_children_cb (const char *path, void *data)
523 if (!strcmp (path, "/org/a11y/atspi/accessible"))
525 return g_strdup ("<node name=\"root\"/>\n");
526 /* TODO: Should we place the whole hierarchy here? */
532 handle_event_listener_registered (DBusConnection *bus, DBusMessage *message,
538 if (!dbus_message_get_args (message, NULL, DBUS_TYPE_STRING, &sender,
539 DBUS_TYPE_STRING, &name, DBUS_TYPE_INVALID))
542 add_event (sender, name);
546 remove_events (const char *bus_name, const char *event)
552 remove_data = g_strsplit (event, ":", 3);
558 for (list = spi_global_app_data->events; list;)
560 event_data *evdata = list->data;
561 if (!g_strcmp0 (evdata->bus_name, bus_name) &&
562 spi_event_is_subtype (evdata->data, remove_data))
564 GList *events = spi_global_app_data->events;
566 g_strfreev (evdata->data);
567 g_free (evdata->bus_name);
569 spi_global_app_data->events = g_list_remove (events, evdata);
579 handle_event_listener_deregistered (DBusConnection *bus, DBusMessage *message,
582 const char *orig_name;
586 if (!dbus_message_get_args (message, NULL, DBUS_TYPE_STRING, &sender,
587 DBUS_TYPE_STRING, &name, DBUS_TYPE_INVALID))
590 remove_events (sender, name);
593 static DBusHandlerResult
594 signal_filter (DBusConnection *bus, DBusMessage *message, void *user_data)
596 const char *interface = dbus_message_get_interface (message);
597 const char *member = dbus_message_get_member (message);
598 DBusHandlerResult result = DBUS_HANDLER_RESULT_NOT_YET_HANDLED;
600 if (dbus_message_get_type (message) != DBUS_MESSAGE_TYPE_SIGNAL)
601 return DBUS_HANDLER_RESULT_NOT_YET_HANDLED;
603 if (!strcmp (interface, SPI_DBUS_INTERFACE_REGISTRY))
605 result = DBUS_HANDLER_RESULT_HANDLED;
606 if (!strcmp (member, "EventListenerRegistered"))
607 handle_event_listener_registered (bus, message, user_data);
608 else if (!strcmp (member, "EventListenerDeregistered"))
609 handle_event_listener_deregistered (bus, message, user_data);
611 result = DBUS_HANDLER_RESULT_NOT_YET_HANDLED;
619 * The following needs to be initialized.
621 * - DRoute for routing message to their accessible objects.
622 * - Event handlers for emmitting signals on specific ATK events.
623 * - Application registration with the AT-SPI registry.
627 adaptor_init (gint * argc, gchar ** argv[])
633 gchar *introspection_directory;
634 static gboolean inited = FALSE;
641 DRoutePath *treepath, *accpath;
643 root = atk_get_root ();
644 g_warn_if_fail (root);
651 /* Parse command line options */
652 opt = g_option_context_new (NULL);
653 g_option_context_add_main_entries (opt, atspi_option_entries, NULL);
654 g_option_context_set_ignore_unknown_options (opt, TRUE);
655 if (!g_option_context_parse (opt, argc, argv, &err))
656 g_warning ("AT-SPI Option parsing failed: %s\n", err->message);
658 /* Allocate global data and do ATK initializations */
659 spi_global_app_data = g_new0 (SpiBridge, 1);
660 atk_misc = atk_misc_get_instance ();
661 spi_global_app_data->root = g_object_ref (root);
663 /* Set up D-Bus connection and register bus name */
664 dbus_error_init (&error);
665 spi_global_app_data->bus = spi_atk_bridge_get_bus ();
666 if (!spi_global_app_data->bus)
668 g_free (spi_global_app_data);
669 spi_global_app_data = NULL;
674 if (atspi_dbus_name != NULL)
676 if (dbus_bus_request_name
677 (spi_global_app_data->bus, atspi_dbus_name, 0, &error))
679 g_print ("AT-SPI Recieved D-Bus name - %s\n", atspi_dbus_name);
684 ("AT-SPI D-Bus name requested but could not be allocated - %s\n",
689 dbus_connection_setup_with_g_main (spi_global_app_data->bus,
690 g_main_context_default ());
692 /* Hook our plug-and socket functions */
693 install_plug_hooks ();
696 * Create the leasing, register and cache objects.
697 * The order is important here, the cache depends on the
700 spi_global_register = g_object_new (SPI_REGISTER_TYPE, NULL);
701 spi_global_leasing = g_object_new (SPI_LEASING_TYPE, NULL);
702 spi_global_cache = g_object_new (SPI_CACHE_TYPE, NULL);
704 /* Register droute for routing AT-SPI messages */
705 spi_global_app_data->droute =
706 droute_new (spi_global_app_data->bus);
708 treepath = droute_add_one (spi_global_app_data->droute,
709 "/org/a11y/atspi/cache", spi_global_cache);
713 g_warning ("atk-bridge: Error in droute_add_one(). Already running?");
717 accpath = droute_add_many (spi_global_app_data->droute,
718 "/org/a11y/atspi/accessible",
720 introspect_children_cb,
722 (DRouteGetDatumFunction)
723 spi_global_register_path_to_object);
726 /* Register all interfaces with droute and set up application accessible db */
727 spi_initialize_cache (treepath);
728 spi_initialize_accessible (accpath);
729 spi_initialize_application (accpath);
730 spi_initialize_action (accpath);
731 spi_initialize_collection (accpath);
732 spi_initialize_component (accpath);
733 spi_initialize_document (accpath);
734 spi_initialize_editabletext (accpath);
735 spi_initialize_hyperlink (accpath);
736 spi_initialize_hypertext (accpath);
737 spi_initialize_image (accpath);
738 spi_initialize_selection (accpath);
739 spi_initialize_socket (accpath);
740 spi_initialize_table (accpath);
741 spi_initialize_text (accpath);
742 spi_initialize_value (accpath);
744 /* Register methods to send D-Bus signals on certain ATK events */
745 spi_atk_register_event_listeners ();
747 /* Set up filter and match rules to catch signals */
748 dbus_bus_add_match (spi_global_app_data->bus, "type='signal', interface='org.a11y.atspi.Registry', sender='org.a11y.atspi.Registry'", NULL);
749 dbus_connection_add_filter (spi_global_app_data->bus, signal_filter, NULL,
752 /* Register this app by sending a signal out to AT-SPI registry daemon */
753 if (!atspi_no_register && (!root || !ATK_IS_PLUG (root)))
754 register_application (spi_global_app_data);
756 get_registered_event_listeners (spi_global_app_data);
758 g_atexit (exit_func);
763 /*---------------------------------------------------------------------------*/
766 gtk_module_init (gint * argc, gchar ** argv[])
768 const gchar *load_bridge = g_getenv ("NO_AT_BRIDGE");
770 if (!load_bridge || g_ascii_strtod (load_bridge, NULL) == 0)
772 return adaptor_init (argc, argv);
778 gnome_accessibility_module_init (void)
780 const gchar *load_bridge = g_getenv ("NO_AT_BRIDGE");
782 if (!load_bridge || g_ascii_strtod (load_bridge, NULL) == 0)
784 adaptor_init (NULL, NULL);
786 if (g_getenv ("AT_SPI_DEBUG"))
788 g_print ("Atk Accessibility bridge initialized\n");
794 gnome_accessibility_module_shutdown (void)
796 spi_atk_deregister_event_listeners ();
800 /*END------------------------------------------------------------------------*/