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>
45 #include "accessible-register.h"
46 #include "accessible-leasing.h"
47 #include "accessible-cache.h"
49 #include "common/spi-dbus.h"
51 /*---------------------------------------------------------------------------*/
53 SpiBridge *spi_global_app_data = NULL;
55 static const AtkMisc *atk_misc = NULL;
57 /*static Display *bridge_display = NULL;*/
59 /*---------------------------------------------------------------------------*/
62 * Returns a 'canonicalized' value for DISPLAY,
63 * with the screen number stripped off if present.
67 spi_display_name (void)
69 static const char *canonical_display_name = NULL;
70 if (!canonical_display_name)
72 const gchar *display_env = g_getenv ("AT_SPI_DISPLAY");
75 display_env = g_getenv ("DISPLAY");
76 if (!display_env || !display_env[0])
77 canonical_display_name = ":0";
80 gchar *display_p, *screen_p;
81 canonical_display_name = g_strdup (display_env);
82 display_p = strrchr (canonical_display_name, ':');
83 screen_p = strrchr (canonical_display_name, '.');
84 if (screen_p && display_p && (screen_p > display_p))
92 canonical_display_name = display_env;
95 return canonical_display_name;
98 /*---------------------------------------------------------------------------*/
101 * Gets the IOR from the XDisplay.
102 * Not currently used in D-Bus version, but something similar
103 * may be employed in the future for accessing the registry daemon
107 static DBusConnection *
108 spi_atk_bridge_get_bus (void)
112 Display *bridge_display;
114 unsigned char *data = NULL;
115 unsigned long nitems;
116 unsigned long leftover;
118 DBusConnection *bus = NULL;
121 bridge_display = XOpenDisplay (spi_display_name ());
124 g_warning ("AT_SPI: Could not get the display\n");
128 AT_SPI_BUS = XInternAtom (bridge_display, "AT_SPI_BUS", False);
129 XGetWindowProperty (bridge_display,
130 XDefaultRootWindow (bridge_display),
132 (long) BUFSIZ, False,
133 (Atom) 31, &actual_type, &actual_format,
134 &nitems, &leftover, &data);
136 dbus_error_init (&error);
141 ("AT-SPI: Accessibility bus not found - Using session bus.\n");
142 bus = dbus_bus_get (DBUS_BUS_SESSION, &error);
145 g_warning ("AT-SPI: Couldn't connect to bus: %s\n", error.message);
151 bus = dbus_connection_open (data, &error);
154 g_warning ("AT-SPI: Couldn't connect to bus: %s\n", error.message);
159 if (!dbus_bus_register (bus, &error))
161 g_warning ("AT-SPI: Couldn't register with bus: %s\n", error.message);
171 set_reply (DBusPendingCall *pending, void *user_data)
173 void **replyptr = (void **)user_data;
175 *replyptr = dbus_pending_call_steal_reply (pending);
179 send_and_allow_reentry (DBusConnection *bus, DBusMessage *message, DBusError *error)
181 DBusPendingCall *pending;
182 DBusMessage *reply = NULL;
184 if (!dbus_connection_send_with_reply (bus, message, &pending, -1))
188 dbus_pending_call_set_notify (pending, set_reply, (void *)&reply, NULL);
191 if (!dbus_connection_read_write_dispatch (bus, -1)) return NULL;
195 /*---------------------------------------------------------------------------*/
198 add_event (const char *bus_name, const char *event)
204 evdata = (event_data *) g_malloc (sizeof (*evdata));
207 data = g_strsplit (event, ":", 3);
213 evdata->bus_name = g_strdup (bus_name);
215 new_list = g_list_append (spi_global_app_data->events, evdata);
217 spi_global_app_data->events = new_list;
221 get_registered_event_listeners (SpiBridge *app)
223 DBusMessage *message, *reply;
224 DBusMessageIter iter, iter_array, iter_struct;
226 message = dbus_message_new_method_call (SPI_DBUS_NAME_REGISTRY,
227 SPI_DBUS_PATH_REGISTRY,
228 SPI_DBUS_INTERFACE_REGISTRY,
229 "GetRegisteredEvents");
230 spi_global_app_data->events_initialized = TRUE;
234 reply = dbus_connection_send_with_reply_and_block (app->bus, message, 5000, NULL);
235 dbus_message_unref (message);
238 if (strcmp (dbus_message_get_signature (reply), "a(ss)") != 0)
240 /* TODO: Add a warning when it's okay to add strings */
241 dbus_message_unref (reply);
244 dbus_message_iter_init (reply, &iter);
245 dbus_message_iter_recurse (&iter, &iter_array);
246 /* TODO: This is bad. Need to determine that the array is non-empty,
247 so that we don't initially read a value rom it in that case, but using
248 a deprecated function. */
249 if (dbus_message_iter_get_array_len (&iter_array) > 0) do
251 char *bus_name, *event;
252 dbus_message_iter_recurse (&iter_array, &iter_struct);
253 dbus_message_iter_get_basic (&iter_struct, &bus_name);
254 dbus_message_iter_next (&iter_struct);
255 dbus_message_iter_get_basic (&iter_struct, &event);
256 add_event (bus_name, event);
258 while (dbus_message_iter_next (&iter_array));
259 dbus_message_unref (reply);
263 register_reply (DBusPendingCall *pending, void *user_data)
266 SpiBridge *app = user_data;
267 DBusMessage *message;
269 reply = dbus_pending_call_steal_reply (pending);
272 gchar *app_name, *obj_path;
274 if (strcmp (dbus_message_get_signature (reply), "(so)") != 0)
276 g_warning ("AT-SPI: Could not obtain desktop path or name\n");
277 printf("sig: %s\n", dbus_message_get_signature(reply));
281 DBusMessageIter iter, iter_struct;
282 dbus_message_iter_init (reply, &iter);
283 dbus_message_iter_recurse (&iter, &iter_struct);
284 dbus_message_iter_get_basic (&iter_struct, &app_name);
285 dbus_message_iter_next (&iter_struct);
286 dbus_message_iter_get_basic (&iter_struct, &obj_path);
288 app->desktop_name = g_strdup (app_name);
289 app->desktop_path = g_strdup (obj_path);
294 g_warning ("AT-SPI: Could not embed inside desktop");
297 dbus_message_unref (reply);
299 get_registered_event_listeners (spi_global_app_data);
303 register_application (SpiBridge * app)
305 DBusMessage *message, *reply;
306 DBusMessageIter iter;
308 DBusPendingCall *pending;
310 dbus_error_init (&error);
312 /* These will be overridden when we get a reply, but in practice these
313 defaults should always be correct */
314 app->desktop_name = SPI_DBUS_NAME_REGISTRY;
315 app->desktop_path = SPI_DBUS_PATH_ROOT;
317 message = dbus_message_new_method_call (SPI_DBUS_NAME_REGISTRY,
319 SPI_DBUS_INTERFACE_SOCKET,
322 dbus_message_iter_init_append (message, &iter);
323 spi_object_append_reference (&iter, app->root);
325 if (!dbus_connection_send_with_reply (app->bus, message, &pending, -1))
330 dbus_pending_call_set_notify (pending, register_reply, app, NULL);
333 dbus_message_unref (message);
338 /*---------------------------------------------------------------------------*/
341 deregister_application (SpiBridge * app)
343 DBusMessage *message;
344 DBusMessageIter iter;
348 dbus_error_init (&error);
350 message = dbus_message_new_method_call (SPI_DBUS_NAME_REGISTRY,
351 SPI_DBUS_PATH_REGISTRY,
352 SPI_DBUS_INTERFACE_REGISTRY,
353 "DeregisterApplication");
354 dbus_message_set_no_reply (message, TRUE);
356 uname = dbus_bus_get_unique_name (app->bus);
358 dbus_message_iter_init_append (message, &iter);
359 dbus_message_iter_append_basic (&iter, DBUS_TYPE_STRING, &uname);
360 dbus_connection_send (app->bus, message, NULL);
362 dbus_message_unref (message);
365 /*---------------------------------------------------------------------------*/
370 if (!spi_global_app_data)
375 spi_atk_tidy_windows ();
376 spi_atk_deregister_event_listeners ();
377 deregister_application (spi_global_app_data);
379 g_free (spi_global_app_data);
380 spi_global_app_data = NULL;
382 /* Not currently creating an XDisplay */
385 XCloseDisplay (bridge_display);
389 /*---------------------------------------------------------------------------*/
391 static AtkPlugClass *plug_class;
392 static AtkSocketClass *socket_class;
395 get_plug_id (AtkPlug * plug)
397 const char *uname = dbus_bus_get_unique_name (spi_global_app_data->bus);
399 GString *str = g_string_new (NULL);
401 path = spi_register_object_to_path (spi_global_register, G_OBJECT (plug));
402 g_string_printf (str, "%s:%s", uname, path);
404 return g_string_free (str, FALSE);
408 socket_ref_state_set (AtkObject *accessible)
410 char *child_name, *child_path;
411 AtkSocket *socket = ATK_SOCKET (accessible);
415 DBusMessage *message, *reply;
416 DBusMessageIter iter, iter_array;
419 if (!socket->embedded_plug_id)
422 child_name = g_strdup (socket->embedded_plug_id);
425 child_path = g_utf8_strchr (child_name + 1, -1, ':');
431 *(child_path++) = '\0';
432 message = dbus_message_new_method_call (child_name, child_path, SPI_DBUS_INTERFACE_ACCESSIBLE, "GetState");
434 reply = dbus_connection_send_with_reply_and_block (spi_global_app_data->bus, message, 1, NULL);
435 dbus_message_unref (message);
438 if (strcmp (dbus_message_get_signature (reply), "au") != 0)
440 dbus_message_unref (reply);
443 set = atk_state_set_new ();
446 dbus_message_iter_init (reply, &iter);
447 dbus_message_iter_recurse (&iter, &iter_array);
450 dbus_message_iter_get_basic (&iter_array, &v);
451 for (j = 0; j < 32; j++)
455 AtkState state = spi_atk_state_from_spi_state ((count << 5) + j);
456 atk_state_set_add_state (set, state);
461 while (dbus_message_iter_next (&iter_array));
462 dbus_message_unref (reply);
467 socket_embed_hook (AtkSocket * socket, gchar * plug_id)
469 AtkObject *accessible = ATK_OBJECT(socket);
470 gchar *plug_name, *plug_path;
471 AtkObjectClass *klass;
473 /* Force registration */
474 gchar *path = spi_register_object_to_path (spi_global_register, G_OBJECT (accessible));
475 /* Let the plug know that it has been embedded */
476 plug_name = g_strdup (plug_id);
482 plug_path = g_utf8_strchr (plug_name + 1, -1, ':');
485 DBusMessage *message;
486 *(plug_path++) = '\0';
487 message = dbus_message_new_method_call (plug_name, plug_path, SPI_DBUS_INTERFACE_SOCKET, "Embedded");
488 dbus_message_append_args (message, DBUS_TYPE_STRING, &path, DBUS_TYPE_INVALID);
489 dbus_connection_send (spi_global_app_data->bus, message, NULL);
494 klass = ATK_OBJECT_GET_CLASS (accessible);
495 klass->ref_state_set = socket_ref_state_set;
499 install_plug_hooks ()
503 data = g_type_class_ref (ATK_TYPE_PLUG);
504 plug_class = ATK_PLUG_CLASS (data);
505 data = g_type_class_ref (ATK_TYPE_SOCKET);
506 socket_class = ATK_SOCKET_CLASS (data);
507 plug_class->get_object_id = get_plug_id;
508 socket_class->embed = socket_embed_hook;
511 gchar *atspi_dbus_name = NULL;
512 static gboolean atspi_no_register = FALSE;
514 static GOptionEntry atspi_option_entries[] = {
515 {"atspi-dbus-name", 0, 0, G_OPTION_ARG_STRING, &atspi_dbus_name,
516 "D-Bus bus name to register as", NULL},
517 {"atspi-no-register", 0, 0, G_OPTION_ARG_NONE, &atspi_no_register,
518 "Do not register with Registry Daemon", NULL},
523 introspect_children_cb (const char *path, void *data)
525 if (!strcmp (path, "/org/a11y/atspi/accessible"))
527 return g_strdup ("<node name=\"root\"/>\n");
528 /* TODO: Should we place the whole hierarchy here? */
534 handle_event_listener_registered (DBusConnection *bus, DBusMessage *message,
540 if (!dbus_message_get_args (message, NULL, DBUS_TYPE_STRING, &sender,
541 DBUS_TYPE_STRING, &name, DBUS_TYPE_INVALID))
544 add_event (sender, name);
548 remove_events (const char *bus_name, const char *event)
554 remove_data = g_strsplit (event, ":", 3);
560 for (list = spi_global_app_data->events; list;)
562 event_data *evdata = list->data;
563 if (!g_strcmp0 (evdata->bus_name, bus_name) &&
564 spi_event_is_subtype (evdata->data, remove_data))
566 GList *events = spi_global_app_data->events;
568 g_strfreev (evdata->data);
569 g_free (evdata->bus_name);
571 spi_global_app_data->events = g_list_remove (events, evdata);
581 handle_event_listener_deregistered (DBusConnection *bus, DBusMessage *message,
584 const char *orig_name;
588 if (!dbus_message_get_args (message, NULL, DBUS_TYPE_STRING, &sender,
589 DBUS_TYPE_STRING, &name, DBUS_TYPE_INVALID))
592 remove_events (sender, name);
595 static DBusHandlerResult
596 signal_filter (DBusConnection *bus, DBusMessage *message, void *user_data)
598 const char *interface = dbus_message_get_interface (message);
599 const char *member = dbus_message_get_member (message);
600 DBusHandlerResult result = DBUS_HANDLER_RESULT_NOT_YET_HANDLED;
602 if (dbus_message_get_type (message) != DBUS_MESSAGE_TYPE_SIGNAL)
603 return DBUS_HANDLER_RESULT_NOT_YET_HANDLED;
605 if (!strcmp (interface, SPI_DBUS_INTERFACE_REGISTRY))
607 result = DBUS_HANDLER_RESULT_HANDLED;
608 if (!strcmp (member, "EventListenerRegistered"))
609 handle_event_listener_registered (bus, message, user_data);
610 else if (!strcmp (member, "EventListenerDeregistered"))
611 handle_event_listener_deregistered (bus, message, user_data);
613 result = DBUS_HANDLER_RESULT_NOT_YET_HANDLED;
621 * The following needs to be initialized.
623 * - DRoute for routing message to their accessible objects.
624 * - Event handlers for emmitting signals on specific ATK events.
625 * - Application registration with the AT-SPI registry.
629 adaptor_init (gint * argc, gchar ** argv[])
635 gchar *introspection_directory;
636 static gboolean inited = FALSE;
643 DRoutePath *treepath, *accpath;
645 root = atk_get_root ();
646 g_warn_if_fail (root);
653 /* Parse command line options */
654 opt = g_option_context_new (NULL);
655 g_option_context_add_main_entries (opt, atspi_option_entries, NULL);
656 g_option_context_set_ignore_unknown_options (opt, TRUE);
657 if (!g_option_context_parse (opt, argc, argv, &err))
658 g_warning ("AT-SPI Option parsing failed: %s\n", err->message);
660 /* Allocate global data and do ATK initializations */
661 spi_global_app_data = g_new0 (SpiBridge, 1);
662 atk_misc = atk_misc_get_instance ();
663 spi_global_app_data->root = g_object_ref (root);
665 /* Set up D-Bus connection and register bus name */
666 dbus_error_init (&error);
667 spi_global_app_data->bus = spi_atk_bridge_get_bus ();
668 if (!spi_global_app_data->bus)
670 g_free (spi_global_app_data);
671 spi_global_app_data = NULL;
676 if (atspi_dbus_name != NULL)
678 if (dbus_bus_request_name
679 (spi_global_app_data->bus, atspi_dbus_name, 0, &error))
681 g_print ("AT-SPI Recieved D-Bus name - %s\n", atspi_dbus_name);
686 ("AT-SPI D-Bus name requested but could not be allocated - %s\n",
691 dbus_connection_setup_with_g_main (spi_global_app_data->bus,
692 g_main_context_default ());
694 /* Hook our plug-and socket functions */
695 install_plug_hooks ();
698 * Create the leasing, register and cache objects.
699 * The order is important here, the cache depends on the
702 spi_global_register = g_object_new (SPI_REGISTER_TYPE, NULL);
703 spi_global_leasing = g_object_new (SPI_LEASING_TYPE, NULL);
704 spi_global_cache = g_object_new (SPI_CACHE_TYPE, NULL);
706 /* Register droute for routing AT-SPI messages */
707 spi_global_app_data->droute =
708 droute_new (spi_global_app_data->bus);
710 treepath = droute_add_one (spi_global_app_data->droute,
711 "/org/a11y/atspi/cache", spi_global_cache);
715 g_warning ("atk-bridge: Error in droute_add_one(). Already running?");
719 accpath = droute_add_many (spi_global_app_data->droute,
720 "/org/a11y/atspi/accessible",
722 introspect_children_cb,
724 (DRouteGetDatumFunction)
725 spi_global_register_path_to_object);
728 /* Register all interfaces with droute and set up application accessible db */
729 spi_initialize_cache (treepath);
730 spi_initialize_accessible (accpath);
731 spi_initialize_application (accpath);
732 spi_initialize_action (accpath);
733 spi_initialize_collection (accpath);
734 spi_initialize_component (accpath);
735 spi_initialize_document (accpath);
736 spi_initialize_editabletext (accpath);
737 spi_initialize_hyperlink (accpath);
738 spi_initialize_hypertext (accpath);
739 spi_initialize_image (accpath);
740 spi_initialize_selection (accpath);
741 spi_initialize_socket (accpath);
742 spi_initialize_table (accpath);
743 spi_initialize_text (accpath);
744 spi_initialize_value (accpath);
746 /* Register methods to send D-Bus signals on certain ATK events */
747 spi_atk_register_event_listeners ();
749 /* Set up filter and match rules to catch signals */
750 dbus_bus_add_match (spi_global_app_data->bus, "type='signal', interface='org.a11y.atspi.Registry', sender='org.a11y.atspi.Registry'", NULL);
751 dbus_connection_add_filter (spi_global_app_data->bus, signal_filter, NULL,
754 /* Register this app by sending a signal out to AT-SPI registry daemon */
755 if (!atspi_no_register && (!root || !ATK_IS_PLUG (root)))
756 register_application (spi_global_app_data);
758 get_registered_event_listeners (spi_global_app_data);
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 g_module_check_init (GModule *module)
780 g_module_make_resident (module);
786 gnome_accessibility_module_init (void)
788 const gchar *load_bridge = g_getenv ("NO_AT_BRIDGE");
790 if (!load_bridge || g_ascii_strtod (load_bridge, NULL) == 0)
792 adaptor_init (NULL, NULL);
794 if (g_getenv ("AT_SPI_DEBUG"))
796 g_print ("Atk Accessibility bridge initialized\n");
802 gnome_accessibility_module_shutdown (void)
804 spi_atk_deregister_event_listeners ();
808 /*END------------------------------------------------------------------------*/