2 * AT-SPI - Assistive Technology Service Provider Interface
3 * (Gnome Accessibility Project; http://developer.gnome.org/projects/gap)
5 * Copyright 2011, F123 Consulting & Mais Diferenças
6 * Copyright 2008, 2009, Codethink Ltd.
7 * Copyright 2001, 2002, 2003 Sun Microsystems Inc.,
8 * Copyright 2001, 2002, 2003 Ximian, Inc.
10 * This library is free software; you can redistribute it and/or
11 * modify it under the terms of the GNU Library General Public
12 * License as published by the Free Software Foundation; either
13 * version 2 of the License, or (at your option) any later version.
15 * This library is distributed in the hope that it will be useful,
16 * but WITHOUT ANY WARRANTY; without even the implied warranty of
17 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
18 * Library General Public License for more details.
20 * You should have received a copy of the GNU Library General Public
21 * License along with this library; if not, write to the
22 * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
23 * Boston, MA 02111-1307, USA.
30 #include <droute/droute.h>
31 #include <atspi/atspi.h>
34 #include "accessible-register.h"
40 static GArray *listener_ids = NULL;
42 static gint atk_bridge_key_event_listener_id;
43 static gint atk_bridge_focus_tracker_id;
45 /*---------------------------------------------------------------------------*/
47 #define ITF_EVENT_OBJECT "org.a11y.atspi.Event.Object"
48 #define ITF_EVENT_WINDOW "org.a11y.atspi.Event.Window"
49 #define ITF_EVENT_DOCUMENT "org.a11y.atspi.Event.Document"
50 #define ITF_EVENT_FOCUS "org.a11y.atspi.Event.Focus"
52 /*---------------------------------------------------------------------------*/
54 typedef struct _SpiReentrantCallClosure
60 } SpiReentrantCallClosure;
63 switch_main_context (GMainContext *cnx)
67 if (spi_global_app_data->server)
68 atspi_dbus_server_setup_with_g_main (spi_global_app_data->server, cnx);
69 atspi_dbus_connection_setup_with_g_main (spi_global_app_data->bus, cnx);
70 atspi_set_main_context (cnx);
71 for (list = spi_global_app_data->direct_connections; list; list = list->next)
72 atspi_dbus_connection_setup_with_g_main (list->data, cnx);
76 set_reply (DBusPendingCall * pending, void *user_data)
78 SpiReentrantCallClosure* closure = (SpiReentrantCallClosure *) user_data;
80 closure->reply = dbus_pending_call_steal_reply (pending);
81 dbus_pending_call_unref (pending);
82 switch_main_context (NULL);
83 g_main_loop_quit (closure->loop);
87 timeout_reply (void *data)
89 SpiReentrantCallClosure *closure = data;
91 if (!dbus_connection_get_is_connected (closure->bus))
92 g_main_loop_quit (closure->loop);
93 closure->timeout = -1;
98 send_and_allow_reentry (DBusConnection * bus, DBusMessage * message)
100 DBusPendingCall *pending;
101 SpiReentrantCallClosure closure;
105 closure.loop = g_main_loop_new (spi_global_app_data->main_context, FALSE);
106 closure.reply = NULL;
107 switch_main_context (spi_global_app_data->main_context);
109 if (!dbus_connection_send_with_reply (bus, message, &pending, 9000) || !pending)
111 switch_main_context (NULL);
114 dbus_pending_call_set_notify (pending, set_reply, (void *) &closure, NULL);
115 source = g_timeout_source_new (500);
116 g_source_set_callback (source, timeout_reply, &closure, NULL);
117 closure.timeout = g_source_attach (source, spi_global_app_data->main_context);
118 g_source_unref (source);
119 g_main_loop_run (closure.loop);
120 if (closure.timeout != -1)
121 g_source_destroy (source);
123 g_main_loop_unref (closure.loop);
124 return closure.reply;
127 /*---------------------------------------------------------------------------*/
130 * Functionality related to sending device events from the application.
132 * This is used for forwarding key events on to the registry daemon.
136 Accessibility_DeviceEventController_NotifyListenersSync (const
140 DBusMessage *message;
141 dbus_bool_t consumed = FALSE;
144 dbus_message_new_method_call (SPI_DBUS_NAME_REGISTRY,
146 ATSPI_DBUS_INTERFACE_DEC,
147 "NotifyListenersSync");
149 if (spi_dbus_marshal_deviceEvent (message, key_event))
152 send_and_allow_reentry (spi_global_app_data->bus, message);
156 dbus_error_init (&error);
157 if (!dbus_message_get_args (reply, &error, DBUS_TYPE_BOOLEAN,
158 &consumed, DBUS_TYPE_INVALID))
160 /* TODO: print a warning */
161 dbus_error_free (&error);
163 dbus_message_unref (reply);
166 dbus_message_unref (message);
171 spi_init_keystroke_from_atk_key_event (AtspiDeviceEvent * keystroke,
172 AtkKeyEventStruct * event)
174 keystroke->id = (dbus_int32_t) event->keyval;
175 keystroke->hw_code = (dbus_int16_t) event->keycode;
176 keystroke->timestamp = (dbus_uint32_t) event->timestamp;
177 keystroke->modifiers = (dbus_uint16_t) (event->state & 0xFFFF);
182 keystroke->event_string = g_strdup (event->string);
183 c = g_utf8_get_char_validated (event->string, -1);
184 if (c > 0 && g_unichar_isprint (c))
185 keystroke->is_text = TRUE;
187 keystroke->is_text = FALSE;
191 keystroke->event_string = g_strdup ("");
192 keystroke->is_text = FALSE;
196 case (ATK_KEY_EVENT_PRESS):
197 keystroke->type = ATSPI_KEY_PRESSED;
199 case (ATK_KEY_EVENT_RELEASE):
200 keystroke->type = ATSPI_KEY_RELEASED;
208 ("key_event type %d; val=%d code=%d modifiers=%x name=%s is_text=%d, time=%lx\n",
209 (int) keystroke->type, (int) keystroke->id, (int) keystroke->hw_code,
210 (int) keystroke->modifiers, keystroke->event_string,
211 (int) keystroke->is_text, (unsigned long) keystroke->timestamp);
217 spi_atk_bridge_key_listener (AtkKeyEventStruct * event, gpointer data)
220 AtspiDeviceEvent key_event;
222 spi_init_keystroke_from_atk_key_event (&key_event, event);
225 Accessibility_DeviceEventController_NotifyListenersSync (&key_event);
227 if (key_event.event_string)
228 g_free (key_event.event_string);
233 /*---------------------------------------------------------------------------*/
236 validate_for_dbus (const gint type,
241 case DBUS_TYPE_STRING:
242 case DBUS_TYPE_OBJECT_PATH:
245 else if (!g_utf8_validate (val, -1, NULL))
247 g_warning ("atk-bridge: Received bad UTF-8 string when emitting event");
258 append_basic (DBusMessageIter *iter,
264 dbus_message_iter_open_container(iter, DBUS_TYPE_VARIANT, type, &sub);
266 val = validate_for_dbus ((int) *type, val);
267 dbus_message_iter_append_basic(&sub, (int) *type, &val);
269 dbus_message_iter_close_container(iter, &sub);
273 append_rect (DBusMessageIter *iter,
277 DBusMessageIter variant, sub;
278 const AtkRectangle *rect = (const AtkRectangle *) val;
280 dbus_message_iter_open_container(iter, DBUS_TYPE_VARIANT, type, &variant);
282 dbus_message_iter_open_container (&variant, DBUS_TYPE_STRUCT, NULL, &sub);
284 dbus_message_iter_append_basic (&sub, DBUS_TYPE_INT32, &(rect->x));
285 dbus_message_iter_append_basic (&sub, DBUS_TYPE_INT32, &(rect->y));
286 dbus_message_iter_append_basic (&sub, DBUS_TYPE_INT32, &(rect->width));
287 dbus_message_iter_append_basic (&sub, DBUS_TYPE_INT32, &(rect->height));
289 dbus_message_iter_close_container (&variant, &sub);
291 dbus_message_iter_close_container(iter, &variant);
295 append_object (DBusMessageIter *iter,
299 spi_object_append_v_reference (iter, ATK_OBJECT (val));
303 signal_name_to_dbus (const gchar *s)
305 gchar *ret = g_strdup (s);
310 ret [0] = toupper (ret [0]);
311 while ((t = strchr (ret, '-')) != NULL)
313 memmove (t, t + 1, strlen (t));
320 * Converts names of the form "active-descendant-changed" to
321 * "ActiveDescendantChanged"
324 ensure_proper_format (const char *name)
326 gchar *ret = (gchar *) g_malloc (strlen (name) * 2 + 2);
328 gboolean need_upper = TRUE;
336 *p++ = toupper (*name);
339 else if (*name == '-')
341 else if (*name == ':')
355 signal_is_needed (const gchar *klass, const gchar *major, const gchar *minor)
359 gboolean ret = FALSE;
362 if (!spi_global_app_data->events_initialized)
365 data [0] = ensure_proper_format (klass + 21);
366 data [1] = ensure_proper_format (major);
367 data [2] = ensure_proper_format (minor);
370 /* Hack: Always pass events that update the cache.
371 * TODO: FOr 2.2, have at-spi2-core define a special "cache listener" for
372 * this instead, so that we don't send these if no one is listening */
373 if (!g_strcmp0 (data [1], "ChildrenChanged") ||
374 ((!g_strcmp0 (data [1], "PropertyChange")) &&
375 (!g_strcmp0 (data [2], "accessible-name") ||
376 !g_strcmp0 (data [2], "accessible-description") ||
377 !g_strcmp0 (data [2], "accessible-parent") ||
378 !g_strcmp0 (data [2], "accessible-role"))) ||
379 !g_strcmp0 (data [1], "StateChanged"))
387 /* Hack: events such as "object::text-changed::insert:system" as
388 generated by Gecko */
389 data [2][strcspn (data [2], ":")] = '\0';
390 for (list = spi_global_app_data->events; list; list = list->next)
393 if (spi_event_is_subtype (data, evdata->data))
401 g_print("event: %s %s %s: %d\n", data[0], data[1], data[2], ret);
409 /* Convert a : to a / so that listeners can use arg0path to match only
412 adapt_minor_for_dbus (const char *source)
414 gchar *ret = g_strdup (source);
415 int i = strcspn (ret, ":");
422 * Emits an AT-SPI event.
423 * AT-SPI events names are split into three parts:
425 * This is mapped onto D-Bus events as:
426 * D-Bus Interface:Signal Name:Detail argument
428 * Marshals a basic type into the 'any_data' attribute of
432 emit_event (AtkObject *obj,
436 dbus_int32_t detail1,
437 dbus_int32_t detail2,
440 void (*append_variant) (DBusMessageIter *, const char *, const void *))
442 DBusConnection *bus = spi_global_app_data->bus;
448 DBusMessageIter iter;
450 if (!klass) klass = "";
451 if (!major) major = "";
452 if (!minor) minor = "";
453 if (!type) type = "u";
455 if (!signal_is_needed (klass, major, minor))
458 path = spi_register_object_to_path (spi_global_register, G_OBJECT (obj));
459 g_return_if_fail (path != NULL);
462 * This is very annoying, but as '-' isn't a legal signal
463 * name in D-Bus (Why not??!?) The names need converting
464 * on this side, and again on the client side.
466 cname = signal_name_to_dbus (major);
467 sig = dbus_message_new_signal(path, klass, cname);
469 dbus_message_iter_init_append(sig, &iter);
471 minor_dbus = adapt_minor_for_dbus (minor);
472 dbus_message_iter_append_basic(&iter, DBUS_TYPE_STRING, &minor_dbus);
474 dbus_message_iter_append_basic(&iter, DBUS_TYPE_INT32, &detail1);
475 dbus_message_iter_append_basic(&iter, DBUS_TYPE_INT32, &detail2);
476 append_variant (&iter, type, val);
477 spi_object_append_reference (&iter, spi_global_app_data->root);
479 dbus_connection_send(bus, sig, NULL);
480 dbus_message_unref(sig);
482 if (g_strcmp0 (cname, "ChildrenChanged") != 0)
483 spi_object_lease_if_needed (G_OBJECT (obj));
489 /*---------------------------------------------------------------------------*/
492 * The focus listener handles the ATK 'focus' signal and forwards it
493 * as the AT-SPI event, 'focus:'
496 focus_tracker (AtkObject * accessible)
498 emit_event (accessible, ITF_EVENT_FOCUS, "focus", "", 0, 0,
499 DBUS_TYPE_INT32_AS_STRING, 0, append_basic);
502 /*---------------------------------------------------------------------------*/
504 #define PCHANGE "PropertyChange"
507 * This handler handles the following ATK signals and
508 * converts them to AT-SPI events:
510 * Gtk:AtkObject:property-change -> object:property-change:(property-name)
512 * The property-name is part of the ATK property-change signal.
515 property_event_listener (GSignalInvocationHint * signal_hint,
516 guint n_param_values,
517 const GValue * param_values, gpointer data)
519 AtkObject *accessible;
520 AtkPropertyValues *values;
522 const gchar *pname = NULL;
528 accessible = g_value_get_object (¶m_values[0]);
529 values = (AtkPropertyValues *) g_value_get_pointer (¶m_values[1]);
531 pname = values[0].property_name;
533 /* TODO Could improve this control statement by matching
534 * on only the end of the signal names,
536 if (strcmp (pname, "accessible-name") == 0)
538 s1 = atk_object_get_name (accessible);
540 emit_event (accessible, ITF_EVENT_OBJECT, PCHANGE, pname, 0, 0,
541 DBUS_TYPE_STRING_AS_STRING, s1, append_basic);
543 else if (strcmp (pname, "accessible-description") == 0)
545 s1 = atk_object_get_description (accessible);
547 emit_event (accessible, ITF_EVENT_OBJECT, PCHANGE, pname, 0, 0,
548 DBUS_TYPE_STRING_AS_STRING, s1, append_basic);
550 else if (strcmp (pname, "accessible-parent") == 0)
552 otemp = atk_object_get_parent (accessible);
554 emit_event (accessible, ITF_EVENT_OBJECT, PCHANGE, pname, 0, 0,
555 "(so)", otemp, append_object);
557 else if (strcmp (pname, "accessible-role") == 0)
559 i = atk_object_get_role (accessible);
560 emit_event (accessible, ITF_EVENT_OBJECT, PCHANGE, pname, 0, 0,
561 DBUS_TYPE_UINT32_AS_STRING, GINT_TO_POINTER(i), append_basic);
563 else if (strcmp (pname, "accessible-table-summary") == 0)
565 otemp = atk_table_get_summary (ATK_TABLE (accessible));
567 emit_event (accessible, ITF_EVENT_OBJECT, PCHANGE, pname, 0, 0,
568 "(so)", otemp, append_object);
570 else if (strcmp (pname, "accessible-table-column-header") == 0)
572 i = g_value_get_int (&(values->new_value));
573 otemp = atk_table_get_column_header (ATK_TABLE (accessible), i);
575 emit_event (accessible, ITF_EVENT_OBJECT, PCHANGE, pname, 0, 0,
576 "(so)", otemp, append_object);
578 else if (strcmp (pname, "accessible-table-row-header") == 0)
580 i = g_value_get_int (&(values->new_value));
581 otemp = atk_table_get_row_header (ATK_TABLE (accessible), i);
583 emit_event (accessible, ITF_EVENT_OBJECT, PCHANGE, pname, 0, 0,
584 "(so)", otemp, append_object);
586 else if (strcmp (pname, "accessible-table-row-description") == 0)
588 i = g_value_get_int (&(values->new_value));
589 s1 = atk_table_get_row_description (ATK_TABLE (accessible), i);
590 emit_event (accessible, ITF_EVENT_OBJECT, PCHANGE, pname, 0, 0,
591 DBUS_TYPE_STRING_AS_STRING, s1, append_basic);
593 else if (strcmp (pname, "accessible-table-column-description") == 0)
595 i = g_value_get_int (&(values->new_value));
596 s1 = atk_table_get_column_description (ATK_TABLE (accessible), i);
597 emit_event (accessible, ITF_EVENT_OBJECT, PCHANGE, pname, 0, 0,
598 DBUS_TYPE_STRING_AS_STRING, s1, append_basic);
600 else if (strcmp (pname, "accessible-table-caption-object") == 0)
602 otemp = atk_table_get_caption (ATK_TABLE (accessible));
603 emit_event (accessible, ITF_EVENT_OBJECT, PCHANGE, pname, 0, 0,
604 "(so)", otemp, append_object);
608 emit_event (accessible, ITF_EVENT_OBJECT, PCHANGE, pname, 0, 0,
609 DBUS_TYPE_INT32_AS_STRING, 0, append_basic);
614 /*---------------------------------------------------------------------------*/
616 #define STATE_CHANGED "state-changed"
619 * The state event listener handles 'Gtk:AtkObject:state-change' ATK signals
620 * and forwards them as object:state-changed:(param-name) AT-SPI events. Where
621 * the param-name is part of the ATK state-change signal.
624 state_event_listener (GSignalInvocationHint * signal_hint,
625 guint n_param_values,
626 const GValue * param_values, gpointer data)
628 AtkObject *accessible;
632 accessible = ATK_OBJECT (g_value_get_object (¶m_values[0]));
633 pname = g_value_get_string (¶m_values[1]);
635 detail1 = (g_value_get_boolean (¶m_values[2])) ? 1 : 0;
636 emit_event (accessible, ITF_EVENT_OBJECT, STATE_CHANGED, pname, detail1, 0,
637 DBUS_TYPE_INT32_AS_STRING, 0, append_basic);
639 if (!g_strcmp0 (pname, "defunct") && detail1)
640 spi_register_deregister_object (spi_global_register, G_OBJECT (accessible),
645 /*---------------------------------------------------------------------------*/
648 * The window event listener handles the following ATK signals and forwards
649 * them as AT-SPI events:
651 * window:create -> window:create
652 * window:destroy -> window:destroy
653 * window:minimize -> window:minimize
654 * window:maximize -> window:maximize
655 * window:activate -> window:activate
656 * window:deactivate -> window:deactivate
659 window_event_listener (GSignalInvocationHint * signal_hint,
660 guint n_param_values,
661 const GValue * param_values, gpointer data)
663 AtkObject *accessible;
664 GSignalQuery signal_query;
665 const gchar *name, *s;
667 g_signal_query (signal_hint->signal_id, &signal_query);
668 name = signal_query.signal_name;
670 accessible = ATK_OBJECT (g_value_get_object (¶m_values[0]));
671 s = atk_object_get_name (accessible);
672 emit_event (accessible, ITF_EVENT_WINDOW, name, "", 0, 0,
673 DBUS_TYPE_STRING_AS_STRING, s, append_basic);
678 /*---------------------------------------------------------------------------*/
681 * The document event listener handles the following ATK signals
682 * and converts them to AT-SPI events:
684 * Gtk:AtkDocument:load-complete -> document:load-complete
685 * Gtk:AtkDocument:load-stopped -> document:load-stopped
686 * Gtk:AtkDocument:reload -> document:reload
689 document_event_listener (GSignalInvocationHint * signal_hint,
690 guint n_param_values,
691 const GValue * param_values, gpointer data)
693 AtkObject *accessible;
694 GSignalQuery signal_query;
695 const gchar *name, *s;
697 g_signal_query (signal_hint->signal_id, &signal_query);
698 name = signal_query.signal_name;
700 accessible = ATK_OBJECT (g_value_get_object (¶m_values[0]));
701 s = atk_object_get_name (accessible);
702 emit_event (accessible, ITF_EVENT_DOCUMENT, name, "", 0, 0,
703 DBUS_TYPE_STRING_AS_STRING, s, append_basic);
708 /*---------------------------------------------------------------------------*/
711 * Signal handler for "Gtk:AtkComponent:bounds-changed". Converts
712 * this to an AT-SPI event - "object:bounds-changed".
715 bounds_event_listener (GSignalInvocationHint * signal_hint,
716 guint n_param_values,
717 const GValue * param_values, gpointer data)
719 AtkObject *accessible;
720 AtkRectangle *atk_rect;
721 GSignalQuery signal_query;
724 g_signal_query (signal_hint->signal_id, &signal_query);
725 name = signal_query.signal_name;
727 accessible = ATK_OBJECT (g_value_get_object (¶m_values[0]));
729 if (G_VALUE_HOLDS_BOXED (param_values + 1))
731 atk_rect = g_value_get_boxed (param_values + 1);
733 emit_event (accessible, ITF_EVENT_OBJECT, name, "", 0, 0,
734 "(iiii)", atk_rect, append_rect);
739 /*---------------------------------------------------------------------------*/
742 * Handles the ATK signal 'Gtk:AtkObject:active-descendant-changed' and
743 * converts it to the AT-SPI signal - 'object:active-descendant-changed'.
747 active_descendant_event_listener (GSignalInvocationHint * signal_hint,
748 guint n_param_values,
749 const GValue * param_values, gpointer data)
751 AtkObject *accessible;
753 GSignalQuery signal_query;
757 g_signal_query (signal_hint->signal_id, &signal_query);
758 name = signal_query.signal_name;
760 accessible = ATK_OBJECT (g_value_get_object (¶m_values[0]));
761 child = ATK_OBJECT (g_value_get_pointer (¶m_values[1]));
762 g_return_val_if_fail (ATK_IS_OBJECT (child), TRUE);
764 detail1 = atk_object_get_index_in_parent (child);
766 emit_event (accessible, ITF_EVENT_OBJECT, name, "", detail1, 0,
767 "(so)", child, append_object);
771 /*---------------------------------------------------------------------------*/
774 * Handles the ATK signal 'Gtk:AtkHypertext:link-selected' and
775 * converts it to the AT-SPI signal - 'object:link-selected'
779 link_selected_event_listener (GSignalInvocationHint * signal_hint,
780 guint n_param_values,
781 const GValue * param_values, gpointer data)
783 AtkObject *accessible;
784 GSignalQuery signal_query;
785 const gchar *name, *minor;
788 g_signal_query (signal_hint->signal_id, &signal_query);
789 name = signal_query.signal_name;
791 accessible = ATK_OBJECT (g_value_get_object (¶m_values[0]));
792 minor = g_quark_to_string (signal_hint->detail);
794 if (G_VALUE_TYPE (¶m_values[1]) == G_TYPE_INT)
795 detail1 = g_value_get_int (¶m_values[1]);
797 emit_event (accessible, ITF_EVENT_OBJECT, name, minor, detail1, 0,
798 DBUS_TYPE_INT32_AS_STRING, 0, append_basic);
802 /*---------------------------------------------------------------------------*/
805 * Handles the ATK signal 'Gtk:AtkText:text-changed' and
806 * converts it to the AT-SPI signal - 'object:text-changed'
807 * This signal is deprecated by Gtk:AtkText:text-insert
808 * and Gtk:AtkText:text-remove
812 text_changed_event_listener (GSignalInvocationHint * signal_hint,
813 guint n_param_values,
814 const GValue * param_values, gpointer data)
816 AtkObject *accessible;
817 GSignalQuery signal_query;
818 const gchar *name, *minor;
820 gint detail1 = 0, detail2 = 0;
822 g_signal_query (signal_hint->signal_id, &signal_query);
823 name = signal_query.signal_name;
825 accessible = ATK_OBJECT (g_value_get_object (¶m_values[0]));
826 minor = g_quark_to_string (signal_hint->detail);
828 if (G_VALUE_TYPE (¶m_values[1]) == G_TYPE_INT)
829 detail1 = g_value_get_int (¶m_values[1]);
831 if (G_VALUE_TYPE (¶m_values[2]) == G_TYPE_INT)
832 detail2 = g_value_get_int (¶m_values[2]);
835 atk_text_get_text (ATK_TEXT (accessible), detail1, detail1 + detail2);
837 emit_event (accessible, ITF_EVENT_OBJECT, name, minor, detail1, detail2,
838 DBUS_TYPE_STRING_AS_STRING, selected, append_basic);
845 * Handles the ATK signal 'Gtk:AtkText:text-insert' and
846 * converts it to the AT-SPI signal - 'object:text-changed'
850 text_insert_event_listener (GSignalInvocationHint * signal_hint,
851 guint n_param_values,
852 const GValue * param_values, gpointer data)
854 AtkObject *accessible;
855 guint text_changed_signal_id;
856 GSignalQuery signal_query;
858 const gchar *minor_raw, *text;
860 gint detail1 = 0, detail2 = 0;
862 accessible = ATK_OBJECT (g_value_get_object (¶m_values[0]));
863 /* Get signal name for 'Gtk:AtkText:text-changed' so
864 * we convert it to the AT-SPI signal - 'object:text-changed'
866 text_changed_signal_id = g_signal_lookup ("text-changed", G_OBJECT_TYPE (accessible));
867 g_signal_query (text_changed_signal_id, &signal_query);
868 name = signal_query.signal_name;
871 /* Add the insert and keep any detail coming from atk */
872 minor_raw = g_quark_to_string (signal_hint->detail);
874 minor = g_strconcat ("insert:", minor_raw, NULL);
876 minor = g_strdup ("insert");
878 if (G_VALUE_TYPE (¶m_values[1]) == G_TYPE_INT)
879 detail1 = g_value_get_int (¶m_values[1]);
881 if (G_VALUE_TYPE (¶m_values[2]) == G_TYPE_INT)
882 detail2 = g_value_get_int (¶m_values[2]);
884 if (G_VALUE_TYPE (¶m_values[3]) == G_TYPE_STRING)
885 text = g_value_get_string (¶m_values[3]);
887 emit_event (accessible, ITF_EVENT_OBJECT, name, minor, detail1, detail2,
888 DBUS_TYPE_STRING_AS_STRING, text, append_basic);
894 * Handles the ATK signal 'Gtk:AtkText:text-remove' and
895 * converts it to the AT-SPI signal - 'object:text-changed'
899 text_remove_event_listener (GSignalInvocationHint * signal_hint,
900 guint n_param_values,
901 const GValue * param_values, gpointer data)
903 AtkObject *accessible;
904 guint text_changed_signal_id;
905 GSignalQuery signal_query;
907 const gchar *minor_raw, *text;
909 gint detail1 = 0, detail2 = 0;
911 accessible = ATK_OBJECT (g_value_get_object (¶m_values[0]));
912 /* Get signal name for 'Gtk:AtkText:text-changed' so
913 * we convert it to the AT-SPI signal - 'object:text-changed'
915 text_changed_signal_id = g_signal_lookup ("text-changed", G_OBJECT_TYPE (accessible));
916 g_signal_query (text_changed_signal_id, &signal_query);
917 name = signal_query.signal_name;
919 minor_raw = g_quark_to_string (signal_hint->detail);
921 /* Add the delete and keep any detail coming from atk */
923 minor = g_strconcat ("delete:", minor_raw, NULL);
925 minor = g_strdup ("delete");
927 if (G_VALUE_TYPE (¶m_values[1]) == G_TYPE_INT)
928 detail1 = g_value_get_int (¶m_values[1]);
930 if (G_VALUE_TYPE (¶m_values[2]) == G_TYPE_INT)
931 detail2 = g_value_get_int (¶m_values[2]);
933 if (G_VALUE_TYPE (¶m_values[3]) == G_TYPE_STRING)
934 text = g_value_get_string (¶m_values[3]);
936 emit_event (accessible, ITF_EVENT_OBJECT, name, minor, detail1, detail2,
937 DBUS_TYPE_STRING_AS_STRING, text, append_basic);
943 /*---------------------------------------------------------------------------*/
946 * Handles the ATK signal 'Gtk:AtkText:text-selection-changed' and
947 * converts it to the AT-SPI signal - 'object:text-selection-changed'
951 text_selection_changed_event_listener (GSignalInvocationHint * signal_hint,
952 guint n_param_values,
953 const GValue * param_values,
956 AtkObject *accessible;
957 GSignalQuery signal_query;
958 const gchar *name, *minor;
959 gint detail1 = 0, detail2 = 0;
961 g_signal_query (signal_hint->signal_id, &signal_query);
962 name = signal_query.signal_name;
964 accessible = ATK_OBJECT (g_value_get_object (¶m_values[0]));
965 minor = g_quark_to_string (signal_hint->detail);
967 if (G_VALUE_TYPE (¶m_values[1]) == G_TYPE_INT)
968 detail1 = g_value_get_int (¶m_values[1]);
970 if (G_VALUE_TYPE (¶m_values[2]) == G_TYPE_INT)
971 detail2 = g_value_get_int (¶m_values[2]);
973 emit_event (accessible, ITF_EVENT_OBJECT, name, minor, detail1, detail2,
974 DBUS_TYPE_STRING_AS_STRING, "", append_basic);
978 /*---------------------------------------------------------------------------*/
981 * Children changed signal converter and forwarder.
983 * Klass (Interface) org.a11y.atspi.Event.Object
984 * Major is the signal name.
985 * Minor is 'add' or 'remove'
986 * detail1 is the index.
988 * any_data is the child reference.
991 children_changed_event_listener (GSignalInvocationHint * signal_hint,
992 guint n_param_values,
993 const GValue * param_values, gpointer data)
995 GSignalQuery signal_query;
996 const gchar *name, *minor;
997 gint detail1 = 0, detail2 = 0;
999 AtkObject *accessible, *ao=NULL;
1002 g_signal_query (signal_hint->signal_id, &signal_query);
1003 name = signal_query.signal_name;
1005 accessible = ATK_OBJECT (g_value_get_object (¶m_values[0]));
1006 minor = g_quark_to_string (signal_hint->detail);
1008 detail1 = g_value_get_uint (param_values + 1);
1009 child = g_value_get_pointer (param_values + 2);
1011 if (ATK_IS_OBJECT (child))
1013 ao = ATK_OBJECT (child);
1014 emit_event (accessible, ITF_EVENT_OBJECT, name, minor, detail1, detail2,
1015 "(so)", ao, append_object);
1017 else if ((minor != NULL) && (strcmp (minor, "add") == 0))
1019 ao = atk_object_ref_accessible_child (accessible,
1021 emit_event (accessible, ITF_EVENT_OBJECT, name, minor, detail1, detail2,
1022 "(so)", ao, append_object);
1023 g_object_unref (ao);
1027 emit_event (accessible, ITF_EVENT_OBJECT, name, minor, detail1, detail2,
1028 "(so)", ao, append_object);
1034 /*---------------------------------------------------------------------------*/
1037 * Generic signal converter and forwarder.
1039 * Klass (Interface) org.a11y.atspi.Event.Object
1040 * Major is the signal name.
1047 generic_event_listener (GSignalInvocationHint * signal_hint,
1048 guint n_param_values,
1049 const GValue * param_values, gpointer data)
1051 AtkObject *accessible;
1052 GSignalQuery signal_query;
1054 int detail1 = 0, detail2 = 0;
1056 g_signal_query (signal_hint->signal_id, &signal_query);
1057 name = signal_query.signal_name;
1059 accessible = ATK_OBJECT (g_value_get_object (¶m_values[0]));
1061 if (n_param_values > 1 && G_VALUE_TYPE (¶m_values[1]) == G_TYPE_INT)
1062 detail1 = g_value_get_int (¶m_values[1]);
1064 if (n_param_values > 2 && G_VALUE_TYPE (¶m_values[2]) == G_TYPE_INT)
1065 detail2 = g_value_get_int (¶m_values[2]);
1067 emit_event (accessible, ITF_EVENT_OBJECT, name, "", detail1, detail2,
1068 DBUS_TYPE_INT32_AS_STRING, 0, append_basic);
1072 /*---------------------------------------------------------------------------*/
1075 * Registers the provided function as a handler for the given signal name
1076 * and stores the signal id returned so that the function may be
1077 * de-registered later.
1080 add_signal_listener (GSignalEmissionHook listener, const char *signal_name)
1084 id = atk_add_global_event_listener (listener, signal_name);
1086 if (id > 0) /* id == 0 is a failure */
1087 g_array_append_val (listener_ids, id);
1093 * Initialization for the signal handlers.
1095 * Registers all required signal handlers.
1098 spi_atk_register_event_listeners (void)
1101 * Kludge to make sure the Atk interface types are registered, otherwise
1102 * the AtkText signal handlers below won't get registered
1104 GObject *ao = g_object_new (ATK_TYPE_OBJECT, NULL);
1105 AtkObject *bo = atk_no_op_object_new (ao);
1108 g_object_unref (G_OBJECT (bo));
1109 g_object_unref (ao);
1113 g_warning ("atk_bridge: spi_atk-register_event_listeners called multiple times");
1117 /* Register for focus event notifications, and register app with central registry */
1118 listener_ids = g_array_sized_new (FALSE, TRUE, sizeof (guint), 16);
1120 atk_bridge_focus_tracker_id = atk_add_focus_tracker (focus_tracker);
1122 add_signal_listener (property_event_listener,
1123 "Gtk:AtkObject:property-change");
1125 /* window events: we tentative try to register using the old format */
1126 id = add_signal_listener (window_event_listener, "window:create");
1130 /* If we are able to register using the old format, we assume
1131 * that the ATK implementor is managing window events without
1132 * AtkWindow. We can't use the opposite test because after
1133 * including AtkWindow on ATK you would be able to register to
1134 * that event, although the ATK implementor could or not use it.
1137 add_signal_listener (window_event_listener, "window:destroy");
1138 add_signal_listener (window_event_listener, "window:minimize");
1139 add_signal_listener (window_event_listener, "window:maximize");
1140 add_signal_listener (window_event_listener, "window:restore");
1141 add_signal_listener (window_event_listener, "window:activate");
1142 add_signal_listener (window_event_listener, "window:deactivate");
1146 add_signal_listener (window_event_listener, "Atk:AtkWindow:create");
1147 add_signal_listener (window_event_listener, "Atk:AtkWindow:destroy");
1148 add_signal_listener (window_event_listener, "Atk:AtkWindow:minimize");
1149 add_signal_listener (window_event_listener, "Atk:AtkWindow:maximize");
1150 add_signal_listener (window_event_listener, "Atk:AtkWindow:restore");
1151 add_signal_listener (window_event_listener, "Atk:AtkWindow:activate");
1152 add_signal_listener (window_event_listener, "Atk:AtkWindow:deactivate");
1155 add_signal_listener (document_event_listener,
1156 "Gtk:AtkDocument:load-complete");
1157 add_signal_listener (document_event_listener, "Gtk:AtkDocument:reload");
1158 add_signal_listener (document_event_listener,
1159 "Gtk:AtkDocument:load-stopped");
1160 /* TODO Fake this event on the client side */
1161 add_signal_listener (state_event_listener, "Gtk:AtkObject:state-change");
1163 add_signal_listener (active_descendant_event_listener,
1164 "Gtk:AtkObject:active-descendant-changed");
1165 add_signal_listener (bounds_event_listener,
1166 "Gtk:AtkComponent:bounds-changed");
1167 add_signal_listener (text_selection_changed_event_listener,
1168 "Gtk:AtkText:text-selection-changed");
1169 add_signal_listener (text_changed_event_listener,
1170 "Gtk:AtkText:text-changed");
1171 add_signal_listener (text_insert_event_listener,
1172 "Gtk:AtkText:text-insert");
1173 add_signal_listener (text_remove_event_listener,
1174 "Gtk:AtkText:text-remove");
1175 add_signal_listener (link_selected_event_listener,
1176 "Gtk:AtkHypertext:link-selected");
1177 add_signal_listener (generic_event_listener,
1178 "Gtk:AtkObject:visible-data-changed");
1179 add_signal_listener (generic_event_listener,
1180 "Gtk:AtkSelection:selection-changed");
1181 add_signal_listener (generic_event_listener,
1182 "Gtk:AtkText:text-attributes-changed");
1183 add_signal_listener (generic_event_listener,
1184 "Gtk:AtkText:text-caret-moved");
1185 add_signal_listener (generic_event_listener, "Gtk:AtkTable:row-inserted");
1186 add_signal_listener (generic_event_listener, "Gtk:AtkTable:row-reordered");
1187 add_signal_listener (generic_event_listener, "Gtk:AtkTable:row-deleted");
1188 add_signal_listener (generic_event_listener,
1189 "Gtk:AtkTable:column-inserted");
1190 add_signal_listener (generic_event_listener,
1191 "Gtk:AtkTable:column-reordered");
1192 add_signal_listener (generic_event_listener, "Gtk:AtkTable:column-deleted");
1193 add_signal_listener (generic_event_listener, "Gtk:AtkTable:model-changed");
1194 add_signal_listener (children_changed_event_listener, "Gtk:AtkObject:children-changed");
1197 g_signal_connect (G_OBJECT (spi_global_app_data->root),
1198 "children-changed::add",
1199 (GCallback) toplevel_added_event_listener, NULL);
1201 g_signal_connect (G_OBJECT (spi_global_app_data->root),
1202 "children-changed::remove",
1203 (GCallback) toplevel_removed_event_listener, NULL);
1207 * May add the following listeners to implement preemptive key listening for GTK+
1209 * atk_add_global_event_listener (spi_atk_bridge_widgetkey_listener, "Gtk:GtkWidget:key-press-event");
1210 * atk_add_global_event_listener (spi_atk_bridge_widgetkey_listener, "Gtk:GtkWidget:key-release-event");
1212 atk_bridge_key_event_listener_id =
1213 atk_add_key_event_listener (spi_atk_bridge_key_listener, NULL);
1216 /*---------------------------------------------------------------------------*/
1219 * De-registers all ATK signal handlers.
1222 spi_atk_deregister_event_listeners (void)
1225 GArray *ids = listener_ids;
1226 listener_ids = NULL;
1228 if (atk_bridge_focus_tracker_id)
1230 atk_remove_focus_tracker (atk_bridge_focus_tracker_id);
1231 atk_bridge_focus_tracker_id = 0;
1236 for (i = 0; i < ids->len; i++)
1238 atk_remove_global_event_listener (g_array_index (ids, guint, i));
1240 g_array_free (ids, TRUE);
1243 if (atk_bridge_key_event_listener_id)
1245 atk_remove_key_event_listener (atk_bridge_key_event_listener_id);
1246 atk_bridge_key_event_listener_id = 0;
1250 /*---------------------------------------------------------------------------*/
1253 * TODO This function seems out of place here.
1255 * Emits fake deactivate signals on all top-level windows.
1256 * Used when shutting down AT-SPI, ensuring that all
1257 * windows have been removed on the client side.
1260 spi_atk_tidy_windows (void)
1266 root = atk_get_root ();
1267 n_children = atk_object_get_n_accessible_children (root);
1268 for (i = 0; i < n_children; i++)
1271 AtkStateSet *stateset;
1274 child = atk_object_ref_accessible_child (root, i);
1275 stateset = atk_object_ref_state_set (child);
1277 name = atk_object_get_name (child);
1278 if (atk_state_set_contains_state (stateset, ATK_STATE_ACTIVE))
1280 emit_event (child, ITF_EVENT_WINDOW, "deactivate", NULL, 0, 0,
1281 DBUS_TYPE_STRING_AS_STRING, name, append_basic);
1283 g_object_unref (stateset);
1285 emit_event (child, ITF_EVENT_WINDOW, "destroy", NULL, 0, 0,
1286 DBUS_TYPE_STRING_AS_STRING, name, append_basic);
1287 g_object_unref (child);
1292 spi_event_is_subtype (gchar **needle, gchar **haystack)
1294 while (*haystack && **haystack)
1296 if (g_strcmp0 (*needle, *haystack))
1304 /*END------------------------------------------------------------------------*/