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 ());
122 g_error ("AT_SPI: Could not get the display\n");
124 AT_SPI_BUS = XInternAtom (bridge_display, "AT_SPI_BUS", False);
125 XGetWindowProperty (bridge_display,
126 XDefaultRootWindow (bridge_display),
128 (long) BUFSIZ, False,
129 (Atom) 31, &actual_type, &actual_format,
130 &nitems, &leftover, &data);
132 dbus_error_init (&error);
137 ("AT-SPI: Accessibility bus not found - Using session bus.\n");
138 bus = dbus_bus_get (DBUS_BUS_SESSION, &error);
140 g_error ("AT-SPI: Couldn't connect to bus: %s\n", error.message);
144 bus = dbus_connection_open (data, &error);
147 g_error ("AT-SPI: Couldn't connect to bus: %s\n", error.message);
151 if (!dbus_bus_register (bus, &error))
152 g_error ("AT-SPI: Couldn't register with bus: %s\n", error.message);
160 set_reply (DBusPendingCall *pending, void *user_data)
162 void **replyptr = (void **)user_data;
164 *replyptr = dbus_pending_call_steal_reply (pending);
168 send_and_allow_reentry (DBusConnection *bus, DBusMessage *message, DBusError *error)
170 DBusPendingCall *pending;
171 DBusMessage *reply = NULL;
173 if (!dbus_connection_send_with_reply (bus, message, &pending, -1))
177 dbus_pending_call_set_notify (pending, set_reply, (void *)&reply, NULL);
180 if (!dbus_connection_read_write_dispatch (bus, -1)) return NULL;
184 /*---------------------------------------------------------------------------*/
187 register_application (SpiBridge * app)
189 DBusMessage *message, *reply;
190 DBusMessageIter iter;
193 dbus_error_init (&error);
195 message = dbus_message_new_method_call (SPI_DBUS_NAME_REGISTRY,
197 SPI_DBUS_INTERFACE_SOCKET,
200 dbus_message_iter_init_append (message, &iter);
201 spi_object_append_reference (&iter, app->root);
203 reply = send_and_allow_reentry (app->bus, message, &error);
206 dbus_message_unref (message);
210 DBusMessageIter iter, iter_struct;
211 gchar *app_name, *obj_path;
213 if (strcmp (dbus_message_get_signature (reply), "(so)") != 0)
215 g_warning ("AT-SPI: Could not obtain desktop path or name\n");
219 dbus_message_iter_init (reply, &iter);
220 dbus_message_iter_recurse (&iter, &iter_struct);
221 dbus_message_iter_get_basic (&iter_struct, &app_name);
222 dbus_message_iter_next (&iter_struct);
223 dbus_message_iter_get_basic (&iter_struct, &obj_path);
225 app->desktop_name = g_strdup (app_name);
226 app->desktop_path = g_strdup (obj_path);
230 g_warning ("AT-SPI: Could not embed inside desktop: %s\n", error.message);
236 /*---------------------------------------------------------------------------*/
239 deregister_application (SpiBridge * app)
241 DBusMessage *message;
242 DBusMessageIter iter;
246 dbus_error_init (&error);
248 message = dbus_message_new_method_call (SPI_DBUS_NAME_REGISTRY,
249 SPI_DBUS_PATH_REGISTRY,
250 SPI_DBUS_INTERFACE_REGISTRY,
251 "DeregisterApplication");
252 dbus_message_set_no_reply (message, TRUE);
254 uname = dbus_bus_get_unique_name (app->bus);
256 dbus_message_iter_init_append (message, &iter);
257 dbus_message_iter_append_basic (&iter, DBUS_TYPE_STRING, &uname);
258 dbus_connection_send (app->bus, message, NULL);
260 dbus_message_unref (message);
263 /*---------------------------------------------------------------------------*/
268 if (!spi_global_app_data)
273 spi_atk_tidy_windows ();
274 spi_atk_deregister_event_listeners ();
275 deregister_application (spi_global_app_data);
277 g_free (spi_global_app_data);
278 spi_global_app_data = NULL;
280 /* Not currently creating an XDisplay */
283 XCloseDisplay (bridge_display);
287 /*---------------------------------------------------------------------------*/
289 static AtkPlugClass *plug_class;
290 static AtkSocketClass *socket_class;
293 get_plug_id (AtkPlug * plug)
295 const char *uname = dbus_bus_get_unique_name (spi_global_app_data->bus);
297 GString *str = g_string_new (NULL);
299 path = spi_register_object_to_path (spi_global_register, G_OBJECT (plug));
300 g_string_printf (str, "%s:%s", uname, path);
302 return g_string_free (str, FALSE);
306 socket_ref_state_set (AtkObject *accessible)
308 char *child_name, *child_path;
309 AtkSocket *socket = ATK_SOCKET (accessible);
313 DBusMessage *message, *reply;
314 DBusMessageIter iter, iter_array;
317 if (!socket->embedded_plug_id)
320 child_name = g_strdup (socket->embedded_plug_id);
323 child_path = g_utf8_strchr (child_name + 1, -1, ':');
329 *(child_path++) = '\0';
330 message = dbus_message_new_method_call (child_name, child_path, SPI_DBUS_INTERFACE_ACCESSIBLE, "GetState");
332 reply = dbus_connection_send_with_reply_and_block (spi_global_app_data->bus, message, 1, NULL);
333 dbus_message_unref (message);
336 if (strcmp (dbus_message_get_signature (reply), "au") != 0)
338 dbus_message_unref (reply);
341 set = atk_state_set_new ();
344 dbus_message_iter_init (reply, &iter);
345 dbus_message_iter_recurse (&iter, &iter_array);
348 dbus_message_iter_get_basic (&iter_array, &v);
349 for (j = 0; j < 32; j++)
353 AtkState state = spi_atk_state_from_spi_state ((count << 5) + j);
354 atk_state_set_add_state (set, state);
359 while (dbus_message_iter_next (&iter_array));
360 dbus_message_unref (reply);
365 socket_embed_hook (AtkSocket * socket, gchar * plug_id)
367 AtkObject *accessible = ATK_OBJECT(socket);
368 gchar *plug_name, *plug_path;
369 AtkObjectClass *klass;
371 /* Force registration */
372 gchar *path = spi_register_object_to_path (spi_global_register, G_OBJECT (accessible));
373 /* Let the plug know that it has been embedded */
374 plug_name = g_strdup (plug_id);
380 plug_path = g_utf8_strchr (plug_name + 1, -1, ':');
383 DBusMessage *message;
384 *(plug_path++) = '\0';
385 message = dbus_message_new_method_call (plug_name, plug_path, SPI_DBUS_INTERFACE_SOCKET, "Embedded");
386 dbus_message_append_args (message, DBUS_TYPE_STRING, &path, DBUS_TYPE_INVALID);
387 dbus_connection_send (spi_global_app_data->bus, message, NULL);
392 klass = ATK_OBJECT_GET_CLASS (accessible);
393 klass->ref_state_set = socket_ref_state_set;
397 install_plug_hooks ()
401 data = g_type_class_ref (ATK_TYPE_PLUG);
402 plug_class = ATK_PLUG_CLASS (data);
403 data = g_type_class_ref (ATK_TYPE_SOCKET);
404 socket_class = ATK_SOCKET_CLASS (data);
405 plug_class->get_object_id = get_plug_id;
406 socket_class->embed = socket_embed_hook;
409 gchar *atspi_dbus_name = NULL;
410 static gboolean atspi_no_register = FALSE;
412 static GOptionEntry atspi_option_entries[] = {
413 {"atspi-dbus-name", 0, 0, G_OPTION_ARG_STRING, &atspi_dbus_name,
414 "D-Bus bus name to register as", NULL},
415 {"atspi-no-register", 0, 0, G_OPTION_ARG_NONE, &atspi_no_register,
416 "Do not register with Registry Daemon", NULL},
421 introspect_children_cb (char *path, void *data)
423 if (!strcmp (path, "/org/a11y/atspi/accessible"))
425 return g_strdup ("<node name=\"root\"/>\n");
426 /* TODO: Should we place the whole hierarchy here? */
434 * The following needs to be initialized.
436 * - DRoute for routing message to their accessible objects.
437 * - Event handlers for emmitting signals on specific ATK events.
438 * - Application registration with the AT-SPI registry.
442 adaptor_init (gint * argc, gchar ** argv[])
449 gchar *introspection_directory;
450 static gboolean inited = FALSE;
457 DRoutePath *treepath, *accpath;
459 root = atk_get_root ();
460 g_return_val_if_fail (root, 0);
462 /* Parse command line options */
463 opt = g_option_context_new (NULL);
464 g_option_context_add_main_entries (opt, atspi_option_entries, NULL);
465 g_option_context_set_ignore_unknown_options (opt, TRUE);
466 if (!g_option_context_parse (opt, argc, argv, &err))
467 g_warning ("AT-SPI Option parsing failed: %s\n", err->message);
469 /* Allocate global data and do ATK initializations */
470 spi_global_app_data = g_new0 (SpiBridge, 1);
471 atk_misc = atk_misc_get_instance ();
472 spi_global_app_data->root = g_object_ref (root);
474 /* Set up D-Bus connection and register bus name */
475 dbus_error_init (&error);
476 spi_global_app_data->bus = spi_atk_bridge_get_bus ();
477 if (!spi_global_app_data->bus)
479 g_free (spi_global_app_data);
480 spi_global_app_data = NULL;
484 if (atspi_dbus_name != NULL)
486 if (dbus_bus_request_name
487 (spi_global_app_data->bus, atspi_dbus_name, 0, &error))
489 g_print ("AT-SPI Recieved D-Bus name - %s\n", atspi_dbus_name);
494 ("AT-SPI D-Bus name requested but could not be allocated - %s\n",
499 dbus_connection_setup_with_g_main (spi_global_app_data->bus,
500 g_main_context_default ());
502 /* Hook our plug-and socket functions */
503 install_plug_hooks ();
506 * Create the leasing, register and cache objects.
507 * The order is important here, the cache depends on the
510 spi_global_register = g_object_new (SPI_REGISTER_TYPE, NULL);
511 spi_global_leasing = g_object_new (SPI_LEASING_TYPE, NULL);
512 spi_global_cache = g_object_new (SPI_CACHE_TYPE, NULL);
514 /* Register droute for routing AT-SPI messages */
515 spi_global_app_data->droute =
516 droute_new (spi_global_app_data->bus);
518 treepath = droute_add_one (spi_global_app_data->droute,
519 "/org/a11y/atspi/cache", spi_global_cache);
523 g_warning ("atk-bridge: Error in droute_add_one(). Already running?");
527 accpath = droute_add_many (spi_global_app_data->droute,
528 "/org/a11y/atspi/accessible",
530 introspect_children_cb,
532 (DRouteGetDatumFunction)
533 spi_global_register_path_to_object);
536 /* Register all interfaces with droute and set up application accessible db */
537 spi_initialize_cache (treepath);
538 spi_initialize_accessible (accpath);
539 spi_initialize_application (accpath);
540 spi_initialize_action (accpath);
541 spi_initialize_collection (accpath);
542 spi_initialize_component (accpath);
543 spi_initialize_document (accpath);
544 spi_initialize_editabletext (accpath);
545 spi_initialize_hyperlink (accpath);
546 spi_initialize_hypertext (accpath);
547 spi_initialize_image (accpath);
548 spi_initialize_selection (accpath);
549 spi_initialize_socket (accpath);
550 spi_initialize_table (accpath);
551 spi_initialize_text (accpath);
552 spi_initialize_value (accpath);
554 /* Register methods to send D-Bus signals on certain ATK events */
555 spi_atk_register_event_listeners ();
557 /* Register this app by sending a signal out to AT-SPI registry daemon */
558 if (!atspi_no_register && (!root || !ATK_IS_PLUG (root)))
559 register_application (spi_global_app_data);
561 g_atexit (exit_func);
566 /*---------------------------------------------------------------------------*/
569 gtk_module_init (gint * argc, gchar ** argv[])
571 const gchar *load_bridge = g_getenv ("NO_AT_BRIDGE");
573 if (!load_bridge || g_ascii_strtod (load_bridge, NULL) == 0)
575 return adaptor_init (argc, argv);
581 gnome_accessibility_module_init (void)
583 const gchar *load_bridge = g_getenv ("NO_AT_BRIDGE");
585 if (!load_bridge || g_ascii_strtod (load_bridge, NULL) == 0)
587 adaptor_init (NULL, NULL);
589 if (g_getenv ("AT_SPI_DEBUG"))
591 g_print ("Atk Accessibility bridge initialized\n");
597 gnome_accessibility_module_shutdown (void)
599 spi_atk_deregister_event_listeners ();
603 /*END------------------------------------------------------------------------*/