2 * AT-SPI - Assistive Technology Service Provider Interface
3 * (Gnome Accessibility Project; http://developer.gnome.org/projects/gap)
5 * Copyright 2001, 2002 Sun Microsystems Inc.,
6 * Copyright 2001, 2002 Ximian, Inc.
7 * Copyright 2010, 2011 Novell, 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.
27 * Basic SPI initialization and event loop function prototypes
31 #include "atspi-private.h"
33 #include "atspi-gmain.h"
37 static void handle_get_items (DBusPendingCall *pending, void *user_data);
39 static DBusConnection *bus = NULL;
40 static GHashTable *live_refs = NULL;
41 static gint method_call_timeout = 800;
42 static gint app_startup_time = 1000;
44 GMainLoop *atspi_main_loop;
45 gboolean atspi_no_cache;
47 const char *atspi_path_dec = ATSPI_DBUS_PATH_DEC;
48 const char *atspi_path_registry = ATSPI_DBUS_PATH_REGISTRY;
49 const char *atspi_path_root = ATSPI_DBUS_PATH_ROOT;
50 const char *atspi_bus_registry = ATSPI_DBUS_NAME_REGISTRY;
51 const char *atspi_interface_accessible = ATSPI_DBUS_INTERFACE_ACCESSIBLE;
52 const char *atspi_interface_action = ATSPI_DBUS_INTERFACE_ACTION;
53 const char *atspi_interface_application = ATSPI_DBUS_INTERFACE_APPLICATION;
54 const char *atspi_interface_collection = ATSPI_DBUS_INTERFACE_COLLECTION;
55 const char *atspi_interface_component = ATSPI_DBUS_INTERFACE_COMPONENT;
56 const char *atspi_interface_dec = ATSPI_DBUS_INTERFACE_DEC;
57 const char *atspi_interface_device_event_listener = ATSPI_DBUS_INTERFACE_DEVICE_EVENT_LISTENER;
58 const char *atspi_interface_document = ATSPI_DBUS_INTERFACE_DOCUMENT;
59 const char *atspi_interface_editable_text = ATSPI_DBUS_INTERFACE_EDITABLE_TEXT;
60 const char *atspi_interface_event_object = ATSPI_DBUS_INTERFACE_EVENT_OBJECT;
61 const char *atspi_interface_hyperlink = ATSPI_DBUS_INTERFACE_HYPERLINK;
62 const char *atspi_interface_hypertext = ATSPI_DBUS_INTERFACE_HYPERTEXT;
63 const char *atspi_interface_image = ATSPI_DBUS_INTERFACE_IMAGE;
64 const char *atspi_interface_registry = ATSPI_DBUS_INTERFACE_REGISTRY;
65 const char *atspi_interface_selection = ATSPI_DBUS_INTERFACE_SELECTION;
66 const char *atspi_interface_table = ATSPI_DBUS_INTERFACE_TABLE;
67 const char *atspi_interface_text = ATSPI_DBUS_INTERFACE_TEXT;
68 const char *atspi_interface_cache = ATSPI_DBUS_INTERFACE_CACHE;
69 const char *atspi_interface_value = ATSPI_DBUS_INTERFACE_VALUE;
71 static const char *interfaces[] =
73 ATSPI_DBUS_INTERFACE_ACCESSIBLE,
74 ATSPI_DBUS_INTERFACE_ACTION,
75 ATSPI_DBUS_INTERFACE_APPLICATION,
76 ATSPI_DBUS_INTERFACE_COLLECTION,
77 ATSPI_DBUS_INTERFACE_COMPONENT,
78 ATSPI_DBUS_INTERFACE_DOCUMENT,
79 ATSPI_DBUS_INTERFACE_EDITABLE_TEXT,
80 ATSPI_DBUS_INTERFACE_HYPERLINK,
81 ATSPI_DBUS_INTERFACE_HYPERTEXT,
82 ATSPI_DBUS_INTERFACE_IMAGE,
83 "org.a11y.atspi.LoginHelper",
84 ATSPI_DBUS_INTERFACE_SELECTION,
85 ATSPI_DBUS_INTERFACE_TABLE,
86 ATSPI_DBUS_INTERFACE_TEXT,
87 ATSPI_DBUS_INTERFACE_VALUE,
92 _atspi_get_iface_num (const char *iface)
94 /* TODO: Use a binary search or hash to improve performance */
97 for (i = 0; interfaces[i]; i++)
99 if (!strcmp(iface, interfaces[i])) return i;
109 live_refs = g_hash_table_new (g_direct_hash, g_direct_equal);
114 /* TODO: Add an application parameter */
121 g_error ("AT-SPI: COuldn't connect to accessibility bus. Is at-spi-bus-launcher running?");
125 #define APP_IS_REGISTRY(app) (!strcmp (app->bus_name, atspi_bus_registry))
136 g_hash_table_destroy (refs);
140 static gboolean atspi_inited = FALSE;
142 static GHashTable *app_hash = NULL;
145 handle_get_bus_address (DBusPendingCall *pending, void *user_data)
147 AtspiApplication *app = user_data;
148 DBusMessage *reply = dbus_pending_call_steal_reply (pending);
149 DBusMessage *message;
151 DBusPendingCall *new_pending;
153 if (dbus_message_get_type (reply) == DBUS_MESSAGE_TYPE_METHOD_RETURN)
155 if (dbus_message_get_args (reply, NULL, DBUS_TYPE_STRING, &address,
159 dbus_error_init (&error);
160 DBusConnection *bus = dbus_connection_open (address, &error);
164 dbus_connection_unref (app->bus);
169 dbus_message_unref (reply);
170 dbus_pending_call_unref (pending);
173 return; /* application has gone away / been disposed */
175 message = dbus_message_new_method_call (app->bus_name,
176 "/org/a11y/atspi/cache",
177 atspi_interface_cache, "GetItems");
179 dbus_connection_send_with_reply (app->bus, message, &new_pending, 2000);
180 dbus_pending_call_set_notify (new_pending, handle_get_items, app, NULL);
181 dbus_message_unref (message);
184 static AtspiApplication *
185 get_application (const char *bus_name)
187 AtspiApplication *app = NULL;
189 DBusMessage *message;
191 DBusPendingCall *pending = NULL;
195 app_hash = g_hash_table_new_full (g_str_hash, g_str_equal, g_free, (GDestroyNotify)g_object_unref);
196 if (!app_hash) return NULL;
198 app = g_hash_table_lookup (app_hash, bus_name);
200 bus_name_dup = g_strdup (bus_name);
201 if (!bus_name_dup) return NULL;
202 // TODO: change below to something that will send state-change:defunct notification if necessary */
203 app = _atspi_application_new (bus_name);
204 if (!app) return NULL;
205 app->hash = g_hash_table_new_full (g_str_hash, g_str_equal, g_free, g_object_unref);
206 app->bus = dbus_connection_ref (_atspi_bus ());
207 gettimeofday (&app->time_added, NULL);
208 app->cache = ATSPI_CACHE_UNDEFINED;
209 g_hash_table_insert (app_hash, bus_name_dup, app);
210 dbus_error_init (&error);
211 message = dbus_message_new_method_call (bus_name, atspi_path_root,
212 atspi_interface_application, "GetApplicationBusAddress");
214 dbus_connection_send_with_reply (app->bus, message, &pending, 2000);
215 dbus_pending_call_set_notify (pending, handle_get_bus_address, app, NULL);
216 dbus_message_unref (message);
220 static AtspiAccessible *
221 ref_accessible (const char *app_name, const char *path)
223 AtspiApplication *app;
226 if (!strcmp (path, ATSPI_DBUS_PATH_NULL))
229 app = get_application (app_name);
231 if (!strcmp (path, "/org/a11y/atspi/accessible/root"))
235 app->root = _atspi_accessible_new (app, atspi_path_root);
236 app->root->accessible_parent = atspi_get_desktop (0);
238 return g_object_ref (app->root);
241 a = g_hash_table_lookup (app->hash, path);
244 return g_object_ref (a);
246 a = _atspi_accessible_new (app, path);
249 g_hash_table_insert (app->hash, g_strdup (a->parent.path), a);
250 g_object_ref (a); /* for the hash */
254 static AtspiHyperlink *
255 ref_hyperlink (const char *app_name, const char *path)
257 AtspiApplication *app = get_application (app_name);
258 AtspiHyperlink *hyperlink;
260 if (!strcmp (path, ATSPI_DBUS_PATH_NULL))
263 hyperlink = g_hash_table_lookup (app->hash, path);
266 return g_object_ref (hyperlink);
268 hyperlink = _atspi_hyperlink_new (app, path);
269 g_hash_table_insert (app->hash, g_strdup (hyperlink->parent.path), hyperlink);
270 /* TODO: This should be a weak ref */
271 g_object_ref (hyperlink); /* for the hash */
284 GArray *state_bitflags;
287 static DBusHandlerResult
288 handle_remove_accessible (DBusConnection *bus, DBusMessage *message, void *user_data)
290 const char *sender = dbus_message_get_sender (message);
291 AtspiApplication *app;
293 DBusMessageIter iter, iter_struct;
294 const char *signature = dbus_message_get_signature (message);
297 if (strcmp (signature, "(so)") != 0)
299 g_warning ("AT-SPI: Unknown signature %s for RemoveAccessible", signature);
300 return DBUS_HANDLER_RESULT_HANDLED;
303 dbus_message_iter_init (message, &iter);
304 dbus_message_iter_recurse (&iter, &iter_struct);
305 dbus_message_iter_get_basic (&iter_struct, &sender);
306 dbus_message_iter_next (&iter_struct);
307 dbus_message_iter_get_basic (&iter_struct, &path);
308 app = get_application (sender);
309 a = ref_accessible (sender, path);
311 return DBUS_HANDLER_RESULT_HANDLED;
312 g_object_run_dispose (G_OBJECT (a));
313 g_hash_table_remove (app->hash, a->parent.path);
314 g_object_unref (a); /* unref our own ref */
315 return DBUS_HANDLER_RESULT_HANDLED;
319 add_app_to_desktop (AtspiAccessible *a, const char *bus_name)
323 dbus_error_init (&error);
324 AtspiAccessible *obj = ref_accessible (bus_name, atspi_path_root);
327 GList *new_list = g_list_append (a->children, obj);
330 a->children = new_list;
336 g_warning ("AT-SPI: Error calling getRoot for %s: %s", bus_name, error.message);
342 send_children_changed (AtspiAccessible *parent, AtspiAccessible *child, gboolean add)
346 memset (&e, 0, sizeof (e));
347 e.type = (add? "object:children-changed:add": "object:children-changed:remove");
349 e.detail1 = g_list_index (parent->children, child);
351 _atspi_send_event (&e);
355 unref_object_and_descendants (AtspiAccessible *obj)
359 for (l = obj->children; l; l = l->next)
361 unref_object_and_descendants (l->data);
363 g_object_unref (obj);
367 remove_app_from_desktop (AtspiAccessible *a, const char *bus_name)
370 AtspiAccessible *child;
372 for (l = a->children; l; l = l->next)
375 if (!strcmp (bus_name, child->parent.app->bus_name)) break;
381 send_children_changed (a, child, FALSE);
382 a->children = g_list_remove (a->children, child);
383 unref_object_and_descendants (child);
387 static AtspiAccessible *desktop;
390 get_reference_from_iter (DBusMessageIter *iter, const char **app_name, const char **path)
392 DBusMessageIter iter_struct;
394 dbus_message_iter_recurse (iter, &iter_struct);
395 dbus_message_iter_get_basic (&iter_struct, app_name);
396 dbus_message_iter_next (&iter_struct);
397 dbus_message_iter_get_basic (&iter_struct, path);
398 dbus_message_iter_next (iter);
402 add_accessible_from_iter (DBusMessageIter *iter)
404 DBusMessageIter iter_struct, iter_array;
405 const char *app_name, *path;
406 AtspiAccessible *accessible;
407 const char *name, *description;
410 dbus_message_iter_recurse (iter, &iter_struct);
413 get_reference_from_iter (&iter_struct, &app_name, &path);
414 accessible = ref_accessible (app_name, path);
418 /* Get application: TODO */
419 dbus_message_iter_next (&iter_struct);
422 get_reference_from_iter (&iter_struct, &app_name, &path);
423 if (accessible->accessible_parent)
424 g_object_unref (accessible->accessible_parent);
425 accessible->accessible_parent = ref_accessible (app_name, path);
428 while (accessible->children)
430 g_object_unref (accessible->children->data);
431 accessible->children = g_list_remove (accessible->children, accessible->children->data);
433 dbus_message_iter_recurse (&iter_struct, &iter_array);
434 while (dbus_message_iter_get_arg_type (&iter_array) != DBUS_TYPE_INVALID)
436 AtspiAccessible *child;
437 get_reference_from_iter (&iter_array, &app_name, &path);
438 child = ref_accessible (app_name, path);
439 accessible->children = g_list_append (accessible->children, child);
443 dbus_message_iter_next (&iter_struct);
444 _atspi_dbus_set_interfaces (accessible, &iter_struct);
445 dbus_message_iter_next (&iter_struct);
448 if (accessible->name)
449 g_free (accessible->name);
450 dbus_message_iter_get_basic (&iter_struct, &name);
451 accessible->name = g_strdup (name);
452 dbus_message_iter_next (&iter_struct);
455 dbus_message_iter_get_basic (&iter_struct, &role);
456 accessible->role = role;
457 dbus_message_iter_next (&iter_struct);
460 if (accessible->description)
461 g_free (accessible->description);
462 dbus_message_iter_get_basic (&iter_struct, &description);
463 accessible->description = g_strdup (description);
464 dbus_message_iter_next (&iter_struct);
466 _atspi_dbus_set_state (accessible, &iter_struct);
467 dbus_message_iter_next (&iter_struct);
469 _atspi_accessible_add_cache (accessible, ATSPI_CACHE_NAME | ATSPI_CACHE_ROLE |
470 ATSPI_CACHE_PARENT | ATSPI_CACHE_DESCRIPTION);
471 if (!atspi_state_set_contains (accessible->states,
472 ATSPI_STATE_MANAGES_DESCENDANTS))
473 _atspi_accessible_add_cache (accessible, ATSPI_CACHE_CHILDREN);
475 /* This is a bit of a hack since the cache holds a ref, so we don't need
476 * the one provided for us anymore */
477 g_object_unref (accessible);
481 handle_get_items (DBusPendingCall *pending, void *user_data)
483 DBusMessage *reply = dbus_pending_call_steal_reply (pending);
484 DBusMessageIter iter, iter_array;
486 if (dbus_message_get_type (reply) == DBUS_MESSAGE_TYPE_ERROR)
488 const char *sender = dbus_message_get_sender (reply);
489 const char *error = NULL;
490 dbus_message_get_args (reply, NULL, DBUS_TYPE_STRING, &error,
492 g_warning ("AT-SPI: Error in GetItems, sender=%s, error=%s", sender, error);
493 dbus_message_unref (reply);
494 dbus_pending_call_unref (pending);
498 dbus_message_iter_init (reply, &iter);
499 dbus_message_iter_recurse (&iter, &iter_array);
500 while (dbus_message_iter_get_arg_type (&iter_array) != DBUS_TYPE_INVALID)
502 add_accessible_from_iter (&iter_array);
503 dbus_message_iter_next (&iter_array);
505 dbus_message_unref (reply);
506 dbus_pending_call_unref (pending);
509 /* TODO: Do we stil need this function? */
510 static AtspiAccessible *
511 ref_accessible_desktop (AtspiApplication *app)
514 DBusMessage *message, *reply;
515 DBusMessageIter iter, iter_array;
520 g_object_ref (desktop);
523 desktop = _atspi_accessible_new (app, atspi_path_root);
528 g_hash_table_insert (app->hash, desktop->parent.path, desktop);
529 g_object_ref (desktop); /* for the hash */
530 desktop->name = g_strdup ("main");
531 dbus_error_init (&error);
532 message = dbus_message_new_method_call (atspi_bus_registry,
534 atspi_interface_accessible,
538 reply = _atspi_dbus_send_with_reply_and_block (message, NULL);
539 if (!reply || strcmp (dbus_message_get_signature (reply), "a(so)") != 0)
541 g_warning ("Couldn't get application list: %s", error.message);
543 dbus_message_unref (reply);
546 dbus_message_iter_init (reply, &iter);
547 dbus_message_iter_recurse (&iter, &iter_array);
548 while (dbus_message_iter_get_arg_type (&iter_array) != DBUS_TYPE_INVALID)
550 const char *app_name, *path;
551 get_reference_from_iter (&iter_array, &app_name, &path);
552 add_app_to_desktop (desktop, app_name);
554 dbus_message_unref (reply);
556 /* Record the alternate name as an alias for org.a11y.atspi.Registry */
557 bus_name_dup = g_strdup (dbus_message_get_sender (reply));
559 g_hash_table_insert (app_hash, bus_name_dup, app);
565 _atspi_ref_accessible (const char *app, const char *path)
567 AtspiApplication *a = get_application (app);
569 if ( APP_IS_REGISTRY(a))
571 return a->root = ref_accessible_desktop (a);
573 return ref_accessible (app, path);
577 _atspi_dbus_return_accessible_from_message (DBusMessage *message)
579 DBusMessageIter iter;
580 AtspiAccessible *retval = NULL;
581 const char *signature;
586 signature = dbus_message_get_signature (message);
587 if (!strcmp (signature, "(so)"))
589 dbus_message_iter_init (message, &iter);
590 retval = _atspi_dbus_return_accessible_from_iter (&iter);
594 g_warning ("AT-SPI: Called _atspi_dbus_return_accessible_from_message with strange signature %s", signature);
596 dbus_message_unref (message);
601 _atspi_dbus_return_accessible_from_iter (DBusMessageIter *iter)
603 const char *app_name, *path;
605 get_reference_from_iter (iter, &app_name, &path);
606 return ref_accessible (app_name, path);
610 _atspi_dbus_return_hyperlink_from_message (DBusMessage *message)
612 DBusMessageIter iter;
613 AtspiHyperlink *retval = NULL;
614 const char *signature = dbus_message_get_signature (message);
616 if (!strcmp (signature, "(so)"))
618 dbus_message_iter_init (message, &iter);
619 retval = _atspi_dbus_return_hyperlink_from_iter (&iter);
623 g_warning ("AT-SPI: Called _atspi_dbus_return_hyperlink_from_message with strange signature %s", signature);
625 dbus_message_unref (message);
630 _atspi_dbus_return_hyperlink_from_iter (DBusMessageIter *iter)
632 const char *app_name, *path;
634 get_reference_from_iter (iter, &app_name, &path);
635 return ref_hyperlink (app_name, path);
638 const char *cache_signal_type = "((so)(so)(so)a(so)assusau)";
640 static DBusHandlerResult
641 handle_add_accessible (DBusConnection *bus, DBusMessage *message, void *user_data)
643 DBusMessageIter iter;
644 const char *sender = dbus_message_get_sender (message);
646 if (strcmp (dbus_message_get_signature (message), cache_signal_type) != 0)
648 g_warning ("AT-SPI: AddAccessible with unknown signature %s\n",
649 dbus_message_get_signature (message));
650 return DBUS_HANDLER_RESULT_HANDLED;
653 dbus_message_iter_init (message, &iter);
654 add_accessible_from_iter (&iter);
655 return DBUS_HANDLER_RESULT_HANDLED;
661 DBusMessage *message;
665 static guint process_deferred_messages_id = -1;
668 process_deferred_message (BusDataClosure *closure)
670 int type = dbus_message_get_type (closure->message);
671 const char *interface = dbus_message_get_interface (closure->message);
673 if (type == DBUS_MESSAGE_TYPE_SIGNAL &&
674 !strncmp (interface, "org.a11y.atspi.Event.", 21))
676 _atspi_dbus_handle_event (closure->bus, closure->message, closure->data);
678 if (dbus_message_is_method_call (closure->message, atspi_interface_device_event_listener, "NotifyEvent"))
680 _atspi_dbus_handle_DeviceEvent (closure->bus,
681 closure->message, closure->data);
683 if (dbus_message_is_signal (closure->message, atspi_interface_cache, "AddAccessible"))
685 handle_add_accessible (closure->bus, closure->message, closure->data);
687 if (dbus_message_is_signal (closure->message, atspi_interface_cache, "RemoveAccessible"))
689 handle_remove_accessible (closure->bus, closure->message, closure->data);
693 static GQueue *deferred_messages = NULL;
696 _atspi_process_deferred_messages (gpointer data)
698 static int in_process_deferred_messages = 0;
699 BusDataClosure *closure;
701 if (in_process_deferred_messages)
703 in_process_deferred_messages = 1;
704 while (closure = g_queue_pop_head (deferred_messages))
706 process_deferred_message (closure);
707 dbus_message_unref (closure->message);
708 dbus_connection_unref (closure->bus);
711 /* If data is NULL, assume that we were called from GLib */
713 process_deferred_messages_id = -1;
714 in_process_deferred_messages = 0;
718 static DBusHandlerResult
719 defer_message (DBusConnection *connection, DBusMessage *message, void *user_data)
721 BusDataClosure *closure = g_new (BusDataClosure, 1);
723 closure->bus = dbus_connection_ref (bus);
724 closure->message = dbus_message_ref (message);
725 closure->data = user_data;
727 g_queue_push_tail (deferred_messages, closure);
729 if (process_deferred_messages_id == -1)
730 process_deferred_messages_id = g_idle_add (_atspi_process_deferred_messages, NULL);
731 return DBUS_HANDLER_RESULT_HANDLED;
734 static DBusHandlerResult
735 atspi_dbus_filter (DBusConnection *bus, DBusMessage *message, void *data)
737 int type = dbus_message_get_type (message);
738 const char *interface = dbus_message_get_interface (message);
740 if (type == DBUS_MESSAGE_TYPE_SIGNAL &&
741 !strncmp (interface, "org.a11y.atspi.Event.", 21))
743 return defer_message (bus, message, data);
745 if (dbus_message_is_method_call (message, atspi_interface_device_event_listener, "NotifyEvent"))
747 return defer_message (bus, message, data);
749 if (dbus_message_is_signal (message, atspi_interface_cache, "AddAccessible"))
751 return defer_message (bus, message, data);
753 if (dbus_message_is_signal (message, atspi_interface_cache, "RemoveAccessible"))
755 return defer_message (bus, message, data);
757 return DBUS_HANDLER_RESULT_NOT_YET_HANDLED;
760 static const char *signal_interfaces[] =
762 "org.a11y.atspi.Event.Object",
763 "org.a11y.atspi.Event.Window",
764 "org.a11y.atspi.Event.Mouse",
765 "org.a11y.atspi.Event.Terminal",
766 "org.a11y.atspi.Event.Document",
767 "org.a11y.atspi.Event.Focus",
772 * Returns a 'canonicalized' value for DISPLAY,
773 * with the screen number stripped off if present.
775 * TODO: Avoid having duplicate functions for this here and in at-spi2-atk
778 spi_display_name (void)
780 static const char *canonical_display_name = NULL;
781 if (!canonical_display_name)
783 const gchar *display_env = g_getenv ("AT_SPI_DISPLAY");
786 display_env = g_getenv ("DISPLAY");
787 if (!display_env || !display_env[0])
788 canonical_display_name = ":0";
791 gchar *display_p, *screen_p;
792 canonical_display_name = g_strdup (display_env);
793 display_p = g_utf8_strrchr (canonical_display_name, -1, ':');
794 screen_p = g_utf8_strrchr (canonical_display_name, -1, '.');
795 if (screen_p && display_p && (screen_p > display_p))
803 canonical_display_name = display_env;
806 return canonical_display_name;
812 * Connects to the accessibility registry and initializes the SPI.
814 * Returns: 0 on success, otherwise an integer error code.
821 const gchar *no_cache;
834 dbus_error_init (&error);
835 bus = atspi_get_a11y_bus ();
838 dbus_bus_register (bus, &error);
839 atspi_dbus_connection_setup_with_g_main(bus, g_main_context_default());
840 dbus_connection_add_filter (bus, atspi_dbus_filter, NULL, NULL);
841 match = g_strdup_printf ("type='signal',interface='%s',member='AddAccessible'", atspi_interface_cache);
842 dbus_error_init (&error);
843 dbus_bus_add_match (bus, match, &error);
845 match = g_strdup_printf ("type='signal',interface='%s',member='RemoveAccessible'", atspi_interface_cache);
846 dbus_bus_add_match (bus, match, &error);
848 match = g_strdup_printf ("type='signal',interface='%s',member='ChildrenChanged'", atspi_interface_event_object);
849 dbus_bus_add_match (bus, match, &error);
851 match = g_strdup_printf ("type='signal',interface='%s',member='PropertyChange'", atspi_interface_event_object);
852 dbus_bus_add_match (bus, match, &error);
854 match = g_strdup_printf ("type='signal',interface='%s',member='StateChanged'", atspi_interface_event_object);
855 dbus_bus_add_match (bus, match, &error);
858 no_cache = g_getenv ("ATSPI_NO_CACHE");
859 if (no_cache && g_strcmp0 (no_cache, "0") != 0)
860 atspi_no_cache = TRUE;
862 deferred_messages = g_queue_new ();
870 * Starts/enters the main event loop for the AT-SPI services.
872 * NOTE: This method does not return control; it is exited via a call to
873 * #atspi_event_quit from within an event handler.
877 atspi_event_main (void)
879 atspi_main_loop = g_main_loop_new (NULL, FALSE);
880 g_main_loop_run (atspi_main_loop);
881 atspi_main_loop = NULL;
887 * Quits the last main event loop for the AT-SPI services,
888 * See: #atspi_event_main
891 atspi_event_quit (void)
893 g_main_loop_quit (atspi_main_loop);
899 * Disconnects from #AtspiRegistry instances and releases
900 * any floating resources. Call only once at exit.
902 * Returns: 0 if there were no leaks, otherwise other integer values.
914 atspi_inited = FALSE;
918 leaked = g_hash_table_size (live_refs);
930 static GSList *hung_processes;
933 remove_hung_process (DBusPendingCall *pending, void *data)
935 gchar *bus_name = data;
937 hung_processes = g_slist_remove (hung_processes, data);
939 dbus_pending_call_unref (pending);
943 check_for_hang (DBusMessage *message, DBusError *error, DBusConnection *bus, const char *bus_name)
945 if (!message && error->name &&
946 !strcmp (error->name, "org.freedesktop.DBus.Error.NoReply"))
949 DBusMessage *message;
951 DBusPendingCall *pending = NULL;
952 for (l = hung_processes; l; l = l->next)
953 if (!strcmp (l->data, bus_name))
955 message = dbus_message_new_method_call (bus_name, "/",
956 "org.freedesktop.DBus.Peer",
960 dbus_connection_send_with_reply (bus, message, &pending, -1);
961 dbus_message_unref (message);
964 bus_name_dup = g_strdup (bus_name);
965 hung_processes = g_slist_append (hung_processes, bus_name_dup);
966 dbus_pending_call_set_notify (pending, remove_hung_process, bus_name_dup, NULL);
971 connection_is_hung (const char *bus_name)
975 for (l = hung_processes; l; l = l->next)
976 if (!strcmp (l->data, bus_name))
982 check_app (AtspiApplication *app, GError **error)
984 if (!app || !app->bus)
986 g_set_error_literal (error, ATSPI_ERROR, ATSPI_ERROR_APPLICATION_GONE,
987 _("The application no longer exists"));
991 if (atspi_main_loop && connection_is_hung (app->bus_name))
993 g_set_error_literal (error, ATSPI_ERROR, ATSPI_ERROR_IPC,
994 "The process appears to be hung.");
1002 set_timeout (AtspiApplication *app)
1007 if (app && app_startup_time > 0)
1009 gettimeofday (&tv, NULL);
1010 diff = (tv.tv_sec - app->time_added.tv_sec) * 1000 + (tv.tv_usec - app->time_added.tv_usec) / 1000;
1011 dbind_set_timeout (MAX(method_call_timeout, app_startup_time - diff));
1014 dbind_set_timeout (method_call_timeout);
1018 _atspi_dbus_call (gpointer obj, const char *interface, const char *method, GError **error, const char *type, ...)
1023 AtspiObject *aobj = ATSPI_OBJECT (obj);
1025 if (!check_app (aobj->app, error))
1028 va_start (args, type);
1029 dbus_error_init (&err);
1030 set_timeout (aobj->app);
1031 retval = dbind_method_call_reentrant_va (aobj->app->bus, aobj->app->bus_name,
1032 aobj->path, interface, method, &err,
1035 check_for_hang (NULL, &err, aobj->app->bus, aobj->app->bus_name);
1036 _atspi_process_deferred_messages ((gpointer)TRUE);
1037 if (dbus_error_is_set (&err))
1039 g_set_error(error, ATSPI_ERROR, ATSPI_ERROR_IPC, "%s", err.message);
1040 dbus_error_free (&err);
1046 _atspi_dbus_call_partial (gpointer obj,
1047 const char *interface,
1050 const char *type, ...)
1054 va_start (args, type);
1055 return _atspi_dbus_call_partial_va (obj, interface, method, error, type, args);
1060 _atspi_dbus_call_partial_va (gpointer obj,
1061 const char *interface,
1067 AtspiObject *aobj = ATSPI_OBJECT (obj);
1069 DBusMessage *msg = NULL, *reply = NULL;
1070 DBusMessageIter iter;
1073 dbus_error_init (&err);
1075 if (!check_app (aobj->app, error))
1078 msg = dbus_message_new_method_call (aobj->app->bus_name, aobj->path, interface, method);
1083 dbus_message_iter_init_append (msg, &iter);
1084 dbind_any_marshal_va (&iter, &p, args);
1086 set_timeout (aobj->app);
1087 reply = dbind_send_and_allow_reentry (aobj->app->bus, msg, &err);
1088 check_for_hang (reply, &err, aobj->app->bus, aobj->app->bus_name);
1092 dbus_message_unref (msg);
1093 _atspi_process_deferred_messages ((gpointer)TRUE);
1094 if (dbus_error_is_set (&err))
1096 /* TODO: Set gerror */
1097 dbus_error_free (&err);
1103 _atspi_dbus_get_property (gpointer obj, const char *interface, const char *name, GError **error, const char *type, void *data)
1105 DBusMessage *message, *reply;
1106 DBusMessageIter iter, iter_variant;
1108 dbus_bool_t retval = FALSE;
1109 AtspiObject *aobj = ATSPI_OBJECT (obj);
1110 char expected_type = (type [0] == '(' ? 'r' : type [0]);
1115 if (!check_app (aobj->app, error))
1118 message = dbus_message_new_method_call (aobj->app->bus_name,
1120 "org.freedesktop.DBus.Properties",
1124 // TODO: throw exception
1127 dbus_message_append_args (message, DBUS_TYPE_STRING, &interface, DBUS_TYPE_STRING, &name, DBUS_TYPE_INVALID);
1128 dbus_error_init (&err);
1129 set_timeout (aobj->app);
1130 reply = dbind_send_and_allow_reentry (aobj->app->bus, message, &err);
1131 check_for_hang (reply, &err, aobj->app->bus, aobj->app->bus_name);
1132 dbus_message_unref (message);
1133 _atspi_process_deferred_messages ((gpointer)TRUE);
1136 // TODO: throw exception
1140 if (dbus_message_get_type (reply) == DBUS_MESSAGE_TYPE_ERROR)
1142 const char *err = NULL;
1143 dbus_message_get_args (reply, NULL, DBUS_TYPE_STRING, &err, DBUS_TYPE_INVALID);
1145 g_set_error_literal (error, ATSPI_ERROR, ATSPI_ERROR_IPC, err);
1149 dbus_message_iter_init (reply, &iter);
1150 if (dbus_message_iter_get_arg_type (&iter) != 'v')
1152 g_warning ("AT-SPI: expected a variant when fetching %s from interface %s; got %s\n", name, interface, dbus_message_get_signature (reply));
1155 dbus_message_iter_recurse (&iter, &iter_variant);
1156 if (dbus_message_iter_get_arg_type (&iter_variant) != expected_type)
1158 g_warning ("atspi_dbus_get_property: Wrong type: expected %s, got %c\n", type, dbus_message_iter_get_arg_type (&iter_variant));
1161 if (!strcmp (type, "(so)"))
1163 *((AtspiAccessible **)data) = _atspi_dbus_return_accessible_from_iter (&iter_variant);
1167 dbus_message_iter_get_basic (&iter_variant, data);
1168 if (type [0] == 's')
1169 *(char **)data = g_strdup (*(char **)data);
1173 dbus_error_free (&err);
1175 dbus_message_unref (reply);
1180 _atspi_dbus_send_with_reply_and_block (DBusMessage *message, GError **error)
1184 AtspiApplication *app;
1185 DBusConnection *bus;
1187 app = get_application (dbus_message_get_destination (message));
1189 if (app && !app->bus)
1190 return NULL; /* will fail anyway; app has been disposed */
1192 bus = (app ? app->bus : _atspi_bus());
1193 dbus_error_init (&err);
1195 reply = dbind_send_and_allow_reentry (bus, message, &err);
1196 _atspi_process_deferred_messages ((gpointer)TRUE);
1197 dbus_message_unref (message);
1201 g_set_error_literal (error, ATSPI_ERROR, ATSPI_ERROR_IPC, err.message);
1202 dbus_error_free (&err);
1208 _atspi_dbus_return_hash_from_message (DBusMessage *message)
1210 DBusMessageIter iter;
1216 _ATSPI_DBUS_CHECK_SIG (message, "a{ss}", NULL, NULL);
1218 dbus_message_iter_init (message, &iter);
1219 ret = _atspi_dbus_hash_from_iter (&iter);
1220 dbus_message_unref (message);
1225 _atspi_dbus_hash_from_iter (DBusMessageIter *iter)
1227 GHashTable *hash = g_hash_table_new_full (g_str_hash, g_str_equal,
1228 (GDestroyNotify) g_free,
1229 (GDestroyNotify) g_free);
1230 DBusMessageIter iter_array, iter_dict;
1232 dbus_message_iter_recurse (iter, &iter_array);
1233 while (dbus_message_iter_get_arg_type (&iter_array) != DBUS_TYPE_INVALID)
1235 const char *name, *value;
1236 dbus_message_iter_recurse (&iter_array, &iter_dict);
1237 dbus_message_iter_get_basic (&iter_dict, &name);
1238 dbus_message_iter_next (&iter_dict);
1239 dbus_message_iter_get_basic (&iter_dict, &value);
1240 g_hash_table_insert (hash, g_strdup (name), g_strdup (value));
1241 dbus_message_iter_next (&iter_array);
1247 _atspi_dbus_return_attribute_array_from_message (DBusMessage *message)
1249 DBusMessageIter iter;
1255 _ATSPI_DBUS_CHECK_SIG (message, "a{ss}", NULL, NULL);
1257 dbus_message_iter_init (message, &iter);
1259 ret = _atspi_dbus_attribute_array_from_iter (&iter);
1260 dbus_message_unref (message);
1265 _atspi_dbus_attribute_array_from_iter (DBusMessageIter *iter)
1267 DBusMessageIter iter_array, iter_dict;
1268 GArray *array = g_array_new (TRUE, TRUE, sizeof (gchar *));
1270 dbus_message_iter_recurse (iter, &iter_array);
1271 while (dbus_message_iter_get_arg_type (&iter_array) != DBUS_TYPE_INVALID)
1273 const char *name, *value;
1275 dbus_message_iter_recurse (&iter_array, &iter_dict);
1276 dbus_message_iter_get_basic (&iter_dict, &name);
1277 dbus_message_iter_next (&iter_dict);
1278 dbus_message_iter_get_basic (&iter_dict, &value);
1279 str = g_strdup_printf ("%s:%s", name, value);
1280 array = g_array_append_val (array, str);
1281 dbus_message_iter_next (&iter_array);;
1287 _atspi_dbus_set_interfaces (AtspiAccessible *accessible, DBusMessageIter *iter)
1289 DBusMessageIter iter_array;
1291 accessible->interfaces = 0;
1292 dbus_message_iter_recurse (iter, &iter_array);
1293 while (dbus_message_iter_get_arg_type (&iter_array) != DBUS_TYPE_INVALID)
1297 dbus_message_iter_get_basic (&iter_array, &iface);
1298 if (!strcmp (iface, "org.freedesktop.DBus.Introspectable")) continue;
1299 n = _atspi_get_iface_num (iface);
1302 g_warning ("AT-SPI: Unknown interface %s", iface);
1305 accessible->interfaces |= (1 << n);
1306 dbus_message_iter_next (&iter_array);
1308 _atspi_accessible_add_cache (accessible, ATSPI_CACHE_INTERFACES);
1312 _atspi_dbus_set_state (AtspiAccessible *accessible, DBusMessageIter *iter)
1314 DBusMessageIter iter_array;
1316 dbus_uint32_t *states;
1318 dbus_message_iter_recurse (iter, &iter_array);
1319 dbus_message_iter_get_fixed_array (&iter_array, &states, &count);
1322 g_warning ("AT-SPI: expected 2 values in states array; got %d\n", count);
1323 if (!accessible->states)
1324 accessible->states = _atspi_state_set_new_internal (accessible, 0);
1328 guint64 val = ((guint64)states [1]) << 32;
1330 if (!accessible->states)
1331 accessible->states = _atspi_state_set_new_internal (accessible, val);
1333 accessible->states->states = val;
1335 _atspi_accessible_add_cache (accessible, ATSPI_CACHE_STATES);
1339 _atspi_error_quark (void)
1341 return g_quark_from_static_string ("atspi_error");
1345 * Gets the IOR from the XDisplay.
1348 get_accessibility_bus_address_x11 (void)
1352 Display *bridge_display;
1354 unsigned char *data = NULL;
1355 unsigned long nitems;
1356 unsigned long leftover;
1358 bridge_display = XOpenDisplay (spi_display_name ());
1359 if (!bridge_display)
1361 g_warning ("Could not open X display");
1365 AT_SPI_BUS = XInternAtom (bridge_display, "AT_SPI_BUS", False);
1366 XGetWindowProperty (bridge_display,
1367 XDefaultRootWindow (bridge_display),
1369 (long) BUFSIZ, False,
1370 (Atom) 31, &actual_type, &actual_format,
1371 &nitems, &leftover, &data);
1372 XCloseDisplay (bridge_display);
1374 return g_strdup (data);
1378 get_accessibility_bus_address_dbus (void)
1380 DBusConnection *session_bus = NULL;
1381 DBusMessage *message;
1384 char *address = NULL;
1386 session_bus = dbus_bus_get (DBUS_BUS_SESSION, NULL);
1390 message = dbus_message_new_method_call ("org.a11y.Bus",
1395 dbus_error_init (&error);
1396 reply = dbus_connection_send_with_reply_and_block (session_bus,
1400 dbus_message_unref (message);
1404 g_warning ("Error retrieving accessibility bus address: %s: %s",
1405 error.name, error.message);
1406 dbus_error_free (&error);
1411 const char *tmp_address;
1412 if (!dbus_message_get_args (reply,
1418 dbus_message_unref (reply);
1421 address = g_strdup (tmp_address);
1422 dbus_message_unref (reply);
1429 atspi_get_a11y_bus (void)
1431 DBusConnection *bus = NULL;
1435 address = get_accessibility_bus_address_x11 ();
1437 address = get_accessibility_bus_address_dbus ();
1441 dbus_error_init (&error);
1442 bus = dbus_connection_open (address, &error);
1447 g_warning ("Couldn't connect to accessibility bus: %s", error.message);
1452 if (!dbus_bus_register (bus, &error))
1454 g_warning ("Couldn't register with accessibility bus: %s", error.message);
1463 * Set the timeout used for method calls. If this is not set explicitly,
1464 * a default of 0.8 ms is used.
1465 * Note that at-spi2-registryd currently uses a timeout of 3 seconds when
1466 * sending a keyboard event notification. This means that, if an AT makes
1467 * a call in response to the keyboard notification and the application
1468 * being called does not respond before the timeout is reached,
1469 * at-spi2-registryd will time out on the keyboard event notification and
1470 * pass the key onto the application (ie, reply to indicate that the key
1471 * was not consumed), so this may make it undesirable to set a timeout
1472 * larger than 3 seconds.
1474 * @val: The timeout value, in milliseconds, or -1 to disable the timeout.
1475 * @startup_time: The amount of time, in milliseconds, to allow to pass
1476 * before enforcing timeouts on an application. Can be used to prevent
1477 * timeout exceptions if an application is likely to block for an extended
1478 * period of time on initialization. -1 can be passed to disable this
1482 atspi_set_timeout (gint val, gint startup_time)
1484 method_call_timeout = val;
1485 app_startup_time = startup_time;