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;
42 GMainLoop *atspi_main_loop;
43 gboolean atspi_no_cache;
45 const char *atspi_path_dec = ATSPI_DBUS_PATH_DEC;
46 const char *atspi_path_registry = ATSPI_DBUS_PATH_REGISTRY;
47 const char *atspi_path_root = ATSPI_DBUS_PATH_ROOT;
48 const char *atspi_bus_registry = ATSPI_DBUS_NAME_REGISTRY;
49 const char *atspi_interface_accessible = ATSPI_DBUS_INTERFACE_ACCESSIBLE;
50 const char *atspi_interface_action = ATSPI_DBUS_INTERFACE_ACTION;
51 const char *atspi_interface_application = ATSPI_DBUS_INTERFACE_APPLICATION;
52 const char *atspi_interface_collection = ATSPI_DBUS_INTERFACE_COLLECTION;
53 const char *atspi_interface_component = ATSPI_DBUS_INTERFACE_COMPONENT;
54 const char *atspi_interface_dec = ATSPI_DBUS_INTERFACE_DEC;
55 const char *atspi_interface_device_event_listener = ATSPI_DBUS_INTERFACE_DEVICE_EVENT_LISTENER;
56 const char *atspi_interface_document = ATSPI_DBUS_INTERFACE_DOCUMENT;
57 const char *atspi_interface_editable_text = ATSPI_DBUS_INTERFACE_EDITABLE_TEXT;
58 const char *atspi_interface_event_object = ATSPI_DBUS_INTERFACE_EVENT_OBJECT;
59 const char *atspi_interface_hyperlink = ATSPI_DBUS_INTERFACE_HYPERLINK;
60 const char *atspi_interface_hypertext = ATSPI_DBUS_INTERFACE_HYPERTEXT;
61 const char *atspi_interface_image = ATSPI_DBUS_INTERFACE_IMAGE;
62 const char *atspi_interface_registry = ATSPI_DBUS_INTERFACE_REGISTRY;
63 const char *atspi_interface_selection = ATSPI_DBUS_INTERFACE_SELECTION;
64 const char *atspi_interface_table = ATSPI_DBUS_INTERFACE_TABLE;
65 const char *atspi_interface_text = ATSPI_DBUS_INTERFACE_TEXT;
66 const char *atspi_interface_cache = ATSPI_DBUS_INTERFACE_CACHE;
67 const char *atspi_interface_value = ATSPI_DBUS_INTERFACE_VALUE;
69 static const char *interfaces[] =
71 ATSPI_DBUS_INTERFACE_ACCESSIBLE,
72 ATSPI_DBUS_INTERFACE_ACTION,
73 ATSPI_DBUS_INTERFACE_APPLICATION,
74 ATSPI_DBUS_INTERFACE_COLLECTION,
75 ATSPI_DBUS_INTERFACE_COMPONENT,
76 ATSPI_DBUS_INTERFACE_DOCUMENT,
77 ATSPI_DBUS_INTERFACE_EDITABLE_TEXT,
78 ATSPI_DBUS_INTERFACE_HYPERLINK,
79 ATSPI_DBUS_INTERFACE_HYPERTEXT,
80 ATSPI_DBUS_INTERFACE_IMAGE,
81 "org.a11y.atspi.LoginHelper",
82 ATSPI_DBUS_INTERFACE_SELECTION,
83 ATSPI_DBUS_INTERFACE_TABLE,
84 ATSPI_DBUS_INTERFACE_TEXT,
85 ATSPI_DBUS_INTERFACE_VALUE,
90 _atspi_get_iface_num (const char *iface)
92 /* TODO: Use a binary search or hash to improve performance */
95 for (i = 0; interfaces[i]; i++)
97 if (!strcmp(iface, interfaces[i])) return i;
107 live_refs = g_hash_table_new (g_direct_hash, g_direct_equal);
112 /* TODO: Add an application parameter */
119 g_error ("AT-SPI: COuldn't connect to accessibility bus. Is at-spi-bus-launcher running?");
123 #define APP_IS_REGISTRY(app) (!strcmp (app->bus_name, atspi_bus_registry))
134 g_hash_table_destroy (refs);
138 static gboolean atspi_inited = FALSE;
140 static GHashTable *app_hash = NULL;
143 handle_get_bus_address (DBusPendingCall *pending, void *user_data)
145 AtspiApplication *app = user_data;
146 DBusMessage *reply = dbus_pending_call_steal_reply (pending);
147 DBusMessage *message;
149 DBusPendingCall *new_pending;
151 if (dbus_message_get_type (reply) == DBUS_MESSAGE_TYPE_METHOD_RETURN)
153 if (dbus_message_get_args (reply, NULL, DBUS_TYPE_STRING, &address,
157 dbus_error_init (&error);
158 DBusConnection *bus = dbus_connection_open (address, &error);
162 dbus_connection_unref (app->bus);
167 dbus_message_unref (reply);
168 dbus_pending_call_unref (pending);
171 return; /* application has gone away / been disposed */
173 message = dbus_message_new_method_call (app->bus_name,
174 "/org/a11y/atspi/cache",
175 atspi_interface_cache, "GetItems");
177 dbus_connection_send_with_reply (app->bus, message, &new_pending, 2000);
178 dbus_pending_call_set_notify (new_pending, handle_get_items, app, NULL);
179 dbus_message_unref (message);
182 static AtspiApplication *
183 get_application (const char *bus_name)
185 AtspiApplication *app = NULL;
187 DBusMessage *message;
189 DBusPendingCall *pending = NULL;
193 app_hash = g_hash_table_new_full (g_str_hash, g_str_equal, g_free, (GDestroyNotify)g_object_unref);
194 if (!app_hash) return NULL;
196 app = g_hash_table_lookup (app_hash, bus_name);
198 bus_name_dup = g_strdup (bus_name);
199 if (!bus_name_dup) return NULL;
200 // TODO: change below to something that will send state-change:defunct notification if necessary */
201 app = _atspi_application_new (bus_name);
202 if (!app) return NULL;
203 app->hash = g_hash_table_new_full (g_str_hash, g_str_equal, g_free, g_object_unref);
204 app->bus = dbus_connection_ref (_atspi_bus ());
205 app->cache = ATSPI_CACHE_UNDEFINED;
206 g_hash_table_insert (app_hash, bus_name_dup, app);
207 dbus_error_init (&error);
208 message = dbus_message_new_method_call (bus_name, atspi_path_root,
209 atspi_interface_application, "GetApplicationBusAddress");
211 dbus_connection_send_with_reply (app->bus, message, &pending, 2000);
212 dbus_pending_call_set_notify (pending, handle_get_bus_address, app, NULL);
213 dbus_message_unref (message);
217 static AtspiAccessible *
218 ref_accessible (const char *app_name, const char *path)
220 AtspiApplication *app;
223 if (!strcmp (path, ATSPI_DBUS_PATH_NULL))
226 app = get_application (app_name);
228 if (!strcmp (path, "/org/a11y/atspi/accessible/root"))
232 app->root = _atspi_accessible_new (app, atspi_path_root);
233 app->root->accessible_parent = atspi_get_desktop (0);
235 return g_object_ref (app->root);
238 a = g_hash_table_lookup (app->hash, path);
241 return g_object_ref (a);
243 a = _atspi_accessible_new (app, path);
246 g_hash_table_insert (app->hash, g_strdup (a->parent.path), a);
247 g_object_ref (a); /* for the hash */
251 static AtspiHyperlink *
252 ref_hyperlink (const char *app_name, const char *path)
254 AtspiApplication *app = get_application (app_name);
255 AtspiHyperlink *hyperlink;
257 if (!strcmp (path, ATSPI_DBUS_PATH_NULL))
260 hyperlink = g_hash_table_lookup (app->hash, path);
263 return g_object_ref (hyperlink);
265 hyperlink = _atspi_hyperlink_new (app, path);
266 g_hash_table_insert (app->hash, g_strdup (hyperlink->parent.path), hyperlink);
267 /* TODO: This should be a weak ref */
268 g_object_ref (hyperlink); /* for the hash */
281 GArray *state_bitflags;
284 static DBusHandlerResult
285 handle_remove_accessible (DBusConnection *bus, DBusMessage *message, void *user_data)
287 const char *sender = dbus_message_get_sender (message);
288 AtspiApplication *app;
290 DBusMessageIter iter, iter_struct;
291 const char *signature = dbus_message_get_signature (message);
294 if (strcmp (signature, "(so)") != 0)
296 g_warning ("AT-SPI: Unknown signature %s for RemoveAccessible", signature);
297 return DBUS_HANDLER_RESULT_HANDLED;
300 dbus_message_iter_init (message, &iter);
301 dbus_message_iter_recurse (&iter, &iter_struct);
302 dbus_message_iter_get_basic (&iter_struct, &sender);
303 dbus_message_iter_next (&iter_struct);
304 dbus_message_iter_get_basic (&iter_struct, &path);
305 app = get_application (sender);
306 a = ref_accessible (sender, path);
308 return DBUS_HANDLER_RESULT_HANDLED;
309 g_object_run_dispose (G_OBJECT (a));
310 g_hash_table_remove (app->hash, a->parent.path);
311 g_object_unref (a); /* unref our own ref */
312 return DBUS_HANDLER_RESULT_HANDLED;
316 add_app_to_desktop (AtspiAccessible *a, const char *bus_name)
320 dbus_error_init (&error);
321 AtspiAccessible *obj = ref_accessible (bus_name, atspi_path_root);
324 GList *new_list = g_list_append (a->children, obj);
327 a->children = new_list;
333 g_warning ("AT-SPI: Error calling getRoot for %s: %s", bus_name, error.message);
339 send_children_changed (AtspiAccessible *parent, AtspiAccessible *child, gboolean add)
343 memset (&e, 0, sizeof (e));
344 e.type = (add? "object:children-changed:add": "object:children-changed:remove");
346 e.detail1 = g_list_index (parent->children, child);
348 _atspi_send_event (&e);
352 unref_object_and_descendants (AtspiAccessible *obj)
356 for (l = obj->children; l; l = l->next)
358 unref_object_and_descendants (l->data);
360 g_object_unref (obj);
364 remove_app_from_desktop (AtspiAccessible *a, const char *bus_name)
367 AtspiAccessible *child;
369 for (l = a->children; l; l = l->next)
372 if (!strcmp (bus_name, child->parent.app->bus_name)) break;
378 send_children_changed (a, child, FALSE);
379 a->children = g_list_remove (a->children, child);
380 unref_object_and_descendants (child);
384 static AtspiAccessible *desktop;
387 get_reference_from_iter (DBusMessageIter *iter, const char **app_name, const char **path)
389 DBusMessageIter iter_struct;
391 dbus_message_iter_recurse (iter, &iter_struct);
392 dbus_message_iter_get_basic (&iter_struct, app_name);
393 dbus_message_iter_next (&iter_struct);
394 dbus_message_iter_get_basic (&iter_struct, path);
395 dbus_message_iter_next (iter);
399 add_accessible_from_iter (DBusMessageIter *iter)
401 DBusMessageIter iter_struct, iter_array;
402 const char *app_name, *path;
403 AtspiAccessible *accessible;
404 const char *name, *description;
407 dbus_message_iter_recurse (iter, &iter_struct);
410 get_reference_from_iter (&iter_struct, &app_name, &path);
411 accessible = ref_accessible (app_name, path);
415 /* Get application: TODO */
416 dbus_message_iter_next (&iter_struct);
419 get_reference_from_iter (&iter_struct, &app_name, &path);
420 if (accessible->accessible_parent)
421 g_object_unref (accessible->accessible_parent);
422 accessible->accessible_parent = ref_accessible (app_name, path);
425 while (accessible->children)
427 g_object_unref (accessible->children->data);
428 accessible->children = g_list_remove (accessible->children, accessible->children->data);
430 dbus_message_iter_recurse (&iter_struct, &iter_array);
431 while (dbus_message_iter_get_arg_type (&iter_array) != DBUS_TYPE_INVALID)
433 AtspiAccessible *child;
434 get_reference_from_iter (&iter_array, &app_name, &path);
435 child = ref_accessible (app_name, path);
436 accessible->children = g_list_append (accessible->children, child);
440 dbus_message_iter_next (&iter_struct);
441 _atspi_dbus_set_interfaces (accessible, &iter_struct);
442 dbus_message_iter_next (&iter_struct);
445 if (accessible->name)
446 g_free (accessible->name);
447 dbus_message_iter_get_basic (&iter_struct, &name);
448 accessible->name = g_strdup (name);
449 dbus_message_iter_next (&iter_struct);
452 dbus_message_iter_get_basic (&iter_struct, &role);
453 accessible->role = role;
454 dbus_message_iter_next (&iter_struct);
457 if (accessible->description)
458 g_free (accessible->description);
459 dbus_message_iter_get_basic (&iter_struct, &description);
460 accessible->description = g_strdup (description);
461 dbus_message_iter_next (&iter_struct);
463 _atspi_dbus_set_state (accessible, &iter_struct);
464 dbus_message_iter_next (&iter_struct);
466 _atspi_accessible_add_cache (accessible, ATSPI_CACHE_NAME | ATSPI_CACHE_ROLE |
467 ATSPI_CACHE_PARENT | ATSPI_CACHE_DESCRIPTION);
468 if (!atspi_state_set_contains (accessible->states,
469 ATSPI_STATE_MANAGES_DESCENDANTS))
470 _atspi_accessible_add_cache (accessible, ATSPI_CACHE_CHILDREN);
472 /* This is a bit of a hack since the cache holds a ref, so we don't need
473 * the one provided for us anymore */
474 g_object_unref (accessible);
478 handle_get_items (DBusPendingCall *pending, void *user_data)
480 DBusMessage *reply = dbus_pending_call_steal_reply (pending);
481 DBusMessageIter iter, iter_array;
483 if (dbus_message_get_type (reply) == DBUS_MESSAGE_TYPE_ERROR)
485 const char *sender = dbus_message_get_sender (reply);
486 const char *error = NULL;
487 dbus_message_get_args (reply, NULL, DBUS_TYPE_STRING, &error,
489 g_warning ("AT-SPI: Error in GetItems, sender=%s, error=%s", sender, error);
490 dbus_message_unref (reply);
491 dbus_pending_call_unref (pending);
495 dbus_message_iter_init (reply, &iter);
496 dbus_message_iter_recurse (&iter, &iter_array);
497 while (dbus_message_iter_get_arg_type (&iter_array) != DBUS_TYPE_INVALID)
499 add_accessible_from_iter (&iter_array);
500 dbus_message_iter_next (&iter_array);
502 dbus_message_unref (reply);
503 dbus_pending_call_unref (pending);
506 /* TODO: Do we stil need this function? */
507 static AtspiAccessible *
508 ref_accessible_desktop (AtspiApplication *app)
511 DBusMessage *message, *reply;
512 DBusMessageIter iter, iter_array;
517 g_object_ref (desktop);
520 desktop = _atspi_accessible_new (app, atspi_path_root);
525 g_hash_table_insert (app->hash, desktop->parent.path, desktop);
526 g_object_ref (desktop); /* for the hash */
527 desktop->name = g_strdup ("main");
528 dbus_error_init (&error);
529 message = dbus_message_new_method_call (atspi_bus_registry,
531 atspi_interface_accessible,
535 reply = _atspi_dbus_send_with_reply_and_block (message, NULL);
536 if (!reply || strcmp (dbus_message_get_signature (reply), "a(so)") != 0)
538 g_warning ("Couldn't get application list: %s", error.message);
540 dbus_message_unref (reply);
543 dbus_message_iter_init (reply, &iter);
544 dbus_message_iter_recurse (&iter, &iter_array);
545 while (dbus_message_iter_get_arg_type (&iter_array) != DBUS_TYPE_INVALID)
547 const char *app_name, *path;
548 get_reference_from_iter (&iter_array, &app_name, &path);
549 add_app_to_desktop (desktop, app_name);
551 dbus_message_unref (reply);
553 /* Record the alternate name as an alias for org.a11y.atspi.Registry */
554 bus_name_dup = g_strdup (dbus_message_get_sender (reply));
556 g_hash_table_insert (app_hash, bus_name_dup, app);
562 _atspi_ref_accessible (const char *app, const char *path)
564 AtspiApplication *a = get_application (app);
566 if ( APP_IS_REGISTRY(a))
568 return a->root = ref_accessible_desktop (a);
570 return ref_accessible (app, path);
574 _atspi_dbus_return_accessible_from_message (DBusMessage *message)
576 DBusMessageIter iter;
577 AtspiAccessible *retval = NULL;
578 const char *signature;
583 signature = dbus_message_get_signature (message);
584 if (!strcmp (signature, "(so)"))
586 dbus_message_iter_init (message, &iter);
587 retval = _atspi_dbus_return_accessible_from_iter (&iter);
591 g_warning ("AT-SPI: Called _atspi_dbus_return_accessible_from_message with strange signature %s", signature);
593 dbus_message_unref (message);
598 _atspi_dbus_return_accessible_from_iter (DBusMessageIter *iter)
600 const char *app_name, *path;
602 get_reference_from_iter (iter, &app_name, &path);
603 return ref_accessible (app_name, path);
607 _atspi_dbus_return_hyperlink_from_message (DBusMessage *message)
609 DBusMessageIter iter;
610 AtspiHyperlink *retval = NULL;
611 const char *signature = dbus_message_get_signature (message);
613 if (!strcmp (signature, "(so)"))
615 dbus_message_iter_init (message, &iter);
616 retval = _atspi_dbus_return_hyperlink_from_iter (&iter);
620 g_warning ("AT-SPI: Called _atspi_dbus_return_hyperlink_from_message with strange signature %s", signature);
622 dbus_message_unref (message);
627 _atspi_dbus_return_hyperlink_from_iter (DBusMessageIter *iter)
629 const char *app_name, *path;
631 get_reference_from_iter (iter, &app_name, &path);
632 return ref_hyperlink (app_name, path);
635 const char *cache_signal_type = "((so)(so)(so)a(so)assusau)";
637 static DBusHandlerResult
638 handle_add_accessible (DBusConnection *bus, DBusMessage *message, void *user_data)
640 DBusMessageIter iter;
641 const char *sender = dbus_message_get_sender (message);
643 if (strcmp (dbus_message_get_signature (message), cache_signal_type) != 0)
645 g_warning ("AT-SPI: AddAccessible with unknown signature %s\n",
646 dbus_message_get_signature (message));
647 return DBUS_HANDLER_RESULT_HANDLED;
650 dbus_message_iter_init (message, &iter);
651 add_accessible_from_iter (&iter);
652 return DBUS_HANDLER_RESULT_HANDLED;
658 DBusMessage *message;
662 static guint process_deferred_messages_id = -1;
665 process_deferred_message (BusDataClosure *closure)
667 int type = dbus_message_get_type (closure->message);
668 const char *interface = dbus_message_get_interface (closure->message);
670 if (type == DBUS_MESSAGE_TYPE_SIGNAL &&
671 !strncmp (interface, "org.a11y.atspi.Event.", 21))
673 _atspi_dbus_handle_event (closure->bus, closure->message, closure->data);
675 if (dbus_message_is_method_call (closure->message, atspi_interface_device_event_listener, "NotifyEvent"))
677 _atspi_dbus_handle_DeviceEvent (closure->bus,
678 closure->message, closure->data);
680 if (dbus_message_is_signal (closure->message, atspi_interface_cache, "AddAccessible"))
682 handle_add_accessible (closure->bus, closure->message, closure->data);
684 if (dbus_message_is_signal (closure->message, atspi_interface_cache, "RemoveAccessible"))
686 handle_remove_accessible (closure->bus, closure->message, closure->data);
690 static GQueue *deferred_messages = NULL;
693 _atspi_process_deferred_messages (gpointer data)
695 static int in_process_deferred_messages = 0;
696 BusDataClosure *closure;
698 if (in_process_deferred_messages)
700 in_process_deferred_messages = 1;
701 while (closure = g_queue_pop_head (deferred_messages))
703 process_deferred_message (closure);
704 dbus_message_unref (closure->message);
705 dbus_connection_unref (closure->bus);
708 /* If data is NULL, assume that we were called from GLib */
710 process_deferred_messages_id = -1;
711 in_process_deferred_messages = 0;
715 static DBusHandlerResult
716 defer_message (DBusConnection *connection, DBusMessage *message, void *user_data)
718 BusDataClosure *closure = g_new (BusDataClosure, 1);
720 closure->bus = dbus_connection_ref (bus);
721 closure->message = dbus_message_ref (message);
722 closure->data = user_data;
724 g_queue_push_tail (deferred_messages, closure);
726 if (process_deferred_messages_id == -1)
727 process_deferred_messages_id = g_idle_add (_atspi_process_deferred_messages, NULL);
728 return DBUS_HANDLER_RESULT_HANDLED;
731 static DBusHandlerResult
732 atspi_dbus_filter (DBusConnection *bus, DBusMessage *message, void *data)
734 int type = dbus_message_get_type (message);
735 const char *interface = dbus_message_get_interface (message);
737 if (type == DBUS_MESSAGE_TYPE_SIGNAL &&
738 !strncmp (interface, "org.a11y.atspi.Event.", 21))
740 return defer_message (bus, message, data);
742 if (dbus_message_is_method_call (message, atspi_interface_device_event_listener, "NotifyEvent"))
744 return defer_message (bus, message, data);
746 if (dbus_message_is_signal (message, atspi_interface_cache, "AddAccessible"))
748 return defer_message (bus, message, data);
750 if (dbus_message_is_signal (message, atspi_interface_cache, "RemoveAccessible"))
752 return defer_message (bus, message, data);
754 return DBUS_HANDLER_RESULT_NOT_YET_HANDLED;
757 static const char *signal_interfaces[] =
759 "org.a11y.atspi.Event.Object",
760 "org.a11y.atspi.Event.Window",
761 "org.a11y.atspi.Event.Mouse",
762 "org.a11y.atspi.Event.Terminal",
763 "org.a11y.atspi.Event.Document",
764 "org.a11y.atspi.Event.Focus",
769 * Returns a 'canonicalized' value for DISPLAY,
770 * with the screen number stripped off if present.
772 * TODO: Avoid having duplicate functions for this here and in at-spi2-atk
775 spi_display_name (void)
777 static const char *canonical_display_name = NULL;
778 if (!canonical_display_name)
780 const gchar *display_env = g_getenv ("AT_SPI_DISPLAY");
783 display_env = g_getenv ("DISPLAY");
784 if (!display_env || !display_env[0])
785 canonical_display_name = ":0";
788 gchar *display_p, *screen_p;
789 canonical_display_name = g_strdup (display_env);
790 display_p = g_utf8_strrchr (canonical_display_name, -1, ':');
791 screen_p = g_utf8_strrchr (canonical_display_name, -1, '.');
792 if (screen_p && display_p && (screen_p > display_p))
800 canonical_display_name = display_env;
803 return canonical_display_name;
809 * Connects to the accessibility registry and initializes the SPI.
811 * Returns: 0 on success, otherwise an integer error code.
818 const gchar *no_cache;
831 dbus_error_init (&error);
832 bus = atspi_get_a11y_bus ();
835 dbus_bus_register (bus, &error);
836 atspi_dbus_connection_setup_with_g_main(bus, g_main_context_default());
837 dbus_connection_add_filter (bus, atspi_dbus_filter, NULL, NULL);
838 dbind_set_timeout (800);
839 match = g_strdup_printf ("type='signal',interface='%s',member='AddAccessible'", atspi_interface_cache);
840 dbus_error_init (&error);
841 dbus_bus_add_match (bus, match, &error);
843 match = g_strdup_printf ("type='signal',interface='%s',member='RemoveAccessible'", atspi_interface_cache);
844 dbus_bus_add_match (bus, match, &error);
846 match = g_strdup_printf ("type='signal',interface='%s',member='ChildrenChanged'", atspi_interface_event_object);
847 dbus_bus_add_match (bus, match, &error);
849 match = g_strdup_printf ("type='signal',interface='%s',member='PropertyChange'", atspi_interface_event_object);
850 dbus_bus_add_match (bus, match, &error);
852 match = g_strdup_printf ("type='signal',interface='%s',member='StateChanged'", atspi_interface_event_object);
853 dbus_bus_add_match (bus, match, &error);
856 no_cache = g_getenv ("ATSPI_NO_CACHE");
857 if (no_cache && g_strcmp0 (no_cache, "0") != 0)
858 atspi_no_cache = TRUE;
860 deferred_messages = g_queue_new ();
868 * Starts/enters the main event loop for the AT-SPI services.
870 * NOTE: This method does not return control; it is exited via a call to
871 * #atspi_event_quit from within an event handler.
875 atspi_event_main (void)
877 atspi_main_loop = g_main_loop_new (NULL, FALSE);
878 g_main_loop_run (atspi_main_loop);
879 atspi_main_loop = NULL;
885 * Quits the last main event loop for the AT-SPI services,
886 * See: #atspi_event_main
889 atspi_event_quit (void)
891 g_main_loop_quit (atspi_main_loop);
897 * Disconnects from #AtspiRegistry instances and releases
898 * any floating resources. Call only once at exit.
900 * Returns: 0 if there were no leaks, otherwise other integer values.
912 atspi_inited = FALSE;
916 leaked = g_hash_table_size (live_refs);
928 static GSList *hung_processes;
931 remove_hung_process (DBusPendingCall *pending, void *data)
933 gchar *bus_name = data;
935 hung_processes = g_slist_remove (hung_processes, data);
937 dbus_pending_call_unref (pending);
941 check_for_hang (DBusMessage *message, DBusError *error, DBusConnection *bus, const char *bus_name)
943 if (!message && error->name &&
944 !strcmp (error->name, "org.freedesktop.DBus.Error.NoReply"))
947 DBusMessage *message;
949 DBusPendingCall *pending = NULL;
950 for (l = hung_processes; l; l = l->next)
951 if (!strcmp (l->data, bus_name))
953 message = dbus_message_new_method_call (bus_name, "/",
954 "org.freedesktop.DBus.Peer",
958 dbus_connection_send_with_reply (bus, message, &pending, -1);
959 dbus_message_unref (message);
962 bus_name_dup = g_strdup (bus_name);
963 hung_processes = g_slist_append (hung_processes, bus_name_dup);
964 dbus_pending_call_set_notify (pending, remove_hung_process, bus_name_dup, NULL);
969 connection_is_hung (const char *bus_name)
973 for (l = hung_processes; l; l = l->next)
974 if (!strcmp (l->data, bus_name))
980 check_app (AtspiApplication *app, GError **error)
982 if (!app || !app->bus)
984 g_set_error_literal (error, ATSPI_ERROR, ATSPI_ERROR_APPLICATION_GONE,
985 _("The application no longer exists"));
989 if (atspi_main_loop && connection_is_hung (app->bus_name))
991 g_set_error_literal (error, ATSPI_ERROR, ATSPI_ERROR_IPC,
992 "The process appears to be hung.");
1000 _atspi_dbus_call (gpointer obj, const char *interface, const char *method, GError **error, const char *type, ...)
1005 AtspiObject *aobj = ATSPI_OBJECT (obj);
1007 if (!check_app (aobj->app, error))
1010 va_start (args, type);
1011 dbus_error_init (&err);
1012 retval = dbind_method_call_reentrant_va (aobj->app->bus, aobj->app->bus_name,
1013 aobj->path, interface, method, &err,
1016 check_for_hang (NULL, &err, aobj->app->bus, aobj->app->bus_name);
1017 _atspi_process_deferred_messages ((gpointer)TRUE);
1018 if (dbus_error_is_set (&err))
1020 g_set_error(error, ATSPI_ERROR, ATSPI_ERROR_IPC, "%s", err.message);
1021 dbus_error_free (&err);
1027 _atspi_dbus_call_partial (gpointer obj,
1028 const char *interface,
1031 const char *type, ...)
1035 va_start (args, type);
1036 return _atspi_dbus_call_partial_va (obj, interface, method, error, type, args);
1041 _atspi_dbus_call_partial_va (gpointer obj,
1042 const char *interface,
1048 AtspiObject *aobj = ATSPI_OBJECT (obj);
1050 DBusMessage *msg = NULL, *reply = NULL;
1051 DBusMessageIter iter;
1054 dbus_error_init (&err);
1056 if (!check_app (aobj->app, error))
1059 msg = dbus_message_new_method_call (aobj->app->bus_name, aobj->path, interface, method);
1064 dbus_message_iter_init_append (msg, &iter);
1065 dbind_any_marshal_va (&iter, &p, args);
1067 reply = dbind_send_and_allow_reentry (aobj->app->bus, msg, &err);
1068 check_for_hang (reply, &err, aobj->app->bus, aobj->app->bus_name);
1072 dbus_message_unref (msg);
1073 _atspi_process_deferred_messages ((gpointer)TRUE);
1074 if (dbus_error_is_set (&err))
1076 /* TODO: Set gerror */
1077 dbus_error_free (&err);
1083 _atspi_dbus_get_property (gpointer obj, const char *interface, const char *name, GError **error, const char *type, void *data)
1085 DBusMessage *message, *reply;
1086 DBusMessageIter iter, iter_variant;
1088 dbus_bool_t retval = FALSE;
1089 AtspiObject *aobj = ATSPI_OBJECT (obj);
1090 char expected_type = (type [0] == '(' ? 'r' : type [0]);
1095 if (!check_app (aobj->app, error))
1098 message = dbus_message_new_method_call (aobj->app->bus_name,
1100 "org.freedesktop.DBus.Properties",
1104 // TODO: throw exception
1107 dbus_message_append_args (message, DBUS_TYPE_STRING, &interface, DBUS_TYPE_STRING, &name, DBUS_TYPE_INVALID);
1108 dbus_error_init (&err);
1109 reply = dbind_send_and_allow_reentry (aobj->app->bus, message, &err);
1110 check_for_hang (reply, &err, aobj->app->bus, aobj->app->bus_name);
1111 dbus_message_unref (message);
1112 _atspi_process_deferred_messages ((gpointer)TRUE);
1115 // TODO: throw exception
1119 if (dbus_message_get_type (reply) == DBUS_MESSAGE_TYPE_ERROR)
1122 dbus_message_get_args (message, NULL, DBUS_TYPE_STRING, &err, DBUS_TYPE_INVALID);
1124 g_set_error_literal (error, ATSPI_ERROR, ATSPI_ERROR_IPC, err);
1128 dbus_message_iter_init (reply, &iter);
1129 if (dbus_message_iter_get_arg_type (&iter) != 'v')
1131 g_warning ("AT-SPI: expected a variant when fetching %s from interface %s; got %s\n", name, interface, dbus_message_get_signature (reply));
1134 dbus_message_iter_recurse (&iter, &iter_variant);
1135 if (dbus_message_iter_get_arg_type (&iter_variant) != expected_type)
1137 g_warning ("atspi_dbus_get_property: Wrong type: expected %s, got %c\n", type, dbus_message_iter_get_arg_type (&iter_variant));
1140 if (!strcmp (type, "(so)"))
1142 *((AtspiAccessible **)data) = _atspi_dbus_return_accessible_from_iter (&iter_variant);
1146 dbus_message_iter_get_basic (&iter_variant, data);
1147 if (type [0] == 's')
1148 *(char **)data = g_strdup (*(char **)data);
1152 dbus_error_free (&err);
1154 dbus_message_unref (reply);
1159 _atspi_dbus_send_with_reply_and_block (DBusMessage *message, GError **error)
1163 AtspiApplication *app;
1164 DBusConnection *bus;
1166 app = get_application (dbus_message_get_destination (message));
1168 if (app && !app->bus)
1169 return NULL; /* will fail anyway; app has been disposed */
1171 bus = (app ? app->bus : _atspi_bus());
1172 dbus_error_init (&err);
1173 reply = dbind_send_and_allow_reentry (bus, message, &err);
1174 _atspi_process_deferred_messages ((gpointer)TRUE);
1175 dbus_message_unref (message);
1179 g_set_error_literal (error, ATSPI_ERROR, ATSPI_ERROR_IPC, err.message);
1180 dbus_error_free (&err);
1186 _atspi_dbus_return_hash_from_message (DBusMessage *message)
1188 DBusMessageIter iter;
1194 _ATSPI_DBUS_CHECK_SIG (message, "a{ss}", NULL, NULL);
1196 dbus_message_iter_init (message, &iter);
1197 ret = _atspi_dbus_hash_from_iter (&iter);
1198 dbus_message_unref (message);
1203 _atspi_dbus_hash_from_iter (DBusMessageIter *iter)
1205 GHashTable *hash = g_hash_table_new_full (g_str_hash, g_str_equal,
1206 (GDestroyNotify) g_free,
1207 (GDestroyNotify) g_free);
1208 DBusMessageIter iter_array, iter_dict;
1210 dbus_message_iter_recurse (iter, &iter_array);
1211 while (dbus_message_iter_get_arg_type (&iter_array) != DBUS_TYPE_INVALID)
1213 const char *name, *value;
1214 dbus_message_iter_recurse (&iter_array, &iter_dict);
1215 dbus_message_iter_get_basic (&iter_dict, &name);
1216 dbus_message_iter_next (&iter_dict);
1217 dbus_message_iter_get_basic (&iter_dict, &value);
1218 g_hash_table_insert (hash, g_strdup (name), g_strdup (value));
1219 dbus_message_iter_next (&iter_array);
1225 _atspi_dbus_return_attribute_array_from_message (DBusMessage *message)
1227 DBusMessageIter iter;
1233 _ATSPI_DBUS_CHECK_SIG (message, "a{ss}", NULL, NULL);
1235 dbus_message_iter_init (message, &iter);
1237 ret = _atspi_dbus_attribute_array_from_iter (&iter);
1238 dbus_message_unref (message);
1243 _atspi_dbus_attribute_array_from_iter (DBusMessageIter *iter)
1245 DBusMessageIter iter_array, iter_dict;
1246 GArray *array = g_array_new (TRUE, TRUE, sizeof (gchar *));
1248 dbus_message_iter_recurse (iter, &iter_array);
1249 while (dbus_message_iter_get_arg_type (&iter_array) != DBUS_TYPE_INVALID)
1251 const char *name, *value;
1253 dbus_message_iter_recurse (&iter_array, &iter_dict);
1254 dbus_message_iter_get_basic (&iter_dict, &name);
1255 dbus_message_iter_next (&iter_dict);
1256 dbus_message_iter_get_basic (&iter_dict, &value);
1257 str = g_strdup_printf ("%s:%s", name, value);
1258 array = g_array_append_val (array, str);
1259 dbus_message_iter_next (&iter_array);;
1265 _atspi_dbus_set_interfaces (AtspiAccessible *accessible, DBusMessageIter *iter)
1267 DBusMessageIter iter_array;
1269 accessible->interfaces = 0;
1270 dbus_message_iter_recurse (iter, &iter_array);
1271 while (dbus_message_iter_get_arg_type (&iter_array) != DBUS_TYPE_INVALID)
1275 dbus_message_iter_get_basic (&iter_array, &iface);
1276 if (!strcmp (iface, "org.freedesktop.DBus.Introspectable")) continue;
1277 n = _atspi_get_iface_num (iface);
1280 g_warning ("AT-SPI: Unknown interface %s", iface);
1283 accessible->interfaces |= (1 << n);
1284 dbus_message_iter_next (&iter_array);
1286 _atspi_accessible_add_cache (accessible, ATSPI_CACHE_INTERFACES);
1290 _atspi_dbus_set_state (AtspiAccessible *accessible, DBusMessageIter *iter)
1292 DBusMessageIter iter_array;
1294 dbus_uint32_t *states;
1296 dbus_message_iter_recurse (iter, &iter_array);
1297 dbus_message_iter_get_fixed_array (&iter_array, &states, &count);
1300 g_warning ("AT-SPI: expected 2 values in states array; got %d\n", count);
1301 if (!accessible->states)
1302 accessible->states = _atspi_state_set_new_internal (accessible, 0);
1306 guint64 val = ((guint64)states [1]) << 32;
1308 if (!accessible->states)
1309 accessible->states = _atspi_state_set_new_internal (accessible, val);
1311 accessible->states->states = val;
1313 _atspi_accessible_add_cache (accessible, ATSPI_CACHE_STATES);
1317 _atspi_error_quark (void)
1319 return g_quark_from_static_string ("atspi_error");
1323 * Gets the IOR from the XDisplay.
1326 get_accessibility_bus_address_x11 (void)
1330 Display *bridge_display;
1332 unsigned char *data = NULL;
1333 unsigned long nitems;
1334 unsigned long leftover;
1336 bridge_display = XOpenDisplay (spi_display_name ());
1337 if (!bridge_display)
1339 g_warning ("Could not open X display");
1343 AT_SPI_BUS = XInternAtom (bridge_display, "AT_SPI_BUS", False);
1344 XGetWindowProperty (bridge_display,
1345 XDefaultRootWindow (bridge_display),
1347 (long) BUFSIZ, False,
1348 (Atom) 31, &actual_type, &actual_format,
1349 &nitems, &leftover, &data);
1350 XCloseDisplay (bridge_display);
1352 return g_strdup (data);
1356 get_accessibility_bus_address_dbus (void)
1358 DBusConnection *session_bus = NULL;
1359 DBusMessage *message;
1362 char *address = NULL;
1364 session_bus = dbus_bus_get (DBUS_BUS_SESSION, NULL);
1368 message = dbus_message_new_method_call ("org.a11y.Bus",
1373 dbus_error_init (&error);
1374 reply = dbus_connection_send_with_reply_and_block (session_bus,
1378 dbus_message_unref (message);
1382 g_warning ("Error retrieving accessibility bus address: %s: %s",
1383 error.name, error.message);
1384 dbus_error_free (&error);
1389 const char *tmp_address;
1390 if (!dbus_message_get_args (reply,
1396 dbus_message_unref (reply);
1399 address = g_strdup (tmp_address);
1400 dbus_message_unref (reply);
1407 atspi_get_a11y_bus (void)
1409 DBusConnection *bus = NULL;
1413 address = get_accessibility_bus_address_x11 ();
1415 address = get_accessibility_bus_address_dbus ();
1419 dbus_error_init (&error);
1420 bus = dbus_connection_open (address, &error);
1425 g_warning ("Couldn't connect to accessibility bus: %s", error.message);
1430 if (!dbus_bus_register (bus, &error))
1432 g_warning ("Couldn't register with accessibility bus: %s", error.message);