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;
44 const char *atspi_path_dec = ATSPI_DBUS_PATH_DEC;
45 const char *atspi_path_registry = ATSPI_DBUS_PATH_REGISTRY;
46 const char *atspi_path_root = ATSPI_DBUS_PATH_ROOT;
47 const char *atspi_bus_registry = ATSPI_DBUS_NAME_REGISTRY;
48 const char *atspi_interface_accessible = ATSPI_DBUS_INTERFACE_ACCESSIBLE;
49 const char *atspi_interface_action = ATSPI_DBUS_INTERFACE_ACTION;
50 const char *atspi_interface_application = ATSPI_DBUS_INTERFACE_APPLICATION;
51 const char *atspi_interface_collection = ATSPI_DBUS_INTERFACE_COLLECTION;
52 const char *atspi_interface_component = ATSPI_DBUS_INTERFACE_COMPONENT;
53 const char *atspi_interface_dec = ATSPI_DBUS_INTERFACE_DEC;
54 const char *atspi_interface_device_event_listener = ATSPI_DBUS_INTERFACE_DEVICE_EVENT_LISTENER;
55 const char *atspi_interface_document = ATSPI_DBUS_INTERFACE_DOCUMENT;
56 const char *atspi_interface_editable_text = ATSPI_DBUS_INTERFACE_EDITABLE_TEXT;
57 const char *atspi_interface_event_object = ATSPI_DBUS_INTERFACE_EVENT_OBJECT;
58 const char *atspi_interface_hyperlink = ATSPI_DBUS_INTERFACE_HYPERLINK;
59 const char *atspi_interface_hypertext = ATSPI_DBUS_INTERFACE_HYPERTEXT;
60 const char *atspi_interface_image = ATSPI_DBUS_INTERFACE_IMAGE;
61 const char *atspi_interface_registry = ATSPI_DBUS_INTERFACE_REGISTRY;
62 const char *atspi_interface_selection = ATSPI_DBUS_INTERFACE_SELECTION;
63 const char *atspi_interface_table = ATSPI_DBUS_INTERFACE_TABLE;
64 const char *atspi_interface_text = ATSPI_DBUS_INTERFACE_TEXT;
65 const char *atspi_interface_cache = ATSPI_DBUS_INTERFACE_CACHE;
66 const char *atspi_interface_value = ATSPI_DBUS_INTERFACE_VALUE;
68 static const char *interfaces[] =
70 ATSPI_DBUS_INTERFACE_ACCESSIBLE,
71 ATSPI_DBUS_INTERFACE_ACTION,
72 ATSPI_DBUS_INTERFACE_APPLICATION,
73 ATSPI_DBUS_INTERFACE_COLLECTION,
74 ATSPI_DBUS_INTERFACE_COMPONENT,
75 ATSPI_DBUS_INTERFACE_DOCUMENT,
76 ATSPI_DBUS_INTERFACE_EDITABLE_TEXT,
77 ATSPI_DBUS_INTERFACE_HYPERLINK,
78 ATSPI_DBUS_INTERFACE_HYPERTEXT,
79 ATSPI_DBUS_INTERFACE_IMAGE,
80 "org.a11y.atspi.LoginHelper",
81 ATSPI_DBUS_INTERFACE_SELECTION,
82 ATSPI_DBUS_INTERFACE_TABLE,
83 ATSPI_DBUS_INTERFACE_TEXT,
84 ATSPI_DBUS_INTERFACE_VALUE,
89 _atspi_get_iface_num (const char *iface)
91 /* TODO: Use a binary search or hash to improve performance */
94 for (i = 0; interfaces[i]; i++)
96 if (!strcmp(iface, interfaces[i])) return i;
106 live_refs = g_hash_table_new (g_direct_hash, g_direct_equal);
111 /* TODO: Add an application parameter */
118 g_error ("AT-SPI: COuldn't connect to accessibility bus. Is at-spi-bus-launcher running?");
122 #define APP_IS_REGISTRY(app) (!strcmp (app->bus_name, atspi_bus_registry))
133 g_hash_table_destroy (refs);
137 static gboolean atspi_inited = FALSE;
139 static GHashTable *app_hash = NULL;
142 handle_get_bus_address (DBusPendingCall *pending, void *user_data)
144 AtspiApplication *app = user_data;
145 DBusMessage *reply = dbus_pending_call_steal_reply (pending);
146 DBusMessage *message;
148 DBusPendingCall *new_pending;
150 if (dbus_message_get_type (reply) == DBUS_MESSAGE_TYPE_METHOD_RETURN)
152 if (dbus_message_get_args (reply, NULL, DBUS_TYPE_STRING, &address,
156 dbus_error_init (&error);
157 DBusConnection *bus = dbus_connection_open (address, &error);
161 dbus_connection_unref (app->bus);
166 dbus_message_unref (reply);
167 dbus_pending_call_unref (pending);
170 return; /* application has gone away / been disposed */
172 message = dbus_message_new_method_call (app->bus_name,
173 "/org/a11y/atspi/cache",
174 atspi_interface_cache, "GetItems");
176 dbus_connection_send_with_reply (app->bus, message, &new_pending, 2000);
177 dbus_pending_call_set_notify (new_pending, handle_get_items, app, NULL);
178 dbus_message_unref (message);
181 static AtspiApplication *
182 get_application (const char *bus_name)
184 AtspiApplication *app = NULL;
186 DBusMessage *message;
188 DBusPendingCall *pending = NULL;
192 app_hash = g_hash_table_new_full (g_str_hash, g_str_equal, g_free, (GDestroyNotify)g_object_unref);
193 if (!app_hash) return NULL;
195 app = g_hash_table_lookup (app_hash, bus_name);
197 bus_name_dup = g_strdup (bus_name);
198 if (!bus_name_dup) return NULL;
199 // TODO: change below to something that will send state-change:defunct notification if necessary */
200 app = _atspi_application_new (bus_name);
201 if (!app) return NULL;
202 app->hash = g_hash_table_new_full (g_str_hash, g_str_equal, g_free, g_object_unref);
203 app->bus = dbus_connection_ref (_atspi_bus ());
204 app->cache = ATSPI_CACHE_UNDEFINED;
205 g_hash_table_insert (app_hash, bus_name_dup, app);
206 dbus_error_init (&error);
207 message = dbus_message_new_method_call (bus_name, atspi_path_root,
208 atspi_interface_application, "GetApplicationBusAddress");
210 dbus_connection_send_with_reply (app->bus, message, &pending, 2000);
211 dbus_pending_call_set_notify (pending, handle_get_bus_address, app, NULL);
212 dbus_message_unref (message);
216 static AtspiAccessible *
217 ref_accessible (const char *app_name, const char *path)
219 AtspiApplication *app;
222 if (!strcmp (path, ATSPI_DBUS_PATH_NULL))
225 app = get_application (app_name);
227 if (!strcmp (path, "/org/a11y/atspi/accessible/root"))
231 app->root = atspi_accessible_new (app, atspi_path_root);
232 app->root->accessible_parent = atspi_get_desktop (0);
234 return g_object_ref (app->root);
237 a = g_hash_table_lookup (app->hash, path);
240 return g_object_ref (a);
242 a = atspi_accessible_new (app, path);
245 g_hash_table_insert (app->hash, g_strdup (a->parent.path), a);
246 g_object_ref (a); /* for the hash */
250 static AtspiHyperlink *
251 ref_hyperlink (const char *app_name, const char *path)
253 AtspiApplication *app = get_application (app_name);
254 AtspiHyperlink *hyperlink;
256 if (!strcmp (path, ATSPI_DBUS_PATH_NULL))
259 hyperlink = g_hash_table_lookup (app->hash, path);
262 return g_object_ref (hyperlink);
264 hyperlink = atspi_hyperlink_new (app, path);
267 g_hash_table_insert (app->hash, g_strdup (hyperlink->parent.path), hyperlink);
268 /* TODO: This should be a weak ref */
269 g_object_ref (hyperlink); /* for the hash */
282 GArray *state_bitflags;
285 static DBusHandlerResult
286 handle_remove_accessible (DBusConnection *bus, DBusMessage *message, void *user_data)
288 const char *sender = dbus_message_get_sender (message);
289 AtspiApplication *app;
291 DBusMessageIter iter, iter_struct;
292 const char *signature = dbus_message_get_signature (message);
295 if (strcmp (signature, "(so)") != 0)
297 g_warning ("AT-SPI: Unknown signature %s for RemoveAccessible", signature);
298 return DBUS_HANDLER_RESULT_HANDLED;
301 dbus_message_iter_init (message, &iter);
302 dbus_message_iter_recurse (&iter, &iter_struct);
303 dbus_message_iter_get_basic (&iter_struct, &sender);
304 dbus_message_iter_next (&iter_struct);
305 dbus_message_iter_get_basic (&iter_struct, &path);
306 app = get_application (sender);
307 a = ref_accessible (sender, path);
309 return DBUS_HANDLER_RESULT_HANDLED;
310 g_object_run_dispose (G_OBJECT (a));
311 g_hash_table_remove (app->hash, a->parent.path);
312 g_object_unref (a); /* unref our own ref */
313 return DBUS_HANDLER_RESULT_HANDLED;
317 add_app_to_desktop (AtspiAccessible *a, const char *bus_name)
321 dbus_error_init (&error);
322 AtspiAccessible *obj = ref_accessible (bus_name, atspi_path_root);
325 GList *new_list = g_list_append (a->children, obj);
328 a->children = new_list;
334 g_warning ("AT-SPI: Error calling getRoot for %s: %s", bus_name, error.message);
340 send_children_changed (AtspiAccessible *parent, AtspiAccessible *child, gboolean add)
344 memset (&e, 0, sizeof (e));
345 e.type = (add? "object:children-changed:add": "object:children-changed:remove");
347 e.detail1 = g_list_index (parent->children, child);
349 _atspi_send_event (&e);
353 unref_object_and_descendants (AtspiAccessible *obj)
357 for (l = obj->children; l; l = l->next)
359 unref_object_and_descendants (l->data);
361 g_object_unref (obj);
365 remove_app_from_desktop (AtspiAccessible *a, const char *bus_name)
368 AtspiAccessible *child;
370 for (l = a->children; l; l = l->next)
373 if (!strcmp (bus_name, child->parent.app->bus_name)) break;
379 send_children_changed (a, child, FALSE);
380 a->children = g_list_remove (a->children, child);
381 unref_object_and_descendants (child);
385 static AtspiAccessible *desktop;
388 get_reference_from_iter (DBusMessageIter *iter, const char **app_name, const char **path)
390 DBusMessageIter iter_struct;
392 dbus_message_iter_recurse (iter, &iter_struct);
393 dbus_message_iter_get_basic (&iter_struct, app_name);
394 dbus_message_iter_next (&iter_struct);
395 dbus_message_iter_get_basic (&iter_struct, path);
396 dbus_message_iter_next (iter);
400 add_accessible_from_iter (DBusMessageIter *iter)
403 DBusMessageIter iter_struct, iter_array;
404 const char *app_name, *path;
405 AtspiAccessible *accessible;
406 const char *name, *description;
409 dbus_message_iter_recurse (iter, &iter_struct);
412 get_reference_from_iter (&iter_struct, &app_name, &path);
413 accessible = ref_accessible (app_name, path);
417 /* Get application: TODO */
418 dbus_message_iter_next (&iter_struct);
421 get_reference_from_iter (&iter_struct, &app_name, &path);
422 if (accessible->accessible_parent)
423 g_object_unref (accessible->accessible_parent);
424 accessible->accessible_parent = ref_accessible (app_name, path);
427 while (accessible->children)
429 g_object_unref (accessible->children->data);
430 accessible->children = g_list_remove (accessible->children, accessible->children->data);
432 dbus_message_iter_recurse (&iter_struct, &iter_array);
433 while (dbus_message_iter_get_arg_type (&iter_array) != DBUS_TYPE_INVALID)
435 AtspiAccessible *child;
436 get_reference_from_iter (&iter_array, &app_name, &path);
437 child = ref_accessible (app_name, path);
438 new_list = g_list_append (accessible->children, child);
439 if (new_list) accessible->children = new_list;
443 dbus_message_iter_next (&iter_struct);
444 _atspi_dbus_set_interfaces (accessible, &iter_struct);
445 dbus_message_iter_next (&iter_struct);
448 if (accessible->name)
449 g_free (accessible->name);
450 dbus_message_iter_get_basic (&iter_struct, &name);
451 accessible->name = g_strdup (name);
452 dbus_message_iter_next (&iter_struct);
455 dbus_message_iter_get_basic (&iter_struct, &role);
456 accessible->role = role;
457 dbus_message_iter_next (&iter_struct);
460 if (accessible->description)
461 g_free (accessible->description);
462 dbus_message_iter_get_basic (&iter_struct, &description);
463 accessible->description = g_strdup (description);
464 dbus_message_iter_next (&iter_struct);
466 _atspi_dbus_set_state (accessible, &iter_struct);
467 dbus_message_iter_next (&iter_struct);
469 _atspi_accessible_add_cache (accessible, ATSPI_CACHE_NAME | ATSPI_CACHE_ROLE |
470 ATSPI_CACHE_PARENT | ATSPI_CACHE_DESCRIPTION);
471 if (!atspi_state_set_contains (accessible->states,
472 ATSPI_STATE_MANAGES_DESCENDANTS))
473 _atspi_accessible_add_cache (accessible, ATSPI_CACHE_CHILDREN);
475 /* This is a bit of a hack since the cache holds a ref, so we don't need
476 * the one provided for us anymore */
477 g_object_unref (accessible);
481 handle_get_items (DBusPendingCall *pending, void *user_data)
483 DBusMessage *reply = dbus_pending_call_steal_reply (pending);
484 DBusMessageIter iter, iter_array;
486 if (dbus_message_get_type (reply) == DBUS_MESSAGE_TYPE_ERROR)
488 const char *sender = dbus_message_get_sender (reply);
489 const char *error = NULL;
490 dbus_message_get_args (reply, NULL, DBUS_TYPE_STRING, &error,
492 g_warning ("AT-SPI: Error in GetItems, sender=%s, error=%s", sender, error);
493 dbus_message_unref (reply);
494 dbus_pending_call_unref (pending);
498 dbus_message_iter_init (reply, &iter);
499 dbus_message_iter_recurse (&iter, &iter_array);
500 while (dbus_message_iter_get_arg_type (&iter_array) != DBUS_TYPE_INVALID)
502 add_accessible_from_iter (&iter_array);
503 dbus_message_iter_next (&iter_array);
505 dbus_message_unref (reply);
506 dbus_pending_call_unref (pending);
509 /* TODO: Do we stil need this function? */
510 static AtspiAccessible *
511 ref_accessible_desktop (AtspiApplication *app)
514 DBusMessage *message, *reply;
515 DBusMessageIter iter, iter_array;
520 g_object_ref (desktop);
523 desktop = atspi_accessible_new (app, atspi_path_root);
528 g_hash_table_insert (app->hash, desktop->parent.path, desktop);
529 g_object_ref (desktop); /* for the hash */
530 desktop->name = g_strdup ("main");
531 dbus_error_init (&error);
532 message = dbus_message_new_method_call (atspi_bus_registry,
534 atspi_interface_accessible,
538 reply = _atspi_dbus_send_with_reply_and_block (message, NULL);
539 if (!reply || strcmp (dbus_message_get_signature (reply), "a(so)") != 0)
541 g_warning ("Couldn't get application list: %s", error.message);
543 dbus_message_unref (reply);
546 dbus_message_iter_init (reply, &iter);
547 dbus_message_iter_recurse (&iter, &iter_array);
548 while (dbus_message_iter_get_arg_type (&iter_array) != DBUS_TYPE_INVALID)
550 const char *app_name, *path;
551 get_reference_from_iter (&iter_array, &app_name, &path);
552 add_app_to_desktop (desktop, app_name);
554 dbus_message_unref (reply);
556 /* Record the alternate name as an alias for org.a11y.atspi.Registry */
557 bus_name_dup = g_strdup (dbus_message_get_sender (reply));
559 g_hash_table_insert (app_hash, bus_name_dup, app);
565 _atspi_ref_accessible (const char *app, const char *path)
567 AtspiApplication *a = get_application (app);
569 if ( APP_IS_REGISTRY(a))
571 return a->root = ref_accessible_desktop (a);
573 return ref_accessible (app, path);
577 _atspi_dbus_return_accessible_from_message (DBusMessage *message)
579 DBusMessageIter iter;
580 AtspiAccessible *retval = NULL;
581 const char *signature;
586 signature = dbus_message_get_signature (message);
587 if (!strcmp (signature, "(so)"))
589 dbus_message_iter_init (message, &iter);
590 retval = _atspi_dbus_return_accessible_from_iter (&iter);
594 g_warning ("AT-SPI: Called _atspi_dbus_return_accessible_from_message with strange signature %s", signature);
596 dbus_message_unref (message);
601 _atspi_dbus_return_accessible_from_iter (DBusMessageIter *iter)
603 const char *app_name, *path;
605 get_reference_from_iter (iter, &app_name, &path);
606 return ref_accessible (app_name, path);
610 _atspi_dbus_return_hyperlink_from_message (DBusMessage *message)
612 DBusMessageIter iter;
613 AtspiHyperlink *retval = NULL;
614 const char *signature = dbus_message_get_signature (message);
616 if (!strcmp (signature, "(so)"))
618 dbus_message_iter_init (message, &iter);
619 retval = _atspi_dbus_return_hyperlink_from_iter (&iter);
623 g_warning ("AT-SPI: Called _atspi_dbus_return_hyperlink_from_message with strange signature %s", signature);
625 dbus_message_unref (message);
630 _atspi_dbus_return_hyperlink_from_iter (DBusMessageIter *iter)
632 const char *app_name, *path;
634 get_reference_from_iter (iter, &app_name, &path);
635 return ref_hyperlink (app_name, path);
638 const char *cache_signal_type = "((so)(so)(so)a(so)assusau)";
640 static DBusHandlerResult
641 handle_add_accessible (DBusConnection *bus, DBusMessage *message, void *user_data)
643 DBusMessageIter iter;
644 const char *sender = dbus_message_get_sender (message);
646 if (strcmp (dbus_message_get_signature (message), cache_signal_type) != 0)
648 g_warning ("AT-SPI: AddAccessible with unknown signature %s\n",
649 dbus_message_get_signature (message));
650 return DBUS_HANDLER_RESULT_HANDLED;
653 dbus_message_iter_init (message, &iter);
654 add_accessible_from_iter (&iter);
655 return DBUS_HANDLER_RESULT_HANDLED;
661 DBusMessage *message;
665 static guint process_deferred_messages_id = -1;
668 process_deferred_message (BusDataClosure *closure)
670 int type = dbus_message_get_type (closure->message);
671 const char *interface = dbus_message_get_interface (closure->message);
673 if (type == DBUS_MESSAGE_TYPE_SIGNAL &&
674 !strncmp (interface, "org.a11y.atspi.Event.", 21))
676 atspi_dbus_handle_event (closure->bus, closure->message, closure->data);
678 if (dbus_message_is_method_call (closure->message, atspi_interface_device_event_listener, "NotifyEvent"))
680 atspi_dbus_handle_DeviceEvent (closure->bus,
681 closure->message, closure->data);
683 if (dbus_message_is_signal (closure->message, atspi_interface_cache, "AddAccessible"))
685 handle_add_accessible (closure->bus, closure->message, closure->data);
687 if (dbus_message_is_signal (closure->message, atspi_interface_cache, "RemoveAccessible"))
689 handle_remove_accessible (closure->bus, closure->message, closure->data);
693 static GList *deferred_messages = NULL;
696 _atspi_process_deferred_messages (gpointer data)
698 static int in_process_deferred_messages = 0;
700 if (in_process_deferred_messages)
702 in_process_deferred_messages = 1;
703 while (deferred_messages != NULL)
705 BusDataClosure *closure = deferred_messages->data;
706 process_deferred_message (closure);
707 deferred_messages = g_list_remove (deferred_messages, closure);
708 dbus_message_unref (closure->message);
709 dbus_connection_unref (closure->bus);
712 /* If data is NULL, assume that we were called from GLib */
714 process_deferred_messages_id = -1;
715 in_process_deferred_messages = 0;
719 static DBusHandlerResult
720 defer_message (DBusConnection *connection, DBusMessage *message, void *user_data)
722 BusDataClosure *closure = g_new (BusDataClosure, 1);
725 closure->bus = dbus_connection_ref (bus);
726 closure->message = dbus_message_ref (message);
727 closure->data = user_data;
729 new_list = g_list_append (deferred_messages, closure);
731 deferred_messages = new_list;
733 if (process_deferred_messages_id == -1)
734 process_deferred_messages_id = g_idle_add (_atspi_process_deferred_messages, NULL);
735 return DBUS_HANDLER_RESULT_HANDLED;
738 static DBusHandlerResult
739 atspi_dbus_filter (DBusConnection *bus, DBusMessage *message, void *data)
741 int type = dbus_message_get_type (message);
742 const char *interface = dbus_message_get_interface (message);
744 if (type == DBUS_MESSAGE_TYPE_SIGNAL &&
745 !strncmp (interface, "org.a11y.atspi.Event.", 21))
747 return defer_message (bus, message, data);
749 if (dbus_message_is_method_call (message, atspi_interface_device_event_listener, "NotifyEvent"))
751 return defer_message (bus, message, data);
753 if (dbus_message_is_signal (message, atspi_interface_cache, "AddAccessible"))
755 return defer_message (bus, message, data);
757 if (dbus_message_is_signal (message, atspi_interface_cache, "RemoveAccessible"))
759 return defer_message (bus, message, data);
761 return DBUS_HANDLER_RESULT_NOT_YET_HANDLED;
764 static const char *signal_interfaces[] =
766 "org.a11y.atspi.Event.Object",
767 "org.a11y.atspi.Event.Window",
768 "org.a11y.atspi.Event.Mouse",
769 "org.a11y.atspi.Event.Terminal",
770 "org.a11y.atspi.Event.Document",
771 "org.a11y.atspi.Event.Focus",
776 * Returns a 'canonicalized' value for DISPLAY,
777 * with the screen number stripped off if present.
779 * TODO: Avoid having duplicate functions for this here and in at-spi2-atk
782 spi_display_name (void)
784 static const char *canonical_display_name = NULL;
785 if (!canonical_display_name)
787 const gchar *display_env = g_getenv ("AT_SPI_DISPLAY");
790 display_env = g_getenv ("DISPLAY");
791 if (!display_env || !display_env[0])
792 canonical_display_name = ":0";
795 gchar *display_p, *screen_p;
796 canonical_display_name = g_strdup (display_env);
797 display_p = g_utf8_strrchr (canonical_display_name, -1, ':');
798 screen_p = g_utf8_strrchr (canonical_display_name, -1, '.');
799 if (screen_p && display_p && (screen_p > display_p))
807 canonical_display_name = display_env;
810 return canonical_display_name;
816 * Connects to the accessibility registry and initializes the SPI.
818 * Returns: 0 on success, otherwise an integer error code.
837 dbus_error_init (&error);
838 bus = atspi_get_a11y_bus ();
841 dbus_bus_register (bus, &error);
842 atspi_dbus_connection_setup_with_g_main(bus, g_main_context_default());
843 dbus_connection_add_filter (bus, atspi_dbus_filter, NULL, NULL);
844 dbind_set_timeout (1000);
845 match = g_strdup_printf ("type='signal',interface='%s',member='AddAccessible'", atspi_interface_cache);
846 dbus_error_init (&error);
847 dbus_bus_add_match (bus, match, &error);
849 match = g_strdup_printf ("type='signal',interface='%s',member='RemoveAccessible'", atspi_interface_cache);
850 dbus_bus_add_match (bus, match, &error);
852 match = g_strdup_printf ("type='signal',interface='%s',member='ChildrenChanged'", atspi_interface_event_object);
853 dbus_bus_add_match (bus, match, &error);
855 match = g_strdup_printf ("type='signal',interface='%s',member='PropertyChange'", atspi_interface_event_object);
856 dbus_bus_add_match (bus, match, &error);
858 match = g_strdup_printf ("type='signal',interface='%s',member='StateChanged'", atspi_interface_event_object);
859 dbus_bus_add_match (bus, match, &error);
867 * Starts/enters the main event loop for the AT-SPI services.
869 * (NOTE: This method does not return control, it is exited via a call to
870 * atspi_event_quit () from within an event handler).
874 atspi_event_main (void)
876 atspi_main_loop = g_main_loop_new (NULL, FALSE);
877 g_main_loop_run (atspi_main_loop);
878 atspi_main_loop = NULL;
884 * Quits the last main event loop for the SPI services,
885 * see atspi_event_main
888 atspi_event_quit (void)
890 g_main_loop_quit (atspi_main_loop);
896 * Disconnects from the Accessibility Registry and releases
897 * any floating resources. Call only once at exit.
899 * Returns: 0 if there were no leaks, otherwise non zero.
911 atspi_inited = FALSE;
915 leaked = g_hash_table_size (live_refs);
928 _atspi_dbus_call (gpointer obj, const char *interface, const char *method, GError **error, const char *type, ...)
933 AtspiObject *aobj = ATSPI_OBJECT (obj);
935 if (!aobj->app || !aobj->app->bus)
937 g_set_error_literal (error, ATSPI_ERROR, ATSPI_ERROR_APPLICATION_GONE,
938 _("The application no longer exists"));
942 va_start (args, type);
943 dbus_error_init (&err);
944 retval = dbind_method_call_reentrant_va (aobj->app->bus, aobj->app->bus_name,
945 aobj->path, interface, method, &err,
948 _atspi_process_deferred_messages ((gpointer)TRUE);
949 if (dbus_error_is_set (&err))
951 /* TODO: Set gerror */
952 dbus_error_free (&err);
958 _atspi_dbus_call_partial (gpointer obj,
959 const char *interface,
962 const char *type, ...)
966 va_start (args, type);
967 return _atspi_dbus_call_partial_va (obj, interface, method, error, type, args);
971 _atspi_dbus_call_partial_va (gpointer obj,
972 const char *interface,
978 AtspiObject *aobj = ATSPI_OBJECT (obj);
980 DBusMessage *msg = NULL, *reply = NULL;
981 DBusMessageIter iter;
984 dbus_error_init (&err);
986 if (!aobj->app || !aobj->app->bus)
988 g_set_error_literal (error, ATSPI_ERROR, ATSPI_ERROR_APPLICATION_GONE,
989 _("The application no longer exists"));
993 msg = dbus_message_new_method_call (aobj->app->bus_name, aobj->path, interface, method);
998 dbus_message_iter_init_append (msg, &iter);
999 dbind_any_marshal_va (&iter, &p, args);
1001 reply = dbind_send_and_allow_reentry (aobj->app->bus, msg, &err);
1005 dbus_message_unref (msg);
1006 _atspi_process_deferred_messages ((gpointer)TRUE);
1007 if (dbus_error_is_set (&err))
1009 /* TODO: Set gerror */
1010 dbus_error_free (&err);
1016 _atspi_dbus_get_property (gpointer obj, const char *interface, const char *name, GError **error, const char *type, void *data)
1018 DBusMessage *message, *reply;
1019 DBusMessageIter iter, iter_variant;
1021 dbus_bool_t retval = FALSE;
1022 AtspiObject *aobj = ATSPI_OBJECT (obj);
1023 char expected_type = (type [0] == '(' ? 'r' : type [0]);
1028 if (!aobj->app || !aobj->app->bus)
1030 g_set_error_literal (error, ATSPI_ERROR, ATSPI_ERROR_APPLICATION_GONE,
1031 _("The application no longer exists"));
1035 message = dbus_message_new_method_call (aobj->app->bus_name,
1037 "org.freedesktop.DBus.Properties",
1041 // TODO: throw exception
1044 dbus_message_append_args (message, DBUS_TYPE_STRING, &interface, DBUS_TYPE_STRING, &name, DBUS_TYPE_INVALID);
1045 dbus_error_init (&err);
1046 reply = dbind_send_and_allow_reentry (aobj->app->bus, message, &err);
1047 dbus_message_unref (message);
1048 _atspi_process_deferred_messages ((gpointer)TRUE);
1051 // TODO: throw exception
1055 if (dbus_message_get_type (reply) == DBUS_MESSAGE_TYPE_ERROR)
1058 dbus_message_get_args (message, NULL, DBUS_TYPE_STRING, &err, DBUS_TYPE_INVALID);
1060 g_set_error_literal (error, ATSPI_ERROR, ATSPI_ERROR_IPC, err);
1064 dbus_message_iter_init (reply, &iter);
1065 if (dbus_message_iter_get_arg_type (&iter) != 'v')
1067 g_warning ("AT-SPI: expected a variant when fetching %s from interface %s; got %s\n", name, interface, dbus_message_get_signature (reply));
1070 dbus_message_iter_recurse (&iter, &iter_variant);
1071 if (dbus_message_iter_get_arg_type (&iter_variant) != expected_type)
1073 g_warning ("atspi_dbus_get_property: Wrong type: expected %s, got %c\n", type, dbus_message_iter_get_arg_type (&iter_variant));
1076 if (!strcmp (type, "(so)"))
1078 *((AtspiAccessible **)data) = _atspi_dbus_return_accessible_from_iter (&iter_variant);
1082 dbus_message_iter_get_basic (&iter_variant, data);
1083 if (type [0] == 's')
1084 *(char **)data = g_strdup (*(char **)data);
1089 dbus_message_unref (reply);
1094 _atspi_dbus_send_with_reply_and_block (DBusMessage *message, GError **error)
1098 AtspiApplication *app;
1099 DBusConnection *bus;
1101 app = get_application (dbus_message_get_destination (message));
1103 if (app && !app->bus)
1104 return NULL; /* will fail anyway; app has been disposed */
1106 bus = (app ? app->bus : _atspi_bus());
1107 dbus_error_init (&err);
1108 reply = dbind_send_and_allow_reentry (bus, message, &err);
1109 _atspi_process_deferred_messages ((gpointer)TRUE);
1110 dbus_message_unref (message);
1114 g_set_error_literal (error, ATSPI_ERROR, ATSPI_ERROR_IPC, err.message);
1115 dbus_error_free (&err);
1121 _atspi_dbus_return_hash_from_message (DBusMessage *message)
1123 DBusMessageIter iter;
1129 _ATSPI_DBUS_CHECK_SIG (message, "a{ss}", NULL, NULL);
1131 dbus_message_iter_init (message, &iter);
1132 ret = _atspi_dbus_hash_from_iter (&iter);
1133 dbus_message_unref (message);
1138 _atspi_dbus_hash_from_iter (DBusMessageIter *iter)
1140 GHashTable *hash = g_hash_table_new (g_str_hash, g_str_equal);
1141 DBusMessageIter iter_array, iter_dict;
1143 dbus_message_iter_recurse (iter, &iter_array);
1144 while (dbus_message_iter_get_arg_type (&iter_array) != DBUS_TYPE_INVALID)
1146 const char *name, *value;
1147 dbus_message_iter_recurse (&iter_array, &iter_dict);
1148 dbus_message_iter_get_basic (&iter_dict, &name);
1149 dbus_message_iter_next (&iter_dict);
1150 dbus_message_iter_get_basic (&iter_dict, &value);
1151 g_hash_table_insert (hash, g_strdup (name), g_strdup (value));
1152 dbus_message_iter_next (&iter_array);
1158 _atspi_dbus_return_attribute_array_from_message (DBusMessage *message)
1160 DBusMessageIter iter;
1166 _ATSPI_DBUS_CHECK_SIG (message, "a{ss}", NULL, NULL);
1168 dbus_message_iter_init (message, &iter);
1170 ret = _atspi_dbus_attribute_array_from_iter (&iter);
1171 dbus_message_unref (message);
1176 _atspi_dbus_attribute_array_from_iter (DBusMessageIter *iter)
1178 DBusMessageIter iter_array, iter_dict;
1179 GArray *array = g_array_new (TRUE, TRUE, sizeof (gchar *));
1181 dbus_message_iter_recurse (iter, &iter_array);
1182 while (dbus_message_iter_get_arg_type (&iter_array) != DBUS_TYPE_INVALID)
1184 const char *name, *value;
1187 dbus_message_iter_recurse (&iter_array, &iter_dict);
1188 dbus_message_iter_get_basic (&iter_dict, &name);
1189 dbus_message_iter_next (&iter_dict);
1190 dbus_message_iter_get_basic (&iter_dict, &value);
1191 str = g_strdup_printf ("%s:%s", name, value);
1192 new_array = g_array_append_val (array, str);
1195 dbus_message_iter_next (&iter_array);;
1201 _atspi_dbus_set_interfaces (AtspiAccessible *accessible, DBusMessageIter *iter)
1203 DBusMessageIter iter_array;
1205 accessible->interfaces = 0;
1206 dbus_message_iter_recurse (iter, &iter_array);
1207 while (dbus_message_iter_get_arg_type (&iter_array) != DBUS_TYPE_INVALID)
1211 dbus_message_iter_get_basic (&iter_array, &iface);
1212 if (!strcmp (iface, "org.freedesktop.DBus.Introspectable")) continue;
1213 n = _atspi_get_iface_num (iface);
1216 g_warning ("AT-SPI: Unknown interface %s", iface);
1219 accessible->interfaces |= (1 << n);
1220 dbus_message_iter_next (&iter_array);
1222 _atspi_accessible_add_cache (accessible, ATSPI_CACHE_INTERFACES);
1226 _atspi_dbus_set_state (AtspiAccessible *accessible, DBusMessageIter *iter)
1228 DBusMessageIter iter_array;
1230 dbus_uint32_t *states;
1232 dbus_message_iter_recurse (iter, &iter_array);
1233 dbus_message_iter_get_fixed_array (&iter_array, &states, &count);
1236 g_warning ("AT-SPI: expected 2 values in states array; got %d\n", count);
1237 if (!accessible->states)
1238 accessible->states = _atspi_state_set_new_internal (accessible, 0);
1242 guint64 val = ((guint64)states [1]) << 32;
1244 if (!accessible->states)
1245 accessible->states = _atspi_state_set_new_internal (accessible, val);
1247 accessible->states->states = val;
1249 _atspi_accessible_add_cache (accessible, ATSPI_CACHE_STATES);
1253 atspi_error_quark (void)
1255 return g_quark_from_static_string ("atspi_error");
1259 * Gets the IOR from the XDisplay.
1262 get_accessibility_bus_address_x11 (void)
1266 Display *bridge_display;
1268 unsigned char *data = NULL;
1269 unsigned long nitems;
1270 unsigned long leftover;
1272 bridge_display = XOpenDisplay (spi_display_name ());
1273 if (!bridge_display)
1275 g_warning ("Could not open X display");
1279 AT_SPI_BUS = XInternAtom (bridge_display, "AT_SPI_BUS", False);
1280 XGetWindowProperty (bridge_display,
1281 XDefaultRootWindow (bridge_display),
1283 (long) BUFSIZ, False,
1284 (Atom) 31, &actual_type, &actual_format,
1285 &nitems, &leftover, &data);
1286 XCloseDisplay (bridge_display);
1288 return g_strdup (data);
1292 get_accessibility_bus_address_dbus (void)
1294 DBusConnection *session_bus = NULL;
1295 DBusMessage *message;
1298 char *address = NULL;
1300 session_bus = dbus_bus_get (DBUS_BUS_SESSION, NULL);
1304 message = dbus_message_new_method_call ("org.a11y.Bus",
1309 dbus_error_init (&error);
1310 reply = dbus_connection_send_with_reply_and_block (session_bus,
1314 dbus_message_unref (message);
1318 g_warning ("Error retrieving accessibility bus address: %s: %s",
1319 error.name, error.message);
1320 dbus_error_init (&error);
1325 const char *tmp_address;
1326 if (!dbus_message_get_args (reply,
1332 dbus_message_unref (reply);
1335 address = g_strdup (tmp_address);
1336 dbus_message_unref (reply);
1343 atspi_get_a11y_bus (void)
1345 DBusConnection *bus = NULL;
1349 address = get_accessibility_bus_address_x11 ();
1351 address = get_accessibility_bus_address_dbus ();
1355 dbus_error_init (&error);
1356 bus = dbus_connection_open (address, &error);
1361 g_warning ("Couldn't connect to accessibility bus: %s", error.message);
1366 if (!dbus_bus_register (bus, &error))
1368 g_warning ("Couldn't register with accessibility bus: %s", error.message);