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 "dbus/dbus-glib.h"
37 static void handle_get_items (DBusPendingCall *pending, void *user_data);
39 static DBusConnection *bus = NULL;
40 static GHashTable *live_refs = NULL;
42 const char *atspi_path_dec = ATSPI_DBUS_PATH_DEC;
43 const char *atspi_path_registry = ATSPI_DBUS_PATH_REGISTRY;
44 const char *atspi_path_root = ATSPI_DBUS_PATH_ROOT;
45 const char *atspi_bus_registry = ATSPI_DBUS_NAME_REGISTRY;
46 const char *atspi_interface_accessible = ATSPI_DBUS_INTERFACE_ACCESSIBLE;
47 const char *atspi_interface_action = ATSPI_DBUS_INTERFACE_ACTION;
48 const char *atspi_interface_application = ATSPI_DBUS_INTERFACE_APPLICATION;
49 const char *atspi_interface_collection = ATSPI_DBUS_INTERFACE_COLLECTION;
50 const char *atspi_interface_component = ATSPI_DBUS_INTERFACE_COMPONENT;
51 const char *atspi_interface_dec = ATSPI_DBUS_INTERFACE_DEC;
52 const char *atspi_interface_device_event_listener = ATSPI_DBUS_INTERFACE_DEVICE_EVENT_LISTENER;
53 const char *atspi_interface_document = ATSPI_DBUS_INTERFACE_DOCUMENT;
54 const char *atspi_interface_editable_text = ATSPI_DBUS_INTERFACE_EDITABLE_TEXT;
55 const char *atspi_interface_event_object = ATSPI_DBUS_INTERFACE_EVENT_OBJECT;
56 const char *atspi_interface_hyperlink = ATSPI_DBUS_INTERFACE_HYPERLINK;
57 const char *atspi_interface_hypertext = ATSPI_DBUS_INTERFACE_HYPERTEXT;
58 const char *atspi_interface_image = ATSPI_DBUS_INTERFACE_IMAGE;
59 const char *atspi_interface_registry = ATSPI_DBUS_INTERFACE_REGISTRY;
60 const char *atspi_interface_selection = ATSPI_DBUS_INTERFACE_SELECTION;
61 const char *atspi_interface_table = ATSPI_DBUS_INTERFACE_TABLE;
62 const char *atspi_interface_text = ATSPI_DBUS_INTERFACE_TEXT;
63 const char *atspi_interface_cache = ATSPI_DBUS_INTERFACE_CACHE;
64 const char *atspi_interface_value = ATSPI_DBUS_INTERFACE_VALUE;
66 static const char *interfaces[] =
68 ATSPI_DBUS_INTERFACE_ACCESSIBLE,
69 ATSPI_DBUS_INTERFACE_ACTION,
70 ATSPI_DBUS_INTERFACE_APPLICATION,
71 ATSPI_DBUS_INTERFACE_COLLECTION,
72 ATSPI_DBUS_INTERFACE_COMPONENT,
73 ATSPI_DBUS_INTERFACE_DOCUMENT,
74 ATSPI_DBUS_INTERFACE_EDITABLE_TEXT,
75 ATSPI_DBUS_INTERFACE_HYPERLINK,
76 ATSPI_DBUS_INTERFACE_HYPERTEXT,
77 ATSPI_DBUS_INTERFACE_IMAGE,
78 "org.a11y.atspi.LoginHelper",
79 ATSPI_DBUS_INTERFACE_SELECTION,
80 ATSPI_DBUS_INTERFACE_TABLE,
81 ATSPI_DBUS_INTERFACE_TEXT,
82 ATSPI_DBUS_INTERFACE_VALUE,
87 _atspi_get_iface_num (const char *iface)
89 /* TODO: Use a binary search or hash to improve performance */
92 for (i = 0; interfaces[i]; i++)
94 if (!strcmp(iface, interfaces[i])) return i;
104 live_refs = g_hash_table_new (g_direct_hash, g_direct_equal);
109 /* TODO: Add an application parameter */
118 #define APP_IS_REGISTRY(app) (!strcmp (app->bus_name, atspi_bus_registry))
129 g_hash_table_destroy (refs);
133 static gboolean atspi_inited = FALSE;
135 static GHashTable *app_hash = NULL;
138 handle_get_bus_address (DBusPendingCall *pending, void *user_data)
140 AtspiApplication *app = user_data;
141 DBusMessage *reply = dbus_pending_call_steal_reply (pending);
142 DBusMessage *message;
144 DBusPendingCall *new_pending;
146 if (dbus_message_get_type (reply) == DBUS_MESSAGE_TYPE_METHOD_RETURN)
148 if (dbus_message_get_args (reply, NULL, DBUS_TYPE_STRING, &address,
152 dbus_error_init (&error);
153 DBusConnection *bus = dbus_connection_open (address, &error);
157 dbus_connection_unref (app->bus);
162 dbus_message_unref (reply);
163 dbus_pending_call_unref (pending);
165 message = dbus_message_new_method_call (app->bus_name,
166 "/org/a11y/atspi/cache",
167 atspi_interface_cache, "GetItems");
169 dbus_connection_send_with_reply (app->bus, message, &new_pending, 2000);
170 dbus_pending_call_set_notify (new_pending, handle_get_items, app, NULL);
171 dbus_message_unref (message);
174 static AtspiApplication *
175 get_application (const char *bus_name)
177 AtspiApplication *app = NULL;
179 DBusMessage *message;
181 DBusPendingCall *pending = NULL;
185 app_hash = g_hash_table_new_full (g_str_hash, g_str_equal, g_free, (GDestroyNotify)g_object_unref);
186 if (!app_hash) return NULL;
188 app = g_hash_table_lookup (app_hash, bus_name);
190 bus_name_dup = g_strdup (bus_name);
191 if (!bus_name_dup) return NULL;
192 // TODO: change below to something that will send state-change:defunct notification if necessary */
193 app = _atspi_application_new (bus_name);
194 if (!app) return NULL;
195 app->hash = g_hash_table_new_full (g_str_hash, g_str_equal, g_free, g_object_unref);
196 app->bus = dbus_connection_ref (_atspi_bus ());
197 app->cache = ATSPI_CACHE_UNDEFINED;
198 g_hash_table_insert (app_hash, bus_name_dup, app);
199 dbus_error_init (&error);
200 message = dbus_message_new_method_call (bus_name, atspi_path_root,
201 atspi_interface_application, "GetApplicationBusAddress");
203 dbus_connection_send_with_reply (app->bus, message, &pending, 2000);
204 dbus_pending_call_set_notify (pending, handle_get_bus_address, app, NULL);
205 dbus_message_unref (message);
209 static AtspiAccessible *
210 ref_accessible (const char *app_name, const char *path)
212 AtspiApplication *app;
215 if (!strcmp (path, ATSPI_DBUS_PATH_NULL))
218 app = get_application (app_name);
220 if (!strcmp (path, "/org/a11y/atspi/accessible/root"))
224 app->root = atspi_accessible_new (app, atspi_path_root);
225 app->root->accessible_parent = atspi_get_desktop (0);
227 return g_object_ref (app->root);
230 a = g_hash_table_lookup (app->hash, path);
233 return g_object_ref (a);
235 a = atspi_accessible_new (app, path);
238 g_hash_table_insert (app->hash, g_strdup (a->parent.path), a);
239 g_object_ref (a); /* for the hash */
243 static AtspiHyperlink *
244 ref_hyperlink (const char *app_name, const char *path)
246 AtspiApplication *app = get_application (app_name);
247 AtspiHyperlink *hyperlink;
249 if (!strcmp (path, ATSPI_DBUS_PATH_NULL))
252 hyperlink = g_hash_table_lookup (app->hash, path);
255 return g_object_ref (hyperlink);
257 hyperlink = atspi_hyperlink_new (app, path);
260 g_hash_table_insert (app->hash, g_strdup (hyperlink->parent.path), hyperlink);
261 /* TODO: This should be a weak ref */
262 g_object_ref (hyperlink); /* for the hash */
275 GArray *state_bitflags;
278 static DBusHandlerResult
279 handle_remove_accessible (DBusConnection *bus, DBusMessage *message, void *user_data)
281 const char *sender = dbus_message_get_sender (message);
282 AtspiApplication *app;
284 DBusMessageIter iter, iter_struct;
285 const char *signature = dbus_message_get_signature (message);
288 if (strcmp (signature, "(so)") != 0)
290 g_warning (_("AT-SPI: Unknown signature %s for RemoveAccessible"), signature);
291 return DBUS_HANDLER_RESULT_HANDLED;
294 dbus_message_iter_init (message, &iter);
295 dbus_message_iter_recurse (&iter, &iter_struct);
296 dbus_message_iter_get_basic (&iter_struct, &sender);
297 dbus_message_iter_next (&iter_struct);
298 dbus_message_iter_get_basic (&iter_struct, &path);
299 app = get_application (sender);
300 a = ref_accessible (sender, path);
302 return DBUS_HANDLER_RESULT_HANDLED;
303 g_object_run_dispose (G_OBJECT (a));
304 g_hash_table_remove (app->hash, a->parent.path);
305 g_object_unref (a); /* unref our own ref */
306 return DBUS_HANDLER_RESULT_HANDLED;
310 add_app_to_desktop (AtspiAccessible *a, const char *bus_name)
314 dbus_error_init (&error);
315 AtspiAccessible *obj = ref_accessible (bus_name, atspi_path_root);
318 GList *new_list = g_list_append (a->children, obj);
321 a->children = new_list;
327 g_warning (_("AT-SPI: Error calling getRoot for %s: %s"), bus_name, error.message);
333 send_children_changed (AtspiAccessible *parent, AtspiAccessible *child, gboolean add)
337 memset (&e, 0, sizeof (e));
338 e.type = (add? "object:children-changed:add": "object:children-changed:remove");
340 e.detail1 = g_list_index (parent->children, child);
342 _atspi_send_event (&e);
346 unref_object_and_descendants (AtspiAccessible *obj)
350 for (l = obj->children; l; l = l->next)
352 unref_object_and_descendants (l->data);
354 g_object_unref (obj);
358 remove_app_from_desktop (AtspiAccessible *a, const char *bus_name)
361 AtspiAccessible *child;
363 for (l = a->children; l; l = l->next)
366 if (!strcmp (bus_name, child->parent.app->bus_name)) break;
372 send_children_changed (a, child, FALSE);
373 a->children = g_list_remove (a->children, child);
374 unref_object_and_descendants (child);
378 static AtspiAccessible *desktop;
381 get_reference_from_iter (DBusMessageIter *iter, const char **app_name, const char **path)
383 DBusMessageIter iter_struct;
385 dbus_message_iter_recurse (iter, &iter_struct);
386 dbus_message_iter_get_basic (&iter_struct, app_name);
387 dbus_message_iter_next (&iter_struct);
388 dbus_message_iter_get_basic (&iter_struct, path);
389 dbus_message_iter_next (iter);
393 add_accessible_from_iter (DBusMessageIter *iter)
396 DBusMessageIter iter_struct, iter_array;
397 const char *app_name, *path;
398 AtspiAccessible *accessible;
399 const char *name, *description;
402 dbus_message_iter_recurse (iter, &iter_struct);
405 get_reference_from_iter (&iter_struct, &app_name, &path);
406 accessible = ref_accessible (app_name, path);
410 /* Get application: TODO */
411 dbus_message_iter_next (&iter_struct);
414 get_reference_from_iter (&iter_struct, &app_name, &path);
415 if (accessible->accessible_parent)
416 g_object_unref (accessible->accessible_parent);
417 accessible->accessible_parent = ref_accessible (app_name, path);
420 while (accessible->children)
422 g_object_unref (accessible->children->data);
423 accessible->children = g_list_remove (accessible->children, accessible->children->data);
425 dbus_message_iter_recurse (&iter_struct, &iter_array);
426 while (dbus_message_iter_get_arg_type (&iter_array) != DBUS_TYPE_INVALID)
428 AtspiAccessible *child;
429 get_reference_from_iter (&iter_array, &app_name, &path);
430 child = ref_accessible (app_name, path);
431 new_list = g_list_append (accessible->children, child);
432 if (new_list) accessible->children = new_list;
436 dbus_message_iter_next (&iter_struct);
437 _atspi_dbus_set_interfaces (accessible, &iter_struct);
438 dbus_message_iter_next (&iter_struct);
441 if (accessible->name)
442 g_free (accessible->name);
443 dbus_message_iter_get_basic (&iter_struct, &name);
444 accessible->name = g_strdup (name);
445 dbus_message_iter_next (&iter_struct);
448 dbus_message_iter_get_basic (&iter_struct, &role);
449 accessible->role = role;
450 dbus_message_iter_next (&iter_struct);
453 if (accessible->description)
454 g_free (accessible->description);
455 dbus_message_iter_get_basic (&iter_struct, &description);
456 accessible->description = g_strdup (description);
457 dbus_message_iter_next (&iter_struct);
459 _atspi_dbus_set_state (accessible, &iter_struct);
460 dbus_message_iter_next (&iter_struct);
462 _atspi_accessible_add_cache (accessible, ATSPI_CACHE_NAME | ATSPI_CACHE_ROLE |
463 ATSPI_CACHE_PARENT | ATSPI_CACHE_DESCRIPTION);
464 if (!atspi_state_set_contains (accessible->states,
465 ATSPI_STATE_MANAGES_DESCENDANTS))
466 _atspi_accessible_add_cache (accessible, ATSPI_CACHE_CHILDREN);
468 /* This is a bit of a hack since the cache holds a ref, so we don't need
469 * the one provided for us anymore */
470 g_object_unref (accessible);
474 handle_get_items (DBusPendingCall *pending, void *user_data)
476 DBusMessage *reply = dbus_pending_call_steal_reply (pending);
477 DBusMessageIter iter, iter_array;
479 if (dbus_message_get_type (reply) == DBUS_MESSAGE_TYPE_ERROR)
481 const char *sender = dbus_message_get_sender (reply);
482 const char *error = NULL;
483 dbus_message_get_args (reply, NULL, DBUS_TYPE_STRING, &error,
485 g_warning (_("AT-SPI: Error in GetItems, sender=%s, error=%s"), sender, error);
486 dbus_message_unref (reply);
487 dbus_pending_call_unref (pending);
491 dbus_message_iter_init (reply, &iter);
492 dbus_message_iter_recurse (&iter, &iter_array);
493 while (dbus_message_iter_get_arg_type (&iter_array) != DBUS_TYPE_INVALID)
495 add_accessible_from_iter (&iter_array);
496 dbus_message_iter_next (&iter_array);
498 dbus_message_unref (reply);
499 dbus_pending_call_unref (pending);
502 /* TODO: Do we stil need this function? */
503 static AtspiAccessible *
504 ref_accessible_desktop (AtspiApplication *app)
507 DBusMessage *message, *reply;
508 DBusMessageIter iter, iter_array;
513 g_object_ref (desktop);
516 desktop = atspi_accessible_new (app, atspi_path_root);
521 g_hash_table_insert (app->hash, desktop->parent.path, desktop);
522 g_object_ref (desktop); /* for the hash */
523 desktop->name = g_strdup ("main");
524 dbus_error_init (&error);
525 message = dbus_message_new_method_call (atspi_bus_registry,
527 atspi_interface_accessible,
531 reply = _atspi_dbus_send_with_reply_and_block (message, NULL);
532 if (!reply || strcmp (dbus_message_get_signature (reply), "a(so)") != 0)
534 g_warning ("Couldn't get application list: %s", error.message);
536 dbus_message_unref (reply);
539 dbus_message_iter_init (reply, &iter);
540 dbus_message_iter_recurse (&iter, &iter_array);
541 while (dbus_message_iter_get_arg_type (&iter_array) != DBUS_TYPE_INVALID)
543 const char *app_name, *path;
544 get_reference_from_iter (&iter_array, &app_name, &path);
545 add_app_to_desktop (desktop, app_name);
547 dbus_message_unref (reply);
549 /* Record the alternate name as an alias for org.a11y.atspi.Registry */
550 bus_name_dup = g_strdup (dbus_message_get_sender (reply));
552 g_hash_table_insert (app_hash, bus_name_dup, app);
558 _atspi_ref_accessible (const char *app, const char *path)
560 AtspiApplication *a = get_application (app);
562 if ( APP_IS_REGISTRY(a))
564 return a->root = ref_accessible_desktop (a);
566 return ref_accessible (app, path);
570 _atspi_dbus_return_accessible_from_message (DBusMessage *message)
572 DBusMessageIter iter;
573 AtspiAccessible *retval = NULL;
574 const char *signature;
579 signature = dbus_message_get_signature (message);
580 if (!strcmp (signature, "(so)"))
582 dbus_message_iter_init (message, &iter);
583 retval = _atspi_dbus_return_accessible_from_iter (&iter);
587 g_warning (_("AT-SPI: Called _atspi_dbus_return_accessible_from_message with strange signature %s"), signature);
589 dbus_message_unref (message);
594 _atspi_dbus_return_accessible_from_iter (DBusMessageIter *iter)
596 const char *app_name, *path;
598 get_reference_from_iter (iter, &app_name, &path);
599 return ref_accessible (app_name, path);
603 _atspi_dbus_return_hyperlink_from_message (DBusMessage *message)
605 DBusMessageIter iter;
606 AtspiHyperlink *retval = NULL;
607 const char *signature = dbus_message_get_signature (message);
609 if (!strcmp (signature, "(so)"))
611 dbus_message_iter_init (message, &iter);
612 retval = _atspi_dbus_return_hyperlink_from_iter (&iter);
616 g_warning (_("AT-SPI: Called _atspi_dbus_return_hyperlink_from_message with strange signature %s"), signature);
618 dbus_message_unref (message);
623 _atspi_dbus_return_hyperlink_from_iter (DBusMessageIter *iter)
625 const char *app_name, *path;
627 get_reference_from_iter (iter, &app_name, &path);
628 return ref_hyperlink (app_name, path);
631 const char *cache_signal_type = "((so)(so)(so)a(so)assusau)";
633 static DBusHandlerResult
634 handle_add_accessible (DBusConnection *bus, DBusMessage *message, void *user_data)
636 DBusMessageIter iter;
637 const char *sender = dbus_message_get_sender (message);
639 if (strcmp (dbus_message_get_signature (message), cache_signal_type) != 0)
641 g_warning (_("AT-SPI: AddAccessible with unknown signature %s\n"),
642 dbus_message_get_signature (message));
643 return DBUS_HANDLER_RESULT_HANDLED;
646 dbus_message_iter_init (message, &iter);
647 add_accessible_from_iter (&iter);
648 return DBUS_HANDLER_RESULT_HANDLED;
654 DBusMessage *message;
658 static guint process_deferred_messages_id = -1;
661 process_deferred_message (BusDataClosure *closure)
663 int type = dbus_message_get_type (closure->message);
664 const char *interface = dbus_message_get_interface (closure->message);
666 if (type == DBUS_MESSAGE_TYPE_SIGNAL &&
667 !strncmp (interface, "org.a11y.atspi.Event.", 21))
669 atspi_dbus_handle_event (closure->bus, closure->message, closure->data);
671 if (dbus_message_is_method_call (closure->message, atspi_interface_device_event_listener, "NotifyEvent"))
673 atspi_dbus_handle_DeviceEvent (closure->bus,
674 closure->message, closure->data);
676 if (dbus_message_is_signal (closure->message, atspi_interface_cache, "AddAccessible"))
678 handle_add_accessible (closure->bus, closure->message, closure->data);
680 if (dbus_message_is_signal (closure->message, atspi_interface_cache, "RemoveAccessible"))
682 handle_remove_accessible (closure->bus, closure->message, closure->data);
686 static GList *deferred_messages = NULL;
689 _atspi_process_deferred_messages (gpointer data)
691 static int in_process_deferred_messages = 0;
693 if (in_process_deferred_messages)
695 in_process_deferred_messages = 1;
696 while (deferred_messages != NULL)
698 BusDataClosure *closure = deferred_messages->data;
699 process_deferred_message (closure);
700 deferred_messages = g_list_remove (deferred_messages, closure);
701 dbus_message_unref (closure->message);
702 dbus_connection_unref (closure->bus);
705 /* If data is NULL, assume that we were called from GLib */
707 process_deferred_messages_id = -1;
708 in_process_deferred_messages = 0;
712 static DBusHandlerResult
713 defer_message (DBusConnection *connection, DBusMessage *message, void *user_data)
715 BusDataClosure *closure = g_new (BusDataClosure, 1);
719 return DBUS_HANDLER_RESULT_NOT_YET_HANDLED;
720 closure->bus = dbus_connection_ref (bus);
721 closure->message = dbus_message_ref (message);
722 closure->data = user_data;
724 new_list = g_list_append (deferred_messages, closure);
726 deferred_messages = new_list;
728 if (process_deferred_messages_id == -1)
729 process_deferred_messages_id = g_idle_add (_atspi_process_deferred_messages, NULL);
730 return DBUS_HANDLER_RESULT_HANDLED;
733 static DBusHandlerResult
734 atspi_dbus_filter (DBusConnection *bus, DBusMessage *message, void *data)
736 int type = dbus_message_get_type (message);
737 const char *interface = dbus_message_get_interface (message);
739 if (type == DBUS_MESSAGE_TYPE_SIGNAL &&
740 !strncmp (interface, "org.a11y.atspi.Event.", 21))
742 return defer_message (bus, message, data);
744 if (dbus_message_is_method_call (message, atspi_interface_device_event_listener, "NotifyEvent"))
746 return defer_message (bus, message, data);
748 if (dbus_message_is_signal (message, atspi_interface_cache, "AddAccessible"))
750 return defer_message (bus, message, data);
752 if (dbus_message_is_signal (message, atspi_interface_cache, "RemoveAccessible"))
754 return defer_message (bus, message, data);
756 return DBUS_HANDLER_RESULT_NOT_YET_HANDLED;
759 static const char *signal_interfaces[] =
761 "org.a11y.atspi.Event.Object",
762 "org.a11y.atspi.Event.Window",
763 "org.a11y.atspi.Event.Mouse",
764 "org.a11y.atspi.Event.Terminal",
765 "org.a11y.atspi.Event.Document",
766 "org.a11y.atspi.Event.Focus",
771 * Returns a 'canonicalized' value for DISPLAY,
772 * with the screen number stripped off if present.
774 * TODO: Avoid having duplicate functions for this here and in at-spi2-atk
777 spi_display_name (void)
779 static const char *canonical_display_name = NULL;
780 if (!canonical_display_name)
782 const gchar *display_env = g_getenv ("AT_SPI_DISPLAY");
785 display_env = g_getenv ("DISPLAY");
786 if (!display_env || !display_env[0])
787 canonical_display_name = ":0";
790 gchar *display_p, *screen_p;
791 canonical_display_name = g_strdup (display_env);
792 display_p = g_utf8_strrchr (canonical_display_name, -1, ':');
793 screen_p = g_utf8_strrchr (canonical_display_name, -1, '.');
794 if (screen_p && display_p && (screen_p > display_p))
802 canonical_display_name = display_env;
805 return canonical_display_name;
811 * Connects to the accessibility registry and initializes the SPI.
813 * Returns: 0 on success, otherwise an integer error code.
832 dbus_error_init (&error);
833 bus = atspi_get_a11y_bus ();
836 dbus_bus_register (bus, &error);
837 dbus_connection_setup_with_g_main(bus, g_main_context_default());
838 dbus_connection_add_filter (bus, atspi_dbus_filter, NULL, NULL);
839 dbind_set_timeout (1000);
840 match = g_strdup_printf ("type='signal',interface='%s',member='AddAccessible'", atspi_interface_cache);
841 dbus_error_init (&error);
842 dbus_bus_add_match (bus, match, &error);
844 match = g_strdup_printf ("type='signal',interface='%s',member='RemoveAccessible'", atspi_interface_cache);
845 dbus_bus_add_match (bus, match, &error);
847 match = g_strdup_printf ("type='signal',interface='%s',member='ChildrenChanged'", atspi_interface_event_object);
848 dbus_bus_add_match (bus, match, &error);
850 match = g_strdup_printf ("type='signal',interface='%s',member='PropertyChange'", atspi_interface_event_object);
851 dbus_bus_add_match (bus, match, &error);
853 match = g_strdup_printf ("type='signal',interface='%s',member='StateChanged'", atspi_interface_event_object);
854 dbus_bus_add_match (bus, match, &error);
859 static GMainLoop *mainloop;
864 * Starts/enters the main event loop for the AT-SPI services.
866 * (NOTE: This method does not return control, it is exited via a call to
867 * atspi_event_quit () from within an event handler).
871 atspi_event_main (void)
873 mainloop = g_main_loop_new (NULL, FALSE);
874 g_main_loop_run (mainloop);
880 * Quits the last main event loop for the SPI services,
881 * see atspi_event_main
884 atspi_event_quit (void)
886 g_main_loop_quit (mainloop);
892 * Disconnects from the Accessibility Registry and releases
893 * any floating resources. Call only once at exit.
895 * Returns: 0 if there were no leaks, otherwise non zero.
907 atspi_inited = FALSE;
911 leaked = g_hash_table_size (live_refs);
924 _atspi_dbus_call (gpointer obj, const char *interface, const char *method, GError **error, const char *type, ...)
929 AtspiObject *aobj = ATSPI_OBJECT (obj);
931 if (!aobj->app || !aobj->app->bus)
933 g_set_error_literal (error, ATSPI_ERROR, ATSPI_ERROR_APPLICATION_GONE,
934 _("The application no longer exists"));
938 va_start (args, type);
939 dbus_error_init (&err);
940 retval = dbind_method_call_reentrant_va (aobj->app->bus, aobj->app->bus_name,
941 aobj->path, interface, method, &err,
944 _atspi_process_deferred_messages ((gpointer)TRUE);
945 if (dbus_error_is_set (&err))
947 /* TODO: Set gerror */
948 dbus_error_free (&err);
954 _atspi_dbus_call_partial (gpointer obj,
955 const char *interface,
958 const char *type, ...)
962 va_start (args, type);
963 return _atspi_dbus_call_partial_va (obj, interface, method, error, type, args);
967 _atspi_dbus_call_partial_va (gpointer obj,
968 const char *interface,
974 AtspiObject *aobj = ATSPI_OBJECT (obj);
976 DBusMessage *msg = NULL, *reply = NULL;
977 DBusMessageIter iter;
980 dbus_error_init (&err);
982 if (!aobj->app || !aobj->app->bus)
984 g_set_error_literal (error, ATSPI_ERROR, ATSPI_ERROR_APPLICATION_GONE,
985 _("The application no longer exists"));
989 msg = dbus_message_new_method_call (aobj->app->bus_name, aobj->path, interface, method);
994 dbus_message_iter_init_append (msg, &iter);
995 dbind_any_marshal_va (&iter, &p, args);
997 reply = dbind_send_and_allow_reentry (aobj->app->bus, msg, &err);
1001 dbus_message_unref (msg);
1002 _atspi_process_deferred_messages ((gpointer)TRUE);
1003 if (dbus_error_is_set (&err))
1005 /* TODO: Set gerror */
1006 dbus_error_free (&err);
1012 _atspi_dbus_get_property (gpointer obj, const char *interface, const char *name, GError **error, const char *type, void *data)
1014 DBusMessage *message, *reply;
1015 DBusMessageIter iter, iter_variant;
1017 dbus_bool_t retval = FALSE;
1018 AtspiObject *aobj = ATSPI_OBJECT (obj);
1023 if (!aobj->app || !aobj->app->bus)
1025 g_set_error_literal (error, ATSPI_ERROR, ATSPI_ERROR_APPLICATION_GONE,
1026 _("The application no longer exists"));
1030 message = dbus_message_new_method_call (aobj->app->bus_name,
1032 "org.freedesktop.DBus.Properties",
1036 // TODO: throw exception
1039 dbus_message_append_args (message, DBUS_TYPE_STRING, &interface, DBUS_TYPE_STRING, &name, DBUS_TYPE_INVALID);
1040 dbus_error_init (&err);
1041 reply = dbind_send_and_allow_reentry (aobj->app->bus, message, &err);
1042 dbus_message_unref (message);
1043 _atspi_process_deferred_messages ((gpointer)TRUE);
1046 // TODO: throw exception
1050 if (dbus_message_get_type (reply) == DBUS_MESSAGE_TYPE_ERROR)
1053 dbus_message_get_args (message, NULL, DBUS_TYPE_STRING, &err, DBUS_TYPE_INVALID);
1055 g_set_error_literal (error, ATSPI_ERROR, ATSPI_ERROR_IPC, err);
1059 dbus_message_iter_init (reply, &iter);
1060 if (dbus_message_iter_get_arg_type (&iter) != 'v')
1062 g_warning (_("AT-SPI: expected a variant when fetching %s from interface %s; got %s\n"), name, interface, dbus_message_get_signature (reply));
1065 dbus_message_iter_recurse (&iter, &iter_variant);
1066 if (dbus_message_iter_get_arg_type (&iter_variant) != type[0])
1068 g_warning (_("atspi_dbus_get_property: Wrong type: expected %s, got %c\n"), type, dbus_message_iter_get_arg_type (&iter_variant));
1071 if (!strcmp (type, "(so)"))
1073 *((AtspiAccessible **)data) = _atspi_dbus_return_accessible_from_iter (&iter_variant);
1077 dbus_message_iter_get_basic (&iter_variant, data);
1078 if (type [0] == 's')
1079 *(char **)data = g_strdup (*(char **)data);
1084 dbus_message_unref (reply);
1089 _atspi_dbus_send_with_reply_and_block (DBusMessage *message, GError **error)
1093 AtspiApplication *app;
1094 DBusConnection *bus;
1096 app = get_application (dbus_message_get_destination (message));
1098 if (app && !app->bus)
1099 return NULL; /* will fail anyway; app has been disposed */
1101 bus = (app ? app->bus : _atspi_bus());
1102 dbus_error_init (&err);
1103 reply = dbind_send_and_allow_reentry (bus, message, &err);
1104 _atspi_process_deferred_messages ((gpointer)TRUE);
1105 dbus_message_unref (message);
1109 g_set_error_literal (error, ATSPI_ERROR, ATSPI_ERROR_IPC, err.message);
1110 dbus_error_free (&err);
1116 _atspi_dbus_return_hash_from_message (DBusMessage *message)
1118 DBusMessageIter iter;
1124 _ATSPI_DBUS_CHECK_SIG (message, "a{ss}", NULL, NULL);
1126 dbus_message_iter_init (message, &iter);
1127 ret = _atspi_dbus_hash_from_iter (&iter);
1128 dbus_message_unref (message);
1133 _atspi_dbus_hash_from_iter (DBusMessageIter *iter)
1135 GHashTable *hash = g_hash_table_new (g_str_hash, g_str_equal);
1136 DBusMessageIter iter_array, iter_dict;
1138 dbus_message_iter_recurse (iter, &iter_array);
1139 while (dbus_message_iter_get_arg_type (&iter_array) != DBUS_TYPE_INVALID)
1141 const char *name, *value;
1142 dbus_message_iter_recurse (&iter_array, &iter_dict);
1143 dbus_message_iter_get_basic (&iter_dict, &name);
1144 dbus_message_iter_next (&iter_dict);
1145 dbus_message_iter_get_basic (&iter_dict, &value);
1146 g_hash_table_insert (hash, g_strdup (name), g_strdup (value));
1147 dbus_message_iter_next (&iter_array);
1153 _atspi_dbus_return_attribute_array_from_message (DBusMessage *message)
1155 DBusMessageIter iter;
1161 _ATSPI_DBUS_CHECK_SIG (message, "a{ss}", NULL, NULL);
1163 dbus_message_iter_init (message, &iter);
1165 ret = _atspi_dbus_attribute_array_from_iter (&iter);
1166 dbus_message_unref (message);
1171 _atspi_dbus_attribute_array_from_iter (DBusMessageIter *iter)
1173 DBusMessageIter iter_array, iter_dict;
1174 GArray *array = g_array_new (TRUE, TRUE, sizeof (gchar *));
1176 dbus_message_iter_recurse (iter, &iter_array);
1177 while (dbus_message_iter_get_arg_type (&iter_array) != DBUS_TYPE_INVALID)
1179 const char *name, *value;
1182 dbus_message_iter_recurse (&iter_array, &iter_dict);
1183 dbus_message_iter_get_basic (&iter_dict, &name);
1184 dbus_message_iter_next (&iter_dict);
1185 dbus_message_iter_get_basic (&iter_dict, &value);
1186 str = g_strdup_printf ("%s:%s", name, value);
1187 new_array = g_array_append_val (array, str);
1190 dbus_message_iter_next (&iter_array);;
1196 _atspi_dbus_set_interfaces (AtspiAccessible *accessible, DBusMessageIter *iter)
1198 DBusMessageIter iter_array;
1200 accessible->interfaces = 0;
1201 dbus_message_iter_recurse (iter, &iter_array);
1202 while (dbus_message_iter_get_arg_type (&iter_array) != DBUS_TYPE_INVALID)
1206 dbus_message_iter_get_basic (&iter_array, &iface);
1207 if (!strcmp (iface, "org.freedesktop.DBus.Introspectable")) continue;
1208 n = _atspi_get_iface_num (iface);
1211 g_warning (_("AT-SPI: Unknown interface %s"), iface);
1214 accessible->interfaces |= (1 << n);
1215 dbus_message_iter_next (&iter_array);
1217 _atspi_accessible_add_cache (accessible, ATSPI_CACHE_INTERFACES);
1221 _atspi_dbus_set_state (AtspiAccessible *accessible, DBusMessageIter *iter)
1223 DBusMessageIter iter_array;
1225 dbus_uint32_t *states;
1227 dbus_message_iter_recurse (iter, &iter_array);
1228 dbus_message_iter_get_fixed_array (&iter_array, &states, &count);
1231 g_warning (_("AT-SPI: expected 2 values in states array; got %d\n"), count);
1232 if (!accessible->states)
1233 accessible->states = _atspi_state_set_new_internal (accessible, 0);
1237 guint64 val = ((guint64)states [1]) << 32;
1239 if (!accessible->states)
1240 accessible->states = _atspi_state_set_new_internal (accessible, val);
1242 accessible->states->states = val;
1244 _atspi_accessible_add_cache (accessible, ATSPI_CACHE_STATES);
1248 atspi_error_quark (void)
1250 return g_quark_from_static_string ("atspi_error");
1254 * Gets the IOR from the XDisplay.
1257 get_accessibility_bus_address_x11 (void)
1261 Display *bridge_display;
1263 unsigned char *data = NULL;
1264 unsigned long nitems;
1265 unsigned long leftover;
1267 bridge_display = XOpenDisplay (spi_display_name ());
1268 if (!bridge_display)
1270 g_warning ("Could not open X display");
1274 AT_SPI_BUS = XInternAtom (bridge_display, "AT_SPI_BUS", False);
1275 XGetWindowProperty (bridge_display,
1276 XDefaultRootWindow (bridge_display),
1278 (long) BUFSIZ, False,
1279 (Atom) 31, &actual_type, &actual_format,
1280 &nitems, &leftover, &data);
1281 XCloseDisplay (bridge_display);
1283 return g_strdup (data);
1287 get_accessibility_bus_address_dbus (void)
1289 DBusConnection *session_bus = NULL;
1290 DBusMessage *message;
1292 char *address = NULL;
1294 session_bus = dbus_bus_get (DBUS_BUS_SESSION, NULL);
1298 message = dbus_message_new_method_call ("org.a11y.Bus",
1303 reply = dbus_connection_send_with_reply_and_block (session_bus,
1307 dbus_message_unref (message);
1313 const char *tmp_address;
1314 if (!dbus_message_get_args (reply,
1320 dbus_message_unref (reply);
1323 address = g_strdup (tmp_address);
1324 dbus_message_unref (reply);
1331 atspi_get_a11y_bus (void)
1333 DBusConnection *bus = NULL;
1337 address = get_accessibility_bus_address_x11 ();
1339 address = get_accessibility_bus_address_dbus ();
1343 dbus_error_init (&error);
1344 bus = dbus_connection_open (address, &error);
1347 g_warning ("Couldn't connect to accessibility bus: %s", error.message);
1352 if (!dbus_bus_register (bus, &error))
1354 g_warning ("Couldn't register with accessibility bus: %s", error.message);