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_value_get_string (¶m_values[1]);
611 detail1 = (g_value_get_boolean (¶m_values[2])) ? 1 : 0;
612 emit_event (accessible, ITF_EVENT_OBJECT, STATE_CHANGED, pname, detail1, 0,
613 DBUS_TYPE_INT32_AS_STRING, 0, append_basic);
615 if (!g_strcmp0 (pname, "defunct"))
616 spi_register_deregister_object (spi_global_register, G_OBJECT (accessible));
620 /*---------------------------------------------------------------------------*/
623 * The window event listener handles the following ATK signals and forwards
624 * them as AT-SPI events:
626 * window:create -> window:create
627 * window:destroy -> window:destroy
628 * window:minimize -> window:minimize
629 * window:maximize -> window:maximize
630 * window:activate -> window:activate
631 * window:deactivate -> window:deactivate
634 window_event_listener (GSignalInvocationHint * signal_hint,
635 guint n_param_values,
636 const GValue * param_values, gpointer data)
638 AtkObject *accessible;
639 GSignalQuery signal_query;
640 const gchar *name, *s;
642 g_signal_query (signal_hint->signal_id, &signal_query);
643 name = signal_query.signal_name;
645 accessible = ATK_OBJECT (g_value_get_object (¶m_values[0]));
646 s = atk_object_get_name (accessible);
647 emit_event (accessible, ITF_EVENT_WINDOW, name, "", 0, 0,
648 DBUS_TYPE_STRING_AS_STRING, s, append_basic);
653 /*---------------------------------------------------------------------------*/
656 * The document event listener handles the following ATK signals
657 * and converts them to AT-SPI events:
659 * Gtk:AtkDocument:load-complete -> document:load-complete
660 * Gtk:AtkDocument:load-stopped -> document:load-stopped
661 * Gtk:AtkDocument:reload -> document:reload
664 document_event_listener (GSignalInvocationHint * signal_hint,
665 guint n_param_values,
666 const GValue * param_values, gpointer data)
668 AtkObject *accessible;
669 GSignalQuery signal_query;
670 const gchar *name, *s;
672 g_signal_query (signal_hint->signal_id, &signal_query);
673 name = signal_query.signal_name;
675 accessible = ATK_OBJECT (g_value_get_object (¶m_values[0]));
676 s = atk_object_get_name (accessible);
677 emit_event (accessible, ITF_EVENT_DOCUMENT, name, "", 0, 0,
678 DBUS_TYPE_STRING_AS_STRING, s, append_basic);
683 /*---------------------------------------------------------------------------*/
686 * Signal handler for "Gtk:AtkComponent:bounds-changed". Converts
687 * this to an AT-SPI event - "object:bounds-changed".
690 bounds_event_listener (GSignalInvocationHint * signal_hint,
691 guint n_param_values,
692 const GValue * param_values, gpointer data)
694 AtkObject *accessible;
695 AtkRectangle *atk_rect;
696 GSignalQuery signal_query;
697 const gchar *name, *s;
699 g_signal_query (signal_hint->signal_id, &signal_query);
700 name = signal_query.signal_name;
702 accessible = ATK_OBJECT (g_value_get_object (¶m_values[0]));
704 if (G_VALUE_HOLDS_BOXED (param_values + 1))
706 atk_rect = g_value_get_boxed (param_values + 1);
708 emit_event (accessible, ITF_EVENT_OBJECT, name, "", 0, 0,
709 "(iiii)", atk_rect, append_rect);
714 /*---------------------------------------------------------------------------*/
717 * Handles the ATK signal 'Gtk:AtkObject:active-descendant-changed' and
718 * converts it to the AT-SPI signal - 'object:active-descendant-changed'.
722 active_descendant_event_listener (GSignalInvocationHint * signal_hint,
723 guint n_param_values,
724 const GValue * param_values, gpointer data)
726 AtkObject *accessible;
728 GSignalQuery signal_query;
729 const gchar *name, *minor;
732 g_signal_query (signal_hint->signal_id, &signal_query);
733 name = signal_query.signal_name;
735 accessible = ATK_OBJECT (g_value_get_object (¶m_values[0]));
736 child = ATK_OBJECT (g_value_get_pointer (¶m_values[1]));
737 g_return_val_if_fail (ATK_IS_OBJECT (child), TRUE);
738 minor = g_quark_to_string (signal_hint->detail);
740 detail1 = atk_object_get_index_in_parent (child);
742 emit_event (accessible, ITF_EVENT_OBJECT, name, "", detail1, 0,
743 "(so)", child, append_object);
747 /*---------------------------------------------------------------------------*/
750 * Handles the ATK signal 'Gtk:AtkHypertext:link-selected' and
751 * converts it to the AT-SPI signal - 'object:link-selected'
755 link_selected_event_listener (GSignalInvocationHint * signal_hint,
756 guint n_param_values,
757 const GValue * param_values, gpointer data)
759 AtkObject *accessible;
760 GSignalQuery signal_query;
761 const gchar *name, *minor;
764 g_signal_query (signal_hint->signal_id, &signal_query);
765 name = signal_query.signal_name;
767 accessible = ATK_OBJECT (g_value_get_object (¶m_values[0]));
768 minor = g_quark_to_string (signal_hint->detail);
770 if (G_VALUE_TYPE (¶m_values[1]) == G_TYPE_INT)
771 detail1 = g_value_get_int (¶m_values[1]);
773 emit_event (accessible, ITF_EVENT_OBJECT, name, minor, detail1, 0,
774 DBUS_TYPE_INT32_AS_STRING, 0, append_basic);
778 /*---------------------------------------------------------------------------*/
781 * Handles the ATK signal 'Gtk:AtkText:text-changed' and
782 * converts it to the AT-SPI signal - 'object:text-changed'
783 * This signal is deprecated by Gtk:AtkText:text-insert
784 * and Gtk:AtkText:text-remove
788 text_changed_event_listener (GSignalInvocationHint * signal_hint,
789 guint n_param_values,
790 const GValue * param_values, gpointer data)
792 AtkObject *accessible;
793 GSignalQuery signal_query;
794 const gchar *name, *minor;
796 gint detail1 = 0, detail2 = 0;
798 g_signal_query (signal_hint->signal_id, &signal_query);
799 name = signal_query.signal_name;
801 accessible = ATK_OBJECT (g_value_get_object (¶m_values[0]));
802 minor = g_quark_to_string (signal_hint->detail);
804 if (G_VALUE_TYPE (¶m_values[1]) == G_TYPE_INT)
805 detail1 = g_value_get_int (¶m_values[1]);
807 if (G_VALUE_TYPE (¶m_values[2]) == G_TYPE_INT)
808 detail2 = g_value_get_int (¶m_values[2]);
811 atk_text_get_text (ATK_TEXT (accessible), detail1, detail1 + detail2);
813 emit_event (accessible, ITF_EVENT_OBJECT, name, minor, detail1, detail2,
814 DBUS_TYPE_STRING_AS_STRING, selected, append_basic);
821 * Handles the ATK signal 'Gtk:AtkText:text-insert' and
822 * converts it to the AT-SPI signal - 'object:text-changed'
826 text_insert_event_listener (GSignalInvocationHint * signal_hint,
827 guint n_param_values,
828 const GValue * param_values, gpointer data)
830 AtkObject *accessible;
831 guint text_changed_signal_id;
832 GSignalQuery signal_query;
835 gint detail1 = 0, detail2 = 0;
837 accessible = ATK_OBJECT (g_value_get_object (¶m_values[0]));
838 /* Get signal name for 'Gtk:AtkText:text-changed' so
839 * we convert it to the AT-SPI signal - 'object:text-changed'
841 text_changed_signal_id = g_signal_lookup ("text-changed", G_OBJECT_TYPE (accessible));
842 g_signal_query (text_changed_signal_id, &signal_query);
843 name = signal_query.signal_name;
846 /* Add the insert and keep any detail coming from atk */
847 minor = g_quark_to_string (signal_hint->detail);
849 minor = g_strconcat ("insert:", minor, NULL);
851 minor = g_strdup ("insert");
853 if (G_VALUE_TYPE (¶m_values[1]) == G_TYPE_INT)
854 detail1 = g_value_get_int (¶m_values[1]);
856 if (G_VALUE_TYPE (¶m_values[2]) == G_TYPE_INT)
857 detail2 = g_value_get_int (¶m_values[2]);
859 if (G_VALUE_TYPE (¶m_values[3]) == G_TYPE_STRING)
860 text = g_value_get_string (¶m_values[3]);
862 emit_event (accessible, ITF_EVENT_OBJECT, name, minor, detail1, detail2,
863 DBUS_TYPE_STRING_AS_STRING, text, append_basic);
869 * Handles the ATK signal 'Gtk:AtkText:text-remove' and
870 * converts it to the AT-SPI signal - 'object:text-changed'
874 text_remove_event_listener (GSignalInvocationHint * signal_hint,
875 guint n_param_values,
876 const GValue * param_values, gpointer data)
878 AtkObject *accessible;
879 guint text_changed_signal_id;
880 GSignalQuery signal_query;
883 gint detail1 = 0, detail2 = 0;
885 accessible = ATK_OBJECT (g_value_get_object (¶m_values[0]));
886 /* Get signal name for 'Gtk:AtkText:text-changed' so
887 * we convert it to the AT-SPI signal - 'object:text-changed'
889 text_changed_signal_id = g_signal_lookup ("text-changed", G_OBJECT_TYPE (accessible));
890 g_signal_query (text_changed_signal_id, &signal_query);
891 name = signal_query.signal_name;
893 minor = g_quark_to_string (signal_hint->detail);
895 /* Add the delete and keep any detail coming from atk */
896 minor = g_quark_to_string (signal_hint->detail);
898 minor = g_strconcat ("delete:", minor, NULL);
900 minor = g_strdup ("delete");
902 if (G_VALUE_TYPE (¶m_values[1]) == G_TYPE_INT)
903 detail1 = g_value_get_int (¶m_values[1]);
905 if (G_VALUE_TYPE (¶m_values[2]) == G_TYPE_INT)
906 detail2 = g_value_get_int (¶m_values[2]);
908 if (G_VALUE_TYPE (¶m_values[3]) == G_TYPE_STRING)
909 text = g_value_get_string (¶m_values[3]);
911 emit_event (accessible, ITF_EVENT_OBJECT, name, minor, detail1, detail2,
912 DBUS_TYPE_STRING_AS_STRING, text, append_basic);
918 /*---------------------------------------------------------------------------*/
921 * Handles the ATK signal 'Gtk:AtkText:text-selection-changed' and
922 * converts it to the AT-SPI signal - 'object:text-selection-changed'
926 text_selection_changed_event_listener (GSignalInvocationHint * signal_hint,
927 guint n_param_values,
928 const GValue * param_values,
931 AtkObject *accessible;
932 GSignalQuery signal_query;
933 const gchar *name, *minor;
934 gint detail1 = 0, detail2 = 0;
936 g_signal_query (signal_hint->signal_id, &signal_query);
937 name = signal_query.signal_name;
939 accessible = ATK_OBJECT (g_value_get_object (¶m_values[0]));
940 minor = g_quark_to_string (signal_hint->detail);
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 emit_event (accessible, ITF_EVENT_OBJECT, name, minor, detail1, detail2,
949 DBUS_TYPE_STRING_AS_STRING, "", append_basic);
953 /*---------------------------------------------------------------------------*/
956 * Children changed signal converter and forwarder.
958 * Klass (Interface) org.a11y.atspi.Event.Object
959 * Major is the signal name.
960 * Minor is 'add' or 'remove'
961 * detail1 is the index.
963 * any_data is the child reference.
966 children_changed_event_listener (GSignalInvocationHint * signal_hint,
967 guint n_param_values,
968 const GValue * param_values, gpointer data)
970 GSignalQuery signal_query;
971 const gchar *name, *minor;
972 gint detail1 = 0, detail2 = 0;
974 AtkObject *accessible, *ao=NULL;
977 g_signal_query (signal_hint->signal_id, &signal_query);
978 name = signal_query.signal_name;
980 accessible = ATK_OBJECT (g_value_get_object (¶m_values[0]));
981 minor = g_quark_to_string (signal_hint->detail);
983 detail1 = g_value_get_uint (param_values + 1);
984 child = g_value_get_pointer (param_values + 2);
986 if (ATK_IS_OBJECT (child))
988 ao = ATK_OBJECT (child);
989 emit_event (accessible, ITF_EVENT_OBJECT, name, minor, detail1, detail2,
990 "(so)", ao, append_object);
992 else if ((minor != NULL) && (strcmp (minor, "add") == 0))
994 ao = atk_object_ref_accessible_child (accessible,
996 emit_event (accessible, ITF_EVENT_OBJECT, name, minor, detail1, detail2,
997 "(so)", ao, append_object);
1001 emit_event (accessible, ITF_EVENT_OBJECT, name, minor, detail1, detail2,
1002 "(so)", ao, append_object);
1008 /*---------------------------------------------------------------------------*/
1011 toplevel_added_event_listener (AtkObject * accessible,
1012 guint index, AtkObject * child)
1014 emit_event (accessible, ITF_EVENT_OBJECT, "children-changed", "add", index, 0,
1015 "(so)", child, append_object);
1019 toplevel_removed_event_listener (AtkObject * accessible,
1020 guint index, AtkObject * child)
1022 emit_event (accessible, ITF_EVENT_OBJECT, "children-changed", "remove", index, 0,
1023 "(so)", child, append_object);
1026 /*---------------------------------------------------------------------------*/
1029 * Generic signal converter and forwarder.
1031 * Klass (Interface) org.a11y.atspi.Event.Object
1032 * Major is the signal name.
1039 generic_event_listener (GSignalInvocationHint * signal_hint,
1040 guint n_param_values,
1041 const GValue * param_values, gpointer data)
1043 AtkObject *accessible;
1044 GSignalQuery signal_query;
1046 int detail1 = 0, detail2 = 0;
1048 g_signal_query (signal_hint->signal_id, &signal_query);
1049 name = signal_query.signal_name;
1051 accessible = ATK_OBJECT (g_value_get_object (¶m_values[0]));
1053 if (n_param_values > 1 && G_VALUE_TYPE (¶m_values[1]) == G_TYPE_INT)
1054 detail1 = g_value_get_int (¶m_values[1]);
1056 if (n_param_values > 2 && G_VALUE_TYPE (¶m_values[2]) == G_TYPE_INT)
1057 detail2 = g_value_get_int (¶m_values[2]);
1059 emit_event (accessible, ITF_EVENT_OBJECT, name, "", detail1, detail2,
1060 DBUS_TYPE_INT32_AS_STRING, 0, append_basic);
1064 /*---------------------------------------------------------------------------*/
1067 * Registers the provided function as a handler for the given signal name
1068 * and stores the signal id returned so that the function may be
1069 * de-registered later.
1072 add_signal_listener (GSignalEmissionHook listener, const char *signal_name)
1076 id = atk_add_global_event_listener (listener, signal_name);
1077 g_array_append_val (listener_ids, id);
1081 * Initialization for the signal handlers.
1083 * Registers all required signal handlers.
1086 spi_atk_register_event_listeners (void)
1089 * Kludge to make sure the Atk interface types are registered, otherwise
1090 * the AtkText signal handlers below won't get registered
1092 GObject *ao = g_object_new (ATK_TYPE_OBJECT, NULL);
1093 AtkObject *bo = atk_no_op_object_new (ao);
1095 g_object_unref (G_OBJECT (bo));
1096 g_object_unref (ao);
1100 g_warning ("atk_bridge: spi_atk-register_event_listeners called multiple times");
1104 /* Register for focus event notifications, and register app with central registry */
1105 listener_ids = g_array_sized_new (FALSE, TRUE, sizeof (guint), 16);
1107 atk_bridge_focus_tracker_id = atk_add_focus_tracker (focus_tracker);
1109 add_signal_listener (property_event_listener,
1110 "Gtk:AtkObject:property-change");
1111 add_signal_listener (window_event_listener, "window:create");
1112 add_signal_listener (window_event_listener, "window:destroy");
1113 add_signal_listener (window_event_listener, "window:minimize");
1114 add_signal_listener (window_event_listener, "window:maximize");
1115 add_signal_listener (window_event_listener, "window:restore");
1116 add_signal_listener (window_event_listener, "window:activate");
1117 add_signal_listener (window_event_listener, "window:deactivate");
1118 add_signal_listener (document_event_listener,
1119 "Gtk:AtkDocument:load-complete");
1120 add_signal_listener (document_event_listener, "Gtk:AtkDocument:reload");
1121 add_signal_listener (document_event_listener,
1122 "Gtk:AtkDocument:load-stopped");
1123 /* TODO Fake this event on the client side */
1124 add_signal_listener (state_event_listener, "Gtk:AtkObject:state-change");
1126 add_signal_listener (active_descendant_event_listener,
1127 "Gtk:AtkObject:active-descendant-changed");
1128 add_signal_listener (bounds_event_listener,
1129 "Gtk:AtkComponent:bounds-changed");
1130 add_signal_listener (text_selection_changed_event_listener,
1131 "Gtk:AtkText:text-selection-changed");
1132 add_signal_listener (text_changed_event_listener,
1133 "Gtk:AtkText:text-changed");
1134 add_signal_listener (text_insert_event_listener,
1135 "Gtk:AtkText:text-insert");
1136 add_signal_listener (text_remove_event_listener,
1137 "Gtk:AtkText:text-remove");
1138 add_signal_listener (link_selected_event_listener,
1139 "Gtk:AtkHypertext:link-selected");
1140 add_signal_listener (generic_event_listener,
1141 "Gtk:AtkObject:visible-data-changed");
1142 add_signal_listener (generic_event_listener,
1143 "Gtk:AtkSelection:selection-changed");
1144 add_signal_listener (generic_event_listener,
1145 "Gtk:AtkText:text-attributes-changed");
1146 add_signal_listener (generic_event_listener,
1147 "Gtk:AtkText:text-caret-moved");
1148 add_signal_listener (generic_event_listener, "Gtk:AtkTable:row-inserted");
1149 add_signal_listener (generic_event_listener, "Gtk:AtkTable:row-reordered");
1150 add_signal_listener (generic_event_listener, "Gtk:AtkTable:row-deleted");
1151 add_signal_listener (generic_event_listener,
1152 "Gtk:AtkTable:column-inserted");
1153 add_signal_listener (generic_event_listener,
1154 "Gtk:AtkTable:column-reordered");
1155 add_signal_listener (generic_event_listener, "Gtk:AtkTable:column-deleted");
1156 add_signal_listener (generic_event_listener, "Gtk:AtkTable:model-changed");
1157 add_signal_listener (children_changed_event_listener, "Gtk:AtkObject:children-changed");
1160 g_signal_connect (G_OBJECT (spi_global_app_data->root),
1161 "children-changed::add",
1162 (GCallback) toplevel_added_event_listener, NULL);
1164 g_signal_connect (G_OBJECT (spi_global_app_data->root),
1165 "children-changed::remove",
1166 (GCallback) toplevel_removed_event_listener, NULL);
1170 * May add the following listeners to implement preemptive key listening for GTK+
1172 * atk_add_global_event_listener (spi_atk_bridge_widgetkey_listener, "Gtk:GtkWidget:key-press-event");
1173 * atk_add_global_event_listener (spi_atk_bridge_widgetkey_listener, "Gtk:GtkWidget:key-release-event");
1175 atk_bridge_key_event_listener_id =
1176 atk_add_key_event_listener (spi_atk_bridge_key_listener, NULL);
1179 /*---------------------------------------------------------------------------*/
1182 * De-registers all ATK signal handlers.
1185 spi_atk_deregister_event_listeners (void)
1188 GArray *ids = listener_ids;
1189 listener_ids = NULL;
1191 if (atk_bridge_focus_tracker_id)
1193 atk_remove_focus_tracker (atk_bridge_focus_tracker_id);
1194 atk_bridge_focus_tracker_id = 0;
1197 for (i = 0; ids && i < ids->len; i++)
1199 atk_remove_global_event_listener (g_array_index (ids, guint, i));
1201 g_array_free (ids, TRUE);
1203 if (atk_bridge_key_event_listener_id)
1205 atk_remove_key_event_listener (atk_bridge_key_event_listener_id);
1206 atk_bridge_key_event_listener_id = 0;
1210 /*---------------------------------------------------------------------------*/
1213 * TODO This function seems out of place here.
1215 * Emits fake deactivate signals on all top-level windows.
1216 * Used when shutting down AT-SPI, ensuring that all
1217 * windows have been removed on the client side.
1220 spi_atk_tidy_windows (void)
1226 root = atk_get_root ();
1227 n_children = atk_object_get_n_accessible_children (root);
1228 for (i = 0; i < n_children; i++)
1231 AtkStateSet *stateset;
1234 child = atk_object_ref_accessible_child (root, i);
1235 stateset = atk_object_ref_state_set (child);
1237 name = atk_object_get_name (child);
1238 if (atk_state_set_contains_state (stateset, ATK_STATE_ACTIVE))
1240 emit_event (child, ITF_EVENT_WINDOW, "deactivate", NULL, 0, 0,
1241 DBUS_TYPE_STRING_AS_STRING, name, append_basic);
1243 g_object_unref (stateset);
1245 emit_event (child, ITF_EVENT_WINDOW, "destroy", NULL, 0, 0,
1246 DBUS_TYPE_STRING_AS_STRING, name, append_basic);
1247 g_object_unref (child);
1252 spi_event_is_subtype (gchar **needle, gchar **haystack)
1254 while (*haystack && **haystack)
1256 if (g_strcmp0 (*needle, *haystack))
1264 /*END------------------------------------------------------------------------*/