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"
35 #include "atspi-gmain.h"
39 static void handle_get_items (DBusPendingCall *pending, void *user_data);
41 static DBusConnection *bus = NULL;
42 static GHashTable *live_refs = NULL;
43 static gint method_call_timeout = 800;
44 static gint app_startup_time = 15000;
45 static gboolean allow_sync = TRUE;
47 GMainLoop *atspi_main_loop;
48 GMainContext *atspi_main_context;
49 gboolean atspi_no_cache;
51 const char *atspi_path_dec = ATSPI_DBUS_PATH_DEC;
52 const char *atspi_path_registry = ATSPI_DBUS_PATH_REGISTRY;
53 const char *atspi_path_root = ATSPI_DBUS_PATH_ROOT;
54 const char *atspi_bus_registry = ATSPI_DBUS_NAME_REGISTRY;
55 const char *atspi_interface_accessible = ATSPI_DBUS_INTERFACE_ACCESSIBLE;
56 const char *atspi_interface_action = ATSPI_DBUS_INTERFACE_ACTION;
57 const char *atspi_interface_application = ATSPI_DBUS_INTERFACE_APPLICATION;
58 const char *atspi_interface_collection = ATSPI_DBUS_INTERFACE_COLLECTION;
59 const char *atspi_interface_component = ATSPI_DBUS_INTERFACE_COMPONENT;
60 const char *atspi_interface_dec = ATSPI_DBUS_INTERFACE_DEC;
61 const char *atspi_interface_device_event_listener = ATSPI_DBUS_INTERFACE_DEVICE_EVENT_LISTENER;
62 const char *atspi_interface_document = ATSPI_DBUS_INTERFACE_DOCUMENT;
63 const char *atspi_interface_editable_text = ATSPI_DBUS_INTERFACE_EDITABLE_TEXT;
64 const char *atspi_interface_event_object = ATSPI_DBUS_INTERFACE_EVENT_OBJECT;
65 const char *atspi_interface_hyperlink = ATSPI_DBUS_INTERFACE_HYPERLINK;
66 const char *atspi_interface_hypertext = ATSPI_DBUS_INTERFACE_HYPERTEXT;
67 const char *atspi_interface_image = ATSPI_DBUS_INTERFACE_IMAGE;
68 const char *atspi_interface_registry = ATSPI_DBUS_INTERFACE_REGISTRY;
69 const char *atspi_interface_selection = ATSPI_DBUS_INTERFACE_SELECTION;
70 const char *atspi_interface_table = ATSPI_DBUS_INTERFACE_TABLE;
71 const char *atspi_interface_text = ATSPI_DBUS_INTERFACE_TEXT;
72 const char *atspi_interface_cache = ATSPI_DBUS_INTERFACE_CACHE;
73 const char *atspi_interface_value = ATSPI_DBUS_INTERFACE_VALUE;
75 static const char *interfaces[] =
77 ATSPI_DBUS_INTERFACE_ACCESSIBLE,
78 ATSPI_DBUS_INTERFACE_ACTION,
79 ATSPI_DBUS_INTERFACE_APPLICATION,
80 ATSPI_DBUS_INTERFACE_COLLECTION,
81 ATSPI_DBUS_INTERFACE_COMPONENT,
82 ATSPI_DBUS_INTERFACE_DOCUMENT,
83 ATSPI_DBUS_INTERFACE_EDITABLE_TEXT,
84 ATSPI_DBUS_INTERFACE_HYPERLINK,
85 ATSPI_DBUS_INTERFACE_HYPERTEXT,
86 ATSPI_DBUS_INTERFACE_IMAGE,
87 "org.a11y.atspi.LoginHelper",
88 ATSPI_DBUS_INTERFACE_SELECTION,
89 ATSPI_DBUS_INTERFACE_TABLE,
90 ATSPI_DBUS_INTERFACE_TEXT,
91 ATSPI_DBUS_INTERFACE_VALUE,
96 _atspi_get_iface_num (const char *iface)
98 /* TODO: Use a binary search or hash to improve performance */
101 for (i = 0; interfaces[i]; i++)
103 if (!strcmp(iface, interfaces[i])) return i;
109 _atspi_get_live_refs (void)
113 live_refs = g_hash_table_new (g_direct_hash, g_direct_equal);
118 /* TODO: Add an application parameter */
125 g_error ("AT-SPI: COuldn't connect to accessibility bus. Is at-spi-bus-launcher running?");
129 #define APP_IS_REGISTRY(app) (!strcmp (app->bus_name, atspi_bus_registry))
131 static AtspiAccessible *desktop;
143 g_hash_table_destroy (refs);
148 dbus_connection_close (bus);
149 dbus_connection_unref (bus);
155 for (l = desktop->children; l;)
157 GList *next = l->next;
158 AtspiAccessible *child = l->data;
159 g_object_run_dispose (G_OBJECT (child->parent.app));
160 g_object_run_dispose (G_OBJECT (child));
163 g_object_run_dispose (G_OBJECT (desktop->parent.app));
164 g_object_unref (desktop);
168 static gboolean atspi_inited = FALSE;
170 static GHashTable *app_hash = NULL;
173 handle_get_bus_address (DBusPendingCall *pending, void *user_data)
175 AtspiApplication *app = user_data;
176 DBusMessage *reply = dbus_pending_call_steal_reply (pending);
177 DBusMessage *message;
179 DBusPendingCall *new_pending;
181 if (dbus_message_get_type (reply) == DBUS_MESSAGE_TYPE_METHOD_RETURN)
183 if (dbus_message_get_args (reply, NULL, DBUS_TYPE_STRING, &address,
184 DBUS_TYPE_INVALID) && address [0])
189 dbus_error_init (&error);
190 bus = dbus_connection_open_private (address, &error);
195 dbus_connection_unref (app->bus);
201 g_warning ("Unable to open bus connection: %s", error.message);
202 dbus_error_free (&error);
206 dbus_message_unref (reply);
207 dbus_pending_call_unref (pending);
210 return; /* application has gone away / been disposed */
212 message = dbus_message_new_method_call (app->bus_name,
213 "/org/a11y/atspi/cache",
214 atspi_interface_cache, "GetItems");
216 dbus_connection_send_with_reply (app->bus, message, &new_pending, 2000);
217 dbus_pending_call_set_notify (new_pending, handle_get_items, app, NULL);
218 dbus_message_unref (message);
221 static AtspiApplication *
222 get_application (const char *bus_name)
224 AtspiApplication *app = NULL;
226 DBusMessage *message;
227 DBusPendingCall *pending = NULL;
231 app_hash = g_hash_table_new_full (g_str_hash, g_str_equal, g_free, (GDestroyNotify)g_object_unref);
232 if (!app_hash) return NULL;
234 app = g_hash_table_lookup (app_hash, bus_name);
236 bus_name_dup = g_strdup (bus_name);
237 if (!bus_name_dup) return NULL;
238 // TODO: change below to something that will send state-change:defunct notification if necessary */
239 app = _atspi_application_new (bus_name);
240 app->hash = g_hash_table_new_full (g_str_hash, g_str_equal, g_free, g_object_unref);
241 app->bus = dbus_connection_ref (_atspi_bus ());
242 gettimeofday (&app->time_added, NULL);
243 app->cache = ATSPI_CACHE_UNDEFINED;
244 g_hash_table_insert (app_hash, bus_name_dup, app);
245 message = dbus_message_new_method_call (bus_name, atspi_path_root,
246 atspi_interface_application, "GetApplicationBusAddress");
248 dbus_connection_send_with_reply (app->bus, message, &pending, 2000);
249 dbus_pending_call_set_notify (pending, handle_get_bus_address, app, NULL);
250 dbus_message_unref (message);
254 static AtspiAccessible *
255 ref_accessible (const char *app_name, const char *path)
257 AtspiApplication *app;
260 if (!strcmp (path, ATSPI_DBUS_PATH_NULL))
263 app = get_application (app_name);
265 if (!strcmp (path, "/org/a11y/atspi/accessible/root"))
269 app->root = _atspi_accessible_new (app, atspi_path_root);
270 app->root->accessible_parent = atspi_get_desktop (0);
271 app->root->accessible_parent->children = g_list_append (app->root->accessible_parent->children, g_object_ref (app->root));
273 return g_object_ref (app->root);
276 a = g_hash_table_lookup (app->hash, path);
279 return g_object_ref (a);
281 a = _atspi_accessible_new (app, path);
284 g_hash_table_insert (app->hash, g_strdup (a->parent.path), g_object_ref (a));
288 static AtspiHyperlink *
289 ref_hyperlink (const char *app_name, const char *path)
291 AtspiApplication *app = get_application (app_name);
292 AtspiHyperlink *hyperlink;
294 if (!strcmp (path, ATSPI_DBUS_PATH_NULL))
297 hyperlink = g_hash_table_lookup (app->hash, path);
300 return g_object_ref (hyperlink);
302 hyperlink = _atspi_hyperlink_new (app, path);
303 g_hash_table_insert (app->hash, g_strdup (hyperlink->parent.path), hyperlink);
304 /* TODO: This should be a weak ref */
305 g_object_ref (hyperlink); /* for the hash */
318 GArray *state_bitflags;
321 static DBusHandlerResult
322 handle_remove_accessible (DBusConnection *bus, DBusMessage *message, void *user_data)
324 const char *sender = dbus_message_get_sender (message);
325 AtspiApplication *app;
327 DBusMessageIter iter, iter_struct;
328 const char *signature = dbus_message_get_signature (message);
331 if (strcmp (signature, "(so)") != 0)
333 g_warning ("AT-SPI: Unknown signature %s for RemoveAccessible", signature);
334 return DBUS_HANDLER_RESULT_HANDLED;
337 dbus_message_iter_init (message, &iter);
338 dbus_message_iter_recurse (&iter, &iter_struct);
339 dbus_message_iter_get_basic (&iter_struct, &sender);
340 dbus_message_iter_next (&iter_struct);
341 dbus_message_iter_get_basic (&iter_struct, &path);
342 app = get_application (sender);
343 a = ref_accessible (sender, path);
345 return DBUS_HANDLER_RESULT_HANDLED;
346 g_object_run_dispose (G_OBJECT (a));
347 g_hash_table_remove (app->hash, a->parent.path);
348 g_object_unref (a); /* unref our own ref */
349 return DBUS_HANDLER_RESULT_HANDLED;
352 static DBusHandlerResult
353 handle_name_owner_changed (DBusConnection *bus, DBusMessage *message, void *user_data)
355 const char *name, *new, *old;
356 static gboolean registry_lost = FALSE;
358 if (!dbus_message_get_args (message, NULL,
359 DBUS_TYPE_STRING, &name,
360 DBUS_TYPE_STRING, &old,
361 DBUS_TYPE_STRING, &new,
364 return DBUS_HANDLER_RESULT_NOT_YET_HANDLED;
367 if (!strcmp (name, "org.a11y.atspi.Registry"))
369 if (registry_lost && !old[0])
371 _atspi_reregister_event_listeners ();
372 _atspi_reregister_device_listeners ();
373 registry_lost = FALSE;
376 registry_lost = TRUE;
380 AtspiAccessible *desktop = atspi_get_desktop (0);
382 for (l = desktop->children; l; l = l->next)
384 AtspiAccessible *child = l->data;
385 if (!strcmp (child->parent.app->bus_name, old))
386 g_object_run_dispose (G_OBJECT (child->parent.app));
388 g_object_unref (desktop);
390 return DBUS_HANDLER_RESULT_HANDLED;
394 add_app_to_desktop (AtspiAccessible *a, const char *bus_name)
396 AtspiAccessible *obj = ref_accessible (bus_name, atspi_path_root);
397 /* The app will be added to the desktop as a side-effect of calling
399 g_object_unref (obj);
400 return (obj != NULL);
404 get_reference_from_iter (DBusMessageIter *iter, const char **app_name, const char **path)
406 DBusMessageIter iter_struct;
408 dbus_message_iter_recurse (iter, &iter_struct);
409 dbus_message_iter_get_basic (&iter_struct, app_name);
410 dbus_message_iter_next (&iter_struct);
411 dbus_message_iter_get_basic (&iter_struct, path);
412 dbus_message_iter_next (iter);
416 add_accessible_from_iter (DBusMessageIter *iter)
418 DBusMessageIter iter_struct, iter_array;
419 const char *app_name, *path;
420 AtspiAccessible *accessible;
421 const char *name, *description;
424 dbus_message_iter_recurse (iter, &iter_struct);
427 get_reference_from_iter (&iter_struct, &app_name, &path);
428 accessible = ref_accessible (app_name, path);
432 /* Get application: TODO */
433 dbus_message_iter_next (&iter_struct);
436 get_reference_from_iter (&iter_struct, &app_name, &path);
437 if (accessible->accessible_parent)
438 g_object_unref (accessible->accessible_parent);
439 accessible->accessible_parent = ref_accessible (app_name, path);
442 while (accessible->children)
444 g_object_unref (accessible->children->data);
445 accessible->children = g_list_remove (accessible->children, accessible->children->data);
447 dbus_message_iter_recurse (&iter_struct, &iter_array);
448 while (dbus_message_iter_get_arg_type (&iter_array) != DBUS_TYPE_INVALID)
450 AtspiAccessible *child;
451 get_reference_from_iter (&iter_array, &app_name, &path);
452 child = ref_accessible (app_name, path);
453 accessible->children = g_list_append (accessible->children, child);
457 dbus_message_iter_next (&iter_struct);
458 _atspi_dbus_set_interfaces (accessible, &iter_struct);
459 dbus_message_iter_next (&iter_struct);
462 if (accessible->name)
463 g_free (accessible->name);
464 dbus_message_iter_get_basic (&iter_struct, &name);
465 accessible->name = g_strdup (name);
466 dbus_message_iter_next (&iter_struct);
469 dbus_message_iter_get_basic (&iter_struct, &role);
470 accessible->role = role;
471 dbus_message_iter_next (&iter_struct);
474 if (accessible->description)
475 g_free (accessible->description);
476 dbus_message_iter_get_basic (&iter_struct, &description);
477 accessible->description = g_strdup (description);
478 dbus_message_iter_next (&iter_struct);
480 _atspi_dbus_set_state (accessible, &iter_struct);
481 dbus_message_iter_next (&iter_struct);
483 _atspi_accessible_add_cache (accessible, ATSPI_CACHE_NAME | ATSPI_CACHE_ROLE |
484 ATSPI_CACHE_PARENT | ATSPI_CACHE_DESCRIPTION);
485 if (!atspi_state_set_contains (accessible->states,
486 ATSPI_STATE_MANAGES_DESCENDANTS))
487 _atspi_accessible_add_cache (accessible, ATSPI_CACHE_CHILDREN);
489 /* This is a bit of a hack since the cache holds a ref, so we don't need
490 * the one provided for us anymore */
491 g_object_unref (accessible);
495 handle_get_items (DBusPendingCall *pending, void *user_data)
497 DBusMessage *reply = dbus_pending_call_steal_reply (pending);
498 DBusMessageIter iter, iter_array;
500 if (dbus_message_get_type (reply) == DBUS_MESSAGE_TYPE_ERROR)
502 const char *sender = dbus_message_get_sender (reply);
503 const char *error = NULL;
504 dbus_message_get_args (reply, NULL, DBUS_TYPE_STRING, &error,
506 g_warning ("AT-SPI: Error in GetItems, sender=%s, error=%s", sender, error);
507 dbus_message_unref (reply);
508 dbus_pending_call_unref (pending);
512 dbus_message_iter_init (reply, &iter);
513 dbus_message_iter_recurse (&iter, &iter_array);
514 while (dbus_message_iter_get_arg_type (&iter_array) != DBUS_TYPE_INVALID)
516 add_accessible_from_iter (&iter_array);
517 dbus_message_iter_next (&iter_array);
519 dbus_message_unref (reply);
520 dbus_pending_call_unref (pending);
523 /* TODO: Do we stil need this function? */
524 static AtspiAccessible *
525 ref_accessible_desktop (AtspiApplication *app)
528 DBusMessage *message, *reply;
529 DBusMessageIter iter, iter_array;
534 g_object_ref (desktop);
537 desktop = _atspi_accessible_new (app, atspi_path_root);
542 g_hash_table_insert (app->hash, g_strdup (desktop->parent.path),
543 g_object_ref (desktop));
544 app->root = g_object_ref (desktop);
545 desktop->name = g_strdup ("main");
546 message = dbus_message_new_method_call (atspi_bus_registry,
548 atspi_interface_accessible,
553 reply = _atspi_dbus_send_with_reply_and_block (message, &error);
554 if (!reply || strcmp (dbus_message_get_signature (reply), "a(so)") != 0)
558 g_warning ("Couldn't get application list: %s", error->message);
559 g_clear_error (&error);
562 dbus_message_unref (reply);
565 dbus_message_iter_init (reply, &iter);
566 dbus_message_iter_recurse (&iter, &iter_array);
567 while (dbus_message_iter_get_arg_type (&iter_array) != DBUS_TYPE_INVALID)
569 const char *app_name, *path;
570 get_reference_from_iter (&iter_array, &app_name, &path);
571 add_app_to_desktop (desktop, app_name);
573 dbus_message_unref (reply);
575 /* Record the alternate name as an alias for org.a11y.atspi.Registry */
576 bus_name_dup = g_strdup (dbus_message_get_sender (reply));
578 g_hash_table_insert (app_hash, bus_name_dup, app);
580 return g_object_ref (desktop);
584 _atspi_ref_accessible (const char *app, const char *path)
586 AtspiApplication *a = get_application (app);
589 if ( APP_IS_REGISTRY(a))
592 g_object_unref (ref_accessible_desktop (a)); /* sets a->root */
593 return g_object_ref (a->root);
595 return ref_accessible (app, path);
599 _atspi_dbus_return_accessible_from_message (DBusMessage *message)
601 DBusMessageIter iter;
602 AtspiAccessible *retval = NULL;
603 const char *signature;
608 signature = dbus_message_get_signature (message);
609 if (!strcmp (signature, "(so)"))
611 dbus_message_iter_init (message, &iter);
612 retval = _atspi_dbus_return_accessible_from_iter (&iter);
616 g_warning ("AT-SPI: Called _atspi_dbus_return_accessible_from_message with strange signature %s", signature);
618 dbus_message_unref (message);
623 _atspi_dbus_return_accessible_from_iter (DBusMessageIter *iter)
625 const char *app_name, *path;
627 get_reference_from_iter (iter, &app_name, &path);
628 return ref_accessible (app_name, path);
632 _atspi_dbus_return_hyperlink_from_message (DBusMessage *message)
634 DBusMessageIter iter;
635 AtspiHyperlink *retval = NULL;
636 const char *signature;
641 signature = dbus_message_get_signature (message);
642 if (!strcmp (signature, "(so)"))
644 dbus_message_iter_init (message, &iter);
645 retval = _atspi_dbus_return_hyperlink_from_iter (&iter);
649 g_warning ("AT-SPI: Called _atspi_dbus_return_hyperlink_from_message with strange signature %s", signature);
651 dbus_message_unref (message);
656 _atspi_dbus_return_hyperlink_from_iter (DBusMessageIter *iter)
658 const char *app_name, *path;
660 get_reference_from_iter (iter, &app_name, &path);
661 return ref_hyperlink (app_name, path);
664 const char *cache_signal_type = "((so)(so)(so)a(so)assusau)";
666 static DBusHandlerResult
667 handle_add_accessible (DBusConnection *bus, DBusMessage *message, void *user_data)
669 DBusMessageIter iter;
671 if (strcmp (dbus_message_get_signature (message), cache_signal_type) != 0)
673 g_warning ("AT-SPI: AddAccessible with unknown signature %s\n",
674 dbus_message_get_signature (message));
675 return DBUS_HANDLER_RESULT_HANDLED;
678 dbus_message_iter_init (message, &iter);
679 add_accessible_from_iter (&iter);
680 return DBUS_HANDLER_RESULT_HANDLED;
686 DBusMessage *message;
690 static GSource *process_deferred_messages_source = NULL;
693 process_deferred_message (BusDataClosure *closure)
695 int type = dbus_message_get_type (closure->message);
696 const char *interface = dbus_message_get_interface (closure->message);
698 if (type == DBUS_MESSAGE_TYPE_SIGNAL &&
699 !strncmp (interface, "org.a11y.atspi.Event.", 21))
701 _atspi_dbus_handle_event (closure->bus, closure->message, closure->data);
703 if (dbus_message_is_method_call (closure->message, atspi_interface_device_event_listener, "NotifyEvent"))
705 _atspi_dbus_handle_DeviceEvent (closure->bus,
706 closure->message, closure->data);
708 if (dbus_message_is_signal (closure->message, atspi_interface_cache, "AddAccessible"))
710 handle_add_accessible (closure->bus, closure->message, closure->data);
712 if (dbus_message_is_signal (closure->message, atspi_interface_cache, "RemoveAccessible"))
714 handle_remove_accessible (closure->bus, closure->message, closure->data);
716 if (dbus_message_is_signal (closure->message, "org.freedesktop.DBus", "NameOwnerChanged"))
718 handle_name_owner_changed (closure->bus, closure->message, closure->data);
722 static GQueue *deferred_messages = NULL;
725 process_deferred_messages (void)
727 static int in_process_deferred_messages = 0;
728 BusDataClosure *closure;
730 if (in_process_deferred_messages)
732 in_process_deferred_messages = 1;
733 while ((closure = g_queue_pop_head (deferred_messages)))
735 process_deferred_message (closure);
736 dbus_message_unref (closure->message);
737 dbus_connection_unref (closure->bus);
740 in_process_deferred_messages = 0;
745 process_deferred_messages_callback (gpointer data)
747 if (process_deferred_messages ())
748 return G_SOURCE_CONTINUE;
750 process_deferred_messages_source = NULL;
751 return G_SOURCE_REMOVE;
754 static DBusHandlerResult
755 defer_message (DBusConnection *connection, DBusMessage *message, void *user_data)
757 BusDataClosure *closure = g_new (BusDataClosure, 1);
759 closure->bus = dbus_connection_ref (bus);
760 closure->message = dbus_message_ref (message);
761 closure->data = user_data;
763 g_queue_push_tail (deferred_messages, closure);
765 if (process_deferred_messages_source == NULL)
767 process_deferred_messages_source = g_idle_source_new ();
768 g_source_set_callback (process_deferred_messages_source,
769 process_deferred_messages_callback, NULL, NULL);
770 g_source_attach (process_deferred_messages_source, atspi_main_context);
771 g_source_unref (process_deferred_messages_source);
774 return DBUS_HANDLER_RESULT_HANDLED;
777 static DBusHandlerResult
778 atspi_dbus_filter (DBusConnection *bus, DBusMessage *message, void *data)
780 int type = dbus_message_get_type (message);
781 const char *interface = dbus_message_get_interface (message);
783 if (type == DBUS_MESSAGE_TYPE_SIGNAL &&
784 !strncmp (interface, "org.a11y.atspi.Event.", 21))
786 return defer_message (bus, message, data);
788 if (dbus_message_is_method_call (message, atspi_interface_device_event_listener, "NotifyEvent"))
790 return defer_message (bus, message, data);
792 if (dbus_message_is_signal (message, atspi_interface_cache, "AddAccessible"))
794 return defer_message (bus, message, data);
796 if (dbus_message_is_signal (message, atspi_interface_cache, "RemoveAccessible"))
798 return defer_message (bus, message, data);
800 if (dbus_message_is_signal (message, "org.freedesktop.DBus", "NameOwnerChanged"))
802 defer_message (bus, message, data);
803 return DBUS_HANDLER_RESULT_NOT_YET_HANDLED;
805 return DBUS_HANDLER_RESULT_NOT_YET_HANDLED;
809 * Returns a 'canonicalized' value for DISPLAY,
810 * with the screen number stripped off if present.
812 * TODO: Avoid having duplicate functions for this here and in at-spi2-atk
815 spi_display_name (void)
817 char *canonical_display_name = NULL;
818 const gchar *display_env = g_getenv ("AT_SPI_DISPLAY");
822 display_env = g_getenv ("DISPLAY");
823 if (!display_env || !display_env[0])
827 gchar *display_p, *screen_p;
828 canonical_display_name = g_strdup (display_env);
829 display_p = g_utf8_strrchr (canonical_display_name, -1, ':');
830 screen_p = g_utf8_strrchr (canonical_display_name, -1, '.');
831 if (screen_p && display_p && (screen_p > display_p))
839 canonical_display_name = g_strdup (display_env);
842 return canonical_display_name;
848 * Connects to the accessibility registry and initializes the SPI.
850 * Returns: 0 on success, 1 if already initialized, or an integer error code.
856 const gchar *no_cache;
865 _atspi_get_live_refs();
867 bus = atspi_get_a11y_bus ();
870 dbus_bus_register (bus, NULL);
871 atspi_dbus_connection_setup_with_g_main(bus, g_main_context_default());
872 dbus_connection_add_filter (bus, atspi_dbus_filter, NULL, NULL);
873 match = g_strdup_printf ("type='signal',interface='%s',member='AddAccessible'", atspi_interface_cache);
874 dbus_bus_add_match (bus, match, NULL);
876 match = g_strdup_printf ("type='signal',interface='%s',member='RemoveAccessible'", atspi_interface_cache);
877 dbus_bus_add_match (bus, match, NULL);
879 match = g_strdup_printf ("type='signal',interface='%s',member='ChildrenChanged'", atspi_interface_event_object);
880 dbus_bus_add_match (bus, match, NULL);
882 match = g_strdup_printf ("type='signal',interface='%s',member='PropertyChange'", atspi_interface_event_object);
883 dbus_bus_add_match (bus, match, NULL);
885 match = g_strdup_printf ("type='signal',interface='%s',member='StateChanged'", atspi_interface_event_object);
886 dbus_bus_add_match (bus, match, NULL);
889 dbus_bus_add_match (bus,
890 "type='signal', interface='org.freedesktop.DBus', member='NameOwnerChanged'",
893 no_cache = g_getenv ("ATSPI_NO_CACHE");
894 if (no_cache && g_strcmp0 (no_cache, "0") != 0)
895 atspi_no_cache = TRUE;
897 deferred_messages = g_queue_new ();
903 * atspi_is_initialized:
905 * Indicates whether AT-SPI has been initialized.
907 * Returns: %True if initialized; %False otherwise.
910 atspi_is_initialized ()
918 * Starts/enters the main event loop for the AT-SPI services.
920 * NOTE: This method does not return control; it is exited via a call to
921 * #atspi_event_quit from within an event handler.
925 atspi_event_main (void)
927 atspi_main_loop = g_main_loop_new (NULL, FALSE);
928 g_main_loop_run (atspi_main_loop);
929 atspi_main_loop = NULL;
935 * Quits the last main event loop for the AT-SPI services,
936 * See: #atspi_event_main
939 atspi_event_quit (void)
941 g_main_loop_quit (atspi_main_loop);
947 * Disconnects from #AtspiRegistry instances and releases
948 * any floating resources. Call only once at exit.
950 * Returns: 0 if there were no leaks, otherwise other integer values.
962 atspi_inited = FALSE;
966 leaked = g_hash_table_size (live_refs);
978 static GSList *hung_processes;
981 remove_hung_process (DBusPendingCall *pending, void *data)
984 hung_processes = g_slist_remove (hung_processes, data);
986 dbus_pending_call_unref (pending);
990 check_for_hang (DBusMessage *message, DBusError *error, DBusConnection *bus, const char *bus_name)
992 if (!message && error->name &&
993 !strcmp (error->name, "org.freedesktop.DBus.Error.NoReply"))
996 DBusMessage *message;
998 DBusPendingCall *pending = NULL;
999 for (l = hung_processes; l; l = l->next)
1000 if (!strcmp (l->data, bus_name))
1002 message = dbus_message_new_method_call (bus_name, "/",
1003 "org.freedesktop.DBus.Peer",
1007 dbus_connection_send_with_reply (bus, message, &pending, -1);
1008 dbus_message_unref (message);
1011 bus_name_dup = g_strdup (bus_name);
1012 hung_processes = g_slist_append (hung_processes, bus_name_dup);
1013 dbus_pending_call_set_notify (pending, remove_hung_process, bus_name_dup, NULL);
1018 connection_is_hung (const char *bus_name)
1022 for (l = hung_processes; l; l = l->next)
1023 if (!strcmp (l->data, bus_name))
1029 check_app (AtspiApplication *app, GError **error)
1031 if (!app || !app->bus)
1033 g_set_error_literal (error, ATSPI_ERROR, ATSPI_ERROR_APPLICATION_GONE,
1034 _("The application no longer exists"));
1038 if (atspi_main_loop && connection_is_hung (app->bus_name))
1040 g_set_error_literal (error, ATSPI_ERROR, ATSPI_ERROR_IPC,
1041 "The process appears to be hung.");
1049 set_timeout (AtspiApplication *app)
1054 if (app && app_startup_time > 0)
1056 gettimeofday (&tv, NULL);
1057 diff = (tv.tv_sec - app->time_added.tv_sec) * 1000 + (tv.tv_usec - app->time_added.tv_usec) / 1000;
1058 dbind_set_timeout (MAX(method_call_timeout, app_startup_time - diff));
1061 dbind_set_timeout (method_call_timeout);
1065 _atspi_dbus_call (gpointer obj, const char *interface, const char *method, GError **error, const char *type, ...)
1070 AtspiObject *aobj = ATSPI_OBJECT (obj);
1072 if (!check_app (aobj->app, error))
1077 _atspi_set_error_no_sync (error);
1081 va_start (args, type);
1082 dbus_error_init (&err);
1083 set_timeout (aobj->app);
1084 retval = dbind_method_call_reentrant_va (aobj->app->bus, aobj->app->bus_name,
1085 aobj->path, interface, method, &err,
1088 check_for_hang (NULL, &err, aobj->app->bus, aobj->app->bus_name);
1089 process_deferred_messages ();
1090 if (dbus_error_is_set (&err))
1092 g_set_error(error, ATSPI_ERROR, ATSPI_ERROR_IPC, "%s", err.message);
1093 dbus_error_free (&err);
1099 _atspi_dbus_call_partial (gpointer obj,
1100 const char *interface,
1103 const char *type, ...)
1107 va_start (args, type);
1108 return _atspi_dbus_call_partial_va (obj, interface, method, error, type, args);
1113 _atspi_dbus_call_partial_va (gpointer obj,
1114 const char *interface,
1120 AtspiObject *aobj = ATSPI_OBJECT (obj);
1122 DBusMessage *msg = NULL, *reply = NULL;
1123 DBusMessageIter iter;
1126 dbus_error_init (&err);
1128 if (!check_app (aobj->app, error))
1131 msg = dbus_message_new_method_call (aobj->app->bus_name, aobj->path, interface, method);
1136 dbus_message_iter_init_append (msg, &iter);
1137 dbind_any_marshal_va (&iter, &p, args);
1139 set_timeout (aobj->app);
1140 reply = dbind_send_and_allow_reentry (aobj->app->bus, msg, &err);
1141 check_for_hang (reply, &err, aobj->app->bus, aobj->app->bus_name);
1145 dbus_message_unref (msg);
1146 process_deferred_messages ();
1147 if (dbus_error_is_set (&err))
1149 /* TODO: Set gerror */
1150 dbus_error_free (&err);
1153 if (reply && dbus_message_get_type (reply) == DBUS_MESSAGE_TYPE_ERROR)
1155 const char *err_str = NULL;
1156 dbus_message_get_args (reply, NULL, DBUS_TYPE_STRING, &err_str, DBUS_TYPE_INVALID);
1158 g_set_error_literal (error, ATSPI_ERROR, ATSPI_ERROR_IPC, err_str);
1159 dbus_message_unref (reply);
1167 _atspi_dbus_get_property (gpointer obj, const char *interface, const char *name, GError **error, const char *type, void *data)
1169 DBusMessage *message, *reply;
1170 DBusMessageIter iter, iter_variant;
1172 dbus_bool_t retval = FALSE;
1173 AtspiObject *aobj = ATSPI_OBJECT (obj);
1174 char expected_type = (type [0] == '(' ? 'r' : type [0]);
1179 if (!check_app (aobj->app, error))
1184 _atspi_set_error_no_sync (error);
1188 message = dbus_message_new_method_call (aobj->app->bus_name,
1190 "org.freedesktop.DBus.Properties",
1194 // TODO: throw exception
1197 dbus_message_append_args (message, DBUS_TYPE_STRING, &interface, DBUS_TYPE_STRING, &name, DBUS_TYPE_INVALID);
1198 dbus_error_init (&err);
1199 set_timeout (aobj->app);
1200 reply = dbind_send_and_allow_reentry (aobj->app->bus, message, &err);
1201 check_for_hang (reply, &err, aobj->app->bus, aobj->app->bus_name);
1202 dbus_message_unref (message);
1203 process_deferred_messages ();
1206 // TODO: throw exception
1210 if (dbus_message_get_type (reply) == DBUS_MESSAGE_TYPE_ERROR)
1212 const char *err_str = NULL;
1213 dbus_message_get_args (reply, NULL, DBUS_TYPE_STRING, &err_str, DBUS_TYPE_INVALID);
1215 g_set_error_literal (error, ATSPI_ERROR, ATSPI_ERROR_IPC, err_str);
1219 dbus_message_iter_init (reply, &iter);
1220 if (dbus_message_iter_get_arg_type (&iter) != 'v')
1222 g_warning ("AT-SPI: expected a variant when fetching %s from interface %s; got %s\n", name, interface, dbus_message_get_signature (reply));
1225 dbus_message_iter_recurse (&iter, &iter_variant);
1226 if (dbus_message_iter_get_arg_type (&iter_variant) != expected_type)
1228 g_warning ("atspi_dbus_get_property: Wrong type: expected %s, got %c\n", type, dbus_message_iter_get_arg_type (&iter_variant));
1231 if (!strcmp (type, "(so)"))
1233 *((AtspiAccessible **)data) = _atspi_dbus_return_accessible_from_iter (&iter_variant);
1237 dbus_message_iter_get_basic (&iter_variant, data);
1238 if (type [0] == 's')
1239 *(char **)data = g_strdup (*(char **)data);
1243 dbus_error_free (&err);
1245 dbus_message_unref (reply);
1250 _atspi_dbus_send_with_reply_and_block (DBusMessage *message, GError **error)
1254 AtspiApplication *app;
1255 DBusConnection *bus;
1257 app = get_application (dbus_message_get_destination (message));
1259 if (app && !app->bus)
1260 return NULL; /* will fail anyway; app has been disposed */
1262 bus = (app ? app->bus : _atspi_bus());
1263 dbus_error_init (&err);
1265 reply = dbind_send_and_allow_reentry (bus, message, &err);
1266 process_deferred_messages ();
1267 dbus_message_unref (message);
1268 if (dbus_error_is_set (&err))
1271 g_set_error_literal (error, ATSPI_ERROR, ATSPI_ERROR_IPC, err.message);
1272 dbus_error_free (&err);
1278 _atspi_dbus_return_hash_from_message (DBusMessage *message)
1280 DBusMessageIter iter;
1286 _ATSPI_DBUS_CHECK_SIG (message, "a{ss}", NULL, NULL);
1288 dbus_message_iter_init (message, &iter);
1289 ret = _atspi_dbus_hash_from_iter (&iter);
1290 dbus_message_unref (message);
1295 _atspi_dbus_hash_from_iter (DBusMessageIter *iter)
1297 GHashTable *hash = g_hash_table_new_full (g_str_hash, g_str_equal,
1298 (GDestroyNotify) g_free,
1299 (GDestroyNotify) g_free);
1300 DBusMessageIter iter_array, iter_dict;
1302 dbus_message_iter_recurse (iter, &iter_array);
1303 while (dbus_message_iter_get_arg_type (&iter_array) != DBUS_TYPE_INVALID)
1305 const char *name, *value;
1306 dbus_message_iter_recurse (&iter_array, &iter_dict);
1307 dbus_message_iter_get_basic (&iter_dict, &name);
1308 dbus_message_iter_next (&iter_dict);
1309 dbus_message_iter_get_basic (&iter_dict, &value);
1310 g_hash_table_insert (hash, g_strdup (name), g_strdup (value));
1311 dbus_message_iter_next (&iter_array);
1317 _atspi_dbus_return_attribute_array_from_message (DBusMessage *message)
1319 DBusMessageIter iter;
1325 _ATSPI_DBUS_CHECK_SIG (message, "a{ss}", NULL, NULL);
1327 dbus_message_iter_init (message, &iter);
1329 ret = _atspi_dbus_attribute_array_from_iter (&iter);
1330 dbus_message_unref (message);
1335 _atspi_dbus_attribute_array_from_iter (DBusMessageIter *iter)
1337 DBusMessageIter iter_array, iter_dict;
1338 GArray *array = g_array_new (TRUE, TRUE, sizeof (gchar *));
1340 dbus_message_iter_recurse (iter, &iter_array);
1341 while (dbus_message_iter_get_arg_type (&iter_array) != DBUS_TYPE_INVALID)
1343 const char *name, *value;
1345 dbus_message_iter_recurse (&iter_array, &iter_dict);
1346 dbus_message_iter_get_basic (&iter_dict, &name);
1347 dbus_message_iter_next (&iter_dict);
1348 dbus_message_iter_get_basic (&iter_dict, &value);
1349 str = g_strdup_printf ("%s:%s", name, value);
1350 array = g_array_append_val (array, str);
1351 dbus_message_iter_next (&iter_array);;
1357 _atspi_dbus_set_interfaces (AtspiAccessible *accessible, DBusMessageIter *iter)
1359 DBusMessageIter iter_array;
1361 accessible->interfaces = 0;
1362 if (strcmp (dbus_message_iter_get_signature (iter), "as") != 0)
1364 g_warning ("_atspi_dbus_set_interfaces: Passed iterator with invalid signature %s", dbus_message_iter_get_signature (iter));
1367 dbus_message_iter_recurse (iter, &iter_array);
1368 while (dbus_message_iter_get_arg_type (&iter_array) != DBUS_TYPE_INVALID)
1372 dbus_message_iter_get_basic (&iter_array, &iface);
1373 if (!strcmp (iface, "org.freedesktop.DBus.Introspectable")) continue;
1374 n = _atspi_get_iface_num (iface);
1377 g_warning ("AT-SPI: Unknown interface %s", iface);
1380 accessible->interfaces |= (1 << n);
1381 dbus_message_iter_next (&iter_array);
1383 _atspi_accessible_add_cache (accessible, ATSPI_CACHE_INTERFACES);
1387 _atspi_dbus_set_state (AtspiAccessible *accessible, DBusMessageIter *iter)
1389 DBusMessageIter iter_array;
1391 dbus_uint32_t *states;
1393 dbus_message_iter_recurse (iter, &iter_array);
1394 dbus_message_iter_get_fixed_array (&iter_array, &states, &count);
1397 g_warning ("AT-SPI: expected 2 values in states array; got %d\n", count);
1398 if (!accessible->states)
1399 accessible->states = _atspi_state_set_new_internal (accessible, 0);
1403 guint64 val = ((guint64)states [1]) << 32;
1405 if (!accessible->states)
1406 accessible->states = _atspi_state_set_new_internal (accessible, val);
1408 accessible->states->states = val;
1410 _atspi_accessible_add_cache (accessible, ATSPI_CACHE_STATES);
1414 _atspi_error_quark (void)
1416 return g_quark_from_static_string ("atspi_error");
1420 * Gets the IOR from the XDisplay.
1424 get_accessibility_bus_address_x11 (void)
1428 Display *bridge_display = NULL;
1431 unsigned char *data_x11 = NULL;
1432 unsigned long nitems;
1433 unsigned long leftover;
1436 display_name = spi_display_name ();
1440 bridge_display = XOpenDisplay (display_name);
1441 g_free (display_name);
1443 if (!bridge_display)
1445 g_warning ("Could not open X display");
1449 AT_SPI_BUS = XInternAtom (bridge_display, "AT_SPI_BUS", False);
1450 XGetWindowProperty (bridge_display,
1451 XDefaultRootWindow (bridge_display),
1453 (long) BUFSIZ, False,
1454 (Atom) 31, &actual_type, &actual_format,
1455 &nitems, &leftover, &data_x11);
1456 XCloseDisplay (bridge_display);
1458 data = g_strdup ((gchar *)data_x11);
1465 get_accessibility_bus_address_dbus (void)
1467 DBusConnection *session_bus = NULL;
1468 DBusMessage *message;
1471 char *address = NULL;
1473 session_bus = dbus_bus_get (DBUS_BUS_SESSION, NULL);
1477 message = dbus_message_new_method_call ("org.a11y.Bus",
1482 dbus_error_init (&error);
1483 reply = dbus_connection_send_with_reply_and_block (session_bus,
1487 dbus_message_unref (message);
1491 g_warning ("Error retrieving accessibility bus address: %s: %s",
1492 error.name, error.message);
1493 dbus_error_free (&error);
1498 const char *tmp_address;
1499 if (!dbus_message_get_args (reply,
1505 dbus_message_unref (reply);
1508 address = g_strdup (tmp_address);
1509 dbus_message_unref (reply);
1515 static DBusConnection *a11y_bus;
1516 static dbus_int32_t a11y_dbus_slot = -1;
1519 a11y_bus_free (void *data)
1521 if (data == a11y_bus)
1524 dbus_connection_free_data_slot (&a11y_dbus_slot);
1529 * atspi_get_a11y_bus: (skip)
1532 atspi_get_a11y_bus (void)
1535 char *address = NULL;
1537 if (a11y_bus && dbus_connection_get_is_connected (a11y_bus))
1540 if (a11y_dbus_slot == -1)
1541 if (!dbus_connection_allocate_data_slot (&a11y_dbus_slot))
1542 g_warning ("at-spi: Unable to allocate D-Bus slot");
1545 address = get_accessibility_bus_address_x11 ();
1548 address = get_accessibility_bus_address_dbus ();
1552 dbus_error_init (&error);
1553 a11y_bus = dbus_connection_open_private (address, &error);
1558 g_warning ("Couldn't connect to accessibility bus: %s", error.message);
1559 dbus_error_free (&error);
1564 if (!dbus_bus_register (a11y_bus, &error))
1566 g_warning ("Couldn't register with accessibility bus: %s", error.message);
1567 dbus_error_free (&error);
1568 dbus_connection_close (a11y_bus);
1569 dbus_connection_unref (a11y_bus);
1575 /* Simulate a weak ref on the bus */
1576 dbus_connection_set_data (a11y_bus, a11y_dbus_slot, a11y_bus, a11y_bus_free);
1582 * atspi_set_timeout:
1583 * @val: The timeout value, in milliseconds, or -1 to disable the timeout.
1584 * @startup_time: The amount of time, in milliseconds, to allow to pass
1585 * before enforcing timeouts on an application. Can be used to prevent
1586 * timeout exceptions if an application is likely to block for an extended
1587 * period of time on initialization. -1 can be passed to disable this
1590 * Set the timeout used for method calls. If this is not set explicitly,
1591 * a default of 0.8 ms is used.
1592 * Note that at-spi2-registryd currently uses a timeout of 3 seconds when
1593 * sending a keyboard event notification. This means that, if an AT makes
1594 * a call in response to the keyboard notification and the application
1595 * being called does not respond before the timeout is reached,
1596 * at-spi2-registryd will time out on the keyboard event notification and
1597 * pass the key onto the application (ie, reply to indicate that the key
1598 * was not consumed), so this may make it undesirable to set a timeout
1599 * larger than 3 seconds.
1601 * By default, the normal timeout is set to 800 ms, and the application startup
1602 * timeout is set to 15 seconds.
1605 atspi_set_timeout (gint val, gint startup_time)
1607 method_call_timeout = val;
1608 app_startup_time = startup_time;
1612 * atspi_set_main_context:
1613 * @cnx: The #GMainContext to use.
1615 * Sets the main loop context that AT-SPI should assume is in use when
1616 * setting an idle callback.
1617 * This function should be called by application-side implementors (ie,
1618 * at-spi2-atk) when it is desirable to re-enter the main loop.
1621 atspi_set_main_context (GMainContext *cnx)
1623 if (atspi_main_context == cnx)
1625 if (process_deferred_messages_source != NULL)
1627 g_source_destroy (process_deferred_messages_source);
1628 process_deferred_messages_source = g_idle_source_new ();
1629 g_source_set_callback (process_deferred_messages_source,
1630 process_deferred_messages_callback, NULL, NULL);
1631 g_source_attach (process_deferred_messages_source, cnx);
1632 g_source_unref (process_deferred_messages_source);
1634 atspi_main_context = cnx;
1635 atspi_dbus_connection_setup_with_g_main (atspi_get_a11y_bus (), cnx);
1638 #ifdef DEBUG_REF_COUNTS
1640 print_disposed (gpointer key, gpointer value, gpointer data)
1642 AtspiAccessible *accessible = key;
1643 if (accessible->parent.app)
1645 g_print ("disposed: %s %d\n", accessible->name, accessible->role);
1651 g_hash_table_foreach (live_refs, print_disposed, NULL);
1656 _atspi_name_compat (gchar *name)
1670 * atspi_role_get_name:
1671 * @role: an #AtspiRole object to query.
1673 * Gets a localizable string that indicates the name of an #AtspiRole.
1674 * <em>DEPRECATED.</em>
1676 * Returns: a localizable string name for an #AtspiRole enumerated type.
1679 atspi_role_get_name (AtspiRole role)
1681 gchar *retval = NULL;
1682 GTypeClass *type_class;
1685 type_class = g_type_class_ref (ATSPI_TYPE_ROLE);
1686 g_return_val_if_fail (G_IS_ENUM_CLASS (type_class), NULL);
1688 value = g_enum_get_value (G_ENUM_CLASS (type_class), role);
1692 retval = g_strdup (value->value_nick);
1696 return _atspi_name_compat (retval);
1702 _atspi_dbus_update_cache_from_dict (AtspiAccessible *accessible, DBusMessageIter *iter)
1704 GHashTable *cache = _atspi_accessible_ref_cache (accessible);
1705 DBusMessageIter iter_dict, iter_dict_entry, iter_struct, iter_variant;
1707 dbus_message_iter_recurse (iter, &iter_dict);
1708 while (dbus_message_iter_get_arg_type (&iter_dict) != DBUS_TYPE_INVALID)
1712 dbus_message_iter_recurse (&iter_dict, &iter_dict_entry);
1713 dbus_message_iter_get_basic (&iter_dict_entry, &key);
1714 dbus_message_iter_next (&iter_dict_entry);
1715 dbus_message_iter_recurse (&iter_dict_entry, &iter_variant);
1716 if (!strcmp (key, "interfaces"))
1718 _atspi_dbus_set_interfaces (accessible, &iter_variant);
1720 else if (!strcmp (key, "Attributes"))
1722 val = g_new0 (GValue, 1);;
1723 g_value_init (val, G_TYPE_HASH_TABLE);
1724 if (strcmp (dbus_message_iter_get_signature (&iter_variant),
1727 g_value_take_boxed (val, _atspi_dbus_hash_from_iter (&iter_variant));
1729 else if (!strcmp (key, "Component.ScreenExtents"))
1733 val = g_new0 (GValue, 1);;
1734 g_value_init (val, ATSPI_TYPE_RECT);
1735 if (strcmp (dbus_message_iter_get_signature (&iter_variant),
1738 dbus_message_iter_recurse (&iter_variant, &iter_struct);
1739 dbus_message_iter_get_basic (&iter_struct, &d_int);
1741 dbus_message_iter_next (&iter_struct);
1742 dbus_message_iter_get_basic (&iter_struct, &d_int);
1744 dbus_message_iter_next (&iter_struct);
1745 dbus_message_iter_get_basic (&iter_struct, &d_int);
1746 extents.width = d_int;
1747 dbus_message_iter_next (&iter_struct);
1748 dbus_message_iter_get_basic (&iter_struct, &d_int);
1749 extents.height = d_int;
1750 g_value_set_boxed (val, &extents);
1753 g_hash_table_insert (cache, g_strdup (key), val);
1754 dbus_message_iter_next (&iter_dict);
1759 _atspi_get_allow_sync ()
1765 _atspi_set_allow_sync (gboolean val)
1767 gboolean ret = allow_sync;
1774 _atspi_set_error_no_sync (GError **error)
1776 g_set_error_literal (error, ATSPI_ERROR, ATSPI_ERROR_SYNC_NOT_ALLOWED,
1777 _("Attempted synchronous call where prohibited"));