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);
268 g_hash_table_insert (app->hash, g_strdup (hyperlink->parent.path), hyperlink);
269 /* TODO: This should be a weak ref */
270 g_object_ref (hyperlink); /* for the hash */
283 GArray *state_bitflags;
286 static DBusHandlerResult
287 handle_remove_accessible (DBusConnection *bus, DBusMessage *message, void *user_data)
289 const char *sender = dbus_message_get_sender (message);
290 AtspiApplication *app;
292 DBusMessageIter iter, iter_struct;
293 const char *signature = dbus_message_get_signature (message);
296 if (strcmp (signature, "(so)") != 0)
298 g_warning ("AT-SPI: Unknown signature %s for RemoveAccessible", signature);
299 return DBUS_HANDLER_RESULT_HANDLED;
302 dbus_message_iter_init (message, &iter);
303 dbus_message_iter_recurse (&iter, &iter_struct);
304 dbus_message_iter_get_basic (&iter_struct, &sender);
305 dbus_message_iter_next (&iter_struct);
306 dbus_message_iter_get_basic (&iter_struct, &path);
307 app = get_application (sender);
308 a = ref_accessible (sender, path);
310 return DBUS_HANDLER_RESULT_HANDLED;
311 g_object_run_dispose (G_OBJECT (a));
312 g_hash_table_remove (app->hash, a->parent.path);
313 g_object_unref (a); /* unref our own ref */
314 return DBUS_HANDLER_RESULT_HANDLED;
318 add_app_to_desktop (AtspiAccessible *a, const char *bus_name)
322 dbus_error_init (&error);
323 AtspiAccessible *obj = ref_accessible (bus_name, atspi_path_root);
326 GList *new_list = g_list_append (a->children, obj);
329 a->children = new_list;
335 g_warning ("AT-SPI: Error calling getRoot for %s: %s", bus_name, error.message);
341 send_children_changed (AtspiAccessible *parent, AtspiAccessible *child, gboolean add)
345 memset (&e, 0, sizeof (e));
346 e.type = (add? "object:children-changed:add": "object:children-changed:remove");
348 e.detail1 = g_list_index (parent->children, child);
350 _atspi_send_event (&e);
354 unref_object_and_descendants (AtspiAccessible *obj)
358 for (l = obj->children; l; l = l->next)
360 unref_object_and_descendants (l->data);
362 g_object_unref (obj);
366 remove_app_from_desktop (AtspiAccessible *a, const char *bus_name)
369 AtspiAccessible *child;
371 for (l = a->children; l; l = l->next)
374 if (!strcmp (bus_name, child->parent.app->bus_name)) break;
380 send_children_changed (a, child, FALSE);
381 a->children = g_list_remove (a->children, child);
382 unref_object_and_descendants (child);
386 static AtspiAccessible *desktop;
389 get_reference_from_iter (DBusMessageIter *iter, const char **app_name, const char **path)
391 DBusMessageIter iter_struct;
393 dbus_message_iter_recurse (iter, &iter_struct);
394 dbus_message_iter_get_basic (&iter_struct, app_name);
395 dbus_message_iter_next (&iter_struct);
396 dbus_message_iter_get_basic (&iter_struct, path);
397 dbus_message_iter_next (iter);
401 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 new_list = g_list_append (accessible->children, child);
440 if (new_list) accessible->children = new_list;
444 dbus_message_iter_next (&iter_struct);
445 _atspi_dbus_set_interfaces (accessible, &iter_struct);
446 dbus_message_iter_next (&iter_struct);
449 if (accessible->name)
450 g_free (accessible->name);
451 dbus_message_iter_get_basic (&iter_struct, &name);
452 accessible->name = g_strdup (name);
453 dbus_message_iter_next (&iter_struct);
456 dbus_message_iter_get_basic (&iter_struct, &role);
457 accessible->role = role;
458 dbus_message_iter_next (&iter_struct);
461 if (accessible->description)
462 g_free (accessible->description);
463 dbus_message_iter_get_basic (&iter_struct, &description);
464 accessible->description = g_strdup (description);
465 dbus_message_iter_next (&iter_struct);
467 _atspi_dbus_set_state (accessible, &iter_struct);
468 dbus_message_iter_next (&iter_struct);
470 _atspi_accessible_add_cache (accessible, ATSPI_CACHE_NAME | ATSPI_CACHE_ROLE |
471 ATSPI_CACHE_PARENT | ATSPI_CACHE_DESCRIPTION);
472 if (!atspi_state_set_contains (accessible->states,
473 ATSPI_STATE_MANAGES_DESCENDANTS))
474 _atspi_accessible_add_cache (accessible, ATSPI_CACHE_CHILDREN);
476 /* This is a bit of a hack since the cache holds a ref, so we don't need
477 * the one provided for us anymore */
478 g_object_unref (accessible);
482 handle_get_items (DBusPendingCall *pending, void *user_data)
484 DBusMessage *reply = dbus_pending_call_steal_reply (pending);
485 DBusMessageIter iter, iter_array;
487 if (dbus_message_get_type (reply) == DBUS_MESSAGE_TYPE_ERROR)
489 const char *sender = dbus_message_get_sender (reply);
490 const char *error = NULL;
491 dbus_message_get_args (reply, NULL, DBUS_TYPE_STRING, &error,
493 g_warning ("AT-SPI: Error in GetItems, sender=%s, error=%s", sender, error);
494 dbus_message_unref (reply);
495 dbus_pending_call_unref (pending);
499 dbus_message_iter_init (reply, &iter);
500 dbus_message_iter_recurse (&iter, &iter_array);
501 while (dbus_message_iter_get_arg_type (&iter_array) != DBUS_TYPE_INVALID)
503 add_accessible_from_iter (&iter_array);
504 dbus_message_iter_next (&iter_array);
506 dbus_message_unref (reply);
507 dbus_pending_call_unref (pending);
510 /* TODO: Do we stil need this function? */
511 static AtspiAccessible *
512 ref_accessible_desktop (AtspiApplication *app)
515 DBusMessage *message, *reply;
516 DBusMessageIter iter, iter_array;
521 g_object_ref (desktop);
524 desktop = atspi_accessible_new (app, atspi_path_root);
529 g_hash_table_insert (app->hash, desktop->parent.path, desktop);
530 g_object_ref (desktop); /* for the hash */
531 desktop->name = g_strdup ("main");
532 dbus_error_init (&error);
533 message = dbus_message_new_method_call (atspi_bus_registry,
535 atspi_interface_accessible,
539 reply = _atspi_dbus_send_with_reply_and_block (message, NULL);
540 if (!reply || strcmp (dbus_message_get_signature (reply), "a(so)") != 0)
542 g_warning ("Couldn't get application list: %s", error.message);
544 dbus_message_unref (reply);
547 dbus_message_iter_init (reply, &iter);
548 dbus_message_iter_recurse (&iter, &iter_array);
549 while (dbus_message_iter_get_arg_type (&iter_array) != DBUS_TYPE_INVALID)
551 const char *app_name, *path;
552 get_reference_from_iter (&iter_array, &app_name, &path);
553 add_app_to_desktop (desktop, app_name);
555 dbus_message_unref (reply);
557 /* Record the alternate name as an alias for org.a11y.atspi.Registry */
558 bus_name_dup = g_strdup (dbus_message_get_sender (reply));
560 g_hash_table_insert (app_hash, bus_name_dup, app);
566 _atspi_ref_accessible (const char *app, const char *path)
568 AtspiApplication *a = get_application (app);
570 if ( APP_IS_REGISTRY(a))
572 return a->root = ref_accessible_desktop (a);
574 return ref_accessible (app, path);
578 _atspi_dbus_return_accessible_from_message (DBusMessage *message)
580 DBusMessageIter iter;
581 AtspiAccessible *retval = NULL;
582 const char *signature;
587 signature = dbus_message_get_signature (message);
588 if (!strcmp (signature, "(so)"))
590 dbus_message_iter_init (message, &iter);
591 retval = _atspi_dbus_return_accessible_from_iter (&iter);
595 g_warning ("AT-SPI: Called _atspi_dbus_return_accessible_from_message with strange signature %s", signature);
597 dbus_message_unref (message);
602 _atspi_dbus_return_accessible_from_iter (DBusMessageIter *iter)
604 const char *app_name, *path;
606 get_reference_from_iter (iter, &app_name, &path);
607 return ref_accessible (app_name, path);
611 _atspi_dbus_return_hyperlink_from_message (DBusMessage *message)
613 DBusMessageIter iter;
614 AtspiHyperlink *retval = NULL;
615 const char *signature = dbus_message_get_signature (message);
617 if (!strcmp (signature, "(so)"))
619 dbus_message_iter_init (message, &iter);
620 retval = _atspi_dbus_return_hyperlink_from_iter (&iter);
624 g_warning ("AT-SPI: Called _atspi_dbus_return_hyperlink_from_message with strange signature %s", signature);
626 dbus_message_unref (message);
631 _atspi_dbus_return_hyperlink_from_iter (DBusMessageIter *iter)
633 const char *app_name, *path;
635 get_reference_from_iter (iter, &app_name, &path);
636 return ref_hyperlink (app_name, path);
639 const char *cache_signal_type = "((so)(so)(so)a(so)assusau)";
641 static DBusHandlerResult
642 handle_add_accessible (DBusConnection *bus, DBusMessage *message, void *user_data)
644 DBusMessageIter iter;
645 const char *sender = dbus_message_get_sender (message);
647 if (strcmp (dbus_message_get_signature (message), cache_signal_type) != 0)
649 g_warning ("AT-SPI: AddAccessible with unknown signature %s\n",
650 dbus_message_get_signature (message));
651 return DBUS_HANDLER_RESULT_HANDLED;
654 dbus_message_iter_init (message, &iter);
655 add_accessible_from_iter (&iter);
656 return DBUS_HANDLER_RESULT_HANDLED;
662 DBusMessage *message;
666 static guint process_deferred_messages_id = -1;
669 process_deferred_message (BusDataClosure *closure)
671 int type = dbus_message_get_type (closure->message);
672 const char *interface = dbus_message_get_interface (closure->message);
674 if (type == DBUS_MESSAGE_TYPE_SIGNAL &&
675 !strncmp (interface, "org.a11y.atspi.Event.", 21))
677 atspi_dbus_handle_event (closure->bus, closure->message, closure->data);
679 if (dbus_message_is_method_call (closure->message, atspi_interface_device_event_listener, "NotifyEvent"))
681 atspi_dbus_handle_DeviceEvent (closure->bus,
682 closure->message, closure->data);
684 if (dbus_message_is_signal (closure->message, atspi_interface_cache, "AddAccessible"))
686 handle_add_accessible (closure->bus, closure->message, closure->data);
688 if (dbus_message_is_signal (closure->message, atspi_interface_cache, "RemoveAccessible"))
690 handle_remove_accessible (closure->bus, closure->message, closure->data);
694 static GList *deferred_messages = NULL;
697 _atspi_process_deferred_messages (gpointer data)
699 static int in_process_deferred_messages = 0;
701 if (in_process_deferred_messages)
703 in_process_deferred_messages = 1;
704 while (deferred_messages != NULL)
706 BusDataClosure *closure = deferred_messages->data;
707 process_deferred_message (closure);
708 deferred_messages = g_list_remove (deferred_messages, closure);
709 dbus_message_unref (closure->message);
710 dbus_connection_unref (closure->bus);
713 /* If data is NULL, assume that we were called from GLib */
715 process_deferred_messages_id = -1;
716 in_process_deferred_messages = 0;
720 static DBusHandlerResult
721 defer_message (DBusConnection *connection, DBusMessage *message, void *user_data)
723 BusDataClosure *closure = g_new (BusDataClosure, 1);
726 closure->bus = dbus_connection_ref (bus);
727 closure->message = dbus_message_ref (message);
728 closure->data = user_data;
730 new_list = g_list_append (deferred_messages, closure);
732 deferred_messages = new_list;
734 if (process_deferred_messages_id == -1)
735 process_deferred_messages_id = g_idle_add (_atspi_process_deferred_messages, NULL);
736 return DBUS_HANDLER_RESULT_HANDLED;
739 static DBusHandlerResult
740 atspi_dbus_filter (DBusConnection *bus, DBusMessage *message, void *data)
742 int type = dbus_message_get_type (message);
743 const char *interface = dbus_message_get_interface (message);
745 if (type == DBUS_MESSAGE_TYPE_SIGNAL &&
746 !strncmp (interface, "org.a11y.atspi.Event.", 21))
748 return defer_message (bus, message, data);
750 if (dbus_message_is_method_call (message, atspi_interface_device_event_listener, "NotifyEvent"))
752 return defer_message (bus, message, data);
754 if (dbus_message_is_signal (message, atspi_interface_cache, "AddAccessible"))
756 return defer_message (bus, message, data);
758 if (dbus_message_is_signal (message, atspi_interface_cache, "RemoveAccessible"))
760 return defer_message (bus, message, data);
762 return DBUS_HANDLER_RESULT_NOT_YET_HANDLED;
765 static const char *signal_interfaces[] =
767 "org.a11y.atspi.Event.Object",
768 "org.a11y.atspi.Event.Window",
769 "org.a11y.atspi.Event.Mouse",
770 "org.a11y.atspi.Event.Terminal",
771 "org.a11y.atspi.Event.Document",
772 "org.a11y.atspi.Event.Focus",
777 * Returns a 'canonicalized' value for DISPLAY,
778 * with the screen number stripped off if present.
780 * TODO: Avoid having duplicate functions for this here and in at-spi2-atk
783 spi_display_name (void)
785 static const char *canonical_display_name = NULL;
786 if (!canonical_display_name)
788 const gchar *display_env = g_getenv ("AT_SPI_DISPLAY");
791 display_env = g_getenv ("DISPLAY");
792 if (!display_env || !display_env[0])
793 canonical_display_name = ":0";
796 gchar *display_p, *screen_p;
797 canonical_display_name = g_strdup (display_env);
798 display_p = g_utf8_strrchr (canonical_display_name, -1, ':');
799 screen_p = g_utf8_strrchr (canonical_display_name, -1, '.');
800 if (screen_p && display_p && (screen_p > display_p))
808 canonical_display_name = display_env;
811 return canonical_display_name;
817 * Connects to the accessibility registry and initializes the SPI.
819 * Returns: 0 on success, otherwise an integer error code.
826 const gchar *no_cache;
839 dbus_error_init (&error);
840 bus = atspi_get_a11y_bus ();
843 dbus_bus_register (bus, &error);
844 atspi_dbus_connection_setup_with_g_main(bus, g_main_context_default());
845 dbus_connection_add_filter (bus, atspi_dbus_filter, NULL, NULL);
846 dbind_set_timeout (1000);
847 match = g_strdup_printf ("type='signal',interface='%s',member='AddAccessible'", atspi_interface_cache);
848 dbus_error_init (&error);
849 dbus_bus_add_match (bus, match, &error);
851 match = g_strdup_printf ("type='signal',interface='%s',member='RemoveAccessible'", atspi_interface_cache);
852 dbus_bus_add_match (bus, match, &error);
854 match = g_strdup_printf ("type='signal',interface='%s',member='ChildrenChanged'", atspi_interface_event_object);
855 dbus_bus_add_match (bus, match, &error);
857 match = g_strdup_printf ("type='signal',interface='%s',member='PropertyChange'", atspi_interface_event_object);
858 dbus_bus_add_match (bus, match, &error);
860 match = g_strdup_printf ("type='signal',interface='%s',member='StateChanged'", atspi_interface_event_object);
861 dbus_bus_add_match (bus, match, &error);
864 no_cache = g_getenv ("ATSPI_NO_CACHE");
865 if (no_cache && g_strcmp0 (no_cache, "0") != 0)
866 atspi_no_cache = TRUE;
873 * Starts/enters the main event loop for the AT-SPI services.
875 * (NOTE: This method does not return control, it is exited via a call to
876 * atspi_event_quit () from within an event handler).
880 atspi_event_main (void)
882 atspi_main_loop = g_main_loop_new (NULL, FALSE);
883 g_main_loop_run (atspi_main_loop);
884 atspi_main_loop = NULL;
890 * Quits the last main event loop for the SPI services,
891 * see atspi_event_main
894 atspi_event_quit (void)
896 g_main_loop_quit (atspi_main_loop);
902 * Disconnects from the Accessibility Registry and releases
903 * any floating resources. Call only once at exit.
905 * Returns: 0 if there were no leaks, otherwise non zero.
917 atspi_inited = FALSE;
921 leaked = g_hash_table_size (live_refs);
934 _atspi_dbus_call (gpointer obj, const char *interface, const char *method, GError **error, const char *type, ...)
939 AtspiObject *aobj = ATSPI_OBJECT (obj);
941 if (!aobj->app || !aobj->app->bus)
943 g_set_error_literal (error, ATSPI_ERROR, ATSPI_ERROR_APPLICATION_GONE,
944 _("The application no longer exists"));
948 va_start (args, type);
949 dbus_error_init (&err);
950 retval = dbind_method_call_reentrant_va (aobj->app->bus, aobj->app->bus_name,
951 aobj->path, interface, method, &err,
954 _atspi_process_deferred_messages ((gpointer)TRUE);
955 if (dbus_error_is_set (&err))
957 /* TODO: Set gerror */
958 dbus_error_free (&err);
964 _atspi_dbus_call_partial (gpointer obj,
965 const char *interface,
968 const char *type, ...)
972 va_start (args, type);
973 return _atspi_dbus_call_partial_va (obj, interface, method, error, type, args);
977 _atspi_dbus_call_partial_va (gpointer obj,
978 const char *interface,
984 AtspiObject *aobj = ATSPI_OBJECT (obj);
986 DBusMessage *msg = NULL, *reply = NULL;
987 DBusMessageIter iter;
990 dbus_error_init (&err);
992 if (!aobj->app || !aobj->app->bus)
994 g_set_error_literal (error, ATSPI_ERROR, ATSPI_ERROR_APPLICATION_GONE,
995 _("The application no longer exists"));
999 msg = dbus_message_new_method_call (aobj->app->bus_name, aobj->path, interface, method);
1004 dbus_message_iter_init_append (msg, &iter);
1005 dbind_any_marshal_va (&iter, &p, args);
1007 reply = dbind_send_and_allow_reentry (aobj->app->bus, msg, &err);
1011 dbus_message_unref (msg);
1012 _atspi_process_deferred_messages ((gpointer)TRUE);
1013 if (dbus_error_is_set (&err))
1015 /* TODO: Set gerror */
1016 dbus_error_free (&err);
1022 _atspi_dbus_get_property (gpointer obj, const char *interface, const char *name, GError **error, const char *type, void *data)
1024 DBusMessage *message, *reply;
1025 DBusMessageIter iter, iter_variant;
1027 dbus_bool_t retval = FALSE;
1028 AtspiObject *aobj = ATSPI_OBJECT (obj);
1029 char expected_type = (type [0] == '(' ? 'r' : type [0]);
1034 if (!aobj->app || !aobj->app->bus)
1036 g_set_error_literal (error, ATSPI_ERROR, ATSPI_ERROR_APPLICATION_GONE,
1037 _("The application no longer exists"));
1041 message = dbus_message_new_method_call (aobj->app->bus_name,
1043 "org.freedesktop.DBus.Properties",
1047 // TODO: throw exception
1050 dbus_message_append_args (message, DBUS_TYPE_STRING, &interface, DBUS_TYPE_STRING, &name, DBUS_TYPE_INVALID);
1051 dbus_error_init (&err);
1052 reply = dbind_send_and_allow_reentry (aobj->app->bus, message, &err);
1053 dbus_message_unref (message);
1054 _atspi_process_deferred_messages ((gpointer)TRUE);
1057 // TODO: throw exception
1061 if (dbus_message_get_type (reply) == DBUS_MESSAGE_TYPE_ERROR)
1064 dbus_message_get_args (message, NULL, DBUS_TYPE_STRING, &err, DBUS_TYPE_INVALID);
1066 g_set_error_literal (error, ATSPI_ERROR, ATSPI_ERROR_IPC, err);
1070 dbus_message_iter_init (reply, &iter);
1071 if (dbus_message_iter_get_arg_type (&iter) != 'v')
1073 g_warning ("AT-SPI: expected a variant when fetching %s from interface %s; got %s\n", name, interface, dbus_message_get_signature (reply));
1076 dbus_message_iter_recurse (&iter, &iter_variant);
1077 if (dbus_message_iter_get_arg_type (&iter_variant) != expected_type)
1079 g_warning ("atspi_dbus_get_property: Wrong type: expected %s, got %c\n", type, dbus_message_iter_get_arg_type (&iter_variant));
1082 if (!strcmp (type, "(so)"))
1084 *((AtspiAccessible **)data) = _atspi_dbus_return_accessible_from_iter (&iter_variant);
1088 dbus_message_iter_get_basic (&iter_variant, data);
1089 if (type [0] == 's')
1090 *(char **)data = g_strdup (*(char **)data);
1095 dbus_message_unref (reply);
1100 _atspi_dbus_send_with_reply_and_block (DBusMessage *message, GError **error)
1104 AtspiApplication *app;
1105 DBusConnection *bus;
1107 app = get_application (dbus_message_get_destination (message));
1109 if (app && !app->bus)
1110 return NULL; /* will fail anyway; app has been disposed */
1112 bus = (app ? app->bus : _atspi_bus());
1113 dbus_error_init (&err);
1114 reply = dbind_send_and_allow_reentry (bus, message, &err);
1115 _atspi_process_deferred_messages ((gpointer)TRUE);
1116 dbus_message_unref (message);
1120 g_set_error_literal (error, ATSPI_ERROR, ATSPI_ERROR_IPC, err.message);
1121 dbus_error_free (&err);
1127 _atspi_dbus_return_hash_from_message (DBusMessage *message)
1129 DBusMessageIter iter;
1135 _ATSPI_DBUS_CHECK_SIG (message, "a{ss}", NULL, NULL);
1137 dbus_message_iter_init (message, &iter);
1138 ret = _atspi_dbus_hash_from_iter (&iter);
1139 dbus_message_unref (message);
1144 _atspi_dbus_hash_from_iter (DBusMessageIter *iter)
1146 GHashTable *hash = g_hash_table_new (g_str_hash, g_str_equal);
1147 DBusMessageIter iter_array, iter_dict;
1149 dbus_message_iter_recurse (iter, &iter_array);
1150 while (dbus_message_iter_get_arg_type (&iter_array) != DBUS_TYPE_INVALID)
1152 const char *name, *value;
1153 dbus_message_iter_recurse (&iter_array, &iter_dict);
1154 dbus_message_iter_get_basic (&iter_dict, &name);
1155 dbus_message_iter_next (&iter_dict);
1156 dbus_message_iter_get_basic (&iter_dict, &value);
1157 g_hash_table_insert (hash, g_strdup (name), g_strdup (value));
1158 dbus_message_iter_next (&iter_array);
1164 _atspi_dbus_return_attribute_array_from_message (DBusMessage *message)
1166 DBusMessageIter iter;
1172 _ATSPI_DBUS_CHECK_SIG (message, "a{ss}", NULL, NULL);
1174 dbus_message_iter_init (message, &iter);
1176 ret = _atspi_dbus_attribute_array_from_iter (&iter);
1177 dbus_message_unref (message);
1182 _atspi_dbus_attribute_array_from_iter (DBusMessageIter *iter)
1184 DBusMessageIter iter_array, iter_dict;
1185 GArray *array = g_array_new (TRUE, TRUE, sizeof (gchar *));
1187 dbus_message_iter_recurse (iter, &iter_array);
1188 while (dbus_message_iter_get_arg_type (&iter_array) != DBUS_TYPE_INVALID)
1190 const char *name, *value;
1193 dbus_message_iter_recurse (&iter_array, &iter_dict);
1194 dbus_message_iter_get_basic (&iter_dict, &name);
1195 dbus_message_iter_next (&iter_dict);
1196 dbus_message_iter_get_basic (&iter_dict, &value);
1197 str = g_strdup_printf ("%s:%s", name, value);
1198 new_array = g_array_append_val (array, str);
1201 dbus_message_iter_next (&iter_array);;
1207 _atspi_dbus_set_interfaces (AtspiAccessible *accessible, DBusMessageIter *iter)
1209 DBusMessageIter iter_array;
1211 accessible->interfaces = 0;
1212 dbus_message_iter_recurse (iter, &iter_array);
1213 while (dbus_message_iter_get_arg_type (&iter_array) != DBUS_TYPE_INVALID)
1217 dbus_message_iter_get_basic (&iter_array, &iface);
1218 if (!strcmp (iface, "org.freedesktop.DBus.Introspectable")) continue;
1219 n = _atspi_get_iface_num (iface);
1222 g_warning ("AT-SPI: Unknown interface %s", iface);
1225 accessible->interfaces |= (1 << n);
1226 dbus_message_iter_next (&iter_array);
1228 _atspi_accessible_add_cache (accessible, ATSPI_CACHE_INTERFACES);
1232 _atspi_dbus_set_state (AtspiAccessible *accessible, DBusMessageIter *iter)
1234 DBusMessageIter iter_array;
1236 dbus_uint32_t *states;
1238 dbus_message_iter_recurse (iter, &iter_array);
1239 dbus_message_iter_get_fixed_array (&iter_array, &states, &count);
1242 g_warning ("AT-SPI: expected 2 values in states array; got %d\n", count);
1243 if (!accessible->states)
1244 accessible->states = _atspi_state_set_new_internal (accessible, 0);
1248 guint64 val = ((guint64)states [1]) << 32;
1250 if (!accessible->states)
1251 accessible->states = _atspi_state_set_new_internal (accessible, val);
1253 accessible->states->states = val;
1255 _atspi_accessible_add_cache (accessible, ATSPI_CACHE_STATES);
1259 atspi_error_quark (void)
1261 return g_quark_from_static_string ("atspi_error");
1265 * Gets the IOR from the XDisplay.
1268 get_accessibility_bus_address_x11 (void)
1272 Display *bridge_display;
1274 unsigned char *data = NULL;
1275 unsigned long nitems;
1276 unsigned long leftover;
1278 bridge_display = XOpenDisplay (spi_display_name ());
1279 if (!bridge_display)
1281 g_warning ("Could not open X display");
1285 AT_SPI_BUS = XInternAtom (bridge_display, "AT_SPI_BUS", False);
1286 XGetWindowProperty (bridge_display,
1287 XDefaultRootWindow (bridge_display),
1289 (long) BUFSIZ, False,
1290 (Atom) 31, &actual_type, &actual_format,
1291 &nitems, &leftover, &data);
1292 XCloseDisplay (bridge_display);
1294 return g_strdup (data);
1298 get_accessibility_bus_address_dbus (void)
1300 DBusConnection *session_bus = NULL;
1301 DBusMessage *message;
1304 char *address = NULL;
1306 session_bus = dbus_bus_get (DBUS_BUS_SESSION, NULL);
1310 message = dbus_message_new_method_call ("org.a11y.Bus",
1315 dbus_error_init (&error);
1316 reply = dbus_connection_send_with_reply_and_block (session_bus,
1320 dbus_message_unref (message);
1324 g_warning ("Error retrieving accessibility bus address: %s: %s",
1325 error.name, error.message);
1326 dbus_error_init (&error);
1331 const char *tmp_address;
1332 if (!dbus_message_get_args (reply,
1338 dbus_message_unref (reply);
1341 address = g_strdup (tmp_address);
1342 dbus_message_unref (reply);
1349 atspi_get_a11y_bus (void)
1351 DBusConnection *bus = NULL;
1355 address = get_accessibility_bus_address_x11 ();
1357 address = get_accessibility_bus_address_dbus ();
1361 dbus_error_init (&error);
1362 bus = dbus_connection_open (address, &error);
1367 g_warning ("Couldn't connect to accessibility bus: %s", error.message);
1372 if (!dbus_bus_register (bus, &error))
1374 g_warning ("Couldn't register with accessibility bus: %s", error.message);