2 * AT-SPI - Assistive Technology Service Provider Interface
3 * (Gnome Accessibility Project; http://developer.gnome.org/projects/gap)
5 * Copyright 2008, 2009, Codethink Ltd.
6 * Copyright 2001, 2002, 2003 Sun Microsystems Inc.,
7 * Copyright 2001, 2002, 2003 Ximian, 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.
28 #include <droute/droute.h>
31 #include "accessible-register.h"
33 #include "common/spi-dbus.h"
35 static GArray *listener_ids = NULL;
37 static gint atk_bridge_key_event_listener_id;
38 static gint atk_bridge_focus_tracker_id;
40 /*---------------------------------------------------------------------------*/
42 #define ITF_EVENT_OBJECT "org.a11y.atspi.Event.Object"
43 #define ITF_EVENT_WINDOW "org.a11y.atspi.Event.Window"
44 #define ITF_EVENT_DOCUMENT "org.a11y.atspi.Event.Document"
45 #define ITF_EVENT_FOCUS "org.a11y.atspi.Event.Focus"
47 /*---------------------------------------------------------------------------*/
49 typedef struct _SpiReentrantCallClosure
53 } SpiReentrantCallClosure;
56 set_reply (DBusPendingCall * pending, void *user_data)
58 SpiReentrantCallClosure* closure = (SpiReentrantCallClosure *) user_data;
60 closure->reply = dbus_pending_call_steal_reply (pending);
61 g_main_loop_quit (closure->loop);
65 send_and_allow_reentry (DBusConnection * bus, DBusMessage * message)
67 DBusPendingCall *pending;
68 SpiReentrantCallClosure closure;
70 if (!dbus_connection_send_with_reply (bus, message, &pending, -1))
72 dbus_pending_call_set_notify (pending, set_reply, (void *) &closure, NULL);
73 closure.loop = g_main_loop_new (NULL, FALSE);
75 /* TODO: Remove old AT_SPI_CLIENT name */
76 if (getenv ("AT_SPI_CLIENT") || getenv ("AT_SPI_REENTER_G_MAIN_LOOP"))
78 g_main_loop_run (closure.loop);
83 while (!closure.reply)
85 if (!dbus_connection_read_write_dispatch (spi_global_app_data->bus, 1000))
90 g_main_loop_unref (closure.loop);
94 /*---------------------------------------------------------------------------*/
97 * Functionality related to sending device events from the application.
99 * This is used for forwarding key events on to the registry daemon.
103 Accessibility_DeviceEventController_NotifyListenersSync (const
104 Accessibility_DeviceEvent
107 DBusMessage *message;
109 dbus_bool_t consumed = FALSE;
112 dbus_message_new_method_call (SPI_DBUS_NAME_REGISTRY,
114 SPI_DBUS_INTERFACE_DEC,
115 "NotifyListenersSync");
117 dbus_error_init (&error);
118 if (spi_dbus_marshal_deviceEvent (message, key_event))
121 send_and_allow_reentry (spi_global_app_data->bus, message);
125 dbus_error_init (&error);
126 dbus_message_get_args (reply, &error, DBUS_TYPE_BOOLEAN, &consumed,
128 dbus_message_unref (reply);
131 dbus_message_unref (message);
136 spi_init_keystroke_from_atk_key_event (Accessibility_DeviceEvent * keystroke,
137 AtkKeyEventStruct * event)
139 keystroke->id = (dbus_int32_t) event->keyval;
140 keystroke->hw_code = (dbus_int16_t) event->keycode;
141 keystroke->timestamp = (dbus_uint32_t) event->timestamp;
142 keystroke->modifiers = (dbus_uint16_t) (event->state & 0xFFFF);
147 keystroke->event_string = g_strdup (event->string);
148 c = g_utf8_get_char_validated (event->string, -1);
149 if (c > 0 && g_unichar_isprint (c))
150 keystroke->is_text = TRUE;
152 keystroke->is_text = FALSE;
156 keystroke->event_string = g_strdup ("");
157 keystroke->is_text = FALSE;
161 case (ATK_KEY_EVENT_PRESS):
162 keystroke->type = Accessibility_KEY_PRESSED_EVENT;
164 case (ATK_KEY_EVENT_RELEASE):
165 keystroke->type = Accessibility_KEY_RELEASED_EVENT;
173 ("key_event type %d; val=%d code=%d modifiers=%x name=%s is_text=%d, time=%lx\n",
174 (int) keystroke->type, (int) keystroke->id, (int) keystroke->hw_code,
175 (int) keystroke->modifiers, keystroke->event_string,
176 (int) keystroke->is_text, (unsigned long) keystroke->timestamp);
182 spi_atk_bridge_key_listener (AtkKeyEventStruct * event, gpointer data)
185 Accessibility_DeviceEvent key_event;
187 spi_init_keystroke_from_atk_key_event (&key_event, event);
190 Accessibility_DeviceEventController_NotifyListenersSync (&key_event);
192 if (key_event.event_string)
193 g_free (key_event.event_string);
198 /*---------------------------------------------------------------------------*/
201 convert_signal_name (const gchar * s)
203 gchar *ret = g_strdup (s);
208 ret[0] = toupper (ret[0]);
209 while ((t = strchr (ret, '-')) != NULL)
211 memmove (t, t + 1, strlen (t));
218 replace_null (const gint type,
223 case DBUS_TYPE_STRING:
224 case DBUS_TYPE_OBJECT_PATH:
235 append_basic (DBusMessageIter *iter,
241 dbus_message_iter_open_container(iter, DBUS_TYPE_VARIANT, type, &sub);
243 val = replace_null ((int) *type, val);
244 dbus_message_iter_append_basic(&sub, (int) *type, &val);
246 dbus_message_iter_close_container(iter, &sub);
250 append_rect (DBusMessageIter *iter,
254 DBusMessageIter variant, sub;
255 const AtkRectangle *rect = (const AtkRectangle *) val;
257 dbus_message_iter_open_container(iter, DBUS_TYPE_VARIANT, type, &variant);
259 dbus_message_iter_open_container (&variant, DBUS_TYPE_STRUCT, NULL, &sub);
261 dbus_message_iter_append_basic (&sub, DBUS_TYPE_INT32, &(rect->x));
262 dbus_message_iter_append_basic (&sub, DBUS_TYPE_INT32, &(rect->y));
263 dbus_message_iter_append_basic (&sub, DBUS_TYPE_INT32, &(rect->width));
264 dbus_message_iter_append_basic (&sub, DBUS_TYPE_INT32, &(rect->height));
266 dbus_message_iter_close_container (&variant, &sub);
268 dbus_message_iter_close_container(iter, &variant);
272 append_object (DBusMessageIter *iter,
276 spi_object_append_v_reference (iter, ATK_OBJECT (val));
280 signal_name_to_dbus (const gchar *s)
282 gchar *ret = g_strdup (s);
287 ret [0] = toupper (ret [0]);
288 while ((t = strchr (ret, '-')) != NULL)
290 memmove (t, t + 1, strlen (t));
297 * Converts names of the form "active-descendant-changed" to
298 * "ActiveDescendantChanged"
301 ensure_proper_format (const char *name)
303 gchar *ret = (gchar *) g_malloc (strlen (name) * 2 + 2);
305 gboolean need_upper = TRUE;
313 *p++ = toupper (*name);
316 else if (*name == '-')
318 else if (*name == ':')
332 signal_is_needed (const gchar *klass, const gchar *major, const gchar *minor)
337 gboolean ret = FALSE;
340 if (!spi_global_app_data->events_initialized)
343 data [0] = ensure_proper_format (klass + 21);
344 data [1] = ensure_proper_format (major);
345 data [2] = ensure_proper_format (minor);
348 /* Hack: events such as "object::text-changed::insert:system" as
349 generated by Gecko */
350 data [2][strcspn (data [2], ":")] = '\0';
351 for (list = spi_global_app_data->events; list; list = list->next)
354 if (spi_event_is_subtype (data, evdata->data))
368 * Emits an AT-SPI event.
369 * AT-SPI events names are split into three parts:
371 * This is mapped onto D-Bus events as:
372 * D-Bus Interface:Signal Name:Detail argument
374 * Marshals a basic type into the 'any_data' attribute of
378 emit_event (AtkObject *obj,
382 dbus_int32_t detail1,
383 dbus_int32_t detail2,
386 void (*append_variant) (DBusMessageIter *, const char *, const void *))
388 DBusConnection *bus = spi_global_app_data->bus;
389 const char *path = spi_register_object_to_path (spi_global_register,
394 DBusMessageIter iter, iter_struct;
396 if (!klass) klass = "";
397 if (!major) major = "";
398 if (!minor) minor = "";
399 if (!type) type = "u";
401 if (!signal_is_needed (klass, major, minor))
405 * This is very annoying, but as '-' isn't a legal signal
406 * name in D-Bus (Why not??!?) The names need converting
407 * on this side, and again on the client side.
409 cname = signal_name_to_dbus (major);
410 sig = dbus_message_new_signal(path, klass, cname);
413 dbus_message_iter_init_append(sig, &iter);
415 dbus_message_iter_append_basic(&iter, DBUS_TYPE_STRING, &minor);
416 dbus_message_iter_append_basic(&iter, DBUS_TYPE_INT32, &detail1);
417 dbus_message_iter_append_basic(&iter, DBUS_TYPE_INT32, &detail2);
418 append_variant (&iter, type, val);
419 spi_object_append_reference (&iter, spi_global_app_data->root);
421 dbus_connection_send(bus, sig, NULL);
422 dbus_message_unref(sig);
424 if (g_strcmp0 (cname, "ChildrenChanged") != 0)
425 spi_object_lease_if_needed (G_OBJECT (obj));
428 /*---------------------------------------------------------------------------*/
431 * The focus listener handles the ATK 'focus' signal and forwards it
432 * as the AT-SPI event, 'focus:'
435 focus_tracker (AtkObject * accessible)
437 emit_event (accessible, ITF_EVENT_FOCUS, "focus", "", 0, 0,
438 DBUS_TYPE_INT32_AS_STRING, 0, append_basic);
441 /*---------------------------------------------------------------------------*/
443 #define PCHANGE "PropertyChange"
446 * This handler handles the following ATK signals and
447 * converts them to AT-SPI events:
449 * Gtk:AtkObject:property-change -> object:property-change:(property-name)
451 * The property-name is part of the ATK property-change signal.
454 property_event_listener (GSignalInvocationHint * signal_hint,
455 guint n_param_values,
456 const GValue * param_values, gpointer data)
458 AtkObject *accessible;
459 AtkPropertyValues *values;
461 const gchar *pname = NULL;
467 accessible = g_value_get_object (¶m_values[0]);
468 values = (AtkPropertyValues *) g_value_get_pointer (¶m_values[1]);
470 pname = values[0].property_name;
472 /* TODO Could improve this control statement by matching
473 * on only the end of the signal names,
475 if (strcmp (pname, "accessible-name") == 0)
477 s1 = atk_object_get_name (accessible);
479 emit_event (accessible, ITF_EVENT_OBJECT, PCHANGE, pname, 0, 0,
480 DBUS_TYPE_STRING_AS_STRING, s1, append_basic);
482 else if (strcmp (pname, "accessible-description") == 0)
484 s1 = atk_object_get_description (accessible);
486 emit_event (accessible, ITF_EVENT_OBJECT, PCHANGE, pname, 0, 0,
487 DBUS_TYPE_STRING_AS_STRING, s1, append_basic);
489 else if (strcmp (pname, "accessible-parent") == 0)
491 otemp = atk_object_get_parent (accessible);
493 emit_event (accessible, ITF_EVENT_OBJECT, PCHANGE, pname, 0, 0,
494 "(so)", otemp, append_object);
496 else if (strcmp (pname, "accessible-role") == 0)
498 i = atk_object_get_role (accessible);
499 emit_event (accessible, ITF_EVENT_OBJECT, PCHANGE, pname, 0, 0,
500 DBUS_TYPE_UINT32_AS_STRING, GINT_TO_POINTER(i), append_basic);
502 else if (strcmp (pname, "accessible-table-summary") == 0)
504 otemp = atk_table_get_summary (ATK_TABLE (accessible));
506 emit_event (accessible, ITF_EVENT_OBJECT, PCHANGE, pname, 0, 0,
507 "(so)", otemp, append_object);
509 else if (strcmp (pname, "accessible-table-column-header") == 0)
511 i = g_value_get_int (&(values->new_value));
512 otemp = atk_table_get_column_header (ATK_TABLE (accessible), i);
514 emit_event (accessible, ITF_EVENT_OBJECT, PCHANGE, pname, 0, 0,
515 "(so)", otemp, append_object);
517 else if (strcmp (pname, "accessible-table-row-header") == 0)
519 i = g_value_get_int (&(values->new_value));
520 otemp = atk_table_get_row_header (ATK_TABLE (accessible), i);
522 emit_event (accessible, ITF_EVENT_OBJECT, PCHANGE, pname, 0, 0,
523 "(so)", otemp, append_object);
525 else if (strcmp (pname, "accessible-table-row-description") == 0)
527 i = g_value_get_int (&(values->new_value));
528 s1 = atk_table_get_row_description (ATK_TABLE (accessible), i);
529 emit_event (accessible, ITF_EVENT_OBJECT, PCHANGE, pname, 0, 0,
530 DBUS_TYPE_STRING_AS_STRING, s1, append_basic);
532 else if (strcmp (pname, "accessible-table-column-description") == 0)
534 i = g_value_get_int (&(values->new_value));
535 s1 = atk_table_get_column_description (ATK_TABLE (accessible), i);
536 emit_event (accessible, ITF_EVENT_OBJECT, PCHANGE, pname, 0, 0,
537 DBUS_TYPE_STRING_AS_STRING, s1, append_basic);
539 else if (strcmp (pname, "accessible-table-caption-object") == 0)
541 otemp = atk_table_get_caption (ATK_TABLE (accessible));
542 emit_event (accessible, ITF_EVENT_OBJECT, PCHANGE, pname, 0, 0,
543 "(so)", otemp, append_object);
547 emit_event (accessible, ITF_EVENT_OBJECT, PCHANGE, pname, 0, 0,
548 DBUS_TYPE_INT32_AS_STRING, 0, append_basic);
553 /*---------------------------------------------------------------------------*/
555 #define STATE_CHANGED "state-changed"
558 * The state event listener handles 'Gtk:AtkObject:state-change' ATK signals
559 * and forwards them as object:state-changed:(param-name) AT-SPI events. Where
560 * the param-name is part of the ATK state-change signal.
563 state_event_listener (GSignalInvocationHint * signal_hint,
564 guint n_param_values,
565 const GValue * param_values, gpointer data)
567 AtkObject *accessible;
571 accessible = ATK_OBJECT (g_value_get_object (¶m_values[0]));
572 pname = g_strdup (g_value_get_string (¶m_values[1]));
574 /* TODO - Possibly ignore a change to the 'defunct' state.
575 * This is because without reference counting defunct objects should be removed.
577 detail1 = (g_value_get_boolean (¶m_values[2])) ? 1 : 0;
578 emit_event (accessible, ITF_EVENT_OBJECT, STATE_CHANGED, pname, detail1, 0,
579 DBUS_TYPE_INT32_AS_STRING, 0, append_basic);
584 /*---------------------------------------------------------------------------*/
587 * The window event listener handles the following ATK signals and forwards
588 * them as AT-SPI events:
590 * window:create -> window:create
591 * window:destroy -> window:destroy
592 * window:minimize -> window:minimize
593 * window:maximize -> window:maximize
594 * window:activate -> window:activate
595 * window:deactivate -> window:deactivate
598 window_event_listener (GSignalInvocationHint * signal_hint,
599 guint n_param_values,
600 const GValue * param_values, gpointer data)
602 AtkObject *accessible;
603 GSignalQuery signal_query;
604 const gchar *name, *s;
606 g_signal_query (signal_hint->signal_id, &signal_query);
607 name = signal_query.signal_name;
609 accessible = ATK_OBJECT (g_value_get_object (¶m_values[0]));
610 s = atk_object_get_name (accessible);
611 emit_event (accessible, ITF_EVENT_WINDOW, name, "", 0, 0,
612 DBUS_TYPE_STRING_AS_STRING, s, append_basic);
617 /*---------------------------------------------------------------------------*/
620 * The document event listener handles the following ATK signals
621 * and converts them to AT-SPI events:
623 * Gtk:AtkDocument:load-complete -> document:load-complete
624 * Gtk:AtkDocument:load-stopped -> document:load-stopped
625 * Gtk:AtkDocument:reload -> document:reload
628 document_event_listener (GSignalInvocationHint * signal_hint,
629 guint n_param_values,
630 const GValue * param_values, gpointer data)
632 AtkObject *accessible;
633 GSignalQuery signal_query;
634 const gchar *name, *s;
636 g_signal_query (signal_hint->signal_id, &signal_query);
637 name = signal_query.signal_name;
639 accessible = ATK_OBJECT (g_value_get_object (¶m_values[0]));
640 s = atk_object_get_name (accessible);
641 emit_event (accessible, ITF_EVENT_DOCUMENT, name, "", 0, 0,
642 DBUS_TYPE_STRING_AS_STRING, s, append_basic);
647 /*---------------------------------------------------------------------------*/
650 * Signal handler for "Gtk:AtkComponent:bounds-changed". Converts
651 * this to an AT-SPI event - "object:bounds-changed".
654 bounds_event_listener (GSignalInvocationHint * signal_hint,
655 guint n_param_values,
656 const GValue * param_values, gpointer data)
658 AtkObject *accessible;
659 AtkRectangle *atk_rect;
660 GSignalQuery signal_query;
661 const gchar *name, *s;
663 g_signal_query (signal_hint->signal_id, &signal_query);
664 name = signal_query.signal_name;
666 accessible = ATK_OBJECT (g_value_get_object (¶m_values[0]));
668 if (G_VALUE_HOLDS_BOXED (param_values + 1))
670 atk_rect = g_value_get_boxed (param_values + 1);
672 emit_event (accessible, ITF_EVENT_OBJECT, name, "", 0, 0,
673 "(iiii)", atk_rect, append_rect);
678 /*---------------------------------------------------------------------------*/
681 * Handles the ATK signal 'Gtk:AtkObject:active-descendant-changed' and
682 * converts it to the AT-SPI signal - 'object:active-descendant-changed'.
686 active_descendant_event_listener (GSignalInvocationHint * signal_hint,
687 guint n_param_values,
688 const GValue * param_values, gpointer data)
690 AtkObject *accessible;
692 GSignalQuery signal_query;
693 const gchar *name, *minor;
696 g_signal_query (signal_hint->signal_id, &signal_query);
697 name = signal_query.signal_name;
699 accessible = ATK_OBJECT (g_value_get_object (¶m_values[0]));
700 child = ATK_OBJECT (g_value_get_pointer (¶m_values[1]));
701 g_return_val_if_fail (ATK_IS_OBJECT (child), TRUE);
702 minor = g_quark_to_string (signal_hint->detail);
704 detail1 = atk_object_get_index_in_parent (child);
706 emit_event (accessible, ITF_EVENT_OBJECT, name, "", detail1, 0,
707 "(so)", child, append_object);
711 /*---------------------------------------------------------------------------*/
714 * Handles the ATK signal 'Gtk:AtkHypertext:link-selected' and
715 * converts it to the AT-SPI signal - 'object:link-selected'
719 link_selected_event_listener (GSignalInvocationHint * signal_hint,
720 guint n_param_values,
721 const GValue * param_values, gpointer data)
723 AtkObject *accessible;
724 GSignalQuery signal_query;
725 const gchar *name, *minor;
728 g_signal_query (signal_hint->signal_id, &signal_query);
729 name = signal_query.signal_name;
731 accessible = ATK_OBJECT (g_value_get_object (¶m_values[0]));
732 minor = g_quark_to_string (signal_hint->detail);
734 if (G_VALUE_TYPE (¶m_values[1]) == G_TYPE_INT)
735 detail1 = g_value_get_int (¶m_values[1]);
737 emit_event (accessible, ITF_EVENT_OBJECT, name, minor, detail1, 0,
738 DBUS_TYPE_INT32_AS_STRING, 0, append_basic);
742 /*---------------------------------------------------------------------------*/
745 * Handles the ATK signal 'Gtk:AtkText:text-changed' and
746 * converts it to the AT-SPI signal - 'object:text-changed'
750 text_changed_event_listener (GSignalInvocationHint * signal_hint,
751 guint n_param_values,
752 const GValue * param_values, gpointer data)
754 AtkObject *accessible;
755 GSignalQuery signal_query;
756 const gchar *name, *minor;
758 gint detail1, detail2;
760 g_signal_query (signal_hint->signal_id, &signal_query);
761 name = signal_query.signal_name;
763 accessible = ATK_OBJECT (g_value_get_object (¶m_values[0]));
764 minor = g_quark_to_string (signal_hint->detail);
766 if (G_VALUE_TYPE (¶m_values[1]) == G_TYPE_INT)
767 detail1 = g_value_get_int (¶m_values[1]);
769 if (G_VALUE_TYPE (¶m_values[2]) == G_TYPE_INT)
770 detail2 = g_value_get_int (¶m_values[2]);
773 atk_text_get_text (ATK_TEXT (accessible), detail1, detail1 + detail2);
775 emit_event (accessible, ITF_EVENT_OBJECT, name, minor, detail1, detail2,
776 DBUS_TYPE_STRING_AS_STRING, selected, append_basic);
780 /*---------------------------------------------------------------------------*/
783 * Handles the ATK signal 'Gtk:AtkText:text-selection-changed' and
784 * converts it to the AT-SPI signal - 'object:text-selection-changed'
788 text_selection_changed_event_listener (GSignalInvocationHint * signal_hint,
789 guint n_param_values,
790 const GValue * param_values,
793 AtkObject *accessible;
794 GSignalQuery signal_query;
795 const gchar *name, *minor;
796 gint detail1, detail2;
798 g_signal_query (signal_hint->signal_id, &signal_query);
799 name = signal_query.signal_name;
801 accessible = ATK_OBJECT (g_value_get_object (¶m_values[0]));
802 minor = g_quark_to_string (signal_hint->detail);
804 if (G_VALUE_TYPE (¶m_values[1]) == G_TYPE_INT)
805 detail1 = g_value_get_int (¶m_values[1]);
807 if (G_VALUE_TYPE (¶m_values[2]) == G_TYPE_INT)
808 detail2 = g_value_get_int (¶m_values[2]);
810 emit_event (accessible, ITF_EVENT_OBJECT, name, minor, detail1, detail2,
811 DBUS_TYPE_STRING_AS_STRING, "", append_basic);
815 /*---------------------------------------------------------------------------*/
818 * Children changed signal converter and forwarder.
820 * Klass (Interface) org.a11y.atspi.Event.Object
821 * Major is the signal name.
822 * Minor is 'add' or 'remove'
823 * detail1 is the index.
825 * any_data is the child reference.
828 children_changed_event_listener (GSignalInvocationHint * signal_hint,
829 guint n_param_values,
830 const GValue * param_values, gpointer data)
832 GSignalQuery signal_query;
833 const gchar *name, *minor;
834 gint detail1, detail2 = 0;
836 AtkObject *accessible, *ao=NULL;
839 g_signal_query (signal_hint->signal_id, &signal_query);
840 name = signal_query.signal_name;
842 accessible = ATK_OBJECT (g_value_get_object (¶m_values[0]));
843 minor = g_quark_to_string (signal_hint->detail);
845 detail1 = g_value_get_uint (param_values + 1);
846 child = g_value_get_pointer (param_values + 2);
848 if (ATK_IS_OBJECT (child))
850 ao = ATK_OBJECT (child);
851 emit_event (accessible, ITF_EVENT_OBJECT, name, minor, detail1, detail2,
852 "(so)", ao, append_object);
854 else if ((minor != NULL) && (strcmp (minor, "add") == 0))
856 ao = atk_object_ref_accessible_child (accessible,
858 emit_event (accessible, ITF_EVENT_OBJECT, name, minor, detail1, detail2,
859 "(so)", ao, append_object);
863 emit_event (accessible, ITF_EVENT_OBJECT, name, minor, detail1, detail2,
864 "(so)", ao, append_object);
870 /*---------------------------------------------------------------------------*/
873 toplevel_added_event_listener (AtkObject * accessible,
874 guint index, AtkObject * child)
876 emit_event (accessible, ITF_EVENT_OBJECT, "children-changed", "add", index, 0,
877 "(so)", child, append_object);
881 toplevel_removed_event_listener (AtkObject * accessible,
882 guint index, AtkObject * child)
884 emit_event (accessible, ITF_EVENT_OBJECT, "children-changed", "remove", index, 0,
885 "(so)", child, append_object);
888 /*---------------------------------------------------------------------------*/
891 * Generic signal converter and forwarder.
893 * Klass (Interface) org.a11y.atspi.Event.Object
894 * Major is the signal name.
901 generic_event_listener (GSignalInvocationHint * signal_hint,
902 guint n_param_values,
903 const GValue * param_values, gpointer data)
905 AtkObject *accessible;
906 GSignalQuery signal_query;
908 int detail1 = 0, detail2 = 0;
910 g_signal_query (signal_hint->signal_id, &signal_query);
911 name = signal_query.signal_name;
913 accessible = ATK_OBJECT (g_value_get_object (¶m_values[0]));
915 if (n_param_values > 1 && G_VALUE_TYPE (¶m_values[1]) == G_TYPE_INT)
916 detail1 = g_value_get_int (¶m_values[1]);
918 if (n_param_values > 2 && G_VALUE_TYPE (¶m_values[2]) == G_TYPE_INT)
919 detail2 = g_value_get_int (¶m_values[2]);
921 emit_event (accessible, ITF_EVENT_OBJECT, name, "", detail1, detail2,
922 DBUS_TYPE_INT32_AS_STRING, 0, append_basic);
926 /*---------------------------------------------------------------------------*/
929 * Registers the provided function as a handler for the given signal name
930 * and stores the signal id returned so that the function may be
931 * de-registered later.
934 add_signal_listener (GSignalEmissionHook listener, const char *signal_name)
938 id = atk_add_global_event_listener (listener, signal_name);
939 g_array_append_val (listener_ids, id);
943 * Initialization for the signal handlers.
945 * Registers all required signal handlers.
948 spi_atk_register_event_listeners (void)
951 * Kludge to make sure the Atk interface types are registered, otherwise
952 * the AtkText signal handlers below won't get registered
954 GObject *ao = g_object_new (ATK_TYPE_OBJECT, NULL);
955 AtkObject *bo = atk_no_op_object_new (ao);
957 g_object_unref (G_OBJECT (bo));
960 /* Register for focus event notifications, and register app with central registry */
961 listener_ids = g_array_sized_new (FALSE, TRUE, sizeof (guint), 16);
963 atk_bridge_focus_tracker_id = atk_add_focus_tracker (focus_tracker);
965 add_signal_listener (property_event_listener,
966 "Gtk:AtkObject:property-change");
967 add_signal_listener (window_event_listener, "window:create");
968 add_signal_listener (window_event_listener, "window:destroy");
969 add_signal_listener (window_event_listener, "window:minimize");
970 add_signal_listener (window_event_listener, "window:maximize");
971 add_signal_listener (window_event_listener, "window:restore");
972 add_signal_listener (window_event_listener, "window:activate");
973 add_signal_listener (window_event_listener, "window:deactivate");
974 add_signal_listener (document_event_listener,
975 "Gtk:AtkDocument:load-complete");
976 add_signal_listener (document_event_listener, "Gtk:AtkDocument:reload");
977 add_signal_listener (document_event_listener,
978 "Gtk:AtkDocument:load-stopped");
979 /* TODO Fake this event on the client side */
980 add_signal_listener (state_event_listener, "Gtk:AtkObject:state-change");
982 add_signal_listener (active_descendant_event_listener,
983 "Gtk:AtkObject:active-descendant-changed");
984 add_signal_listener (bounds_event_listener,
985 "Gtk:AtkComponent:bounds-changed");
986 add_signal_listener (text_selection_changed_event_listener,
987 "Gtk:AtkText:text-selection-changed");
988 add_signal_listener (text_changed_event_listener,
989 "Gtk:AtkText:text-changed");
990 add_signal_listener (link_selected_event_listener,
991 "Gtk:AtkHypertext:link-selected");
992 add_signal_listener (generic_event_listener,
993 "Gtk:AtkObject:visible-data-changed");
994 add_signal_listener (generic_event_listener,
995 "Gtk:AtkSelection:selection-changed");
996 add_signal_listener (generic_event_listener,
997 "Gtk:AtkText:text-attributes-changed");
998 add_signal_listener (generic_event_listener,
999 "Gtk:AtkText:text-caret-moved");
1000 add_signal_listener (generic_event_listener, "Gtk:AtkTable:row-inserted");
1001 add_signal_listener (generic_event_listener, "Gtk:AtkTable:row-reordered");
1002 add_signal_listener (generic_event_listener, "Gtk:AtkTable:row-deleted");
1003 add_signal_listener (generic_event_listener,
1004 "Gtk:AtkTable:column-inserted");
1005 add_signal_listener (generic_event_listener,
1006 "Gtk:AtkTable:column-reordered");
1007 add_signal_listener (generic_event_listener, "Gtk:AtkTable:column-deleted");
1008 add_signal_listener (generic_event_listener, "Gtk:AtkTable:model-changed");
1010 /* Children signal listeners */
1011 atk_add_global_event_listener (children_changed_event_listener,
1012 "Gtk:AtkObject:children-changed");
1015 g_signal_connect (G_OBJECT (spi_global_app_data->root),
1016 "children-changed::add",
1017 (GCallback) toplevel_added_event_listener, NULL);
1019 g_signal_connect (G_OBJECT (spi_global_app_data->root),
1020 "children-changed::remove",
1021 (GCallback) toplevel_removed_event_listener, NULL);
1025 * May add the following listeners to implement preemptive key listening for GTK+
1027 * atk_add_global_event_listener (spi_atk_bridge_widgetkey_listener, "Gtk:GtkWidget:key-press-event");
1028 * atk_add_global_event_listener (spi_atk_bridge_widgetkey_listener, "Gtk:GtkWidget:key-release-event");
1030 atk_bridge_key_event_listener_id =
1031 atk_add_key_event_listener (spi_atk_bridge_key_listener, NULL);
1034 /*---------------------------------------------------------------------------*/
1037 * De-registers all ATK signal handlers.
1040 spi_atk_deregister_event_listeners (void)
1043 GArray *ids = listener_ids;
1044 listener_ids = NULL;
1046 if (atk_bridge_focus_tracker_id)
1047 atk_remove_focus_tracker (atk_bridge_focus_tracker_id);
1049 for (i = 0; ids && i < ids->len; i++)
1051 atk_remove_global_event_listener (g_array_index (ids, guint, i));
1054 if (atk_bridge_key_event_listener_id)
1055 atk_remove_key_event_listener (atk_bridge_key_event_listener_id);
1058 /*---------------------------------------------------------------------------*/
1061 * TODO This function seems out of place here.
1063 * Emits fake deactivate signals on all top-level windows.
1064 * Used when shutting down AT-SPI, ensuring that all
1065 * windows have been removed on the client side.
1068 spi_atk_tidy_windows (void)
1074 root = atk_get_root ();
1075 n_children = atk_object_get_n_accessible_children (root);
1076 for (i = 0; i < n_children; i++)
1079 AtkStateSet *stateset;
1082 child = atk_object_ref_accessible_child (root, i);
1083 stateset = atk_object_ref_state_set (child);
1085 name = atk_object_get_name (child);
1086 if (atk_state_set_contains_state (stateset, ATK_STATE_ACTIVE))
1088 emit_event (child, ITF_EVENT_WINDOW, "deactivate", NULL, 0, 0,
1089 DBUS_TYPE_STRING_AS_STRING, name, append_basic);
1091 g_object_unref (stateset);
1093 emit_event (child, ITF_EVENT_WINDOW, "destroy", NULL, 0, 0,
1094 DBUS_TYPE_STRING_AS_STRING, name, append_basic);
1095 g_object_unref (child);
1100 spi_event_is_subtype (gchar **needle, gchar **haystack)
1102 while (*haystack && **haystack)
1104 if (g_strcmp0 (*needle, *haystack))
1112 /*END------------------------------------------------------------------------*/