2 * AT-SPI - Assistive Technology Service Provider Interface
3 * (Gnome Accessibility Project; http://developer.gnome.org/projects/gap)
5 * Copyright 2011, F123 Consulting & Mais Diferenças
6 * Copyright 2008, 2009, Codethink Ltd.
7 * Copyright 2001, 2002, 2003 Sun Microsystems Inc.,
8 * Copyright 2001, 2002, 2003 Ximian, Inc.
10 * This library is free software; you can redistribute it and/or
11 * modify it under the terms of the GNU Library General Public
12 * License as published by the Free Software Foundation; either
13 * version 2 of the License, or (at your option) any later version.
15 * This library is distributed in the hope that it will be useful,
16 * but WITHOUT ANY WARRANTY; without even the implied warranty of
17 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
18 * Library General Public License for more details.
20 * You should have received a copy of the GNU Library General Public
21 * License along with this library; if not, write to the
22 * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
23 * Boston, MA 02111-1307, USA.
30 #include <droute/droute.h>
31 #include <atspi/atspi.h>
34 #include "accessible-register.h"
40 static GArray *listener_ids = NULL;
42 static gint atk_bridge_key_event_listener_id;
43 static gint atk_bridge_focus_tracker_id;
45 /*---------------------------------------------------------------------------*/
47 #define ITF_EVENT_OBJECT "org.a11y.atspi.Event.Object"
48 #define ITF_EVENT_WINDOW "org.a11y.atspi.Event.Window"
49 #define ITF_EVENT_DOCUMENT "org.a11y.atspi.Event.Document"
50 #define ITF_EVENT_FOCUS "org.a11y.atspi.Event.Focus"
52 /*---------------------------------------------------------------------------*/
54 typedef struct _SpiReentrantCallClosure
60 } SpiReentrantCallClosure;
63 switch_main_context (GMainContext *cnx)
67 if (spi_global_app_data->server)
68 atspi_dbus_server_setup_with_g_main (spi_global_app_data->server, cnx);
69 atspi_dbus_connection_setup_with_g_main (spi_global_app_data->bus, cnx);
70 atspi_set_main_context (cnx);
71 for (list = spi_global_app_data->direct_connections; list; list = list->next)
72 atspi_dbus_connection_setup_with_g_main (list->data, cnx);
76 set_reply (DBusPendingCall * pending, void *user_data)
78 SpiReentrantCallClosure* closure = (SpiReentrantCallClosure *) user_data;
80 closure->reply = dbus_pending_call_steal_reply (pending);
81 dbus_pending_call_unref (pending);
82 switch_main_context (NULL);
83 g_main_loop_quit (closure->loop);
87 timeout_reply (void *data)
89 SpiReentrantCallClosure *closure = data;
91 switch_main_context (NULL);
92 g_main_loop_quit (closure->loop);
93 closure->timeout = -1;
98 send_and_allow_reentry (DBusConnection * bus, DBusMessage * message)
100 DBusPendingCall *pending;
101 SpiReentrantCallClosure closure;
105 closure.loop = g_main_loop_new (spi_global_app_data->main_context, FALSE);
106 closure.reply = NULL;
107 switch_main_context (spi_global_app_data->main_context);
109 if (!dbus_connection_send_with_reply (bus, message, &pending, 9000) || !pending)
111 switch_main_context (NULL);
114 dbus_pending_call_set_notify (pending, set_reply, (void *) &closure, NULL);
115 source = g_timeout_source_new (500);
116 g_source_set_callback (source, timeout_reply, &closure, NULL);
117 closure.timeout = g_source_attach (source, spi_global_app_data->main_context);
118 g_source_unref (source);
119 g_main_loop_run (closure.loop);
120 if (closure.timeout != -1)
121 g_source_destroy (source);
123 g_main_loop_unref (closure.loop);
125 dbus_pending_call_cancel (pending);
126 return closure.reply;
129 /*---------------------------------------------------------------------------*/
132 * Functionality related to sending device events from the application.
134 * This is used for forwarding key events on to the registry daemon.
138 Accessibility_DeviceEventController_NotifyListenersSync (const
142 DBusMessage *message;
143 dbus_bool_t consumed = FALSE;
146 dbus_message_new_method_call (SPI_DBUS_NAME_REGISTRY,
148 ATSPI_DBUS_INTERFACE_DEC,
149 "NotifyListenersSync");
151 if (spi_dbus_marshal_deviceEvent (message, key_event))
154 send_and_allow_reentry (spi_global_app_data->bus, message);
158 dbus_error_init (&error);
159 if (!dbus_message_get_args (reply, &error, DBUS_TYPE_BOOLEAN,
160 &consumed, DBUS_TYPE_INVALID))
162 /* TODO: print a warning */
163 dbus_error_free (&error);
165 dbus_message_unref (reply);
168 dbus_message_unref (message);
173 spi_init_keystroke_from_atk_key_event (AtspiDeviceEvent * keystroke,
174 AtkKeyEventStruct * event)
176 keystroke->id = (dbus_int32_t) event->keyval;
177 keystroke->hw_code = (dbus_int16_t) event->keycode;
178 keystroke->timestamp = (dbus_uint32_t) event->timestamp;
179 keystroke->modifiers = (dbus_uint16_t) (event->state & 0xFFFF);
184 keystroke->event_string = g_strdup (event->string);
185 c = g_utf8_get_char_validated (event->string, -1);
186 if (c > 0 && g_unichar_isprint (c))
187 keystroke->is_text = TRUE;
189 keystroke->is_text = FALSE;
193 keystroke->event_string = g_strdup ("");
194 keystroke->is_text = FALSE;
198 case (ATK_KEY_EVENT_PRESS):
199 keystroke->type = ATSPI_KEY_PRESSED;
201 case (ATK_KEY_EVENT_RELEASE):
202 keystroke->type = ATSPI_KEY_RELEASED;
210 ("key_event type %d; val=%d code=%d modifiers=%x name=%s is_text=%d, time=%lx\n",
211 (int) keystroke->type, (int) keystroke->id, (int) keystroke->hw_code,
212 (int) keystroke->modifiers, keystroke->event_string,
213 (int) keystroke->is_text, (unsigned long) keystroke->timestamp);
219 spi_atk_bridge_key_listener (AtkKeyEventStruct * event, gpointer data)
222 AtspiDeviceEvent key_event;
224 spi_init_keystroke_from_atk_key_event (&key_event, event);
227 Accessibility_DeviceEventController_NotifyListenersSync (&key_event);
229 if (key_event.event_string)
230 g_free (key_event.event_string);
235 /*---------------------------------------------------------------------------*/
238 validate_for_dbus (const gint type,
243 case DBUS_TYPE_STRING:
244 case DBUS_TYPE_OBJECT_PATH:
247 else if (!g_utf8_validate (val, -1, NULL))
249 g_warning ("atk-bridge: Received bad UTF-8 string when emitting event");
260 append_basic (DBusMessageIter *iter,
266 dbus_message_iter_open_container(iter, DBUS_TYPE_VARIANT, type, &sub);
268 val = validate_for_dbus ((int) *type, val);
269 dbus_message_iter_append_basic(&sub, (int) *type, &val);
271 dbus_message_iter_close_container(iter, &sub);
275 append_rect (DBusMessageIter *iter,
279 DBusMessageIter variant, sub;
280 const AtkRectangle *rect = (const AtkRectangle *) val;
282 dbus_message_iter_open_container(iter, DBUS_TYPE_VARIANT, type, &variant);
284 dbus_message_iter_open_container (&variant, DBUS_TYPE_STRUCT, NULL, &sub);
286 dbus_message_iter_append_basic (&sub, DBUS_TYPE_INT32, &(rect->x));
287 dbus_message_iter_append_basic (&sub, DBUS_TYPE_INT32, &(rect->y));
288 dbus_message_iter_append_basic (&sub, DBUS_TYPE_INT32, &(rect->width));
289 dbus_message_iter_append_basic (&sub, DBUS_TYPE_INT32, &(rect->height));
291 dbus_message_iter_close_container (&variant, &sub);
293 dbus_message_iter_close_container(iter, &variant);
297 append_object (DBusMessageIter *iter,
301 spi_object_append_v_reference (iter, ATK_OBJECT (val));
305 signal_name_to_dbus (const gchar *s)
307 gchar *ret = g_strdup (s);
312 ret [0] = toupper (ret [0]);
313 while ((t = strchr (ret, '-')) != NULL)
315 memmove (t, t + 1, strlen (t));
322 * Converts names of the form "active-descendant-changed" to
323 * "ActiveDescendantChanged"
326 ensure_proper_format (const char *name)
328 gchar *ret = (gchar *) g_malloc (strlen (name) * 2 + 2);
330 gboolean need_upper = TRUE;
338 *p++ = toupper (*name);
341 else if (*name == '-')
343 else if (*name == ':')
357 signal_is_needed (const gchar *klass, const gchar *major, const gchar *minor)
361 gboolean ret = FALSE;
364 if (!spi_global_app_data->events_initialized)
367 data [0] = ensure_proper_format (klass + 21);
368 data [1] = ensure_proper_format (major);
369 data [2] = ensure_proper_format (minor);
372 /* Hack: Always pass events that update the cache.
373 * TODO: FOr 2.2, have at-spi2-core define a special "cache listener" for
374 * this instead, so that we don't send these if no one is listening */
375 if (!g_strcmp0 (data [1], "ChildrenChanged") ||
376 ((!g_strcmp0 (data [1], "PropertyChange")) &&
377 (!g_strcmp0 (data [2], "accessible-name") ||
378 !g_strcmp0 (data [2], "accessible-description") ||
379 !g_strcmp0 (data [2], "accessible-parent") ||
380 !g_strcmp0 (data [2], "accessible-role"))) ||
381 !g_strcmp0 (data [1], "StateChanged"))
389 /* Hack: events such as "object::text-changed::insert:system" as
390 generated by Gecko */
391 data [2][strcspn (data [2], ":")] = '\0';
392 for (list = spi_global_app_data->events; list; list = list->next)
395 if (spi_event_is_subtype (data, evdata->data))
403 g_print("event: %s %s %s: %d\n", data[0], data[1], data[2], ret);
411 /* Convert a : to a / so that listeners can use arg0path to match only
414 adapt_minor_for_dbus (const char *source)
416 gchar *ret = g_strdup (source);
417 int i = strcspn (ret, ":");
424 * Emits an AT-SPI event.
425 * AT-SPI events names are split into three parts:
427 * This is mapped onto D-Bus events as:
428 * D-Bus Interface:Signal Name:Detail argument
430 * Marshals a basic type into the 'any_data' attribute of
434 emit_event (AtkObject *obj,
438 dbus_int32_t detail1,
439 dbus_int32_t detail2,
442 void (*append_variant) (DBusMessageIter *, const char *, const void *))
444 DBusConnection *bus = spi_global_app_data->bus;
450 DBusMessageIter iter;
452 if (!klass) klass = "";
453 if (!major) major = "";
454 if (!minor) minor = "";
455 if (!type) type = "u";
457 if (!signal_is_needed (klass, major, minor))
460 path = spi_register_object_to_path (spi_global_register, G_OBJECT (obj));
461 g_return_if_fail (path != NULL);
464 * This is very annoying, but as '-' isn't a legal signal
465 * name in D-Bus (Why not??!?) The names need converting
466 * on this side, and again on the client side.
468 cname = signal_name_to_dbus (major);
469 sig = dbus_message_new_signal(path, klass, cname);
471 dbus_message_iter_init_append(sig, &iter);
473 minor_dbus = adapt_minor_for_dbus (minor);
474 dbus_message_iter_append_basic(&iter, DBUS_TYPE_STRING, &minor_dbus);
476 dbus_message_iter_append_basic(&iter, DBUS_TYPE_INT32, &detail1);
477 dbus_message_iter_append_basic(&iter, DBUS_TYPE_INT32, &detail2);
478 append_variant (&iter, type, val);
479 spi_object_append_reference (&iter, spi_global_app_data->root);
481 dbus_connection_send(bus, sig, NULL);
482 dbus_message_unref(sig);
484 if (g_strcmp0 (cname, "ChildrenChanged") != 0)
485 spi_object_lease_if_needed (G_OBJECT (obj));
491 /*---------------------------------------------------------------------------*/
494 * The focus listener handles the ATK 'focus' signal and forwards it
495 * as the AT-SPI event, 'focus:'
498 focus_tracker (AtkObject * accessible)
500 emit_event (accessible, ITF_EVENT_FOCUS, "focus", "", 0, 0,
501 DBUS_TYPE_INT32_AS_STRING, 0, append_basic);
504 /*---------------------------------------------------------------------------*/
506 #define PCHANGE "PropertyChange"
509 * This handler handles the following ATK signals and
510 * converts them to AT-SPI events:
512 * Gtk:AtkObject:property-change -> object:property-change:(property-name)
514 * The property-name is part of the ATK property-change signal.
517 property_event_listener (GSignalInvocationHint * signal_hint,
518 guint n_param_values,
519 const GValue * param_values, gpointer data)
521 AtkObject *accessible;
522 AtkPropertyValues *values;
524 const gchar *pname = NULL;
530 accessible = g_value_get_object (¶m_values[0]);
531 values = (AtkPropertyValues *) g_value_get_pointer (¶m_values[1]);
533 pname = values[0].property_name;
535 /* TODO Could improve this control statement by matching
536 * on only the end of the signal names,
538 if (strcmp (pname, "accessible-name") == 0)
540 s1 = atk_object_get_name (accessible);
542 emit_event (accessible, ITF_EVENT_OBJECT, PCHANGE, pname, 0, 0,
543 DBUS_TYPE_STRING_AS_STRING, s1, append_basic);
545 else if (strcmp (pname, "accessible-description") == 0)
547 s1 = atk_object_get_description (accessible);
549 emit_event (accessible, ITF_EVENT_OBJECT, PCHANGE, pname, 0, 0,
550 DBUS_TYPE_STRING_AS_STRING, s1, append_basic);
552 else if (strcmp (pname, "accessible-parent") == 0)
554 otemp = atk_object_get_parent (accessible);
556 emit_event (accessible, ITF_EVENT_OBJECT, PCHANGE, pname, 0, 0,
557 "(so)", otemp, append_object);
559 else if (strcmp (pname, "accessible-role") == 0)
561 i = atk_object_get_role (accessible);
562 emit_event (accessible, ITF_EVENT_OBJECT, PCHANGE, pname, 0, 0,
563 DBUS_TYPE_UINT32_AS_STRING, GINT_TO_POINTER(i), append_basic);
565 else if (strcmp (pname, "accessible-table-summary") == 0)
567 otemp = atk_table_get_summary (ATK_TABLE (accessible));
569 emit_event (accessible, ITF_EVENT_OBJECT, PCHANGE, pname, 0, 0,
570 "(so)", otemp, append_object);
572 else if (strcmp (pname, "accessible-table-column-header") == 0)
574 i = g_value_get_int (&(values->new_value));
575 otemp = atk_table_get_column_header (ATK_TABLE (accessible), i);
577 emit_event (accessible, ITF_EVENT_OBJECT, PCHANGE, pname, 0, 0,
578 "(so)", otemp, append_object);
580 else if (strcmp (pname, "accessible-table-row-header") == 0)
582 i = g_value_get_int (&(values->new_value));
583 otemp = atk_table_get_row_header (ATK_TABLE (accessible), i);
585 emit_event (accessible, ITF_EVENT_OBJECT, PCHANGE, pname, 0, 0,
586 "(so)", otemp, append_object);
588 else if (strcmp (pname, "accessible-table-row-description") == 0)
590 i = g_value_get_int (&(values->new_value));
591 s1 = atk_table_get_row_description (ATK_TABLE (accessible), i);
592 emit_event (accessible, ITF_EVENT_OBJECT, PCHANGE, pname, 0, 0,
593 DBUS_TYPE_STRING_AS_STRING, s1, append_basic);
595 else if (strcmp (pname, "accessible-table-column-description") == 0)
597 i = g_value_get_int (&(values->new_value));
598 s1 = atk_table_get_column_description (ATK_TABLE (accessible), i);
599 emit_event (accessible, ITF_EVENT_OBJECT, PCHANGE, pname, 0, 0,
600 DBUS_TYPE_STRING_AS_STRING, s1, append_basic);
602 else if (strcmp (pname, "accessible-table-caption-object") == 0)
604 otemp = atk_table_get_caption (ATK_TABLE (accessible));
605 emit_event (accessible, ITF_EVENT_OBJECT, PCHANGE, pname, 0, 0,
606 "(so)", otemp, append_object);
610 emit_event (accessible, ITF_EVENT_OBJECT, PCHANGE, pname, 0, 0,
611 DBUS_TYPE_INT32_AS_STRING, 0, append_basic);
616 /*---------------------------------------------------------------------------*/
618 #define STATE_CHANGED "state-changed"
621 * The state event listener handles 'Gtk:AtkObject:state-change' ATK signals
622 * and forwards them as object:state-changed:(param-name) AT-SPI events. Where
623 * the param-name is part of the ATK state-change signal.
626 state_event_listener (GSignalInvocationHint * signal_hint,
627 guint n_param_values,
628 const GValue * param_values, gpointer data)
630 AtkObject *accessible;
634 accessible = ATK_OBJECT (g_value_get_object (¶m_values[0]));
635 pname = g_value_get_string (¶m_values[1]);
637 detail1 = (g_value_get_boolean (¶m_values[2])) ? 1 : 0;
638 emit_event (accessible, ITF_EVENT_OBJECT, STATE_CHANGED, pname, detail1, 0,
639 DBUS_TYPE_INT32_AS_STRING, 0, append_basic);
641 if (!g_strcmp0 (pname, "defunct") && detail1)
642 spi_register_deregister_object (spi_global_register, G_OBJECT (accessible),
647 /*---------------------------------------------------------------------------*/
650 * The window event listener handles the following ATK signals and forwards
651 * them as AT-SPI events:
653 * window:create -> window:create
654 * window:destroy -> window:destroy
655 * window:minimize -> window:minimize
656 * window:maximize -> window:maximize
657 * window:activate -> window:activate
658 * window:deactivate -> window:deactivate
661 window_event_listener (GSignalInvocationHint * signal_hint,
662 guint n_param_values,
663 const GValue * param_values, gpointer data)
665 AtkObject *accessible;
666 GSignalQuery signal_query;
667 const gchar *name, *s;
669 g_signal_query (signal_hint->signal_id, &signal_query);
670 name = signal_query.signal_name;
672 accessible = ATK_OBJECT (g_value_get_object (¶m_values[0]));
673 s = atk_object_get_name (accessible);
674 emit_event (accessible, ITF_EVENT_WINDOW, name, "", 0, 0,
675 DBUS_TYPE_STRING_AS_STRING, s, append_basic);
680 /*---------------------------------------------------------------------------*/
683 * The document event listener handles the following ATK signals
684 * and converts them to AT-SPI events:
686 * Gtk:AtkDocument:load-complete -> document:load-complete
687 * Gtk:AtkDocument:load-stopped -> document:load-stopped
688 * Gtk:AtkDocument:reload -> document:reload
691 document_event_listener (GSignalInvocationHint * signal_hint,
692 guint n_param_values,
693 const GValue * param_values, gpointer data)
695 AtkObject *accessible;
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]));
703 s = atk_object_get_name (accessible);
704 emit_event (accessible, ITF_EVENT_DOCUMENT, name, "", 0, 0,
705 DBUS_TYPE_STRING_AS_STRING, s, append_basic);
710 /*---------------------------------------------------------------------------*/
713 * Signal handler for "Gtk:AtkComponent:bounds-changed". Converts
714 * this to an AT-SPI event - "object:bounds-changed".
717 bounds_event_listener (GSignalInvocationHint * signal_hint,
718 guint n_param_values,
719 const GValue * param_values, gpointer data)
721 AtkObject *accessible;
722 AtkRectangle *atk_rect;
723 GSignalQuery signal_query;
726 g_signal_query (signal_hint->signal_id, &signal_query);
727 name = signal_query.signal_name;
729 accessible = ATK_OBJECT (g_value_get_object (¶m_values[0]));
731 if (G_VALUE_HOLDS_BOXED (param_values + 1))
733 atk_rect = g_value_get_boxed (param_values + 1);
735 emit_event (accessible, ITF_EVENT_OBJECT, name, "", 0, 0,
736 "(iiii)", atk_rect, append_rect);
741 /*---------------------------------------------------------------------------*/
744 * Handles the ATK signal 'Gtk:AtkObject:active-descendant-changed' and
745 * converts it to the AT-SPI signal - 'object:active-descendant-changed'.
749 active_descendant_event_listener (GSignalInvocationHint * signal_hint,
750 guint n_param_values,
751 const GValue * param_values, gpointer data)
753 AtkObject *accessible;
755 GSignalQuery signal_query;
759 g_signal_query (signal_hint->signal_id, &signal_query);
760 name = signal_query.signal_name;
762 accessible = ATK_OBJECT (g_value_get_object (¶m_values[0]));
763 child = ATK_OBJECT (g_value_get_pointer (¶m_values[1]));
764 g_return_val_if_fail (ATK_IS_OBJECT (child), TRUE);
766 detail1 = atk_object_get_index_in_parent (child);
768 emit_event (accessible, ITF_EVENT_OBJECT, name, "", detail1, 0,
769 "(so)", child, append_object);
773 /*---------------------------------------------------------------------------*/
776 * Handles the ATK signal 'Gtk:AtkHypertext:link-selected' and
777 * converts it to the AT-SPI signal - 'object:link-selected'
781 link_selected_event_listener (GSignalInvocationHint * signal_hint,
782 guint n_param_values,
783 const GValue * param_values, gpointer data)
785 AtkObject *accessible;
786 GSignalQuery signal_query;
787 const gchar *name, *minor;
790 g_signal_query (signal_hint->signal_id, &signal_query);
791 name = signal_query.signal_name;
793 accessible = ATK_OBJECT (g_value_get_object (¶m_values[0]));
794 minor = g_quark_to_string (signal_hint->detail);
796 if (G_VALUE_TYPE (¶m_values[1]) == G_TYPE_INT)
797 detail1 = g_value_get_int (¶m_values[1]);
799 emit_event (accessible, ITF_EVENT_OBJECT, name, minor, detail1, 0,
800 DBUS_TYPE_INT32_AS_STRING, 0, append_basic);
804 /*---------------------------------------------------------------------------*/
807 * Handles the ATK signal 'Gtk:AtkText:text-changed' and
808 * converts it to the AT-SPI signal - 'object:text-changed'
809 * This signal is deprecated by Gtk:AtkText:text-insert
810 * and Gtk:AtkText:text-remove
814 text_changed_event_listener (GSignalInvocationHint * signal_hint,
815 guint n_param_values,
816 const GValue * param_values, gpointer data)
818 AtkObject *accessible;
819 GSignalQuery signal_query;
820 const gchar *name, *minor;
822 gint detail1 = 0, detail2 = 0;
824 g_signal_query (signal_hint->signal_id, &signal_query);
825 name = signal_query.signal_name;
827 accessible = ATK_OBJECT (g_value_get_object (¶m_values[0]));
828 minor = g_quark_to_string (signal_hint->detail);
830 if (G_VALUE_TYPE (¶m_values[1]) == G_TYPE_INT)
831 detail1 = g_value_get_int (¶m_values[1]);
833 if (G_VALUE_TYPE (¶m_values[2]) == G_TYPE_INT)
834 detail2 = g_value_get_int (¶m_values[2]);
837 atk_text_get_text (ATK_TEXT (accessible), detail1, detail1 + detail2);
839 emit_event (accessible, ITF_EVENT_OBJECT, name, minor, detail1, detail2,
840 DBUS_TYPE_STRING_AS_STRING, selected, append_basic);
847 * Handles the ATK signal 'Gtk:AtkText:text-insert' and
848 * converts it to the AT-SPI signal - 'object:text-changed'
852 text_insert_event_listener (GSignalInvocationHint * signal_hint,
853 guint n_param_values,
854 const GValue * param_values, gpointer data)
856 AtkObject *accessible;
857 guint text_changed_signal_id;
858 GSignalQuery signal_query;
860 const gchar *minor_raw, *text;
862 gint detail1 = 0, detail2 = 0;
864 accessible = ATK_OBJECT (g_value_get_object (¶m_values[0]));
865 /* Get signal name for 'Gtk:AtkText:text-changed' so
866 * we convert it to the AT-SPI signal - 'object:text-changed'
868 text_changed_signal_id = g_signal_lookup ("text-changed", G_OBJECT_TYPE (accessible));
869 g_signal_query (text_changed_signal_id, &signal_query);
870 name = signal_query.signal_name;
873 /* Add the insert and keep any detail coming from atk */
874 minor_raw = g_quark_to_string (signal_hint->detail);
876 minor = g_strconcat ("insert:", minor_raw, NULL);
878 minor = g_strdup ("insert");
880 if (G_VALUE_TYPE (¶m_values[1]) == G_TYPE_INT)
881 detail1 = g_value_get_int (¶m_values[1]);
883 if (G_VALUE_TYPE (¶m_values[2]) == G_TYPE_INT)
884 detail2 = g_value_get_int (¶m_values[2]);
886 if (G_VALUE_TYPE (¶m_values[3]) == G_TYPE_STRING)
887 text = g_value_get_string (¶m_values[3]);
889 emit_event (accessible, ITF_EVENT_OBJECT, name, minor, detail1, detail2,
890 DBUS_TYPE_STRING_AS_STRING, text, append_basic);
896 * Handles the ATK signal 'Gtk:AtkText:text-remove' and
897 * converts it to the AT-SPI signal - 'object:text-changed'
901 text_remove_event_listener (GSignalInvocationHint * signal_hint,
902 guint n_param_values,
903 const GValue * param_values, gpointer data)
905 AtkObject *accessible;
906 guint text_changed_signal_id;
907 GSignalQuery signal_query;
909 const gchar *minor_raw, *text;
911 gint detail1 = 0, detail2 = 0;
913 accessible = ATK_OBJECT (g_value_get_object (¶m_values[0]));
914 /* Get signal name for 'Gtk:AtkText:text-changed' so
915 * we convert it to the AT-SPI signal - 'object:text-changed'
917 text_changed_signal_id = g_signal_lookup ("text-changed", G_OBJECT_TYPE (accessible));
918 g_signal_query (text_changed_signal_id, &signal_query);
919 name = signal_query.signal_name;
921 minor_raw = g_quark_to_string (signal_hint->detail);
923 /* Add the delete and keep any detail coming from atk */
925 minor = g_strconcat ("delete:", minor_raw, NULL);
927 minor = g_strdup ("delete");
929 if (G_VALUE_TYPE (¶m_values[1]) == G_TYPE_INT)
930 detail1 = g_value_get_int (¶m_values[1]);
932 if (G_VALUE_TYPE (¶m_values[2]) == G_TYPE_INT)
933 detail2 = g_value_get_int (¶m_values[2]);
935 if (G_VALUE_TYPE (¶m_values[3]) == G_TYPE_STRING)
936 text = g_value_get_string (¶m_values[3]);
938 emit_event (accessible, ITF_EVENT_OBJECT, name, minor, detail1, detail2,
939 DBUS_TYPE_STRING_AS_STRING, text, append_basic);
945 /*---------------------------------------------------------------------------*/
948 * Handles the ATK signal 'Gtk:AtkText:text-selection-changed' and
949 * converts it to the AT-SPI signal - 'object:text-selection-changed'
953 text_selection_changed_event_listener (GSignalInvocationHint * signal_hint,
954 guint n_param_values,
955 const GValue * param_values,
958 AtkObject *accessible;
959 GSignalQuery signal_query;
960 const gchar *name, *minor;
961 gint detail1 = 0, detail2 = 0;
963 g_signal_query (signal_hint->signal_id, &signal_query);
964 name = signal_query.signal_name;
966 accessible = ATK_OBJECT (g_value_get_object (¶m_values[0]));
967 minor = g_quark_to_string (signal_hint->detail);
969 if (G_VALUE_TYPE (¶m_values[1]) == G_TYPE_INT)
970 detail1 = g_value_get_int (¶m_values[1]);
972 if (G_VALUE_TYPE (¶m_values[2]) == G_TYPE_INT)
973 detail2 = g_value_get_int (¶m_values[2]);
975 emit_event (accessible, ITF_EVENT_OBJECT, name, minor, detail1, detail2,
976 DBUS_TYPE_STRING_AS_STRING, "", append_basic);
980 /*---------------------------------------------------------------------------*/
983 * Children changed signal converter and forwarder.
985 * Klass (Interface) org.a11y.atspi.Event.Object
986 * Major is the signal name.
987 * Minor is 'add' or 'remove'
988 * detail1 is the index.
990 * any_data is the child reference.
993 children_changed_event_listener (GSignalInvocationHint * signal_hint,
994 guint n_param_values,
995 const GValue * param_values, gpointer data)
997 GSignalQuery signal_query;
998 const gchar *name, *minor;
999 gint detail1 = 0, detail2 = 0;
1001 AtkObject *accessible, *ao=NULL;
1004 g_signal_query (signal_hint->signal_id, &signal_query);
1005 name = signal_query.signal_name;
1007 accessible = ATK_OBJECT (g_value_get_object (¶m_values[0]));
1008 minor = g_quark_to_string (signal_hint->detail);
1010 detail1 = g_value_get_uint (param_values + 1);
1011 child = g_value_get_pointer (param_values + 2);
1013 if (ATK_IS_OBJECT (child))
1015 ao = ATK_OBJECT (child);
1016 emit_event (accessible, ITF_EVENT_OBJECT, name, minor, detail1, detail2,
1017 "(so)", ao, append_object);
1019 else if ((minor != NULL) && (strcmp (minor, "add") == 0))
1021 ao = atk_object_ref_accessible_child (accessible,
1023 emit_event (accessible, ITF_EVENT_OBJECT, name, minor, detail1, detail2,
1024 "(so)", ao, append_object);
1025 g_object_unref (ao);
1029 emit_event (accessible, ITF_EVENT_OBJECT, name, minor, detail1, detail2,
1030 "(so)", ao, append_object);
1036 /*---------------------------------------------------------------------------*/
1039 * Generic signal converter and forwarder.
1041 * Klass (Interface) org.a11y.atspi.Event.Object
1042 * Major is the signal name.
1049 generic_event_listener (GSignalInvocationHint * signal_hint,
1050 guint n_param_values,
1051 const GValue * param_values, gpointer data)
1053 AtkObject *accessible;
1054 GSignalQuery signal_query;
1056 int detail1 = 0, detail2 = 0;
1058 g_signal_query (signal_hint->signal_id, &signal_query);
1059 name = signal_query.signal_name;
1061 accessible = ATK_OBJECT (g_value_get_object (¶m_values[0]));
1063 if (n_param_values > 1 && G_VALUE_TYPE (¶m_values[1]) == G_TYPE_INT)
1064 detail1 = g_value_get_int (¶m_values[1]);
1066 if (n_param_values > 2 && G_VALUE_TYPE (¶m_values[2]) == G_TYPE_INT)
1067 detail2 = g_value_get_int (¶m_values[2]);
1069 emit_event (accessible, ITF_EVENT_OBJECT, name, "", detail1, detail2,
1070 DBUS_TYPE_INT32_AS_STRING, 0, append_basic);
1074 /*---------------------------------------------------------------------------*/
1077 * Registers the provided function as a handler for the given signal name
1078 * and stores the signal id returned so that the function may be
1079 * de-registered later.
1082 add_signal_listener (GSignalEmissionHook listener, const char *signal_name)
1086 id = atk_add_global_event_listener (listener, signal_name);
1088 if (id > 0) /* id == 0 is a failure */
1089 g_array_append_val (listener_ids, id);
1095 * Initialization for the signal handlers.
1097 * Registers all required signal handlers.
1100 spi_atk_register_event_listeners (void)
1103 * Kludge to make sure the Atk interface types are registered, otherwise
1104 * the AtkText signal handlers below won't get registered
1106 GObject *ao = g_object_new (ATK_TYPE_OBJECT, NULL);
1107 AtkObject *bo = atk_no_op_object_new (ao);
1110 g_object_unref (G_OBJECT (bo));
1111 g_object_unref (ao);
1115 g_warning ("atk_bridge: spi_atk-register_event_listeners called multiple times");
1119 /* Register for focus event notifications, and register app with central registry */
1120 listener_ids = g_array_sized_new (FALSE, TRUE, sizeof (guint), 16);
1122 atk_bridge_focus_tracker_id = atk_add_focus_tracker (focus_tracker);
1124 add_signal_listener (property_event_listener,
1125 "Gtk:AtkObject:property-change");
1127 /* window events: we tentative try to register using the old format */
1128 id = add_signal_listener (window_event_listener, "window:create");
1132 /* If we are able to register using the old format, we assume
1133 * that the ATK implementor is managing window events without
1134 * AtkWindow. We can't use the opposite test because after
1135 * including AtkWindow on ATK you would be able to register to
1136 * that event, although the ATK implementor could or not use it.
1139 add_signal_listener (window_event_listener, "window:destroy");
1140 add_signal_listener (window_event_listener, "window:minimize");
1141 add_signal_listener (window_event_listener, "window:maximize");
1142 add_signal_listener (window_event_listener, "window:restore");
1143 add_signal_listener (window_event_listener, "window:activate");
1144 add_signal_listener (window_event_listener, "window:deactivate");
1148 add_signal_listener (window_event_listener, "Atk:AtkWindow:create");
1149 add_signal_listener (window_event_listener, "Atk:AtkWindow:destroy");
1150 add_signal_listener (window_event_listener, "Atk:AtkWindow:minimize");
1151 add_signal_listener (window_event_listener, "Atk:AtkWindow:maximize");
1152 add_signal_listener (window_event_listener, "Atk:AtkWindow:restore");
1153 add_signal_listener (window_event_listener, "Atk:AtkWindow:activate");
1154 add_signal_listener (window_event_listener, "Atk:AtkWindow:deactivate");
1157 add_signal_listener (document_event_listener,
1158 "Gtk:AtkDocument:load-complete");
1159 add_signal_listener (document_event_listener, "Gtk:AtkDocument:reload");
1160 add_signal_listener (document_event_listener,
1161 "Gtk:AtkDocument:load-stopped");
1162 /* TODO Fake this event on the client side */
1163 add_signal_listener (state_event_listener, "Gtk:AtkObject:state-change");
1165 add_signal_listener (active_descendant_event_listener,
1166 "Gtk:AtkObject:active-descendant-changed");
1167 add_signal_listener (bounds_event_listener,
1168 "Gtk:AtkComponent:bounds-changed");
1169 add_signal_listener (text_selection_changed_event_listener,
1170 "Gtk:AtkText:text-selection-changed");
1171 add_signal_listener (text_changed_event_listener,
1172 "Gtk:AtkText:text-changed");
1173 add_signal_listener (text_insert_event_listener,
1174 "Gtk:AtkText:text-insert");
1175 add_signal_listener (text_remove_event_listener,
1176 "Gtk:AtkText:text-remove");
1177 add_signal_listener (link_selected_event_listener,
1178 "Gtk:AtkHypertext:link-selected");
1179 add_signal_listener (generic_event_listener,
1180 "Gtk:AtkObject:visible-data-changed");
1181 add_signal_listener (generic_event_listener,
1182 "Gtk:AtkSelection:selection-changed");
1183 add_signal_listener (generic_event_listener,
1184 "Gtk:AtkText:text-attributes-changed");
1185 add_signal_listener (generic_event_listener,
1186 "Gtk:AtkText:text-caret-moved");
1187 add_signal_listener (generic_event_listener, "Gtk:AtkTable:row-inserted");
1188 add_signal_listener (generic_event_listener, "Gtk:AtkTable:row-reordered");
1189 add_signal_listener (generic_event_listener, "Gtk:AtkTable:row-deleted");
1190 add_signal_listener (generic_event_listener,
1191 "Gtk:AtkTable:column-inserted");
1192 add_signal_listener (generic_event_listener,
1193 "Gtk:AtkTable:column-reordered");
1194 add_signal_listener (generic_event_listener, "Gtk:AtkTable:column-deleted");
1195 add_signal_listener (generic_event_listener, "Gtk:AtkTable:model-changed");
1196 add_signal_listener (children_changed_event_listener, "Gtk:AtkObject:children-changed");
1199 g_signal_connect (G_OBJECT (spi_global_app_data->root),
1200 "children-changed::add",
1201 (GCallback) toplevel_added_event_listener, NULL);
1203 g_signal_connect (G_OBJECT (spi_global_app_data->root),
1204 "children-changed::remove",
1205 (GCallback) toplevel_removed_event_listener, NULL);
1209 * May add the following listeners to implement preemptive key listening for GTK+
1211 * atk_add_global_event_listener (spi_atk_bridge_widgetkey_listener, "Gtk:GtkWidget:key-press-event");
1212 * atk_add_global_event_listener (spi_atk_bridge_widgetkey_listener, "Gtk:GtkWidget:key-release-event");
1214 atk_bridge_key_event_listener_id =
1215 atk_add_key_event_listener (spi_atk_bridge_key_listener, NULL);
1218 /*---------------------------------------------------------------------------*/
1221 * De-registers all ATK signal handlers.
1224 spi_atk_deregister_event_listeners (void)
1227 GArray *ids = listener_ids;
1228 listener_ids = NULL;
1230 if (atk_bridge_focus_tracker_id)
1232 atk_remove_focus_tracker (atk_bridge_focus_tracker_id);
1233 atk_bridge_focus_tracker_id = 0;
1238 for (i = 0; i < ids->len; i++)
1240 atk_remove_global_event_listener (g_array_index (ids, guint, i));
1242 g_array_free (ids, TRUE);
1245 if (atk_bridge_key_event_listener_id)
1247 atk_remove_key_event_listener (atk_bridge_key_event_listener_id);
1248 atk_bridge_key_event_listener_id = 0;
1252 /*---------------------------------------------------------------------------*/
1255 * TODO This function seems out of place here.
1257 * Emits fake deactivate signals on all top-level windows.
1258 * Used when shutting down AT-SPI, ensuring that all
1259 * windows have been removed on the client side.
1262 spi_atk_tidy_windows (void)
1268 root = atk_get_root ();
1269 n_children = atk_object_get_n_accessible_children (root);
1270 for (i = 0; i < n_children; i++)
1273 AtkStateSet *stateset;
1276 child = atk_object_ref_accessible_child (root, i);
1277 stateset = atk_object_ref_state_set (child);
1279 name = atk_object_get_name (child);
1280 if (atk_state_set_contains_state (stateset, ATK_STATE_ACTIVE))
1282 emit_event (child, ITF_EVENT_WINDOW, "deactivate", NULL, 0, 0,
1283 DBUS_TYPE_STRING_AS_STRING, name, append_basic);
1285 g_object_unref (stateset);
1287 emit_event (child, ITF_EVENT_WINDOW, "destroy", NULL, 0, 0,
1288 DBUS_TYPE_STRING_AS_STRING, name, append_basic);
1289 g_object_unref (child);
1294 spi_event_is_subtype (gchar **needle, gchar **haystack)
1296 while (*haystack && **haystack)
1298 if (g_strcmp0 (*needle, *haystack))
1306 /*END------------------------------------------------------------------------*/