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);
159 /*---------------------------------------------------------------------------*/
162 register_application (SpiBridge * app)
164 DBusMessage *message, *reply;
165 DBusMessageIter iter;
168 dbus_error_init (&error);
170 message = dbus_message_new_method_call (SPI_DBUS_NAME_REGISTRY,
172 SPI_DBUS_INTERFACE_SOCKET,
175 dbus_message_iter_init_append (message, &iter);
176 spi_object_append_reference (&iter, app->root);
178 reply = dbus_connection_send_with_reply_and_block (app->bus, message, -1, &error);
181 dbus_message_unref (message);
185 DBusMessageIter iter, iter_struct;
186 gchar *app_name, *obj_path;
188 dbus_message_iter_init (reply, &iter);
189 dbus_message_iter_recurse (&iter, &iter_struct);
190 if (!(dbus_message_iter_get_arg_type (&iter_struct) == DBUS_TYPE_STRING))
191 g_error ("AT-SPI: Could not obtain desktop path or name\n");
192 dbus_message_iter_get_basic (&iter_struct, &app_name);
193 if (!dbus_message_iter_next (&iter_struct))
194 g_error ("AT-SPI: Could not obtain desktop name");
195 if (!(dbus_message_iter_get_arg_type (&iter_struct) == DBUS_TYPE_OBJECT_PATH))
196 g_error ("AT-SPI: Could not obtain desktop path");
197 dbus_message_iter_get_basic (&iter_struct, &obj_path);
199 app->desktop_name = g_strdup (app_name);
200 app->desktop_path = g_strdup (obj_path);
204 g_error ("AT-SPI: Could not embed inside desktop: %s\n", error.message);
209 /*---------------------------------------------------------------------------*/
212 deregister_application (SpiBridge * app)
214 DBusMessage *message;
215 DBusMessageIter iter;
219 dbus_error_init (&error);
221 message = dbus_message_new_method_call (SPI_DBUS_NAME_REGISTRY,
222 SPI_DBUS_PATH_REGISTRY,
223 SPI_DBUS_INTERFACE_REGISTRY,
224 "DeregisterApplication");
225 dbus_message_set_no_reply (message, TRUE);
227 uname = dbus_bus_get_unique_name (app->bus);
229 dbus_message_iter_init_append (message, &iter);
230 dbus_message_iter_append_basic (&iter, DBUS_TYPE_STRING, &uname);
231 dbus_connection_send (app->bus, message, NULL);
233 dbus_message_unref (message);
236 /*---------------------------------------------------------------------------*/
241 if (!spi_global_app_data)
246 spi_atk_tidy_windows ();
247 spi_atk_deregister_event_listeners ();
248 deregister_application (spi_global_app_data);
250 g_free (spi_global_app_data);
251 spi_global_app_data = NULL;
253 /* Not currently creating an XDisplay */
256 XCloseDisplay (bridge_display);
260 /*---------------------------------------------------------------------------*/
262 static AtkPlugClass *plug_class;
263 static AtkSocketClass *socket_class;
266 get_plug_id (AtkPlug * plug)
268 const char *uname = dbus_bus_get_unique_name (spi_global_app_data->bus);
270 GString *str = g_string_new (NULL);
272 path = spi_register_object_to_path (spi_global_register, G_OBJECT (plug));
273 g_string_printf (str, "%s:%s", uname, path);
275 return g_string_free (str, FALSE);
279 socket_embed_hook (AtkSocket * socket, gchar * plug_id)
281 AtkObject *accessible = ATK_OBJECT(socket);
282 gchar *plug_name, *plug_path;
284 /* Force registration */
285 gchar *path = spi_register_object_to_path (spi_global_register, G_OBJECT (accessible));
286 /* Let the plug know that it has been embedded */
287 plug_name = g_strdup (plug_id);
293 plug_path = g_utf8_strchr (plug_name + 1, -1, ':');
296 DBusMessage *message;
297 *(plug_path++) = '\0';
298 message = dbus_message_new_method_call (plug_name, plug_path, "org.freedesktop.atspi.Accessible", "Embedded");
299 dbus_message_append_args (message, DBUS_TYPE_STRING, &path, DBUS_TYPE_INVALID);
300 dbus_connection_send (spi_global_app_data->bus, message, NULL);
307 install_plug_hooks ()
311 data = g_type_class_ref (ATK_TYPE_PLUG);
312 plug_class = ATK_PLUG_CLASS (data);
313 data = g_type_class_ref (ATK_TYPE_SOCKET);
314 socket_class = ATK_SOCKET_CLASS (data);
315 plug_class->get_object_id = get_plug_id;
316 socket_class->embed = socket_embed_hook;
319 gchar *atspi_dbus_name = NULL;
320 static gboolean atspi_no_register = FALSE;
322 static GOptionEntry atspi_option_entries[] = {
323 {"atspi-dbus-name", 0, 0, G_OPTION_ARG_STRING, &atspi_dbus_name,
324 "D-Bus bus name to register as", NULL},
325 {"atspi-no-register", 0, 0, G_OPTION_ARG_NONE, &atspi_no_register,
326 "Do not register with Registry Daemon", NULL},
333 * The following needs to be initialized.
335 * - DRoute for routing message to their accessible objects.
336 * - Event handlers for emmitting signals on specific ATK events.
337 * - Application registration with the AT-SPI registry.
341 adaptor_init (gint * argc, gchar ** argv[])
348 gchar *introspection_directory;
349 static gboolean inited = FALSE;
356 DRoutePath *treepath, *accpath;
358 root = atk_get_root ();
359 g_return_val_if_fail (root, 0);
361 /* Parse command line options */
362 opt = g_option_context_new (NULL);
363 g_option_context_add_main_entries (opt, atspi_option_entries, NULL);
364 g_option_context_set_ignore_unknown_options (opt, TRUE);
365 if (!g_option_context_parse (opt, argc, argv, &err))
366 g_warning ("AT-SPI Option parsing failed: %s\n", err->message);
368 /* Allocate global data and do ATK initializations */
369 spi_global_app_data = g_new0 (SpiBridge, 1);
370 atk_misc = atk_misc_get_instance ();
371 spi_global_app_data->root = g_object_ref (root);
373 /* Set up D-Bus connection and register bus name */
374 dbus_error_init (&error);
375 spi_global_app_data->bus = spi_atk_bridge_get_bus ();
376 if (!spi_global_app_data->bus)
378 g_free (spi_global_app_data);
379 spi_global_app_data = NULL;
383 if (atspi_dbus_name != NULL)
385 if (dbus_bus_request_name
386 (spi_global_app_data->bus, atspi_dbus_name, 0, &error))
388 g_print ("AT-SPI Recieved D-Bus name - %s\n", atspi_dbus_name);
393 ("AT-SPI D-Bus name requested but could not be allocated - %s\n",
398 dbus_connection_setup_with_g_main (spi_global_app_data->bus,
399 g_main_context_default ());
402 * Create the leasing, register and cache objects.
403 * The order is important here, the cache depends on the
406 spi_global_register = g_object_new (SPI_REGISTER_TYPE, NULL);
407 spi_global_leasing = g_object_new (SPI_LEASING_TYPE, NULL);
408 spi_global_cache = g_object_new (SPI_CACHE_TYPE, NULL);
410 /* Register droute for routing AT-SPI messages */
411 spi_global_app_data->droute =
412 droute_new (spi_global_app_data->bus);
414 treepath = droute_add_one (spi_global_app_data->droute,
415 "/org/at_spi/cache", spi_global_cache);
417 accpath = droute_add_many (spi_global_app_data->droute,
418 "/org/freedesktop/atspi/accessible",
420 (DRouteGetDatumFunction)
421 spi_global_register_path_to_object);
424 /* Register all interfaces with droute and set up application accessible db */
425 spi_initialize_cache (treepath);
426 spi_initialize_accessible (accpath);
427 spi_initialize_application (accpath);
428 spi_initialize_action (accpath);
429 spi_initialize_collection (accpath);
430 spi_initialize_component (accpath);
431 spi_initialize_document (accpath);
432 spi_initialize_editabletext (accpath);
433 spi_initialize_hyperlink (accpath);
434 spi_initialize_hypertext (accpath);
435 spi_initialize_image (accpath);
436 spi_initialize_selection (accpath);
437 spi_initialize_table (accpath);
438 spi_initialize_text (accpath);
439 spi_initialize_value (accpath);
441 /* Register methods to send D-Bus signals on certain ATK events */
442 spi_atk_register_event_listeners ();
444 /* Hook our plug-and socket functions */
445 install_plug_hooks ();
447 /* Register this app by sending a signal out to AT-SPI registry daemon */
448 if (!atspi_no_register)
449 register_application (spi_global_app_data);
451 g_atexit (exit_func);
456 /*---------------------------------------------------------------------------*/
459 gtk_module_init (gint * argc, gchar ** argv[])
461 const gchar *load_bridge = g_getenv ("NO_AT_BRIDGE");
463 if (!load_bridge || g_ascii_strtod (load_bridge, NULL) == 0)
465 return adaptor_init (argc, argv);
471 gnome_accessibility_module_init (void)
473 const gchar *load_bridge = g_getenv ("NO_AT_BRIDGE");
475 if (!load_bridge || g_ascii_strtod (load_bridge, NULL) == 0)
477 adaptor_init (NULL, NULL);
479 if (g_getenv ("AT_SPI_DEBUG"))
481 g_print ("Atk Accessibility bridge initialized\n");
487 gnome_accessibility_module_shutdown (void)
489 spi_atk_deregister_event_listeners ();
493 /*END------------------------------------------------------------------------*/