Only add items to the cache on children-changed if they are passed in
[platform/core/uifw/at-spi2-atk.git] / atk-adaptor / event.c
1 /*
2  * AT-SPI - Assistive Technology Service Provider Interface
3  * (Gnome Accessibility Project; http://developer.gnome.org/projects/gap)
4  *
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.
9  *
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.
14  *
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.
19  *
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.
24  */
25
26 #include <string.h>
27 #include <ctype.h>
28
29 #include <atk/atk.h>
30 #include <droute/droute.h>
31 #include <atspi/atspi.h>
32
33 #include "bridge.h"
34 #include "accessible-register.h"
35
36 #include "spi-dbus.h"
37 #include "event.h"
38 #include "object.h"
39
40 static GArray *listener_ids = NULL;
41
42 static gint atk_bridge_key_event_listener_id;
43 static gint atk_bridge_focus_tracker_id;
44
45 /*---------------------------------------------------------------------------*/
46
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"
51
52 /*---------------------------------------------------------------------------*/
53
54 typedef struct _SpiReentrantCallClosure 
55 {
56   DBusConnection *bus;
57   GMainLoop   *loop;
58   DBusMessage *reply;
59   guint timeout;
60 } SpiReentrantCallClosure;
61
62 static void
63 switch_main_context (GMainContext *cnx)
64 {
65   GList *list;
66
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   for (list = spi_global_app_data->direct_connections; list; list = list->next)
71     atspi_dbus_connection_setup_with_g_main (list->data, cnx);
72 }
73
74 static void
75 set_reply (DBusPendingCall * pending, void *user_data)
76 {
77   SpiReentrantCallClosure* closure = (SpiReentrantCallClosure *) user_data; 
78
79   closure->reply = dbus_pending_call_steal_reply (pending);
80   dbus_pending_call_unref (pending);
81   switch_main_context (NULL);
82   g_main_loop_quit (closure->loop);
83 }
84
85 static gboolean
86 timeout_reply (void *data)
87 {
88   SpiReentrantCallClosure *closure = data;
89
90   if (!dbus_connection_get_is_connected (closure->bus))
91     g_main_loop_quit (closure->loop);
92   closure->timeout = -1;
93   return FALSE;
94 }
95
96 static DBusMessage *
97 send_and_allow_reentry (DBusConnection * bus, DBusMessage * message)
98 {
99   DBusPendingCall *pending;
100   SpiReentrantCallClosure closure;
101   GMainContext *main_context;
102   GSource *source;
103
104   main_context = (g_getenv ("AT_SPI_CLIENT") ? NULL :
105                   spi_global_app_data->main_context);
106   closure.bus = bus;
107   closure.loop = g_main_loop_new (main_context, FALSE);
108   closure.reply = NULL;
109   switch_main_context (main_context);
110
111   if (!dbus_connection_send_with_reply (bus, message, &pending, 9000) || !pending)
112     {
113       switch_main_context (NULL);
114       return NULL;
115     }
116   dbus_pending_call_set_notify (pending, set_reply, (void *) &closure, NULL);
117   source = g_timeout_source_new (500);
118   g_source_set_callback (source, timeout_reply, &closure, NULL);
119   closure.timeout = g_source_attach (source, main_context);
120   g_source_unref (source);
121   g_main_loop_run  (closure.loop);
122   if (closure.timeout != -1)
123     g_source_destroy (source);
124   
125   g_main_loop_unref (closure.loop);
126   return closure.reply;
127 }
128
129 /*---------------------------------------------------------------------------*/
130
131 /*
132  * Functionality related to sending device events from the application.
133  *
134  * This is used for forwarding key events on to the registry daemon.
135  */
136
137 static gboolean
138 Accessibility_DeviceEventController_NotifyListenersSync (const
139                                                          AtspiDeviceEvent
140                                                          * key_event)
141 {
142   DBusMessage *message;
143   DBusError error;
144   dbus_bool_t consumed = FALSE;
145
146   message =
147     dbus_message_new_method_call (SPI_DBUS_NAME_REGISTRY,
148                                   ATSPI_DBUS_PATH_DEC,
149                                   ATSPI_DBUS_INTERFACE_DEC,
150                                   "NotifyListenersSync");
151
152   dbus_error_init (&error);
153   if (spi_dbus_marshal_deviceEvent (message, key_event))
154     {
155       DBusMessage *reply =
156         send_and_allow_reentry (spi_global_app_data->bus, message);
157       if (reply)
158         {
159           DBusError error;
160           dbus_error_init (&error);
161           dbus_message_get_args (reply, &error, DBUS_TYPE_BOOLEAN, &consumed,
162                                  DBUS_TYPE_INVALID);
163           dbus_message_unref (reply);
164         }
165     }
166   dbus_message_unref (message);
167   return consumed;
168 }
169
170 static void
171 spi_init_keystroke_from_atk_key_event (AtspiDeviceEvent * keystroke,
172                                        AtkKeyEventStruct * event)
173 {
174   keystroke->id = (dbus_int32_t) event->keyval;
175   keystroke->hw_code = (dbus_int16_t) event->keycode;
176   keystroke->timestamp = (dbus_uint32_t) event->timestamp;
177   keystroke->modifiers = (dbus_uint16_t) (event->state & 0xFFFF);
178   if (event->string)
179     {
180       gunichar c;
181
182       keystroke->event_string = g_strdup (event->string);
183       c = g_utf8_get_char_validated (event->string, -1);
184       if (c > 0 && g_unichar_isprint (c))
185         keystroke->is_text = TRUE;
186       else
187         keystroke->is_text = FALSE;
188     }
189   else
190     {
191       keystroke->event_string = g_strdup ("");
192       keystroke->is_text = FALSE;
193     }
194   switch (event->type)
195     {
196     case (ATK_KEY_EVENT_PRESS):
197       keystroke->type = ATSPI_KEY_PRESSED;
198       break;
199     case (ATK_KEY_EVENT_RELEASE):
200       keystroke->type = ATSPI_KEY_RELEASED;
201       break;
202     default:
203       keystroke->type = 0;
204       break;
205     }
206 #if 0
207   g_print
208     ("key_event type %d; val=%d code=%d modifiers=%x name=%s is_text=%d, time=%lx\n",
209      (int) keystroke->type, (int) keystroke->id, (int) keystroke->hw_code,
210      (int) keystroke->modifiers, keystroke->event_string,
211      (int) keystroke->is_text, (unsigned long) keystroke->timestamp);
212 #endif
213 }
214
215
216 static gint
217 spi_atk_bridge_key_listener (AtkKeyEventStruct * event, gpointer data)
218 {
219   gboolean result;
220   AtspiDeviceEvent key_event;
221
222   spi_init_keystroke_from_atk_key_event (&key_event, event);
223
224   result =
225     Accessibility_DeviceEventController_NotifyListenersSync (&key_event);
226
227   if (key_event.event_string)
228     g_free (key_event.event_string);
229
230   return result;
231 }
232
233 /*---------------------------------------------------------------------------*/
234
235 static const void *
236 validate_for_dbus (const gint type,
237               const void *val)
238 {
239   switch (type)
240     {
241       case DBUS_TYPE_STRING:
242       case DBUS_TYPE_OBJECT_PATH:
243            if (!val)
244               return "";
245            else if (!g_utf8_validate (val, -1, NULL))
246              {
247                g_warning ("atk-bridge: Received bad UTF-8 string when emitting event");
248                return "";
249                }
250            else
251               return val;
252       default:
253            return val;
254     }
255 }
256
257 static void
258 append_basic (DBusMessageIter *iter,
259               const char *type,
260               const void *val)
261 {
262   DBusMessageIter sub;
263
264   dbus_message_iter_open_container(iter, DBUS_TYPE_VARIANT, type, &sub);
265
266     val = validate_for_dbus ((int) *type, val);
267     dbus_message_iter_append_basic(&sub, (int) *type, &val);
268
269   dbus_message_iter_close_container(iter, &sub);
270 }
271
272 static void
273 append_rect (DBusMessageIter *iter,
274              const char *type,
275              const void *val)
276 {
277   DBusMessageIter variant, sub;
278   const AtkRectangle *rect = (const AtkRectangle *) val;
279
280   dbus_message_iter_open_container(iter, DBUS_TYPE_VARIANT, type, &variant);
281
282     dbus_message_iter_open_container (&variant, DBUS_TYPE_STRUCT, NULL, &sub);
283
284       dbus_message_iter_append_basic (&sub, DBUS_TYPE_INT32, &(rect->x));
285       dbus_message_iter_append_basic (&sub, DBUS_TYPE_INT32, &(rect->y));
286       dbus_message_iter_append_basic (&sub, DBUS_TYPE_INT32, &(rect->width));
287       dbus_message_iter_append_basic (&sub, DBUS_TYPE_INT32, &(rect->height));
288
289     dbus_message_iter_close_container (&variant, &sub);
290
291   dbus_message_iter_close_container(iter, &variant);
292 }
293
294 static void
295 append_object (DBusMessageIter *iter,
296                const char *type,
297                const void *val)
298 {
299   spi_object_append_v_reference (iter, ATK_OBJECT (val));
300 }
301
302 static gchar *
303 signal_name_to_dbus (const gchar *s)
304 {
305   gchar *ret = g_strdup (s);
306   gchar *t;
307
308   if (!ret)
309     return NULL;
310   ret [0] = toupper (ret [0]);
311   while ((t = strchr (ret, '-')) != NULL)
312   {
313     memmove (t, t + 1, strlen (t));
314     *t = toupper (*t);
315   }
316   return ret;
317 }
318
319 /*
320  * Converts names of the form "active-descendant-changed" to
321  * "ActiveDescendantChanged"
322  */
323 static gchar *
324 ensure_proper_format (const char *name)
325 {
326   gchar *ret = (gchar *) g_malloc (strlen (name) * 2 + 2);
327   gchar *p = ret;
328   gboolean need_upper = TRUE;
329
330   if (!ret)
331     return NULL;
332   while (*name)
333     {
334       if (need_upper)
335         {
336           *p++ = toupper (*name);
337           need_upper = FALSE;
338         }
339       else if (*name == '-')
340         need_upper = TRUE;
341       else if (*name == ':')
342         {
343           need_upper = TRUE;
344           *p++ = *name;
345         }
346       else
347         *p++ = *name;
348       name++;
349     }
350   *p = '\0';
351   return ret;
352 }
353
354 static gboolean
355 signal_is_needed (const gchar *klass, const gchar *major, const gchar *minor)
356 {
357   gchar *data [4];
358   event_data *evdata;
359   gboolean ret = FALSE;
360   GList *list;
361
362   if (!spi_global_app_data->events_initialized)
363     return TRUE;
364
365   data [0] = ensure_proper_format (klass + 21);
366   data [1] = ensure_proper_format (major);
367   data [2] = ensure_proper_format (minor);
368   data [3] = NULL;
369
370   /* Hack: Always pass events that update the cache.
371    * TODO: FOr 2.2, have at-spi2-core define a special "cache listener" for
372    * this instead, so that we don't send these if no one is listening */
373   if (!g_strcmp0 (data [1], "ChildrenChanged") ||
374       !g_strcmp0 (data [1], "PropertyChange") ||
375       !g_strcmp0 (data [1], "StateChanged"))
376   {
377     g_free (data [2]);
378     g_free (data [1]);
379     g_free (data [0]);
380     return TRUE;
381   }
382
383   /* Hack: events such as "object::text-changed::insert:system" as
384      generated by Gecko */
385   data [2][strcspn (data [2], ":")] = '\0';
386   for (list = spi_global_app_data->events; list; list = list->next)
387     {
388       evdata = list->data;
389       if (spi_event_is_subtype (data, evdata->data))
390         {
391           ret = TRUE;
392           break;
393         }
394     }
395
396 #if 0
397   g_print("event: %s %s %s: %d\n", data[0], data[1], data[2], ret);
398 #endif
399   g_free (data [2]);
400   g_free (data [1]);
401   g_free (data [0]);
402   return ret;
403 }
404
405 /* Convert a : to a / so that listeners can use arg0path to match only
406  *  * the prefix */
407 static char *
408 adapt_minor_for_dbus (const char *source)
409 {
410   gchar *ret = g_strdup (source);
411   int i = strcspn (ret, ":");
412   if (ret[i] == ':')
413     ret[i] = '/';
414   return ret;
415 }
416
417 /*
418  * Emits an AT-SPI event.
419  * AT-SPI events names are split into three parts:
420  * class:major:minor
421  * This is mapped onto D-Bus events as:
422  * D-Bus Interface:Signal Name:Detail argument
423  *
424  * Marshals a basic type into the 'any_data' attribute of
425  * the AT-SPI event.
426  */
427 static void 
428 emit_event (AtkObject  *obj,
429             const char *klass,
430             const char *major,
431             const char *minor,
432             dbus_int32_t detail1,
433             dbus_int32_t detail2,
434             const char *type,
435             const void *val,
436             void (*append_variant) (DBusMessageIter *, const char *, const void *))
437 {
438   DBusConnection *bus = spi_global_app_data->bus;
439   char *path;
440   char *minor_dbus;
441
442   gchar *cname;
443   DBusMessage *sig;
444   DBusMessageIter iter;
445   
446   if (!klass) klass = "";
447   if (!major) major = "";
448   if (!minor) minor = "";
449   if (!type) type = "u";
450
451   if (!signal_is_needed (klass, major, minor))
452     return;
453
454   path =  spi_register_object_to_path (spi_global_register, G_OBJECT (obj));
455   g_return_if_fail (path != NULL);
456
457   /*
458    * This is very annoying, but as '-' isn't a legal signal
459    * name in D-Bus (Why not??!?) The names need converting
460    * on this side, and again on the client side.
461    */
462   cname = signal_name_to_dbus (major);
463   sig = dbus_message_new_signal(path, klass, cname);
464
465   dbus_message_iter_init_append(sig, &iter);
466
467   minor_dbus = adapt_minor_for_dbus (minor);
468   dbus_message_iter_append_basic(&iter, DBUS_TYPE_STRING, &minor_dbus);
469   g_free (minor_dbus);
470   dbus_message_iter_append_basic(&iter, DBUS_TYPE_INT32, &detail1);
471   dbus_message_iter_append_basic(&iter, DBUS_TYPE_INT32, &detail2);
472   append_variant (&iter, type, val);
473   spi_object_append_reference (&iter, spi_global_app_data->root);
474
475   dbus_connection_send(bus, sig, NULL);
476   dbus_message_unref(sig);
477
478   if (g_strcmp0 (cname, "ChildrenChanged") != 0)
479     spi_object_lease_if_needed (G_OBJECT (obj));
480
481   g_free(cname);
482   g_free (path);
483 }
484
485 /*---------------------------------------------------------------------------*/
486
487 /*
488  * The focus listener handles the ATK 'focus' signal and forwards it
489  * as the AT-SPI event, 'focus:'
490  */
491 static void
492 focus_tracker (AtkObject * accessible)
493 {
494   emit_event (accessible, ITF_EVENT_FOCUS, "focus", "", 0, 0,
495               DBUS_TYPE_INT32_AS_STRING, 0, append_basic);
496 }
497
498 /*---------------------------------------------------------------------------*/
499
500 #define PCHANGE "PropertyChange"
501
502 /* 
503  * This handler handles the following ATK signals and
504  * converts them to AT-SPI events:
505  *  
506  * Gtk:AtkObject:property-change -> object:property-change:(property-name)
507  *
508  * The property-name is part of the ATK property-change signal.
509  */
510 static gboolean
511 property_event_listener (GSignalInvocationHint * signal_hint,
512                          guint n_param_values,
513                          const GValue * param_values, gpointer data)
514 {
515   AtkObject *accessible;
516   AtkPropertyValues *values;
517
518   const gchar *pname = NULL;
519
520   AtkObject *otemp;
521   const gchar *s1;
522   gint i;
523
524   accessible = g_value_get_object (&param_values[0]);
525   values = (AtkPropertyValues *) g_value_get_pointer (&param_values[1]);
526
527   pname = values[0].property_name;
528
529   /* TODO Could improve this control statement by matching
530    * on only the end of the signal names,
531    */
532   if (strcmp (pname, "accessible-name") == 0)
533     {
534       s1 = atk_object_get_name (accessible);
535       if (s1 != NULL)
536         emit_event (accessible, ITF_EVENT_OBJECT, PCHANGE, pname, 0, 0,
537                     DBUS_TYPE_STRING_AS_STRING, s1, append_basic);
538     }
539   else if (strcmp (pname, "accessible-description") == 0)
540     {
541       s1 = atk_object_get_description (accessible);
542       if (s1 != NULL)
543         emit_event (accessible, ITF_EVENT_OBJECT, PCHANGE, pname, 0, 0,
544                     DBUS_TYPE_STRING_AS_STRING, s1, append_basic);
545     }
546   else if (strcmp (pname, "accessible-parent") == 0)
547     {
548       otemp = atk_object_get_parent (accessible);
549       if (otemp != NULL)
550         emit_event (accessible, ITF_EVENT_OBJECT, PCHANGE, pname, 0, 0,
551                     "(so)", otemp, append_object);
552     }
553   else if (strcmp (pname, "accessible-role") == 0)
554     {
555       i = atk_object_get_role (accessible);
556       emit_event (accessible, ITF_EVENT_OBJECT, PCHANGE, pname, 0, 0,
557                     DBUS_TYPE_UINT32_AS_STRING, GINT_TO_POINTER(i), append_basic);
558     }
559   else if (strcmp (pname, "accessible-table-summary") == 0)
560     {
561       otemp = atk_table_get_summary (ATK_TABLE (accessible));
562       if (otemp != NULL)
563         emit_event (accessible, ITF_EVENT_OBJECT, PCHANGE, pname, 0, 0,
564                     "(so)", otemp, append_object);
565     }
566   else if (strcmp (pname, "accessible-table-column-header") == 0)
567     {
568       i = g_value_get_int (&(values->new_value));
569       otemp = atk_table_get_column_header (ATK_TABLE (accessible), i);
570       if (otemp != NULL)
571         emit_event (accessible, ITF_EVENT_OBJECT, PCHANGE, pname, 0, 0,
572                     "(so)", otemp, append_object);
573     }
574   else if (strcmp (pname, "accessible-table-row-header") == 0)
575     {
576       i = g_value_get_int (&(values->new_value));
577       otemp = atk_table_get_row_header (ATK_TABLE (accessible), i);
578       if (otemp != NULL)
579         emit_event (accessible, ITF_EVENT_OBJECT, PCHANGE, pname, 0, 0,
580                     "(so)", otemp, append_object);
581     }
582   else if (strcmp (pname, "accessible-table-row-description") == 0)
583     {
584       i = g_value_get_int (&(values->new_value));
585       s1 = atk_table_get_row_description (ATK_TABLE (accessible), i);
586       emit_event (accessible, ITF_EVENT_OBJECT, PCHANGE, pname, 0, 0,
587                   DBUS_TYPE_STRING_AS_STRING, s1, append_basic);
588     }
589   else if (strcmp (pname, "accessible-table-column-description") == 0)
590     {
591       i = g_value_get_int (&(values->new_value));
592       s1 = atk_table_get_column_description (ATK_TABLE (accessible), i);
593       emit_event (accessible, ITF_EVENT_OBJECT, PCHANGE, pname, 0, 0,
594                   DBUS_TYPE_STRING_AS_STRING, s1, append_basic);
595     }
596   else if (strcmp (pname, "accessible-table-caption-object") == 0)
597     {
598       otemp = atk_table_get_caption (ATK_TABLE (accessible));
599       emit_event (accessible, ITF_EVENT_OBJECT, PCHANGE, pname, 0, 0,
600                   "(so)", otemp, append_object);
601     }
602   else
603     {
604       emit_event (accessible, ITF_EVENT_OBJECT, PCHANGE, pname, 0, 0,
605             DBUS_TYPE_INT32_AS_STRING, 0, append_basic);
606     }
607   return TRUE;
608 }
609
610 /*---------------------------------------------------------------------------*/
611
612 #define STATE_CHANGED "state-changed"
613
614 /*
615  * The state event listener handles 'Gtk:AtkObject:state-change' ATK signals
616  * and forwards them as object:state-changed:(param-name) AT-SPI events. Where
617  * the param-name is part of the ATK state-change signal.
618  */
619 static gboolean
620 state_event_listener (GSignalInvocationHint * signal_hint,
621                       guint n_param_values,
622                       const GValue * param_values, gpointer data)
623 {
624   AtkObject *accessible;
625   const gchar *pname;
626   guint detail1;
627
628   accessible = ATK_OBJECT (g_value_get_object (&param_values[0]));
629   pname = g_value_get_string (&param_values[1]);
630
631   detail1 = (g_value_get_boolean (&param_values[2])) ? 1 : 0;
632   emit_event (accessible, ITF_EVENT_OBJECT, STATE_CHANGED, pname, detail1, 0,
633               DBUS_TYPE_INT32_AS_STRING, 0, append_basic);
634
635   if (!g_strcmp0 (pname, "defunct") && detail1)
636     spi_register_deregister_object (spi_global_register, G_OBJECT (accessible),
637                                     TRUE);
638   return TRUE;
639 }
640
641 /*---------------------------------------------------------------------------*/
642
643 /*
644  * The window event listener handles the following ATK signals and forwards
645  * them as AT-SPI events:
646  *
647  * window:create     -> window:create
648  * window:destroy    -> window:destroy
649  * window:minimize   -> window:minimize
650  * window:maximize   -> window:maximize
651  * window:activate   -> window:activate
652  * window:deactivate -> window:deactivate
653  */
654 static gboolean
655 window_event_listener (GSignalInvocationHint * signal_hint,
656                        guint n_param_values,
657                        const GValue * param_values, gpointer data)
658 {
659   AtkObject *accessible;
660   GSignalQuery signal_query;
661   const gchar *name, *s;
662
663   g_signal_query (signal_hint->signal_id, &signal_query);
664   name = signal_query.signal_name;
665
666   accessible = ATK_OBJECT (g_value_get_object (&param_values[0]));
667   s = atk_object_get_name (accessible);
668   emit_event (accessible, ITF_EVENT_WINDOW, name, "", 0, 0,
669               DBUS_TYPE_STRING_AS_STRING, s, append_basic);
670
671   return TRUE;
672 }
673
674 /*---------------------------------------------------------------------------*/
675
676 /* 
677  * The document event listener handles the following ATK signals
678  * and converts them to AT-SPI events:
679  *
680  * Gtk:AtkDocument:load-complete ->  document:load-complete
681  * Gtk:AtkDocument:load-stopped  ->  document:load-stopped
682  * Gtk:AtkDocument:reload        ->  document:reload
683  */
684 static gboolean
685 document_event_listener (GSignalInvocationHint * signal_hint,
686                          guint n_param_values,
687                          const GValue * param_values, gpointer data)
688 {
689   AtkObject *accessible;
690   GSignalQuery signal_query;
691   const gchar *name, *s;
692
693   g_signal_query (signal_hint->signal_id, &signal_query);
694   name = signal_query.signal_name;
695
696   accessible = ATK_OBJECT (g_value_get_object (&param_values[0]));
697   s = atk_object_get_name (accessible);
698   emit_event (accessible, ITF_EVENT_DOCUMENT, name, "", 0, 0,
699               DBUS_TYPE_STRING_AS_STRING, s, append_basic);
700
701   return TRUE;
702 }
703
704 /*---------------------------------------------------------------------------*/
705
706 /*
707  * Signal handler for  "Gtk:AtkComponent:bounds-changed". Converts
708  * this to an AT-SPI event - "object:bounds-changed".
709  */
710 static gboolean
711 bounds_event_listener (GSignalInvocationHint * signal_hint,
712                        guint n_param_values,
713                        const GValue * param_values, gpointer data)
714 {
715   AtkObject *accessible;
716   AtkRectangle *atk_rect;
717   GSignalQuery signal_query;
718   const gchar *name;
719
720   g_signal_query (signal_hint->signal_id, &signal_query);
721   name = signal_query.signal_name;
722
723   accessible = ATK_OBJECT (g_value_get_object (&param_values[0]));
724
725   if (G_VALUE_HOLDS_BOXED (param_values + 1))
726   {
727     atk_rect = g_value_get_boxed (param_values + 1);
728
729     emit_event (accessible, ITF_EVENT_OBJECT, name, "", 0, 0,
730                 "(iiii)", atk_rect, append_rect);
731   }
732   return TRUE;
733 }
734
735 /*---------------------------------------------------------------------------*/
736
737 /* 
738  * Handles the ATK signal 'Gtk:AtkObject:active-descendant-changed' and 
739  * converts it to the AT-SPI signal - 'object:active-descendant-changed'.
740  *
741  */
742 static gboolean
743 active_descendant_event_listener (GSignalInvocationHint * signal_hint,
744                                   guint n_param_values,
745                                   const GValue * param_values, gpointer data)
746 {
747   AtkObject *accessible;
748   AtkObject *child;
749   GSignalQuery signal_query;
750   const gchar *name;
751   gint detail1;
752
753   g_signal_query (signal_hint->signal_id, &signal_query);
754   name = signal_query.signal_name;
755
756   accessible = ATK_OBJECT (g_value_get_object (&param_values[0]));
757   child = ATK_OBJECT (g_value_get_pointer (&param_values[1]));
758   g_return_val_if_fail (ATK_IS_OBJECT (child), TRUE);
759
760   detail1 = atk_object_get_index_in_parent (child);
761
762   emit_event (accessible, ITF_EVENT_OBJECT, name, "", detail1, 0,
763               "(so)", child, append_object);
764   return TRUE;
765 }
766
767 /*---------------------------------------------------------------------------*/
768
769 /* 
770  * Handles the ATK signal 'Gtk:AtkHypertext:link-selected' and
771  * converts it to the AT-SPI signal - 'object:link-selected'
772  *
773  */
774 static gboolean
775 link_selected_event_listener (GSignalInvocationHint * signal_hint,
776                               guint n_param_values,
777                               const GValue * param_values, gpointer data)
778 {
779   AtkObject *accessible;
780   GSignalQuery signal_query;
781   const gchar *name, *minor;
782   gint detail1 = 0;
783
784   g_signal_query (signal_hint->signal_id, &signal_query);
785   name = signal_query.signal_name;
786
787   accessible = ATK_OBJECT (g_value_get_object (&param_values[0]));
788   minor = g_quark_to_string (signal_hint->detail);
789
790   if (G_VALUE_TYPE (&param_values[1]) == G_TYPE_INT)
791     detail1 = g_value_get_int (&param_values[1]);
792
793   emit_event (accessible, ITF_EVENT_OBJECT, name, minor, detail1, 0,
794               DBUS_TYPE_INT32_AS_STRING, 0, append_basic);
795   return TRUE;
796 }
797
798 /*---------------------------------------------------------------------------*/
799
800 /* 
801  * Handles the ATK signal 'Gtk:AtkText:text-changed' and
802  * converts it to the AT-SPI signal - 'object:text-changed'
803  * This signal is deprecated by Gtk:AtkText:text-insert
804  * and Gtk:AtkText:text-remove
805  *
806  */
807 static gboolean
808 text_changed_event_listener (GSignalInvocationHint * signal_hint,
809                              guint n_param_values,
810                              const GValue * param_values, gpointer data)
811 {
812   AtkObject *accessible;
813   GSignalQuery signal_query;
814   const gchar *name, *minor;
815   gchar *selected;
816   gint detail1 = 0, detail2 = 0;
817
818   g_signal_query (signal_hint->signal_id, &signal_query);
819   name = signal_query.signal_name;
820
821   accessible = ATK_OBJECT (g_value_get_object (&param_values[0]));
822   minor = g_quark_to_string (signal_hint->detail);
823
824   if (G_VALUE_TYPE (&param_values[1]) == G_TYPE_INT)
825     detail1 = g_value_get_int (&param_values[1]);
826
827   if (G_VALUE_TYPE (&param_values[2]) == G_TYPE_INT)
828     detail2 = g_value_get_int (&param_values[2]);
829
830   selected =
831     atk_text_get_text (ATK_TEXT (accessible), detail1, detail1 + detail2);
832
833   emit_event (accessible, ITF_EVENT_OBJECT, name, minor, detail1, detail2,
834               DBUS_TYPE_STRING_AS_STRING, selected, append_basic);
835   g_free (selected);
836
837   return TRUE;
838 }
839
840 /* 
841  * Handles the ATK signal 'Gtk:AtkText:text-insert' and
842  * converts it to the AT-SPI signal - 'object:text-changed'
843  *
844  */
845 static gboolean
846 text_insert_event_listener (GSignalInvocationHint * signal_hint,
847                             guint n_param_values,
848                             const GValue * param_values, gpointer data)
849 {
850   AtkObject *accessible;
851   guint text_changed_signal_id;
852   GSignalQuery signal_query;
853   const gchar *name;
854   const gchar *minor_raw, *text;
855   gchar *minor;
856   gint detail1 = 0, detail2 = 0;
857
858   accessible = ATK_OBJECT (g_value_get_object (&param_values[0]));
859   /* Get signal name for 'Gtk:AtkText:text-changed' so
860    * we convert it to the AT-SPI signal - 'object:text-changed'
861    */
862   text_changed_signal_id = g_signal_lookup ("text-changed", G_OBJECT_TYPE (accessible));
863   g_signal_query (text_changed_signal_id, &signal_query);
864   name = signal_query.signal_name;
865
866
867   /* Add the insert and keep any detail coming from atk */
868   minor_raw = g_quark_to_string (signal_hint->detail);
869   if (minor_raw)
870     minor = g_strconcat ("insert:", minor_raw, NULL);
871   else
872     minor = g_strdup ("insert");
873
874   if (G_VALUE_TYPE (&param_values[1]) == G_TYPE_INT)
875     detail1 = g_value_get_int (&param_values[1]);
876
877   if (G_VALUE_TYPE (&param_values[2]) == G_TYPE_INT)
878     detail2 = g_value_get_int (&param_values[2]);
879
880   if (G_VALUE_TYPE (&param_values[3]) == G_TYPE_STRING)
881     text = g_value_get_string (&param_values[3]);
882
883   emit_event (accessible, ITF_EVENT_OBJECT, name, minor, detail1, detail2,
884               DBUS_TYPE_STRING_AS_STRING, text, append_basic);
885   g_free (minor);
886   return TRUE;
887 }
888
889 /* 
890  * Handles the ATK signal 'Gtk:AtkText:text-remove' and
891  * converts it to the AT-SPI signal - 'object:text-changed'
892  *
893  */
894 static gboolean
895 text_remove_event_listener (GSignalInvocationHint * signal_hint,
896                             guint n_param_values,
897                             const GValue * param_values, gpointer data)
898 {
899   AtkObject *accessible;
900   guint text_changed_signal_id;
901   GSignalQuery signal_query;
902   const gchar *name;
903   const gchar *minor_raw, *text;
904   gchar *minor;
905   gint detail1 = 0, detail2 = 0;
906
907   accessible = ATK_OBJECT (g_value_get_object (&param_values[0]));
908   /* Get signal name for 'Gtk:AtkText:text-changed' so
909    * we convert it to the AT-SPI signal - 'object:text-changed'
910    */
911   text_changed_signal_id = g_signal_lookup ("text-changed", G_OBJECT_TYPE (accessible));
912   g_signal_query (text_changed_signal_id, &signal_query);
913   name = signal_query.signal_name;
914
915   minor_raw = g_quark_to_string (signal_hint->detail);
916
917   /* Add the delete and keep any detail coming from atk */
918   if (minor_raw)
919     minor = g_strconcat ("delete:", minor_raw, NULL);
920   else
921     minor = g_strdup ("delete");
922
923   if (G_VALUE_TYPE (&param_values[1]) == G_TYPE_INT)
924     detail1 = g_value_get_int (&param_values[1]);
925
926   if (G_VALUE_TYPE (&param_values[2]) == G_TYPE_INT)
927     detail2 = g_value_get_int (&param_values[2]);
928
929   if (G_VALUE_TYPE (&param_values[3]) == G_TYPE_STRING)
930     text = g_value_get_string (&param_values[3]);
931
932   emit_event (accessible, ITF_EVENT_OBJECT, name, minor, detail1, detail2,
933               DBUS_TYPE_STRING_AS_STRING, text, append_basic);
934   g_free (minor);
935   return TRUE;
936 }
937
938
939 /*---------------------------------------------------------------------------*/
940
941 /* 
942  * Handles the ATK signal 'Gtk:AtkText:text-selection-changed' and
943  * converts it to the AT-SPI signal - 'object:text-selection-changed'
944  *
945  */
946 static gboolean
947 text_selection_changed_event_listener (GSignalInvocationHint * signal_hint,
948                                        guint n_param_values,
949                                        const GValue * param_values,
950                                        gpointer data)
951 {
952   AtkObject *accessible;
953   GSignalQuery signal_query;
954   const gchar *name, *minor;
955   gint detail1 = 0, detail2 = 0;
956
957   g_signal_query (signal_hint->signal_id, &signal_query);
958   name = signal_query.signal_name;
959
960   accessible = ATK_OBJECT (g_value_get_object (&param_values[0]));
961   minor = g_quark_to_string (signal_hint->detail);
962
963   if (G_VALUE_TYPE (&param_values[1]) == G_TYPE_INT)
964     detail1 = g_value_get_int (&param_values[1]);
965
966   if (G_VALUE_TYPE (&param_values[2]) == G_TYPE_INT)
967     detail2 = g_value_get_int (&param_values[2]);
968
969   emit_event (accessible, ITF_EVENT_OBJECT, name, minor, detail1, detail2,
970               DBUS_TYPE_STRING_AS_STRING, "", append_basic);
971   return TRUE;
972 }
973
974 /*---------------------------------------------------------------------------*/
975
976 /*
977  * Children changed signal converter and forwarder.
978  *
979  * Klass (Interface) org.a11y.atspi.Event.Object
980  * Major is the signal name.
981  * Minor is 'add' or 'remove'
982  * detail1 is the index.
983  * detail2 is 0.
984  * any_data is the child reference.
985  */
986 static gboolean
987 children_changed_event_listener (GSignalInvocationHint * signal_hint,
988                                  guint n_param_values,
989                                  const GValue * param_values, gpointer data)
990 {
991   GSignalQuery signal_query;
992   const gchar *name, *minor;
993   gint detail1 = 0, detail2 = 0;
994
995   AtkObject *accessible, *ao=NULL;
996   gpointer child;
997
998   g_signal_query (signal_hint->signal_id, &signal_query);
999   name = signal_query.signal_name;
1000
1001   accessible = ATK_OBJECT (g_value_get_object (&param_values[0]));
1002   minor = g_quark_to_string (signal_hint->detail);
1003
1004   detail1 = g_value_get_uint (param_values + 1);
1005   child = g_value_get_pointer (param_values + 2);
1006
1007   if (ATK_IS_OBJECT (child))
1008     {
1009       ao = ATK_OBJECT (child);
1010       emit_event (accessible, ITF_EVENT_OBJECT, name, minor, detail1, detail2,
1011                   "(so)", ao, append_object);
1012     }
1013   else if ((minor != NULL) && (strcmp (minor, "add") == 0))
1014     {
1015       ao = atk_object_ref_accessible_child (accessible, 
1016                                             detail1);
1017       emit_event (accessible, ITF_EVENT_OBJECT, name, minor, detail1, detail2,
1018                   "(so)", ao, append_object);
1019       g_object_unref (ao);
1020     }
1021   else
1022     {
1023       emit_event (accessible, ITF_EVENT_OBJECT, name, minor, detail1, detail2,
1024                   "(so)", ao, append_object);
1025     }
1026  
1027   return TRUE;
1028 }
1029
1030 /*---------------------------------------------------------------------------*/
1031
1032 /*
1033  * Generic signal converter and forwarder.
1034  *
1035  * Klass (Interface) org.a11y.atspi.Event.Object
1036  * Major is the signal name.
1037  * Minor is NULL.
1038  * detail1 is 0.
1039  * detail2 is 0.
1040  * any_data is NULL.
1041  */
1042 static gboolean
1043 generic_event_listener (GSignalInvocationHint * signal_hint,
1044                         guint n_param_values,
1045                         const GValue * param_values, gpointer data)
1046 {
1047   AtkObject *accessible;
1048   GSignalQuery signal_query;
1049   const gchar *name;
1050   int detail1 = 0, detail2 = 0;
1051
1052   g_signal_query (signal_hint->signal_id, &signal_query);
1053   name = signal_query.signal_name;
1054
1055   accessible = ATK_OBJECT (g_value_get_object (&param_values[0]));
1056
1057   if (n_param_values > 1 && G_VALUE_TYPE (&param_values[1]) == G_TYPE_INT)
1058     detail1 = g_value_get_int (&param_values[1]);
1059
1060   if (n_param_values > 2 && G_VALUE_TYPE (&param_values[2]) == G_TYPE_INT)
1061     detail2 = g_value_get_int (&param_values[2]);
1062
1063   emit_event (accessible, ITF_EVENT_OBJECT, name, "", detail1, detail2,
1064               DBUS_TYPE_INT32_AS_STRING, 0, append_basic);
1065   return TRUE;
1066 }
1067
1068 /*---------------------------------------------------------------------------*/
1069
1070 /*
1071  * Registers the provided function as a handler for the given signal name
1072  * and stores the signal id returned so that the function may be
1073  * de-registered later.
1074  */
1075 static guint
1076 add_signal_listener (GSignalEmissionHook listener, const char *signal_name)
1077 {
1078   guint id;
1079
1080   id = atk_add_global_event_listener (listener, signal_name);
1081
1082   if (id > 0) /* id == 0 is a failure */
1083     g_array_append_val (listener_ids, id);
1084
1085   return id;
1086 }
1087
1088 /*
1089  * Initialization for the signal handlers.
1090  *
1091  * Registers all required signal handlers.
1092  */
1093 void
1094 spi_atk_register_event_listeners (void)
1095 {
1096   /*
1097    * Kludge to make sure the Atk interface types are registered, otherwise
1098    * the AtkText signal handlers below won't get registered
1099    */
1100   GObject *ao = g_object_new (ATK_TYPE_OBJECT, NULL);
1101   AtkObject *bo = atk_no_op_object_new (ao);
1102   guint id = 0;
1103
1104   g_object_unref (G_OBJECT (bo));
1105   g_object_unref (ao);
1106
1107   if (listener_ids)
1108   {
1109     g_warning ("atk_bridge: spi_atk-register_event_listeners called multiple times");
1110     return;
1111   }
1112
1113   /* Register for focus event notifications, and register app with central registry  */
1114   listener_ids = g_array_sized_new (FALSE, TRUE, sizeof (guint), 16);
1115
1116   atk_bridge_focus_tracker_id = atk_add_focus_tracker (focus_tracker);
1117
1118   add_signal_listener (property_event_listener,
1119                        "Gtk:AtkObject:property-change");
1120
1121   /* window events: we tentative try to register using the old format */
1122   id = add_signal_listener (window_event_listener, "window:create");
1123
1124   if (id != 0)
1125     {
1126       /* If we are able to register using the old format, we assume
1127        * that the ATK implementor is managing window events without
1128        * AtkWindow. We can't use the opposite test because after
1129        * including AtkWindow on ATK you would be able to register to
1130        * that event, although the ATK implementor could or not use it.
1131        */
1132
1133       add_signal_listener (window_event_listener, "window:destroy");
1134       add_signal_listener (window_event_listener, "window:minimize");
1135       add_signal_listener (window_event_listener, "window:maximize");
1136       add_signal_listener (window_event_listener, "window:restore");
1137       add_signal_listener (window_event_listener, "window:activate");
1138       add_signal_listener (window_event_listener, "window:deactivate");
1139     }
1140   else
1141     {
1142       add_signal_listener (window_event_listener, "Atk:AtkWindow:create");
1143       add_signal_listener (window_event_listener, "Atk:AtkWindow:destroy");
1144       add_signal_listener (window_event_listener, "Atk:AtkWindow:minimize");
1145       add_signal_listener (window_event_listener, "Atk:AtkWindow:maximize");
1146       add_signal_listener (window_event_listener, "Atk:AtkWindow:restore");
1147       add_signal_listener (window_event_listener, "Atk:AtkWindow:activate");
1148       add_signal_listener (window_event_listener, "Atk:AtkWindow:deactivate");
1149     }
1150
1151   add_signal_listener (document_event_listener,
1152                        "Gtk:AtkDocument:load-complete");
1153   add_signal_listener (document_event_listener, "Gtk:AtkDocument:reload");
1154   add_signal_listener (document_event_listener,
1155                        "Gtk:AtkDocument:load-stopped");
1156   /* TODO Fake this event on the client side */
1157   add_signal_listener (state_event_listener, "Gtk:AtkObject:state-change");
1158   /* TODO */
1159   add_signal_listener (active_descendant_event_listener,
1160                        "Gtk:AtkObject:active-descendant-changed");
1161   add_signal_listener (bounds_event_listener,
1162                        "Gtk:AtkComponent:bounds-changed");
1163   add_signal_listener (text_selection_changed_event_listener,
1164                        "Gtk:AtkText:text-selection-changed");
1165   add_signal_listener (text_changed_event_listener,
1166                        "Gtk:AtkText:text-changed");
1167   add_signal_listener (text_insert_event_listener,
1168                        "Gtk:AtkText:text-insert");
1169   add_signal_listener (text_remove_event_listener,
1170                        "Gtk:AtkText:text-remove");
1171   add_signal_listener (link_selected_event_listener,
1172                        "Gtk:AtkHypertext:link-selected");
1173   add_signal_listener (generic_event_listener,
1174                        "Gtk:AtkObject:visible-data-changed");
1175   add_signal_listener (generic_event_listener,
1176                        "Gtk:AtkSelection:selection-changed");
1177   add_signal_listener (generic_event_listener,
1178                        "Gtk:AtkText:text-attributes-changed");
1179   add_signal_listener (generic_event_listener,
1180                        "Gtk:AtkText:text-caret-moved");
1181   add_signal_listener (generic_event_listener, "Gtk:AtkTable:row-inserted");
1182   add_signal_listener (generic_event_listener, "Gtk:AtkTable:row-reordered");
1183   add_signal_listener (generic_event_listener, "Gtk:AtkTable:row-deleted");
1184   add_signal_listener (generic_event_listener,
1185                        "Gtk:AtkTable:column-inserted");
1186   add_signal_listener (generic_event_listener,
1187                        "Gtk:AtkTable:column-reordered");
1188   add_signal_listener (generic_event_listener, "Gtk:AtkTable:column-deleted");
1189   add_signal_listener (generic_event_listener, "Gtk:AtkTable:model-changed");
1190   add_signal_listener (children_changed_event_listener, "Gtk:AtkObject:children-changed");
1191
1192 #if 0
1193   g_signal_connect (G_OBJECT (spi_global_app_data->root),
1194                     "children-changed::add",
1195                     (GCallback) toplevel_added_event_listener, NULL);
1196
1197   g_signal_connect (G_OBJECT (spi_global_app_data->root),
1198                     "children-changed::remove",
1199                     (GCallback) toplevel_removed_event_listener, NULL);
1200 #endif
1201
1202   /*
1203    * May add the following listeners to implement preemptive key listening for GTK+
1204    *
1205    * atk_add_global_event_listener (spi_atk_bridge_widgetkey_listener, "Gtk:GtkWidget:key-press-event");
1206    * atk_add_global_event_listener (spi_atk_bridge_widgetkey_listener, "Gtk:GtkWidget:key-release-event");
1207    */
1208   atk_bridge_key_event_listener_id =
1209     atk_add_key_event_listener (spi_atk_bridge_key_listener, NULL);
1210 }
1211
1212 /*---------------------------------------------------------------------------*/
1213
1214 /* 
1215  * De-registers all ATK signal handlers.
1216  */
1217 void
1218 spi_atk_deregister_event_listeners (void)
1219 {
1220   gint i;
1221   GArray *ids = listener_ids;
1222   listener_ids = NULL;
1223
1224   if (atk_bridge_focus_tracker_id)
1225   {
1226     atk_remove_focus_tracker (atk_bridge_focus_tracker_id);
1227     atk_bridge_focus_tracker_id = 0;
1228   }
1229
1230   if (ids)
1231     {
1232       for (i = 0; i < ids->len; i++)
1233         {
1234           atk_remove_global_event_listener (g_array_index (ids, guint, i));
1235         }
1236       g_array_free (ids, TRUE);
1237     }
1238
1239   if (atk_bridge_key_event_listener_id)
1240   {
1241     atk_remove_key_event_listener (atk_bridge_key_event_listener_id);
1242     atk_bridge_key_event_listener_id = 0;
1243   }
1244 }
1245
1246 /*---------------------------------------------------------------------------*/
1247
1248 /*
1249  * TODO This function seems out of place here.
1250  *
1251  * Emits fake deactivate signals on all top-level windows.
1252  * Used when shutting down AT-SPI, ensuring that all
1253  * windows have been removed on the client side.
1254  */
1255 void
1256 spi_atk_tidy_windows (void)
1257 {
1258   AtkObject *root;
1259   gint n_children;
1260   gint i;
1261
1262   root = atk_get_root ();
1263   n_children = atk_object_get_n_accessible_children (root);
1264   for (i = 0; i < n_children; i++)
1265     {
1266       AtkObject *child;
1267       AtkStateSet *stateset;
1268       const gchar *name;
1269
1270       child = atk_object_ref_accessible_child (root, i);
1271       stateset = atk_object_ref_state_set (child);
1272
1273       name = atk_object_get_name (child);
1274       if (atk_state_set_contains_state (stateset, ATK_STATE_ACTIVE))
1275         {
1276           emit_event (child, ITF_EVENT_WINDOW, "deactivate", NULL, 0, 0,
1277                       DBUS_TYPE_STRING_AS_STRING, name, append_basic);
1278         }
1279       g_object_unref (stateset);
1280
1281       emit_event (child, ITF_EVENT_WINDOW, "destroy", NULL, 0, 0,
1282                   DBUS_TYPE_STRING_AS_STRING, name, append_basic);
1283       g_object_unref (child);
1284     }
1285 }
1286
1287 gboolean
1288 spi_event_is_subtype (gchar **needle, gchar **haystack)
1289 {
1290   while (*haystack && **haystack)
1291     {
1292       if (g_strcmp0 (*needle, *haystack))
1293         return FALSE;
1294       needle++;
1295       haystack++;
1296     }
1297   return TRUE;
1298 }
1299
1300 /*END------------------------------------------------------------------------*/