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.
29 #include <droute/droute.h>
30 #include <atspi/atspi.h>
33 #include "accessible-register.h"
35 #include "common/spi-dbus.h"
39 static GArray *listener_ids = NULL;
41 static gint atk_bridge_key_event_listener_id;
42 static gint atk_bridge_focus_tracker_id;
44 /*---------------------------------------------------------------------------*/
46 #define ITF_EVENT_OBJECT "org.a11y.atspi.Event.Object"
47 #define ITF_EVENT_WINDOW "org.a11y.atspi.Event.Window"
48 #define ITF_EVENT_DOCUMENT "org.a11y.atspi.Event.Document"
49 #define ITF_EVENT_FOCUS "org.a11y.atspi.Event.Focus"
51 /*---------------------------------------------------------------------------*/
53 typedef struct _SpiReentrantCallClosure
57 } SpiReentrantCallClosure;
60 switch_main_context (GMainContext *cnx)
65 atspi_dbus_server_setup_with_g_main (spi_global_app_data->server, cnx);
67 atspi_dbus_connection_setup_with_g_main (spi_global_app_data->bus, cnx);
68 for (list = spi_global_app_data->direct_connections; list; list = list->next)
69 atspi_dbus_connection_setup_with_g_main (list->data, cnx);
73 set_reply (DBusPendingCall * pending, void *user_data)
75 SpiReentrantCallClosure* closure = (SpiReentrantCallClosure *) user_data;
77 closure->reply = dbus_pending_call_steal_reply (pending);
78 dbus_pending_call_unref (pending);
79 switch_main_context (NULL);
80 g_main_loop_quit (closure->loop);
84 send_and_allow_reentry (DBusConnection * bus, DBusMessage * message)
86 DBusPendingCall *pending;
87 SpiReentrantCallClosure closure;
88 GMainContext *main_context;
90 main_context = (g_getenv ("AT_SPI_CLIENT") ? NULL :
91 spi_global_app_data->main_context);
92 closure.loop = g_main_loop_new (main_context, FALSE);
93 switch_main_context (main_context);
95 if (!dbus_connection_send_with_reply (bus, message, &pending, -1) || !pending)
97 switch_main_context (NULL);
100 dbus_pending_call_set_notify (pending, set_reply, (void *) &closure, NULL);
101 g_main_loop_run (closure.loop);
103 g_main_loop_unref (closure.loop);
104 return closure.reply;
107 /*---------------------------------------------------------------------------*/
110 * Functionality related to sending device events from the application.
112 * This is used for forwarding key events on to the registry daemon.
116 Accessibility_DeviceEventController_NotifyListenersSync (const
117 Accessibility_DeviceEvent
120 DBusMessage *message;
122 dbus_bool_t consumed = FALSE;
125 dbus_message_new_method_call (SPI_DBUS_NAME_REGISTRY,
127 SPI_DBUS_INTERFACE_DEC,
128 "NotifyListenersSync");
130 dbus_error_init (&error);
131 if (spi_dbus_marshal_deviceEvent (message, key_event))
134 send_and_allow_reentry (spi_global_app_data->bus, message);
138 dbus_error_init (&error);
139 dbus_message_get_args (reply, &error, DBUS_TYPE_BOOLEAN, &consumed,
141 dbus_message_unref (reply);
144 dbus_message_unref (message);
149 spi_init_keystroke_from_atk_key_event (Accessibility_DeviceEvent * keystroke,
150 AtkKeyEventStruct * event)
152 keystroke->id = (dbus_int32_t) event->keyval;
153 keystroke->hw_code = (dbus_int16_t) event->keycode;
154 keystroke->timestamp = (dbus_uint32_t) event->timestamp;
155 keystroke->modifiers = (dbus_uint16_t) (event->state & 0xFFFF);
160 keystroke->event_string = g_strdup (event->string);
161 c = g_utf8_get_char_validated (event->string, -1);
162 if (c > 0 && g_unichar_isprint (c))
163 keystroke->is_text = TRUE;
165 keystroke->is_text = FALSE;
169 keystroke->event_string = g_strdup ("");
170 keystroke->is_text = FALSE;
174 case (ATK_KEY_EVENT_PRESS):
175 keystroke->type = Accessibility_KEY_PRESSED_EVENT;
177 case (ATK_KEY_EVENT_RELEASE):
178 keystroke->type = Accessibility_KEY_RELEASED_EVENT;
186 ("key_event type %d; val=%d code=%d modifiers=%x name=%s is_text=%d, time=%lx\n",
187 (int) keystroke->type, (int) keystroke->id, (int) keystroke->hw_code,
188 (int) keystroke->modifiers, keystroke->event_string,
189 (int) keystroke->is_text, (unsigned long) keystroke->timestamp);
195 spi_atk_bridge_key_listener (AtkKeyEventStruct * event, gpointer data)
198 Accessibility_DeviceEvent key_event;
200 spi_init_keystroke_from_atk_key_event (&key_event, event);
203 Accessibility_DeviceEventController_NotifyListenersSync (&key_event);
205 if (key_event.event_string)
206 g_free (key_event.event_string);
211 /*---------------------------------------------------------------------------*/
214 convert_signal_name (const gchar * s)
216 gchar *ret = g_strdup (s);
221 ret[0] = toupper (ret[0]);
222 while ((t = strchr (ret, '-')) != NULL)
224 memmove (t, t + 1, strlen (t));
231 validate_for_dbus (const gint type,
236 case DBUS_TYPE_STRING:
237 case DBUS_TYPE_OBJECT_PATH:
240 else if (!g_utf8_validate (val, -1, NULL))
242 g_warning ("atk-bridge: Received bad UTF-8 string when emitting event");
253 append_basic (DBusMessageIter *iter,
259 dbus_message_iter_open_container(iter, DBUS_TYPE_VARIANT, type, &sub);
261 val = validate_for_dbus ((int) *type, val);
262 dbus_message_iter_append_basic(&sub, (int) *type, &val);
264 dbus_message_iter_close_container(iter, &sub);
268 append_rect (DBusMessageIter *iter,
272 DBusMessageIter variant, sub;
273 const AtkRectangle *rect = (const AtkRectangle *) val;
275 dbus_message_iter_open_container(iter, DBUS_TYPE_VARIANT, type, &variant);
277 dbus_message_iter_open_container (&variant, DBUS_TYPE_STRUCT, NULL, &sub);
279 dbus_message_iter_append_basic (&sub, DBUS_TYPE_INT32, &(rect->x));
280 dbus_message_iter_append_basic (&sub, DBUS_TYPE_INT32, &(rect->y));
281 dbus_message_iter_append_basic (&sub, DBUS_TYPE_INT32, &(rect->width));
282 dbus_message_iter_append_basic (&sub, DBUS_TYPE_INT32, &(rect->height));
284 dbus_message_iter_close_container (&variant, &sub);
286 dbus_message_iter_close_container(iter, &variant);
290 append_object (DBusMessageIter *iter,
294 spi_object_append_v_reference (iter, ATK_OBJECT (val));
298 signal_name_to_dbus (const gchar *s)
300 gchar *ret = g_strdup (s);
305 ret [0] = toupper (ret [0]);
306 while ((t = strchr (ret, '-')) != NULL)
308 memmove (t, t + 1, strlen (t));
315 * Converts names of the form "active-descendant-changed" to
316 * "ActiveDescendantChanged"
319 ensure_proper_format (const char *name)
321 gchar *ret = (gchar *) g_malloc (strlen (name) * 2 + 2);
323 gboolean need_upper = TRUE;
331 *p++ = toupper (*name);
334 else if (*name == '-')
336 else if (*name == ':')
350 signal_is_needed (const gchar *klass, const gchar *major, const gchar *minor)
355 gboolean ret = FALSE;
358 if (!spi_global_app_data->events_initialized)
361 data [0] = ensure_proper_format (klass + 21);
362 data [1] = ensure_proper_format (major);
363 data [2] = ensure_proper_format (minor);
366 /* Hack: Always pass events that update the cache.
367 * TODO: FOr 2.2, have at-spi2-core define a special "cache listener" for
368 * this instead, so that we don't send these if no one is listening */
369 if (!g_strcmp0 (data [1], "ChildrenChanged") ||
370 !g_strcmp0 (data [1], "PropertyChange") ||
371 !g_strcmp0 (data [1], "StateChanged"))
379 /* Hack: events such as "object::text-changed::insert:system" as
380 generated by Gecko */
381 data [2][strcspn (data [2], ":")] = '\0';
382 for (list = spi_global_app_data->events; list; list = list->next)
385 if (spi_event_is_subtype (data, evdata->data))
393 g_print("event: %s %s %s: %d\n", data[0], data[1], data[2], ret);
402 * Emits an AT-SPI event.
403 * AT-SPI events names are split into three parts:
405 * This is mapped onto D-Bus events as:
406 * D-Bus Interface:Signal Name:Detail argument
408 * Marshals a basic type into the 'any_data' attribute of
412 emit_event (AtkObject *obj,
416 dbus_int32_t detail1,
417 dbus_int32_t detail2,
420 void (*append_variant) (DBusMessageIter *, const char *, const void *))
422 DBusConnection *bus = spi_global_app_data->bus;
427 DBusMessageIter iter, iter_struct;
429 if (!klass) klass = "";
430 if (!major) major = "";
431 if (!minor) minor = "";
432 if (!type) type = "u";
434 if (!signal_is_needed (klass, major, minor))
437 path = spi_register_object_to_path (spi_global_register, G_OBJECT (obj));
440 * This is very annoying, but as '-' isn't a legal signal
441 * name in D-Bus (Why not??!?) The names need converting
442 * on this side, and again on the client side.
444 cname = signal_name_to_dbus (major);
445 sig = dbus_message_new_signal(path, klass, cname);
447 dbus_message_iter_init_append(sig, &iter);
449 dbus_message_iter_append_basic(&iter, DBUS_TYPE_STRING, &minor);
450 dbus_message_iter_append_basic(&iter, DBUS_TYPE_INT32, &detail1);
451 dbus_message_iter_append_basic(&iter, DBUS_TYPE_INT32, &detail2);
452 append_variant (&iter, type, val);
453 spi_object_append_reference (&iter, spi_global_app_data->root);
455 dbus_connection_send(bus, sig, NULL);
456 dbus_message_unref(sig);
458 if (g_strcmp0 (cname, "ChildrenChanged") != 0)
459 spi_object_lease_if_needed (G_OBJECT (obj));
465 /*---------------------------------------------------------------------------*/
468 * The focus listener handles the ATK 'focus' signal and forwards it
469 * as the AT-SPI event, 'focus:'
472 focus_tracker (AtkObject * accessible)
474 emit_event (accessible, ITF_EVENT_FOCUS, "focus", "", 0, 0,
475 DBUS_TYPE_INT32_AS_STRING, 0, append_basic);
478 /*---------------------------------------------------------------------------*/
480 #define PCHANGE "PropertyChange"
483 * This handler handles the following ATK signals and
484 * converts them to AT-SPI events:
486 * Gtk:AtkObject:property-change -> object:property-change:(property-name)
488 * The property-name is part of the ATK property-change signal.
491 property_event_listener (GSignalInvocationHint * signal_hint,
492 guint n_param_values,
493 const GValue * param_values, gpointer data)
495 AtkObject *accessible;
496 AtkPropertyValues *values;
498 const gchar *pname = NULL;
504 accessible = g_value_get_object (¶m_values[0]);
505 values = (AtkPropertyValues *) g_value_get_pointer (¶m_values[1]);
507 pname = values[0].property_name;
509 /* TODO Could improve this control statement by matching
510 * on only the end of the signal names,
512 if (strcmp (pname, "accessible-name") == 0)
514 s1 = atk_object_get_name (accessible);
516 emit_event (accessible, ITF_EVENT_OBJECT, PCHANGE, pname, 0, 0,
517 DBUS_TYPE_STRING_AS_STRING, s1, append_basic);
519 else if (strcmp (pname, "accessible-description") == 0)
521 s1 = atk_object_get_description (accessible);
523 emit_event (accessible, ITF_EVENT_OBJECT, PCHANGE, pname, 0, 0,
524 DBUS_TYPE_STRING_AS_STRING, s1, append_basic);
526 else if (strcmp (pname, "accessible-parent") == 0)
528 otemp = atk_object_get_parent (accessible);
530 emit_event (accessible, ITF_EVENT_OBJECT, PCHANGE, pname, 0, 0,
531 "(so)", otemp, append_object);
533 else if (strcmp (pname, "accessible-role") == 0)
535 i = atk_object_get_role (accessible);
536 emit_event (accessible, ITF_EVENT_OBJECT, PCHANGE, pname, 0, 0,
537 DBUS_TYPE_UINT32_AS_STRING, GINT_TO_POINTER(i), append_basic);
539 else if (strcmp (pname, "accessible-table-summary") == 0)
541 otemp = atk_table_get_summary (ATK_TABLE (accessible));
543 emit_event (accessible, ITF_EVENT_OBJECT, PCHANGE, pname, 0, 0,
544 "(so)", otemp, append_object);
546 else if (strcmp (pname, "accessible-table-column-header") == 0)
548 i = g_value_get_int (&(values->new_value));
549 otemp = atk_table_get_column_header (ATK_TABLE (accessible), i);
551 emit_event (accessible, ITF_EVENT_OBJECT, PCHANGE, pname, 0, 0,
552 "(so)", otemp, append_object);
554 else if (strcmp (pname, "accessible-table-row-header") == 0)
556 i = g_value_get_int (&(values->new_value));
557 otemp = atk_table_get_row_header (ATK_TABLE (accessible), i);
559 emit_event (accessible, ITF_EVENT_OBJECT, PCHANGE, pname, 0, 0,
560 "(so)", otemp, append_object);
562 else if (strcmp (pname, "accessible-table-row-description") == 0)
564 i = g_value_get_int (&(values->new_value));
565 s1 = atk_table_get_row_description (ATK_TABLE (accessible), i);
566 emit_event (accessible, ITF_EVENT_OBJECT, PCHANGE, pname, 0, 0,
567 DBUS_TYPE_STRING_AS_STRING, s1, append_basic);
569 else if (strcmp (pname, "accessible-table-column-description") == 0)
571 i = g_value_get_int (&(values->new_value));
572 s1 = atk_table_get_column_description (ATK_TABLE (accessible), i);
573 emit_event (accessible, ITF_EVENT_OBJECT, PCHANGE, pname, 0, 0,
574 DBUS_TYPE_STRING_AS_STRING, s1, append_basic);
576 else if (strcmp (pname, "accessible-table-caption-object") == 0)
578 otemp = atk_table_get_caption (ATK_TABLE (accessible));
579 emit_event (accessible, ITF_EVENT_OBJECT, PCHANGE, pname, 0, 0,
580 "(so)", otemp, append_object);
584 emit_event (accessible, ITF_EVENT_OBJECT, PCHANGE, pname, 0, 0,
585 DBUS_TYPE_INT32_AS_STRING, 0, append_basic);
590 /*---------------------------------------------------------------------------*/
592 #define STATE_CHANGED "state-changed"
595 * The state event listener handles 'Gtk:AtkObject:state-change' ATK signals
596 * and forwards them as object:state-changed:(param-name) AT-SPI events. Where
597 * the param-name is part of the ATK state-change signal.
600 state_event_listener (GSignalInvocationHint * signal_hint,
601 guint n_param_values,
602 const GValue * param_values, gpointer data)
604 AtkObject *accessible;
608 accessible = ATK_OBJECT (g_value_get_object (¶m_values[0]));
609 pname = g_strdup (g_value_get_string (¶m_values[1]));
611 /* TODO - Possibly ignore a change to the 'defunct' state.
612 * This is because without reference counting defunct objects should be removed.
614 detail1 = (g_value_get_boolean (¶m_values[2])) ? 1 : 0;
615 emit_event (accessible, ITF_EVENT_OBJECT, STATE_CHANGED, pname, detail1, 0,
616 DBUS_TYPE_INT32_AS_STRING, 0, append_basic);
621 /*---------------------------------------------------------------------------*/
624 * The window event listener handles the following ATK signals and forwards
625 * them as AT-SPI events:
627 * window:create -> window:create
628 * window:destroy -> window:destroy
629 * window:minimize -> window:minimize
630 * window:maximize -> window:maximize
631 * window:activate -> window:activate
632 * window:deactivate -> window:deactivate
635 window_event_listener (GSignalInvocationHint * signal_hint,
636 guint n_param_values,
637 const GValue * param_values, gpointer data)
639 AtkObject *accessible;
640 GSignalQuery signal_query;
641 const gchar *name, *s;
643 g_signal_query (signal_hint->signal_id, &signal_query);
644 name = signal_query.signal_name;
646 accessible = ATK_OBJECT (g_value_get_object (¶m_values[0]));
647 s = atk_object_get_name (accessible);
648 emit_event (accessible, ITF_EVENT_WINDOW, name, "", 0, 0,
649 DBUS_TYPE_STRING_AS_STRING, s, append_basic);
654 /*---------------------------------------------------------------------------*/
657 * The document event listener handles the following ATK signals
658 * and converts them to AT-SPI events:
660 * Gtk:AtkDocument:load-complete -> document:load-complete
661 * Gtk:AtkDocument:load-stopped -> document:load-stopped
662 * Gtk:AtkDocument:reload -> document:reload
665 document_event_listener (GSignalInvocationHint * signal_hint,
666 guint n_param_values,
667 const GValue * param_values, gpointer data)
669 AtkObject *accessible;
670 GSignalQuery signal_query;
671 const gchar *name, *s;
673 g_signal_query (signal_hint->signal_id, &signal_query);
674 name = signal_query.signal_name;
676 accessible = ATK_OBJECT (g_value_get_object (¶m_values[0]));
677 s = atk_object_get_name (accessible);
678 emit_event (accessible, ITF_EVENT_DOCUMENT, name, "", 0, 0,
679 DBUS_TYPE_STRING_AS_STRING, s, append_basic);
684 /*---------------------------------------------------------------------------*/
687 * Signal handler for "Gtk:AtkComponent:bounds-changed". Converts
688 * this to an AT-SPI event - "object:bounds-changed".
691 bounds_event_listener (GSignalInvocationHint * signal_hint,
692 guint n_param_values,
693 const GValue * param_values, gpointer data)
695 AtkObject *accessible;
696 AtkRectangle *atk_rect;
697 GSignalQuery signal_query;
698 const gchar *name, *s;
700 g_signal_query (signal_hint->signal_id, &signal_query);
701 name = signal_query.signal_name;
703 accessible = ATK_OBJECT (g_value_get_object (¶m_values[0]));
705 if (G_VALUE_HOLDS_BOXED (param_values + 1))
707 atk_rect = g_value_get_boxed (param_values + 1);
709 emit_event (accessible, ITF_EVENT_OBJECT, name, "", 0, 0,
710 "(iiii)", atk_rect, append_rect);
715 /*---------------------------------------------------------------------------*/
718 * Handles the ATK signal 'Gtk:AtkObject:active-descendant-changed' and
719 * converts it to the AT-SPI signal - 'object:active-descendant-changed'.
723 active_descendant_event_listener (GSignalInvocationHint * signal_hint,
724 guint n_param_values,
725 const GValue * param_values, gpointer data)
727 AtkObject *accessible;
729 GSignalQuery signal_query;
730 const gchar *name, *minor;
733 g_signal_query (signal_hint->signal_id, &signal_query);
734 name = signal_query.signal_name;
736 accessible = ATK_OBJECT (g_value_get_object (¶m_values[0]));
737 child = ATK_OBJECT (g_value_get_pointer (¶m_values[1]));
738 g_return_val_if_fail (ATK_IS_OBJECT (child), TRUE);
739 minor = g_quark_to_string (signal_hint->detail);
741 detail1 = atk_object_get_index_in_parent (child);
743 emit_event (accessible, ITF_EVENT_OBJECT, name, "", detail1, 0,
744 "(so)", child, append_object);
748 /*---------------------------------------------------------------------------*/
751 * Handles the ATK signal 'Gtk:AtkHypertext:link-selected' and
752 * converts it to the AT-SPI signal - 'object:link-selected'
756 link_selected_event_listener (GSignalInvocationHint * signal_hint,
757 guint n_param_values,
758 const GValue * param_values, gpointer data)
760 AtkObject *accessible;
761 GSignalQuery signal_query;
762 const gchar *name, *minor;
765 g_signal_query (signal_hint->signal_id, &signal_query);
766 name = signal_query.signal_name;
768 accessible = ATK_OBJECT (g_value_get_object (¶m_values[0]));
769 minor = g_quark_to_string (signal_hint->detail);
771 if (G_VALUE_TYPE (¶m_values[1]) == G_TYPE_INT)
772 detail1 = g_value_get_int (¶m_values[1]);
774 emit_event (accessible, ITF_EVENT_OBJECT, name, minor, detail1, 0,
775 DBUS_TYPE_INT32_AS_STRING, 0, append_basic);
779 /*---------------------------------------------------------------------------*/
782 * Handles the ATK signal 'Gtk:AtkText:text-changed' and
783 * converts it to the AT-SPI signal - 'object:text-changed'
784 * This signal is deprecated by Gtk:AtkText:text-insert
785 * and Gtk:AtkText:text-remove
789 text_changed_event_listener (GSignalInvocationHint * signal_hint,
790 guint n_param_values,
791 const GValue * param_values, gpointer data)
793 AtkObject *accessible;
794 GSignalQuery signal_query;
795 const gchar *name, *minor;
797 gint detail1, detail2;
799 g_signal_query (signal_hint->signal_id, &signal_query);
800 name = signal_query.signal_name;
802 accessible = ATK_OBJECT (g_value_get_object (¶m_values[0]));
803 minor = g_quark_to_string (signal_hint->detail);
805 if (G_VALUE_TYPE (¶m_values[1]) == G_TYPE_INT)
806 detail1 = g_value_get_int (¶m_values[1]);
808 if (G_VALUE_TYPE (¶m_values[2]) == G_TYPE_INT)
809 detail2 = g_value_get_int (¶m_values[2]);
812 atk_text_get_text (ATK_TEXT (accessible), detail1, detail1 + detail2);
814 emit_event (accessible, ITF_EVENT_OBJECT, name, minor, detail1, detail2,
815 DBUS_TYPE_STRING_AS_STRING, selected, append_basic);
822 * Handles the ATK signal 'Gtk:AtkText:text-insert' and
823 * converts it to the AT-SPI signal - 'object:text-changed'
827 text_insert_event_listener (GSignalInvocationHint * signal_hint,
828 guint n_param_values,
829 const GValue * param_values, gpointer data)
831 AtkObject *accessible;
832 guint text_changed_signal_id;
833 GSignalQuery signal_query;
836 gint detail1, detail2;
838 accessible = ATK_OBJECT (g_value_get_object (¶m_values[0]));
839 /* Get signal name for 'Gtk:AtkText:text-changed' so
840 * we convert it to the AT-SPI signal - 'object:text-changed'
842 text_changed_signal_id = g_signal_lookup ("text-changed", G_OBJECT_TYPE (accessible));
843 g_signal_query (text_changed_signal_id, &signal_query);
844 name = signal_query.signal_name;
847 /* Add the insert and keep any detail coming from atk */
848 minor = g_quark_to_string (signal_hint->detail);
850 minor = g_strconcat ("insert:", minor, NULL);
852 minor = g_strdup ("insert");
854 if (G_VALUE_TYPE (¶m_values[1]) == G_TYPE_INT)
855 detail1 = g_value_get_int (¶m_values[1]);
857 if (G_VALUE_TYPE (¶m_values[2]) == G_TYPE_INT)
858 detail2 = g_value_get_int (¶m_values[2]);
860 if (G_VALUE_TYPE (¶m_values[3]) == G_TYPE_STRING)
861 text = g_value_get_string (¶m_values[3]);
863 emit_event (accessible, ITF_EVENT_OBJECT, name, minor, detail1, detail2,
864 DBUS_TYPE_STRING_AS_STRING, text, append_basic);
870 * Handles the ATK signal 'Gtk:AtkText:text-remove' and
871 * converts it to the AT-SPI signal - 'object:text-changed'
875 text_remove_event_listener (GSignalInvocationHint * signal_hint,
876 guint n_param_values,
877 const GValue * param_values, gpointer data)
879 AtkObject *accessible;
880 guint text_changed_signal_id;
881 GSignalQuery signal_query;
884 gint detail1, detail2;
886 accessible = ATK_OBJECT (g_value_get_object (¶m_values[0]));
887 /* Get signal name for 'Gtk:AtkText:text-changed' so
888 * we convert it to the AT-SPI signal - 'object:text-changed'
890 text_changed_signal_id = g_signal_lookup ("text-changed", G_OBJECT_TYPE (accessible));
891 g_signal_query (text_changed_signal_id, &signal_query);
892 name = signal_query.signal_name;
894 minor = g_quark_to_string (signal_hint->detail);
896 /* Add the delete and keep any detail coming from atk */
897 minor = g_quark_to_string (signal_hint->detail);
899 minor = g_strconcat ("delete:", minor, NULL);
901 minor = g_strdup ("delete");
903 if (G_VALUE_TYPE (¶m_values[1]) == G_TYPE_INT)
904 detail1 = g_value_get_int (¶m_values[1]);
906 if (G_VALUE_TYPE (¶m_values[2]) == G_TYPE_INT)
907 detail2 = g_value_get_int (¶m_values[2]);
909 if (G_VALUE_TYPE (¶m_values[3]) == G_TYPE_STRING)
910 text = g_value_get_string (¶m_values[3]);
912 emit_event (accessible, ITF_EVENT_OBJECT, name, minor, detail1, detail2,
913 DBUS_TYPE_STRING_AS_STRING, text, append_basic);
919 /*---------------------------------------------------------------------------*/
922 * Handles the ATK signal 'Gtk:AtkText:text-selection-changed' and
923 * converts it to the AT-SPI signal - 'object:text-selection-changed'
927 text_selection_changed_event_listener (GSignalInvocationHint * signal_hint,
928 guint n_param_values,
929 const GValue * param_values,
932 AtkObject *accessible;
933 GSignalQuery signal_query;
934 const gchar *name, *minor;
935 gint detail1, detail2;
937 g_signal_query (signal_hint->signal_id, &signal_query);
938 name = signal_query.signal_name;
940 accessible = ATK_OBJECT (g_value_get_object (¶m_values[0]));
941 minor = g_quark_to_string (signal_hint->detail);
943 if (G_VALUE_TYPE (¶m_values[1]) == G_TYPE_INT)
944 detail1 = g_value_get_int (¶m_values[1]);
946 if (G_VALUE_TYPE (¶m_values[2]) == G_TYPE_INT)
947 detail2 = g_value_get_int (¶m_values[2]);
949 emit_event (accessible, ITF_EVENT_OBJECT, name, minor, detail1, detail2,
950 DBUS_TYPE_STRING_AS_STRING, "", append_basic);
954 /*---------------------------------------------------------------------------*/
957 * Children changed signal converter and forwarder.
959 * Klass (Interface) org.a11y.atspi.Event.Object
960 * Major is the signal name.
961 * Minor is 'add' or 'remove'
962 * detail1 is the index.
964 * any_data is the child reference.
967 children_changed_event_listener (GSignalInvocationHint * signal_hint,
968 guint n_param_values,
969 const GValue * param_values, gpointer data)
971 GSignalQuery signal_query;
972 const gchar *name, *minor;
973 gint detail1, detail2 = 0;
975 AtkObject *accessible, *ao=NULL;
978 g_signal_query (signal_hint->signal_id, &signal_query);
979 name = signal_query.signal_name;
981 accessible = ATK_OBJECT (g_value_get_object (¶m_values[0]));
982 minor = g_quark_to_string (signal_hint->detail);
984 detail1 = g_value_get_uint (param_values + 1);
985 child = g_value_get_pointer (param_values + 2);
987 if (ATK_IS_OBJECT (child))
989 ao = ATK_OBJECT (child);
990 emit_event (accessible, ITF_EVENT_OBJECT, name, minor, detail1, detail2,
991 "(so)", ao, append_object);
993 else if ((minor != NULL) && (strcmp (minor, "add") == 0))
995 ao = atk_object_ref_accessible_child (accessible,
997 emit_event (accessible, ITF_EVENT_OBJECT, name, minor, detail1, detail2,
998 "(so)", ao, append_object);
1002 emit_event (accessible, ITF_EVENT_OBJECT, name, minor, detail1, detail2,
1003 "(so)", ao, append_object);
1009 /*---------------------------------------------------------------------------*/
1012 toplevel_added_event_listener (AtkObject * accessible,
1013 guint index, AtkObject * child)
1015 emit_event (accessible, ITF_EVENT_OBJECT, "children-changed", "add", index, 0,
1016 "(so)", child, append_object);
1020 toplevel_removed_event_listener (AtkObject * accessible,
1021 guint index, AtkObject * child)
1023 emit_event (accessible, ITF_EVENT_OBJECT, "children-changed", "remove", index, 0,
1024 "(so)", child, append_object);
1027 /*---------------------------------------------------------------------------*/
1030 * Generic signal converter and forwarder.
1032 * Klass (Interface) org.a11y.atspi.Event.Object
1033 * Major is the signal name.
1040 generic_event_listener (GSignalInvocationHint * signal_hint,
1041 guint n_param_values,
1042 const GValue * param_values, gpointer data)
1044 AtkObject *accessible;
1045 GSignalQuery signal_query;
1047 int detail1 = 0, detail2 = 0;
1049 g_signal_query (signal_hint->signal_id, &signal_query);
1050 name = signal_query.signal_name;
1052 accessible = ATK_OBJECT (g_value_get_object (¶m_values[0]));
1054 if (n_param_values > 1 && G_VALUE_TYPE (¶m_values[1]) == G_TYPE_INT)
1055 detail1 = g_value_get_int (¶m_values[1]);
1057 if (n_param_values > 2 && G_VALUE_TYPE (¶m_values[2]) == G_TYPE_INT)
1058 detail2 = g_value_get_int (¶m_values[2]);
1060 emit_event (accessible, ITF_EVENT_OBJECT, name, "", detail1, detail2,
1061 DBUS_TYPE_INT32_AS_STRING, 0, append_basic);
1065 /*---------------------------------------------------------------------------*/
1068 * Registers the provided function as a handler for the given signal name
1069 * and stores the signal id returned so that the function may be
1070 * de-registered later.
1073 add_signal_listener (GSignalEmissionHook listener, const char *signal_name)
1077 id = atk_add_global_event_listener (listener, signal_name);
1078 g_array_append_val (listener_ids, id);
1082 * Initialization for the signal handlers.
1084 * Registers all required signal handlers.
1087 spi_atk_register_event_listeners (void)
1090 * Kludge to make sure the Atk interface types are registered, otherwise
1091 * the AtkText signal handlers below won't get registered
1093 GObject *ao = g_object_new (ATK_TYPE_OBJECT, NULL);
1094 AtkObject *bo = atk_no_op_object_new (ao);
1096 g_object_unref (G_OBJECT (bo));
1097 g_object_unref (ao);
1101 g_warning ("atk_bridge: spi_atk-register_event_listeners called multiple times");
1105 /* Register for focus event notifications, and register app with central registry */
1106 listener_ids = g_array_sized_new (FALSE, TRUE, sizeof (guint), 16);
1108 atk_bridge_focus_tracker_id = atk_add_focus_tracker (focus_tracker);
1110 add_signal_listener (property_event_listener,
1111 "Gtk:AtkObject:property-change");
1112 add_signal_listener (window_event_listener, "window:create");
1113 add_signal_listener (window_event_listener, "window:destroy");
1114 add_signal_listener (window_event_listener, "window:minimize");
1115 add_signal_listener (window_event_listener, "window:maximize");
1116 add_signal_listener (window_event_listener, "window:restore");
1117 add_signal_listener (window_event_listener, "window:activate");
1118 add_signal_listener (window_event_listener, "window:deactivate");
1119 add_signal_listener (document_event_listener,
1120 "Gtk:AtkDocument:load-complete");
1121 add_signal_listener (document_event_listener, "Gtk:AtkDocument:reload");
1122 add_signal_listener (document_event_listener,
1123 "Gtk:AtkDocument:load-stopped");
1124 /* TODO Fake this event on the client side */
1125 add_signal_listener (state_event_listener, "Gtk:AtkObject:state-change");
1127 add_signal_listener (active_descendant_event_listener,
1128 "Gtk:AtkObject:active-descendant-changed");
1129 add_signal_listener (bounds_event_listener,
1130 "Gtk:AtkComponent:bounds-changed");
1131 add_signal_listener (text_selection_changed_event_listener,
1132 "Gtk:AtkText:text-selection-changed");
1133 add_signal_listener (text_changed_event_listener,
1134 "Gtk:AtkText:text-changed");
1135 add_signal_listener (text_insert_event_listener,
1136 "Gtk:AtkText:text-insert");
1137 add_signal_listener (text_remove_event_listener,
1138 "Gtk:AtkText:text-remove");
1139 add_signal_listener (link_selected_event_listener,
1140 "Gtk:AtkHypertext:link-selected");
1141 add_signal_listener (generic_event_listener,
1142 "Gtk:AtkObject:visible-data-changed");
1143 add_signal_listener (generic_event_listener,
1144 "Gtk:AtkSelection:selection-changed");
1145 add_signal_listener (generic_event_listener,
1146 "Gtk:AtkText:text-attributes-changed");
1147 add_signal_listener (generic_event_listener,
1148 "Gtk:AtkText:text-caret-moved");
1149 add_signal_listener (generic_event_listener, "Gtk:AtkTable:row-inserted");
1150 add_signal_listener (generic_event_listener, "Gtk:AtkTable:row-reordered");
1151 add_signal_listener (generic_event_listener, "Gtk:AtkTable:row-deleted");
1152 add_signal_listener (generic_event_listener,
1153 "Gtk:AtkTable:column-inserted");
1154 add_signal_listener (generic_event_listener,
1155 "Gtk:AtkTable:column-reordered");
1156 add_signal_listener (generic_event_listener, "Gtk:AtkTable:column-deleted");
1157 add_signal_listener (generic_event_listener, "Gtk:AtkTable:model-changed");
1158 add_signal_listener (children_changed_event_listener, "Gtk:AtkObject:children-changed");
1161 g_signal_connect (G_OBJECT (spi_global_app_data->root),
1162 "children-changed::add",
1163 (GCallback) toplevel_added_event_listener, NULL);
1165 g_signal_connect (G_OBJECT (spi_global_app_data->root),
1166 "children-changed::remove",
1167 (GCallback) toplevel_removed_event_listener, NULL);
1171 * May add the following listeners to implement preemptive key listening for GTK+
1173 * atk_add_global_event_listener (spi_atk_bridge_widgetkey_listener, "Gtk:GtkWidget:key-press-event");
1174 * atk_add_global_event_listener (spi_atk_bridge_widgetkey_listener, "Gtk:GtkWidget:key-release-event");
1176 atk_bridge_key_event_listener_id =
1177 atk_add_key_event_listener (spi_atk_bridge_key_listener, NULL);
1180 /*---------------------------------------------------------------------------*/
1183 * De-registers all ATK signal handlers.
1186 spi_atk_deregister_event_listeners (void)
1189 GArray *ids = listener_ids;
1190 listener_ids = NULL;
1192 if (atk_bridge_focus_tracker_id)
1194 atk_remove_focus_tracker (atk_bridge_focus_tracker_id);
1195 atk_bridge_focus_tracker_id = 0;
1198 for (i = 0; ids && i < ids->len; i++)
1200 atk_remove_global_event_listener (g_array_index (ids, guint, i));
1202 g_array_free (ids, TRUE);
1204 if (atk_bridge_key_event_listener_id)
1206 atk_remove_key_event_listener (atk_bridge_key_event_listener_id);
1207 atk_bridge_key_event_listener_id = 0;
1211 /*---------------------------------------------------------------------------*/
1214 * TODO This function seems out of place here.
1216 * Emits fake deactivate signals on all top-level windows.
1217 * Used when shutting down AT-SPI, ensuring that all
1218 * windows have been removed on the client side.
1221 spi_atk_tidy_windows (void)
1227 root = atk_get_root ();
1228 n_children = atk_object_get_n_accessible_children (root);
1229 for (i = 0; i < n_children; i++)
1232 AtkStateSet *stateset;
1235 child = atk_object_ref_accessible_child (root, i);
1236 stateset = atk_object_ref_state_set (child);
1238 name = atk_object_get_name (child);
1239 if (atk_state_set_contains_state (stateset, ATK_STATE_ACTIVE))
1241 emit_event (child, ITF_EVENT_WINDOW, "deactivate", NULL, 0, 0,
1242 DBUS_TYPE_STRING_AS_STRING, name, append_basic);
1244 g_object_unref (stateset);
1246 emit_event (child, ITF_EVENT_WINDOW, "destroy", NULL, 0, 0,
1247 DBUS_TYPE_STRING_AS_STRING, name, append_basic);
1248 g_object_unref (child);
1253 spi_event_is_subtype (gchar **needle, gchar **haystack)
1255 while (*haystack && **haystack)
1257 if (g_strcmp0 (*needle, *haystack))
1265 /*END------------------------------------------------------------------------*/