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