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)
68 atspi_dbus_server_setup_with_g_main (spi_global_app_data->server, cnx);
70 atspi_dbus_connection_setup_with_g_main (spi_global_app_data->bus, 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;
102 GMainContext *main_context;
105 main_context = (g_getenv ("AT_SPI_CLIENT") ? NULL :
106 spi_global_app_data->main_context);
108 closure.loop = g_main_loop_new (main_context, FALSE);
109 closure.reply = NULL;
110 switch_main_context (main_context);
112 if (!dbus_connection_send_with_reply (bus, message, &pending, 9000) || !pending)
114 switch_main_context (NULL);
117 dbus_pending_call_set_notify (pending, set_reply, (void *) &closure, NULL);
118 source = g_timeout_source_new (500);
119 g_source_set_callback (source, timeout_reply, &closure, NULL);
120 closure.timeout = g_source_attach (source, main_context);
121 g_source_unref (source);
122 g_main_loop_run (closure.loop);
123 if (closure.timeout != -1)
124 g_source_destroy (source);
126 g_main_loop_unref (closure.loop);
127 return closure.reply;
130 /*---------------------------------------------------------------------------*/
133 * Functionality related to sending device events from the application.
135 * This is used for forwarding key events on to the registry daemon.
139 Accessibility_DeviceEventController_NotifyListenersSync (const
143 DBusMessage *message;
145 dbus_bool_t consumed = FALSE;
148 dbus_message_new_method_call (SPI_DBUS_NAME_REGISTRY,
150 ATSPI_DBUS_INTERFACE_DEC,
151 "NotifyListenersSync");
153 dbus_error_init (&error);
154 if (spi_dbus_marshal_deviceEvent (message, key_event))
157 send_and_allow_reentry (spi_global_app_data->bus, message);
161 dbus_error_init (&error);
162 dbus_message_get_args (reply, &error, DBUS_TYPE_BOOLEAN, &consumed,
164 dbus_message_unref (reply);
167 dbus_message_unref (message);
172 spi_init_keystroke_from_atk_key_event (AtspiDeviceEvent * keystroke,
173 AtkKeyEventStruct * event)
175 keystroke->id = (dbus_int32_t) event->keyval;
176 keystroke->hw_code = (dbus_int16_t) event->keycode;
177 keystroke->timestamp = (dbus_uint32_t) event->timestamp;
178 keystroke->modifiers = (dbus_uint16_t) (event->state & 0xFFFF);
183 keystroke->event_string = g_strdup (event->string);
184 c = g_utf8_get_char_validated (event->string, -1);
185 if (c > 0 && g_unichar_isprint (c))
186 keystroke->is_text = TRUE;
188 keystroke->is_text = FALSE;
192 keystroke->event_string = g_strdup ("");
193 keystroke->is_text = FALSE;
197 case (ATK_KEY_EVENT_PRESS):
198 keystroke->type = ATSPI_KEY_PRESSED;
200 case (ATK_KEY_EVENT_RELEASE):
201 keystroke->type = ATSPI_KEY_RELEASED;
209 ("key_event type %d; val=%d code=%d modifiers=%x name=%s is_text=%d, time=%lx\n",
210 (int) keystroke->type, (int) keystroke->id, (int) keystroke->hw_code,
211 (int) keystroke->modifiers, keystroke->event_string,
212 (int) keystroke->is_text, (unsigned long) keystroke->timestamp);
218 spi_atk_bridge_key_listener (AtkKeyEventStruct * event, gpointer data)
221 AtspiDeviceEvent key_event;
223 spi_init_keystroke_from_atk_key_event (&key_event, event);
226 Accessibility_DeviceEventController_NotifyListenersSync (&key_event);
228 if (key_event.event_string)
229 g_free (key_event.event_string);
234 /*---------------------------------------------------------------------------*/
237 convert_signal_name (const gchar * s)
239 gchar *ret = g_strdup (s);
244 ret[0] = toupper (ret[0]);
245 while ((t = strchr (ret, '-')) != NULL)
247 memmove (t, t + 1, strlen (t));
254 validate_for_dbus (const gint type,
259 case DBUS_TYPE_STRING:
260 case DBUS_TYPE_OBJECT_PATH:
263 else if (!g_utf8_validate (val, -1, NULL))
265 g_warning ("atk-bridge: Received bad UTF-8 string when emitting event");
276 append_basic (DBusMessageIter *iter,
282 dbus_message_iter_open_container(iter, DBUS_TYPE_VARIANT, type, &sub);
284 val = validate_for_dbus ((int) *type, val);
285 dbus_message_iter_append_basic(&sub, (int) *type, &val);
287 dbus_message_iter_close_container(iter, &sub);
291 append_rect (DBusMessageIter *iter,
295 DBusMessageIter variant, sub;
296 const AtkRectangle *rect = (const AtkRectangle *) val;
298 dbus_message_iter_open_container(iter, DBUS_TYPE_VARIANT, type, &variant);
300 dbus_message_iter_open_container (&variant, DBUS_TYPE_STRUCT, NULL, &sub);
302 dbus_message_iter_append_basic (&sub, DBUS_TYPE_INT32, &(rect->x));
303 dbus_message_iter_append_basic (&sub, DBUS_TYPE_INT32, &(rect->y));
304 dbus_message_iter_append_basic (&sub, DBUS_TYPE_INT32, &(rect->width));
305 dbus_message_iter_append_basic (&sub, DBUS_TYPE_INT32, &(rect->height));
307 dbus_message_iter_close_container (&variant, &sub);
309 dbus_message_iter_close_container(iter, &variant);
313 append_object (DBusMessageIter *iter,
317 spi_object_append_v_reference (iter, ATK_OBJECT (val));
321 signal_name_to_dbus (const gchar *s)
323 gchar *ret = g_strdup (s);
328 ret [0] = toupper (ret [0]);
329 while ((t = strchr (ret, '-')) != NULL)
331 memmove (t, t + 1, strlen (t));
338 * Converts names of the form "active-descendant-changed" to
339 * "ActiveDescendantChanged"
342 ensure_proper_format (const char *name)
344 gchar *ret = (gchar *) g_malloc (strlen (name) * 2 + 2);
346 gboolean need_upper = TRUE;
354 *p++ = toupper (*name);
357 else if (*name == '-')
359 else if (*name == ':')
373 signal_is_needed (const gchar *klass, const gchar *major, const gchar *minor)
378 gboolean ret = FALSE;
381 if (!spi_global_app_data->events_initialized)
384 data [0] = ensure_proper_format (klass + 21);
385 data [1] = ensure_proper_format (major);
386 data [2] = ensure_proper_format (minor);
389 /* Hack: Always pass events that update the cache.
390 * TODO: FOr 2.2, have at-spi2-core define a special "cache listener" for
391 * this instead, so that we don't send these if no one is listening */
392 if (!g_strcmp0 (data [1], "ChildrenChanged") ||
393 !g_strcmp0 (data [1], "PropertyChange") ||
394 !g_strcmp0 (data [1], "StateChanged"))
402 /* Hack: events such as "object::text-changed::insert:system" as
403 generated by Gecko */
404 data [2][strcspn (data [2], ":")] = '\0';
405 for (list = spi_global_app_data->events; list; list = list->next)
408 if (spi_event_is_subtype (data, evdata->data))
416 g_print("event: %s %s %s: %d\n", data[0], data[1], data[2], ret);
424 /* Convert a : to a / so that listeners can use arg0path to match only
427 adapt_minor_for_dbus (const char *source)
429 gchar *ret = g_strdup (source);
430 int i = strcspn (ret, ":");
437 * Emits an AT-SPI event.
438 * AT-SPI events names are split into three parts:
440 * This is mapped onto D-Bus events as:
441 * D-Bus Interface:Signal Name:Detail argument
443 * Marshals a basic type into the 'any_data' attribute of
447 emit_event (AtkObject *obj,
451 dbus_int32_t detail1,
452 dbus_int32_t detail2,
455 void (*append_variant) (DBusMessageIter *, const char *, const void *))
457 DBusConnection *bus = spi_global_app_data->bus;
463 DBusMessageIter iter, iter_struct;
465 if (!klass) klass = "";
466 if (!major) major = "";
467 if (!minor) minor = "";
468 if (!type) type = "u";
470 if (!signal_is_needed (klass, major, minor))
473 path = spi_register_object_to_path (spi_global_register, G_OBJECT (obj));
474 g_return_if_fail (path != NULL);
477 * This is very annoying, but as '-' isn't a legal signal
478 * name in D-Bus (Why not??!?) The names need converting
479 * on this side, and again on the client side.
481 cname = signal_name_to_dbus (major);
482 sig = dbus_message_new_signal(path, klass, cname);
484 dbus_message_iter_init_append(sig, &iter);
486 minor_dbus = adapt_minor_for_dbus (minor);
487 dbus_message_iter_append_basic(&iter, DBUS_TYPE_STRING, &minor_dbus);
489 dbus_message_iter_append_basic(&iter, DBUS_TYPE_INT32, &detail1);
490 dbus_message_iter_append_basic(&iter, DBUS_TYPE_INT32, &detail2);
491 append_variant (&iter, type, val);
492 spi_object_append_reference (&iter, spi_global_app_data->root);
494 dbus_connection_send(bus, sig, NULL);
495 dbus_message_unref(sig);
497 if (g_strcmp0 (cname, "ChildrenChanged") != 0)
498 spi_object_lease_if_needed (G_OBJECT (obj));
504 /*---------------------------------------------------------------------------*/
507 * The focus listener handles the ATK 'focus' signal and forwards it
508 * as the AT-SPI event, 'focus:'
511 focus_tracker (AtkObject * accessible)
513 emit_event (accessible, ITF_EVENT_FOCUS, "focus", "", 0, 0,
514 DBUS_TYPE_INT32_AS_STRING, 0, append_basic);
517 /*---------------------------------------------------------------------------*/
519 #define PCHANGE "PropertyChange"
522 * This handler handles the following ATK signals and
523 * converts them to AT-SPI events:
525 * Gtk:AtkObject:property-change -> object:property-change:(property-name)
527 * The property-name is part of the ATK property-change signal.
530 property_event_listener (GSignalInvocationHint * signal_hint,
531 guint n_param_values,
532 const GValue * param_values, gpointer data)
534 AtkObject *accessible;
535 AtkPropertyValues *values;
537 const gchar *pname = NULL;
543 accessible = g_value_get_object (¶m_values[0]);
544 values = (AtkPropertyValues *) g_value_get_pointer (¶m_values[1]);
546 pname = values[0].property_name;
548 /* TODO Could improve this control statement by matching
549 * on only the end of the signal names,
551 if (strcmp (pname, "accessible-name") == 0)
553 s1 = atk_object_get_name (accessible);
555 emit_event (accessible, ITF_EVENT_OBJECT, PCHANGE, pname, 0, 0,
556 DBUS_TYPE_STRING_AS_STRING, s1, append_basic);
558 else if (strcmp (pname, "accessible-description") == 0)
560 s1 = atk_object_get_description (accessible);
562 emit_event (accessible, ITF_EVENT_OBJECT, PCHANGE, pname, 0, 0,
563 DBUS_TYPE_STRING_AS_STRING, s1, append_basic);
565 else if (strcmp (pname, "accessible-parent") == 0)
567 otemp = atk_object_get_parent (accessible);
569 emit_event (accessible, ITF_EVENT_OBJECT, PCHANGE, pname, 0, 0,
570 "(so)", otemp, append_object);
572 else if (strcmp (pname, "accessible-role") == 0)
574 i = atk_object_get_role (accessible);
575 emit_event (accessible, ITF_EVENT_OBJECT, PCHANGE, pname, 0, 0,
576 DBUS_TYPE_UINT32_AS_STRING, GINT_TO_POINTER(i), append_basic);
578 else if (strcmp (pname, "accessible-table-summary") == 0)
580 otemp = atk_table_get_summary (ATK_TABLE (accessible));
582 emit_event (accessible, ITF_EVENT_OBJECT, PCHANGE, pname, 0, 0,
583 "(so)", otemp, append_object);
585 else if (strcmp (pname, "accessible-table-column-header") == 0)
587 i = g_value_get_int (&(values->new_value));
588 otemp = atk_table_get_column_header (ATK_TABLE (accessible), i);
590 emit_event (accessible, ITF_EVENT_OBJECT, PCHANGE, pname, 0, 0,
591 "(so)", otemp, append_object);
593 else if (strcmp (pname, "accessible-table-row-header") == 0)
595 i = g_value_get_int (&(values->new_value));
596 otemp = atk_table_get_row_header (ATK_TABLE (accessible), i);
598 emit_event (accessible, ITF_EVENT_OBJECT, PCHANGE, pname, 0, 0,
599 "(so)", otemp, append_object);
601 else if (strcmp (pname, "accessible-table-row-description") == 0)
603 i = g_value_get_int (&(values->new_value));
604 s1 = atk_table_get_row_description (ATK_TABLE (accessible), i);
605 emit_event (accessible, ITF_EVENT_OBJECT, PCHANGE, pname, 0, 0,
606 DBUS_TYPE_STRING_AS_STRING, s1, append_basic);
608 else if (strcmp (pname, "accessible-table-column-description") == 0)
610 i = g_value_get_int (&(values->new_value));
611 s1 = atk_table_get_column_description (ATK_TABLE (accessible), i);
612 emit_event (accessible, ITF_EVENT_OBJECT, PCHANGE, pname, 0, 0,
613 DBUS_TYPE_STRING_AS_STRING, s1, append_basic);
615 else if (strcmp (pname, "accessible-table-caption-object") == 0)
617 otemp = atk_table_get_caption (ATK_TABLE (accessible));
618 emit_event (accessible, ITF_EVENT_OBJECT, PCHANGE, pname, 0, 0,
619 "(so)", otemp, append_object);
623 emit_event (accessible, ITF_EVENT_OBJECT, PCHANGE, pname, 0, 0,
624 DBUS_TYPE_INT32_AS_STRING, 0, append_basic);
629 /*---------------------------------------------------------------------------*/
631 #define STATE_CHANGED "state-changed"
634 * The state event listener handles 'Gtk:AtkObject:state-change' ATK signals
635 * and forwards them as object:state-changed:(param-name) AT-SPI events. Where
636 * the param-name is part of the ATK state-change signal.
639 state_event_listener (GSignalInvocationHint * signal_hint,
640 guint n_param_values,
641 const GValue * param_values, gpointer data)
643 AtkObject *accessible;
647 accessible = ATK_OBJECT (g_value_get_object (¶m_values[0]));
648 pname = g_value_get_string (¶m_values[1]);
650 detail1 = (g_value_get_boolean (¶m_values[2])) ? 1 : 0;
651 emit_event (accessible, ITF_EVENT_OBJECT, STATE_CHANGED, pname, detail1, 0,
652 DBUS_TYPE_INT32_AS_STRING, 0, append_basic);
654 if (!g_strcmp0 (pname, "defunct") && detail1)
655 spi_register_deregister_object (spi_global_register, G_OBJECT (accessible),
660 /*---------------------------------------------------------------------------*/
663 * The window event listener handles the following ATK signals and forwards
664 * them as AT-SPI events:
666 * window:create -> window:create
667 * window:destroy -> window:destroy
668 * window:minimize -> window:minimize
669 * window:maximize -> window:maximize
670 * window:activate -> window:activate
671 * window:deactivate -> window:deactivate
674 window_event_listener (GSignalInvocationHint * signal_hint,
675 guint n_param_values,
676 const GValue * param_values, gpointer data)
678 AtkObject *accessible;
679 GSignalQuery signal_query;
680 const gchar *name, *s;
682 g_signal_query (signal_hint->signal_id, &signal_query);
683 name = signal_query.signal_name;
685 accessible = ATK_OBJECT (g_value_get_object (¶m_values[0]));
686 s = atk_object_get_name (accessible);
687 emit_event (accessible, ITF_EVENT_WINDOW, name, "", 0, 0,
688 DBUS_TYPE_STRING_AS_STRING, s, append_basic);
693 /*---------------------------------------------------------------------------*/
696 * The document event listener handles the following ATK signals
697 * and converts them to AT-SPI events:
699 * Gtk:AtkDocument:load-complete -> document:load-complete
700 * Gtk:AtkDocument:load-stopped -> document:load-stopped
701 * Gtk:AtkDocument:reload -> document:reload
704 document_event_listener (GSignalInvocationHint * signal_hint,
705 guint n_param_values,
706 const GValue * param_values, gpointer data)
708 AtkObject *accessible;
709 GSignalQuery signal_query;
710 const gchar *name, *s;
712 g_signal_query (signal_hint->signal_id, &signal_query);
713 name = signal_query.signal_name;
715 accessible = ATK_OBJECT (g_value_get_object (¶m_values[0]));
716 s = atk_object_get_name (accessible);
717 emit_event (accessible, ITF_EVENT_DOCUMENT, name, "", 0, 0,
718 DBUS_TYPE_STRING_AS_STRING, s, append_basic);
723 /*---------------------------------------------------------------------------*/
726 * Signal handler for "Gtk:AtkComponent:bounds-changed". Converts
727 * this to an AT-SPI event - "object:bounds-changed".
730 bounds_event_listener (GSignalInvocationHint * signal_hint,
731 guint n_param_values,
732 const GValue * param_values, gpointer data)
734 AtkObject *accessible;
735 AtkRectangle *atk_rect;
736 GSignalQuery signal_query;
737 const gchar *name, *s;
739 g_signal_query (signal_hint->signal_id, &signal_query);
740 name = signal_query.signal_name;
742 accessible = ATK_OBJECT (g_value_get_object (¶m_values[0]));
744 if (G_VALUE_HOLDS_BOXED (param_values + 1))
746 atk_rect = g_value_get_boxed (param_values + 1);
748 emit_event (accessible, ITF_EVENT_OBJECT, name, "", 0, 0,
749 "(iiii)", atk_rect, append_rect);
754 /*---------------------------------------------------------------------------*/
757 * Handles the ATK signal 'Gtk:AtkObject:active-descendant-changed' and
758 * converts it to the AT-SPI signal - 'object:active-descendant-changed'.
762 active_descendant_event_listener (GSignalInvocationHint * signal_hint,
763 guint n_param_values,
764 const GValue * param_values, gpointer data)
766 AtkObject *accessible;
768 GSignalQuery signal_query;
769 const gchar *name, *minor;
772 g_signal_query (signal_hint->signal_id, &signal_query);
773 name = signal_query.signal_name;
775 accessible = ATK_OBJECT (g_value_get_object (¶m_values[0]));
776 child = ATK_OBJECT (g_value_get_pointer (¶m_values[1]));
777 g_return_val_if_fail (ATK_IS_OBJECT (child), TRUE);
778 minor = g_quark_to_string (signal_hint->detail);
780 detail1 = atk_object_get_index_in_parent (child);
782 emit_event (accessible, ITF_EVENT_OBJECT, name, "", detail1, 0,
783 "(so)", child, append_object);
787 /*---------------------------------------------------------------------------*/
790 * Handles the ATK signal 'Gtk:AtkHypertext:link-selected' and
791 * converts it to the AT-SPI signal - 'object:link-selected'
795 link_selected_event_listener (GSignalInvocationHint * signal_hint,
796 guint n_param_values,
797 const GValue * param_values, gpointer data)
799 AtkObject *accessible;
800 GSignalQuery signal_query;
801 const gchar *name, *minor;
804 g_signal_query (signal_hint->signal_id, &signal_query);
805 name = signal_query.signal_name;
807 accessible = ATK_OBJECT (g_value_get_object (¶m_values[0]));
808 minor = g_quark_to_string (signal_hint->detail);
810 if (G_VALUE_TYPE (¶m_values[1]) == G_TYPE_INT)
811 detail1 = g_value_get_int (¶m_values[1]);
813 emit_event (accessible, ITF_EVENT_OBJECT, name, minor, detail1, 0,
814 DBUS_TYPE_INT32_AS_STRING, 0, append_basic);
818 /*---------------------------------------------------------------------------*/
821 * Handles the ATK signal 'Gtk:AtkText:text-changed' and
822 * converts it to the AT-SPI signal - 'object:text-changed'
823 * This signal is deprecated by Gtk:AtkText:text-insert
824 * and Gtk:AtkText:text-remove
828 text_changed_event_listener (GSignalInvocationHint * signal_hint,
829 guint n_param_values,
830 const GValue * param_values, gpointer data)
832 AtkObject *accessible;
833 GSignalQuery signal_query;
834 const gchar *name, *minor;
836 gint detail1 = 0, detail2 = 0;
838 g_signal_query (signal_hint->signal_id, &signal_query);
839 name = signal_query.signal_name;
841 accessible = ATK_OBJECT (g_value_get_object (¶m_values[0]));
842 minor = g_quark_to_string (signal_hint->detail);
844 if (G_VALUE_TYPE (¶m_values[1]) == G_TYPE_INT)
845 detail1 = g_value_get_int (¶m_values[1]);
847 if (G_VALUE_TYPE (¶m_values[2]) == G_TYPE_INT)
848 detail2 = g_value_get_int (¶m_values[2]);
851 atk_text_get_text (ATK_TEXT (accessible), detail1, detail1 + detail2);
853 emit_event (accessible, ITF_EVENT_OBJECT, name, minor, detail1, detail2,
854 DBUS_TYPE_STRING_AS_STRING, selected, append_basic);
861 * Handles the ATK signal 'Gtk:AtkText:text-insert' and
862 * converts it to the AT-SPI signal - 'object:text-changed'
866 text_insert_event_listener (GSignalInvocationHint * signal_hint,
867 guint n_param_values,
868 const GValue * param_values, gpointer data)
870 AtkObject *accessible;
871 guint text_changed_signal_id;
872 GSignalQuery signal_query;
875 gint detail1 = 0, detail2 = 0;
877 accessible = ATK_OBJECT (g_value_get_object (¶m_values[0]));
878 /* Get signal name for 'Gtk:AtkText:text-changed' so
879 * we convert it to the AT-SPI signal - 'object:text-changed'
881 text_changed_signal_id = g_signal_lookup ("text-changed", G_OBJECT_TYPE (accessible));
882 g_signal_query (text_changed_signal_id, &signal_query);
883 name = signal_query.signal_name;
886 /* Add the insert and keep any detail coming from atk */
887 minor = g_quark_to_string (signal_hint->detail);
889 minor = g_strconcat ("insert:", minor, NULL);
891 minor = g_strdup ("insert");
893 if (G_VALUE_TYPE (¶m_values[1]) == G_TYPE_INT)
894 detail1 = g_value_get_int (¶m_values[1]);
896 if (G_VALUE_TYPE (¶m_values[2]) == G_TYPE_INT)
897 detail2 = g_value_get_int (¶m_values[2]);
899 if (G_VALUE_TYPE (¶m_values[3]) == G_TYPE_STRING)
900 text = g_value_get_string (¶m_values[3]);
902 emit_event (accessible, ITF_EVENT_OBJECT, name, minor, detail1, detail2,
903 DBUS_TYPE_STRING_AS_STRING, text, append_basic);
909 * Handles the ATK signal 'Gtk:AtkText:text-remove' and
910 * converts it to the AT-SPI signal - 'object:text-changed'
914 text_remove_event_listener (GSignalInvocationHint * signal_hint,
915 guint n_param_values,
916 const GValue * param_values, gpointer data)
918 AtkObject *accessible;
919 guint text_changed_signal_id;
920 GSignalQuery signal_query;
923 gint detail1 = 0, detail2 = 0;
925 accessible = ATK_OBJECT (g_value_get_object (¶m_values[0]));
926 /* Get signal name for 'Gtk:AtkText:text-changed' so
927 * we convert it to the AT-SPI signal - 'object:text-changed'
929 text_changed_signal_id = g_signal_lookup ("text-changed", G_OBJECT_TYPE (accessible));
930 g_signal_query (text_changed_signal_id, &signal_query);
931 name = signal_query.signal_name;
933 minor = g_quark_to_string (signal_hint->detail);
935 /* Add the delete and keep any detail coming from atk */
936 minor = g_quark_to_string (signal_hint->detail);
938 minor = g_strconcat ("delete:", minor, NULL);
940 minor = g_strdup ("delete");
942 if (G_VALUE_TYPE (¶m_values[1]) == G_TYPE_INT)
943 detail1 = g_value_get_int (¶m_values[1]);
945 if (G_VALUE_TYPE (¶m_values[2]) == G_TYPE_INT)
946 detail2 = g_value_get_int (¶m_values[2]);
948 if (G_VALUE_TYPE (¶m_values[3]) == G_TYPE_STRING)
949 text = g_value_get_string (¶m_values[3]);
951 emit_event (accessible, ITF_EVENT_OBJECT, name, minor, detail1, detail2,
952 DBUS_TYPE_STRING_AS_STRING, text, append_basic);
958 /*---------------------------------------------------------------------------*/
961 * Handles the ATK signal 'Gtk:AtkText:text-selection-changed' and
962 * converts it to the AT-SPI signal - 'object:text-selection-changed'
966 text_selection_changed_event_listener (GSignalInvocationHint * signal_hint,
967 guint n_param_values,
968 const GValue * param_values,
971 AtkObject *accessible;
972 GSignalQuery signal_query;
973 const gchar *name, *minor;
974 gint detail1 = 0, detail2 = 0;
976 g_signal_query (signal_hint->signal_id, &signal_query);
977 name = signal_query.signal_name;
979 accessible = ATK_OBJECT (g_value_get_object (¶m_values[0]));
980 minor = g_quark_to_string (signal_hint->detail);
982 if (G_VALUE_TYPE (¶m_values[1]) == G_TYPE_INT)
983 detail1 = g_value_get_int (¶m_values[1]);
985 if (G_VALUE_TYPE (¶m_values[2]) == G_TYPE_INT)
986 detail2 = g_value_get_int (¶m_values[2]);
988 emit_event (accessible, ITF_EVENT_OBJECT, name, minor, detail1, detail2,
989 DBUS_TYPE_STRING_AS_STRING, "", append_basic);
993 /*---------------------------------------------------------------------------*/
996 * Children changed signal converter and forwarder.
998 * Klass (Interface) org.a11y.atspi.Event.Object
999 * Major is the signal name.
1000 * Minor is 'add' or 'remove'
1001 * detail1 is the index.
1003 * any_data is the child reference.
1006 children_changed_event_listener (GSignalInvocationHint * signal_hint,
1007 guint n_param_values,
1008 const GValue * param_values, gpointer data)
1010 GSignalQuery signal_query;
1011 const gchar *name, *minor;
1012 gint detail1 = 0, detail2 = 0;
1014 AtkObject *accessible, *ao=NULL;
1017 g_signal_query (signal_hint->signal_id, &signal_query);
1018 name = signal_query.signal_name;
1020 accessible = ATK_OBJECT (g_value_get_object (¶m_values[0]));
1021 minor = g_quark_to_string (signal_hint->detail);
1023 detail1 = g_value_get_uint (param_values + 1);
1024 child = g_value_get_pointer (param_values + 2);
1026 if (ATK_IS_OBJECT (child))
1028 ao = ATK_OBJECT (child);
1029 emit_event (accessible, ITF_EVENT_OBJECT, name, minor, detail1, detail2,
1030 "(so)", ao, append_object);
1032 else if ((minor != NULL) && (strcmp (minor, "add") == 0))
1034 ao = atk_object_ref_accessible_child (accessible,
1036 emit_event (accessible, ITF_EVENT_OBJECT, name, minor, detail1, detail2,
1037 "(so)", ao, append_object);
1041 emit_event (accessible, ITF_EVENT_OBJECT, name, minor, detail1, detail2,
1042 "(so)", ao, append_object);
1048 /*---------------------------------------------------------------------------*/
1051 toplevel_added_event_listener (AtkObject * accessible,
1052 guint index, AtkObject * child)
1054 emit_event (accessible, ITF_EVENT_OBJECT, "children-changed", "add", index, 0,
1055 "(so)", child, append_object);
1059 toplevel_removed_event_listener (AtkObject * accessible,
1060 guint index, AtkObject * child)
1062 emit_event (accessible, ITF_EVENT_OBJECT, "children-changed", "remove", index, 0,
1063 "(so)", child, append_object);
1066 /*---------------------------------------------------------------------------*/
1069 * Generic signal converter and forwarder.
1071 * Klass (Interface) org.a11y.atspi.Event.Object
1072 * Major is the signal name.
1079 generic_event_listener (GSignalInvocationHint * signal_hint,
1080 guint n_param_values,
1081 const GValue * param_values, gpointer data)
1083 AtkObject *accessible;
1084 GSignalQuery signal_query;
1086 int detail1 = 0, detail2 = 0;
1088 g_signal_query (signal_hint->signal_id, &signal_query);
1089 name = signal_query.signal_name;
1091 accessible = ATK_OBJECT (g_value_get_object (¶m_values[0]));
1093 if (n_param_values > 1 && G_VALUE_TYPE (¶m_values[1]) == G_TYPE_INT)
1094 detail1 = g_value_get_int (¶m_values[1]);
1096 if (n_param_values > 2 && G_VALUE_TYPE (¶m_values[2]) == G_TYPE_INT)
1097 detail2 = g_value_get_int (¶m_values[2]);
1099 emit_event (accessible, ITF_EVENT_OBJECT, name, "", detail1, detail2,
1100 DBUS_TYPE_INT32_AS_STRING, 0, append_basic);
1104 /*---------------------------------------------------------------------------*/
1107 * Registers the provided function as a handler for the given signal name
1108 * and stores the signal id returned so that the function may be
1109 * de-registered later.
1112 add_signal_listener (GSignalEmissionHook listener, const char *signal_name)
1116 id = atk_add_global_event_listener (listener, signal_name);
1118 if (id > 0) /* id == 0 is a failure */
1119 g_array_append_val (listener_ids, id);
1125 * Initialization for the signal handlers.
1127 * Registers all required signal handlers.
1130 spi_atk_register_event_listeners (void)
1133 * Kludge to make sure the Atk interface types are registered, otherwise
1134 * the AtkText signal handlers below won't get registered
1136 GObject *ao = g_object_new (ATK_TYPE_OBJECT, NULL);
1137 AtkObject *bo = atk_no_op_object_new (ao);
1140 g_object_unref (G_OBJECT (bo));
1141 g_object_unref (ao);
1145 g_warning ("atk_bridge: spi_atk-register_event_listeners called multiple times");
1149 /* Register for focus event notifications, and register app with central registry */
1150 listener_ids = g_array_sized_new (FALSE, TRUE, sizeof (guint), 16);
1152 atk_bridge_focus_tracker_id = atk_add_focus_tracker (focus_tracker);
1154 add_signal_listener (property_event_listener,
1155 "Gtk:AtkObject:property-change");
1157 /* window events: we tentative try to register using the old format */
1158 id = add_signal_listener (window_event_listener, "window:create");
1162 /* If we are able to register using the old format, we assume
1163 * that the ATK implementor is managing window events without
1164 * AtkWindow. We can't use the opposite test because after
1165 * including AtkWindow on ATK you would be able to register to
1166 * that event, although the ATK implementor could or not use it.
1169 add_signal_listener (window_event_listener, "window:destroy");
1170 add_signal_listener (window_event_listener, "window:minimize");
1171 add_signal_listener (window_event_listener, "window:maximize");
1172 add_signal_listener (window_event_listener, "window:restore");
1173 add_signal_listener (window_event_listener, "window:activate");
1174 add_signal_listener (window_event_listener, "window:deactivate");
1178 add_signal_listener (window_event_listener, "Atk:AtkWindow:create");
1179 add_signal_listener (window_event_listener, "Atk:AtkWindow:destroy");
1180 add_signal_listener (window_event_listener, "Atk:AtkWindow:minimize");
1181 add_signal_listener (window_event_listener, "Atk:AtkWindow:maximize");
1182 add_signal_listener (window_event_listener, "Atk:AtkWindow:restore");
1183 add_signal_listener (window_event_listener, "Atk:AtkWindow:activate");
1184 add_signal_listener (window_event_listener, "Atk:AtkWindow:deactivate");
1187 add_signal_listener (document_event_listener,
1188 "Gtk:AtkDocument:load-complete");
1189 add_signal_listener (document_event_listener, "Gtk:AtkDocument:reload");
1190 add_signal_listener (document_event_listener,
1191 "Gtk:AtkDocument:load-stopped");
1192 /* TODO Fake this event on the client side */
1193 add_signal_listener (state_event_listener, "Gtk:AtkObject:state-change");
1195 add_signal_listener (active_descendant_event_listener,
1196 "Gtk:AtkObject:active-descendant-changed");
1197 add_signal_listener (bounds_event_listener,
1198 "Gtk:AtkComponent:bounds-changed");
1199 add_signal_listener (text_selection_changed_event_listener,
1200 "Gtk:AtkText:text-selection-changed");
1201 add_signal_listener (text_changed_event_listener,
1202 "Gtk:AtkText:text-changed");
1203 add_signal_listener (text_insert_event_listener,
1204 "Gtk:AtkText:text-insert");
1205 add_signal_listener (text_remove_event_listener,
1206 "Gtk:AtkText:text-remove");
1207 add_signal_listener (link_selected_event_listener,
1208 "Gtk:AtkHypertext:link-selected");
1209 add_signal_listener (generic_event_listener,
1210 "Gtk:AtkObject:visible-data-changed");
1211 add_signal_listener (generic_event_listener,
1212 "Gtk:AtkSelection:selection-changed");
1213 add_signal_listener (generic_event_listener,
1214 "Gtk:AtkText:text-attributes-changed");
1215 add_signal_listener (generic_event_listener,
1216 "Gtk:AtkText:text-caret-moved");
1217 add_signal_listener (generic_event_listener, "Gtk:AtkTable:row-inserted");
1218 add_signal_listener (generic_event_listener, "Gtk:AtkTable:row-reordered");
1219 add_signal_listener (generic_event_listener, "Gtk:AtkTable:row-deleted");
1220 add_signal_listener (generic_event_listener,
1221 "Gtk:AtkTable:column-inserted");
1222 add_signal_listener (generic_event_listener,
1223 "Gtk:AtkTable:column-reordered");
1224 add_signal_listener (generic_event_listener, "Gtk:AtkTable:column-deleted");
1225 add_signal_listener (generic_event_listener, "Gtk:AtkTable:model-changed");
1226 add_signal_listener (children_changed_event_listener, "Gtk:AtkObject:children-changed");
1229 g_signal_connect (G_OBJECT (spi_global_app_data->root),
1230 "children-changed::add",
1231 (GCallback) toplevel_added_event_listener, NULL);
1233 g_signal_connect (G_OBJECT (spi_global_app_data->root),
1234 "children-changed::remove",
1235 (GCallback) toplevel_removed_event_listener, NULL);
1239 * May add the following listeners to implement preemptive key listening for GTK+
1241 * atk_add_global_event_listener (spi_atk_bridge_widgetkey_listener, "Gtk:GtkWidget:key-press-event");
1242 * atk_add_global_event_listener (spi_atk_bridge_widgetkey_listener, "Gtk:GtkWidget:key-release-event");
1244 atk_bridge_key_event_listener_id =
1245 atk_add_key_event_listener (spi_atk_bridge_key_listener, NULL);
1248 /*---------------------------------------------------------------------------*/
1251 * De-registers all ATK signal handlers.
1254 spi_atk_deregister_event_listeners (void)
1257 GArray *ids = listener_ids;
1258 listener_ids = NULL;
1260 if (atk_bridge_focus_tracker_id)
1262 atk_remove_focus_tracker (atk_bridge_focus_tracker_id);
1263 atk_bridge_focus_tracker_id = 0;
1268 for (i = 0; i < ids->len; i++)
1270 atk_remove_global_event_listener (g_array_index (ids, guint, i));
1272 g_array_free (ids, TRUE);
1275 if (atk_bridge_key_event_listener_id)
1277 atk_remove_key_event_listener (atk_bridge_key_event_listener_id);
1278 atk_bridge_key_event_listener_id = 0;
1282 /*---------------------------------------------------------------------------*/
1285 * TODO This function seems out of place here.
1287 * Emits fake deactivate signals on all top-level windows.
1288 * Used when shutting down AT-SPI, ensuring that all
1289 * windows have been removed on the client side.
1292 spi_atk_tidy_windows (void)
1298 root = atk_get_root ();
1299 n_children = atk_object_get_n_accessible_children (root);
1300 for (i = 0; i < n_children; i++)
1303 AtkStateSet *stateset;
1306 child = atk_object_ref_accessible_child (root, i);
1307 stateset = atk_object_ref_state_set (child);
1309 name = atk_object_get_name (child);
1310 if (atk_state_set_contains_state (stateset, ATK_STATE_ACTIVE))
1312 emit_event (child, ITF_EVENT_WINDOW, "deactivate", NULL, 0, 0,
1313 DBUS_TYPE_STRING_AS_STRING, name, append_basic);
1315 g_object_unref (stateset);
1317 emit_event (child, ITF_EVENT_WINDOW, "destroy", NULL, 0, 0,
1318 DBUS_TYPE_STRING_AS_STRING, name, append_basic);
1319 g_object_unref (child);
1324 spi_event_is_subtype (gchar **needle, gchar **haystack)
1326 while (*haystack && **haystack)
1328 if (g_strcmp0 (*needle, *haystack))
1336 /*END------------------------------------------------------------------------*/