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