d19f4512da17ffb137b2cc58bdb1c5a360c7b712
[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 const void *
237 validate_for_dbus (const gint type,
238               const void *val)
239 {
240   switch (type)
241     {
242       case DBUS_TYPE_STRING:
243       case DBUS_TYPE_OBJECT_PATH:
244            if (!val)
245               return "";
246            else if (!g_utf8_validate (val, -1, NULL))
247              {
248                g_warning ("atk-bridge: Received bad UTF-8 string when emitting event");
249                return "";
250                }
251            else
252               return val;
253       default:
254            return val;
255     }
256 }
257
258 static void
259 append_basic (DBusMessageIter *iter,
260               const char *type,
261               const void *val)
262 {
263   DBusMessageIter sub;
264
265   dbus_message_iter_open_container(iter, DBUS_TYPE_VARIANT, type, &sub);
266
267     val = validate_for_dbus ((int) *type, val);
268     dbus_message_iter_append_basic(&sub, (int) *type, &val);
269
270   dbus_message_iter_close_container(iter, &sub);
271 }
272
273 static void
274 append_rect (DBusMessageIter *iter,
275              const char *type,
276              const void *val)
277 {
278   DBusMessageIter variant, sub;
279   const AtkRectangle *rect = (const AtkRectangle *) val;
280
281   dbus_message_iter_open_container(iter, DBUS_TYPE_VARIANT, type, &variant);
282
283     dbus_message_iter_open_container (&variant, DBUS_TYPE_STRUCT, NULL, &sub);
284
285       dbus_message_iter_append_basic (&sub, DBUS_TYPE_INT32, &(rect->x));
286       dbus_message_iter_append_basic (&sub, DBUS_TYPE_INT32, &(rect->y));
287       dbus_message_iter_append_basic (&sub, DBUS_TYPE_INT32, &(rect->width));
288       dbus_message_iter_append_basic (&sub, DBUS_TYPE_INT32, &(rect->height));
289
290     dbus_message_iter_close_container (&variant, &sub);
291
292   dbus_message_iter_close_container(iter, &variant);
293 }
294
295 static void
296 append_object (DBusMessageIter *iter,
297                const char *type,
298                const void *val)
299 {
300   spi_object_append_v_reference (iter, ATK_OBJECT (val));
301 }
302
303 static gchar *
304 signal_name_to_dbus (const gchar *s)
305 {
306   gchar *ret = g_strdup (s);
307   gchar *t;
308
309   if (!ret)
310     return NULL;
311   ret [0] = toupper (ret [0]);
312   while ((t = strchr (ret, '-')) != NULL)
313   {
314     memmove (t, t + 1, strlen (t));
315     *t = toupper (*t);
316   }
317   return ret;
318 }
319
320 /*
321  * Converts names of the form "active-descendant-changed" to
322  * "ActiveDescendantChanged"
323  */
324 static gchar *
325 ensure_proper_format (const char *name)
326 {
327   gchar *ret = (gchar *) g_malloc (strlen (name) * 2 + 2);
328   gchar *p = ret;
329   gboolean need_upper = TRUE;
330
331   if (!ret)
332     return NULL;
333   while (*name)
334     {
335       if (need_upper)
336         {
337           *p++ = toupper (*name);
338           need_upper = FALSE;
339         }
340       else if (*name == '-')
341         need_upper = TRUE;
342       else if (*name == ':')
343         {
344           need_upper = TRUE;
345           *p++ = *name;
346         }
347       else
348         *p++ = *name;
349       name++;
350     }
351   *p = '\0';
352   return ret;
353 }
354
355 static gboolean
356 signal_is_needed (const gchar *klass, const gchar *major, const gchar *minor)
357 {
358   gchar *data [4];
359   event_data *evdata;
360   gboolean ret = FALSE;
361   GList *list;
362
363   if (!spi_global_app_data->events_initialized)
364     return TRUE;
365
366   data [0] = ensure_proper_format (klass + 21);
367   data [1] = ensure_proper_format (major);
368   data [2] = ensure_proper_format (minor);
369   data [3] = NULL;
370
371   /* Hack: Always pass events that update the cache.
372    * TODO: FOr 2.2, have at-spi2-core define a special "cache listener" for
373    * this instead, so that we don't send these if no one is listening */
374   if (!g_strcmp0 (data [1], "ChildrenChanged") ||
375       !g_strcmp0 (data [1], "PropertyChange") ||
376       !g_strcmp0 (data [1], "StateChanged"))
377   {
378     g_free (data [2]);
379     g_free (data [1]);
380     g_free (data [0]);
381     return TRUE;
382   }
383
384   /* Hack: events such as "object::text-changed::insert:system" as
385      generated by Gecko */
386   data [2][strcspn (data [2], ":")] = '\0';
387   for (list = spi_global_app_data->events; list; list = list->next)
388     {
389       evdata = list->data;
390       if (spi_event_is_subtype (data, evdata->data))
391         {
392           ret = TRUE;
393           break;
394         }
395     }
396
397 #if 0
398   g_print("event: %s %s %s: %d\n", data[0], data[1], data[2], ret);
399 #endif
400   g_free (data [2]);
401   g_free (data [1]);
402   g_free (data [0]);
403   return ret;
404 }
405
406 /* Convert a : to a / so that listeners can use arg0path to match only
407  *  * the prefix */
408 static char *
409 adapt_minor_for_dbus (const char *source)
410 {
411   gchar *ret = g_strdup (source);
412   int i = strcspn (ret, ":");
413   if (ret[i] == ':')
414     ret[i] = '/';
415   return ret;
416 }
417
418 /*
419  * Emits an AT-SPI event.
420  * AT-SPI events names are split into three parts:
421  * class:major:minor
422  * This is mapped onto D-Bus events as:
423  * D-Bus Interface:Signal Name:Detail argument
424  *
425  * Marshals a basic type into the 'any_data' attribute of
426  * the AT-SPI event.
427  */
428 static void 
429 emit_event (AtkObject  *obj,
430             const char *klass,
431             const char *major,
432             const char *minor,
433             dbus_int32_t detail1,
434             dbus_int32_t detail2,
435             const char *type,
436             const void *val,
437             void (*append_variant) (DBusMessageIter *, const char *, const void *))
438 {
439   DBusConnection *bus = spi_global_app_data->bus;
440   char *path;
441   char *minor_dbus;
442
443   gchar *cname;
444   DBusMessage *sig;
445   DBusMessageIter iter;
446   
447   if (!klass) klass = "";
448   if (!major) major = "";
449   if (!minor) minor = "";
450   if (!type) type = "u";
451
452   if (!signal_is_needed (klass, major, minor))
453     return;
454
455   path =  spi_register_object_to_path (spi_global_register, G_OBJECT (obj));
456   g_return_if_fail (path != NULL);
457
458   /*
459    * This is very annoying, but as '-' isn't a legal signal
460    * name in D-Bus (Why not??!?) The names need converting
461    * on this side, and again on the client side.
462    */
463   cname = signal_name_to_dbus (major);
464   sig = dbus_message_new_signal(path, klass, cname);
465
466   dbus_message_iter_init_append(sig, &iter);
467
468   minor_dbus = adapt_minor_for_dbus (minor);
469   dbus_message_iter_append_basic(&iter, DBUS_TYPE_STRING, &minor_dbus);
470   g_free (minor_dbus);
471   dbus_message_iter_append_basic(&iter, DBUS_TYPE_INT32, &detail1);
472   dbus_message_iter_append_basic(&iter, DBUS_TYPE_INT32, &detail2);
473   append_variant (&iter, type, val);
474   spi_object_append_reference (&iter, spi_global_app_data->root);
475
476   dbus_connection_send(bus, sig, NULL);
477   dbus_message_unref(sig);
478
479   if (g_strcmp0 (cname, "ChildrenChanged") != 0)
480     spi_object_lease_if_needed (G_OBJECT (obj));
481
482   g_free(cname);
483   g_free (path);
484 }
485
486 /*---------------------------------------------------------------------------*/
487
488 /*
489  * The focus listener handles the ATK 'focus' signal and forwards it
490  * as the AT-SPI event, 'focus:'
491  */
492 static void
493 focus_tracker (AtkObject * accessible)
494 {
495   emit_event (accessible, ITF_EVENT_FOCUS, "focus", "", 0, 0,
496               DBUS_TYPE_INT32_AS_STRING, 0, append_basic);
497 }
498
499 /*---------------------------------------------------------------------------*/
500
501 #define PCHANGE "PropertyChange"
502
503 /* 
504  * This handler handles the following ATK signals and
505  * converts them to AT-SPI events:
506  *  
507  * Gtk:AtkObject:property-change -> object:property-change:(property-name)
508  *
509  * The property-name is part of the ATK property-change signal.
510  */
511 static gboolean
512 property_event_listener (GSignalInvocationHint * signal_hint,
513                          guint n_param_values,
514                          const GValue * param_values, gpointer data)
515 {
516   AtkObject *accessible;
517   AtkPropertyValues *values;
518
519   const gchar *pname = NULL;
520
521   AtkObject *otemp;
522   const gchar *s1;
523   gint i;
524
525   accessible = g_value_get_object (&param_values[0]);
526   values = (AtkPropertyValues *) g_value_get_pointer (&param_values[1]);
527
528   pname = values[0].property_name;
529
530   /* TODO Could improve this control statement by matching
531    * on only the end of the signal names,
532    */
533   if (strcmp (pname, "accessible-name") == 0)
534     {
535       s1 = atk_object_get_name (accessible);
536       if (s1 != NULL)
537         emit_event (accessible, ITF_EVENT_OBJECT, PCHANGE, pname, 0, 0,
538                     DBUS_TYPE_STRING_AS_STRING, s1, append_basic);
539     }
540   else if (strcmp (pname, "accessible-description") == 0)
541     {
542       s1 = atk_object_get_description (accessible);
543       if (s1 != NULL)
544         emit_event (accessible, ITF_EVENT_OBJECT, PCHANGE, pname, 0, 0,
545                     DBUS_TYPE_STRING_AS_STRING, s1, append_basic);
546     }
547   else if (strcmp (pname, "accessible-parent") == 0)
548     {
549       otemp = atk_object_get_parent (accessible);
550       if (otemp != NULL)
551         emit_event (accessible, ITF_EVENT_OBJECT, PCHANGE, pname, 0, 0,
552                     "(so)", otemp, append_object);
553     }
554   else if (strcmp (pname, "accessible-role") == 0)
555     {
556       i = atk_object_get_role (accessible);
557       emit_event (accessible, ITF_EVENT_OBJECT, PCHANGE, pname, 0, 0,
558                     DBUS_TYPE_UINT32_AS_STRING, GINT_TO_POINTER(i), append_basic);
559     }
560   else if (strcmp (pname, "accessible-table-summary") == 0)
561     {
562       otemp = atk_table_get_summary (ATK_TABLE (accessible));
563       if (otemp != NULL)
564         emit_event (accessible, ITF_EVENT_OBJECT, PCHANGE, pname, 0, 0,
565                     "(so)", otemp, append_object);
566     }
567   else if (strcmp (pname, "accessible-table-column-header") == 0)
568     {
569       i = g_value_get_int (&(values->new_value));
570       otemp = atk_table_get_column_header (ATK_TABLE (accessible), i);
571       if (otemp != NULL)
572         emit_event (accessible, ITF_EVENT_OBJECT, PCHANGE, pname, 0, 0,
573                     "(so)", otemp, append_object);
574     }
575   else if (strcmp (pname, "accessible-table-row-header") == 0)
576     {
577       i = g_value_get_int (&(values->new_value));
578       otemp = atk_table_get_row_header (ATK_TABLE (accessible), i);
579       if (otemp != NULL)
580         emit_event (accessible, ITF_EVENT_OBJECT, PCHANGE, pname, 0, 0,
581                     "(so)", otemp, append_object);
582     }
583   else if (strcmp (pname, "accessible-table-row-description") == 0)
584     {
585       i = g_value_get_int (&(values->new_value));
586       s1 = atk_table_get_row_description (ATK_TABLE (accessible), i);
587       emit_event (accessible, ITF_EVENT_OBJECT, PCHANGE, pname, 0, 0,
588                   DBUS_TYPE_STRING_AS_STRING, s1, append_basic);
589     }
590   else if (strcmp (pname, "accessible-table-column-description") == 0)
591     {
592       i = g_value_get_int (&(values->new_value));
593       s1 = atk_table_get_column_description (ATK_TABLE (accessible), i);
594       emit_event (accessible, ITF_EVENT_OBJECT, PCHANGE, pname, 0, 0,
595                   DBUS_TYPE_STRING_AS_STRING, s1, append_basic);
596     }
597   else if (strcmp (pname, "accessible-table-caption-object") == 0)
598     {
599       otemp = atk_table_get_caption (ATK_TABLE (accessible));
600       emit_event (accessible, ITF_EVENT_OBJECT, PCHANGE, pname, 0, 0,
601                   "(so)", otemp, append_object);
602     }
603   else
604     {
605       emit_event (accessible, ITF_EVENT_OBJECT, PCHANGE, pname, 0, 0,
606             DBUS_TYPE_INT32_AS_STRING, 0, append_basic);
607     }
608   return TRUE;
609 }
610
611 /*---------------------------------------------------------------------------*/
612
613 #define STATE_CHANGED "state-changed"
614
615 /*
616  * The state event listener handles 'Gtk:AtkObject:state-change' ATK signals
617  * and forwards them as object:state-changed:(param-name) AT-SPI events. Where
618  * the param-name is part of the ATK state-change signal.
619  */
620 static gboolean
621 state_event_listener (GSignalInvocationHint * signal_hint,
622                       guint n_param_values,
623                       const GValue * param_values, gpointer data)
624 {
625   AtkObject *accessible;
626   const gchar *pname;
627   guint detail1;
628
629   accessible = ATK_OBJECT (g_value_get_object (&param_values[0]));
630   pname = g_value_get_string (&param_values[1]);
631
632   detail1 = (g_value_get_boolean (&param_values[2])) ? 1 : 0;
633   emit_event (accessible, ITF_EVENT_OBJECT, STATE_CHANGED, pname, detail1, 0,
634               DBUS_TYPE_INT32_AS_STRING, 0, append_basic);
635
636   if (!g_strcmp0 (pname, "defunct") && detail1)
637     spi_register_deregister_object (spi_global_register, G_OBJECT (accessible),
638                                     TRUE);
639   return TRUE;
640 }
641
642 /*---------------------------------------------------------------------------*/
643
644 /*
645  * The window event listener handles the following ATK signals and forwards
646  * them as AT-SPI events:
647  *
648  * window:create     -> window:create
649  * window:destroy    -> window:destroy
650  * window:minimize   -> window:minimize
651  * window:maximize   -> window:maximize
652  * window:activate   -> window:activate
653  * window:deactivate -> window:deactivate
654  */
655 static gboolean
656 window_event_listener (GSignalInvocationHint * signal_hint,
657                        guint n_param_values,
658                        const GValue * param_values, gpointer data)
659 {
660   AtkObject *accessible;
661   GSignalQuery signal_query;
662   const gchar *name, *s;
663
664   g_signal_query (signal_hint->signal_id, &signal_query);
665   name = signal_query.signal_name;
666
667   accessible = ATK_OBJECT (g_value_get_object (&param_values[0]));
668   s = atk_object_get_name (accessible);
669   emit_event (accessible, ITF_EVENT_WINDOW, name, "", 0, 0,
670               DBUS_TYPE_STRING_AS_STRING, s, append_basic);
671
672   return TRUE;
673 }
674
675 /*---------------------------------------------------------------------------*/
676
677 /* 
678  * The document event listener handles the following ATK signals
679  * and converts them to AT-SPI events:
680  *
681  * Gtk:AtkDocument:load-complete ->  document:load-complete
682  * Gtk:AtkDocument:load-stopped  ->  document:load-stopped
683  * Gtk:AtkDocument:reload        ->  document:reload
684  */
685 static gboolean
686 document_event_listener (GSignalInvocationHint * signal_hint,
687                          guint n_param_values,
688                          const GValue * param_values, gpointer data)
689 {
690   AtkObject *accessible;
691   GSignalQuery signal_query;
692   const gchar *name, *s;
693
694   g_signal_query (signal_hint->signal_id, &signal_query);
695   name = signal_query.signal_name;
696
697   accessible = ATK_OBJECT (g_value_get_object (&param_values[0]));
698   s = atk_object_get_name (accessible);
699   emit_event (accessible, ITF_EVENT_DOCUMENT, name, "", 0, 0,
700               DBUS_TYPE_STRING_AS_STRING, s, append_basic);
701
702   return TRUE;
703 }
704
705 /*---------------------------------------------------------------------------*/
706
707 /*
708  * Signal handler for  "Gtk:AtkComponent:bounds-changed". Converts
709  * this to an AT-SPI event - "object:bounds-changed".
710  */
711 static gboolean
712 bounds_event_listener (GSignalInvocationHint * signal_hint,
713                        guint n_param_values,
714                        const GValue * param_values, gpointer data)
715 {
716   AtkObject *accessible;
717   AtkRectangle *atk_rect;
718   GSignalQuery signal_query;
719   const gchar *name;
720
721   g_signal_query (signal_hint->signal_id, &signal_query);
722   name = signal_query.signal_name;
723
724   accessible = ATK_OBJECT (g_value_get_object (&param_values[0]));
725
726   if (G_VALUE_HOLDS_BOXED (param_values + 1))
727   {
728     atk_rect = g_value_get_boxed (param_values + 1);
729
730     emit_event (accessible, ITF_EVENT_OBJECT, name, "", 0, 0,
731                 "(iiii)", atk_rect, append_rect);
732   }
733   return TRUE;
734 }
735
736 /*---------------------------------------------------------------------------*/
737
738 /* 
739  * Handles the ATK signal 'Gtk:AtkObject:active-descendant-changed' and 
740  * converts it to the AT-SPI signal - 'object:active-descendant-changed'.
741  *
742  */
743 static gboolean
744 active_descendant_event_listener (GSignalInvocationHint * signal_hint,
745                                   guint n_param_values,
746                                   const GValue * param_values, gpointer data)
747 {
748   AtkObject *accessible;
749   AtkObject *child;
750   GSignalQuery signal_query;
751   const gchar *name;
752   gint detail1;
753
754   g_signal_query (signal_hint->signal_id, &signal_query);
755   name = signal_query.signal_name;
756
757   accessible = ATK_OBJECT (g_value_get_object (&param_values[0]));
758   child = ATK_OBJECT (g_value_get_pointer (&param_values[1]));
759   g_return_val_if_fail (ATK_IS_OBJECT (child), TRUE);
760
761   detail1 = atk_object_get_index_in_parent (child);
762
763   emit_event (accessible, ITF_EVENT_OBJECT, name, "", detail1, 0,
764               "(so)", child, append_object);
765   return TRUE;
766 }
767
768 /*---------------------------------------------------------------------------*/
769
770 /* 
771  * Handles the ATK signal 'Gtk:AtkHypertext:link-selected' and
772  * converts it to the AT-SPI signal - 'object:link-selected'
773  *
774  */
775 static gboolean
776 link_selected_event_listener (GSignalInvocationHint * signal_hint,
777                               guint n_param_values,
778                               const GValue * param_values, gpointer data)
779 {
780   AtkObject *accessible;
781   GSignalQuery signal_query;
782   const gchar *name, *minor;
783   gint detail1 = 0;
784
785   g_signal_query (signal_hint->signal_id, &signal_query);
786   name = signal_query.signal_name;
787
788   accessible = ATK_OBJECT (g_value_get_object (&param_values[0]));
789   minor = g_quark_to_string (signal_hint->detail);
790
791   if (G_VALUE_TYPE (&param_values[1]) == G_TYPE_INT)
792     detail1 = g_value_get_int (&param_values[1]);
793
794   emit_event (accessible, ITF_EVENT_OBJECT, name, minor, detail1, 0,
795               DBUS_TYPE_INT32_AS_STRING, 0, append_basic);
796   return TRUE;
797 }
798
799 /*---------------------------------------------------------------------------*/
800
801 /* 
802  * Handles the ATK signal 'Gtk:AtkText:text-changed' and
803  * converts it to the AT-SPI signal - 'object:text-changed'
804  * This signal is deprecated by Gtk:AtkText:text-insert
805  * and Gtk:AtkText:text-remove
806  *
807  */
808 static gboolean
809 text_changed_event_listener (GSignalInvocationHint * signal_hint,
810                              guint n_param_values,
811                              const GValue * param_values, gpointer data)
812 {
813   AtkObject *accessible;
814   GSignalQuery signal_query;
815   const gchar *name, *minor;
816   gchar *selected;
817   gint detail1 = 0, detail2 = 0;
818
819   g_signal_query (signal_hint->signal_id, &signal_query);
820   name = signal_query.signal_name;
821
822   accessible = ATK_OBJECT (g_value_get_object (&param_values[0]));
823   minor = g_quark_to_string (signal_hint->detail);
824
825   if (G_VALUE_TYPE (&param_values[1]) == G_TYPE_INT)
826     detail1 = g_value_get_int (&param_values[1]);
827
828   if (G_VALUE_TYPE (&param_values[2]) == G_TYPE_INT)
829     detail2 = g_value_get_int (&param_values[2]);
830
831   selected =
832     atk_text_get_text (ATK_TEXT (accessible), detail1, detail1 + detail2);
833
834   emit_event (accessible, ITF_EVENT_OBJECT, name, minor, detail1, detail2,
835               DBUS_TYPE_STRING_AS_STRING, selected, append_basic);
836   g_free (selected);
837
838   return TRUE;
839 }
840
841 /* 
842  * Handles the ATK signal 'Gtk:AtkText:text-insert' and
843  * converts it to the AT-SPI signal - 'object:text-changed'
844  *
845  */
846 static gboolean
847 text_insert_event_listener (GSignalInvocationHint * signal_hint,
848                             guint n_param_values,
849                             const GValue * param_values, gpointer data)
850 {
851   AtkObject *accessible;
852   guint text_changed_signal_id;
853   GSignalQuery signal_query;
854   const gchar *name;
855   const gchar *minor_raw, *text;
856   gchar *minor;
857   gint detail1 = 0, detail2 = 0;
858
859   accessible = ATK_OBJECT (g_value_get_object (&param_values[0]));
860   /* Get signal name for 'Gtk:AtkText:text-changed' so
861    * we convert it to the AT-SPI signal - 'object:text-changed'
862    */
863   text_changed_signal_id = g_signal_lookup ("text-changed", G_OBJECT_TYPE (accessible));
864   g_signal_query (text_changed_signal_id, &signal_query);
865   name = signal_query.signal_name;
866
867
868   /* Add the insert and keep any detail coming from atk */
869   minor_raw = g_quark_to_string (signal_hint->detail);
870   if (minor_raw)
871     minor = g_strconcat ("insert:", minor_raw, NULL);
872   else
873     minor = g_strdup ("insert");
874
875   if (G_VALUE_TYPE (&param_values[1]) == G_TYPE_INT)
876     detail1 = g_value_get_int (&param_values[1]);
877
878   if (G_VALUE_TYPE (&param_values[2]) == G_TYPE_INT)
879     detail2 = g_value_get_int (&param_values[2]);
880
881   if (G_VALUE_TYPE (&param_values[3]) == G_TYPE_STRING)
882     text = g_value_get_string (&param_values[3]);
883
884   emit_event (accessible, ITF_EVENT_OBJECT, name, minor, detail1, detail2,
885               DBUS_TYPE_STRING_AS_STRING, text, append_basic);
886   g_free (minor);
887   return TRUE;
888 }
889
890 /* 
891  * Handles the ATK signal 'Gtk:AtkText:text-remove' and
892  * converts it to the AT-SPI signal - 'object:text-changed'
893  *
894  */
895 static gboolean
896 text_remove_event_listener (GSignalInvocationHint * signal_hint,
897                             guint n_param_values,
898                             const GValue * param_values, gpointer data)
899 {
900   AtkObject *accessible;
901   guint text_changed_signal_id;
902   GSignalQuery signal_query;
903   const gchar *name;
904   const gchar *minor_raw, *text;
905   gchar *minor;
906   gint detail1 = 0, detail2 = 0;
907
908   accessible = ATK_OBJECT (g_value_get_object (&param_values[0]));
909   /* Get signal name for 'Gtk:AtkText:text-changed' so
910    * we convert it to the AT-SPI signal - 'object:text-changed'
911    */
912   text_changed_signal_id = g_signal_lookup ("text-changed", G_OBJECT_TYPE (accessible));
913   g_signal_query (text_changed_signal_id, &signal_query);
914   name = signal_query.signal_name;
915
916   minor_raw = g_quark_to_string (signal_hint->detail);
917
918   /* Add the delete and keep any detail coming from atk */
919   if (minor_raw)
920     minor = g_strconcat ("delete:", minor_raw, NULL);
921   else
922     minor = g_strdup ("delete");
923
924   if (G_VALUE_TYPE (&param_values[1]) == G_TYPE_INT)
925     detail1 = g_value_get_int (&param_values[1]);
926
927   if (G_VALUE_TYPE (&param_values[2]) == G_TYPE_INT)
928     detail2 = g_value_get_int (&param_values[2]);
929
930   if (G_VALUE_TYPE (&param_values[3]) == G_TYPE_STRING)
931     text = g_value_get_string (&param_values[3]);
932
933   emit_event (accessible, ITF_EVENT_OBJECT, name, minor, detail1, detail2,
934               DBUS_TYPE_STRING_AS_STRING, text, append_basic);
935   g_free (minor);
936   return TRUE;
937 }
938
939
940 /*---------------------------------------------------------------------------*/
941
942 /* 
943  * Handles the ATK signal 'Gtk:AtkText:text-selection-changed' and
944  * converts it to the AT-SPI signal - 'object:text-selection-changed'
945  *
946  */
947 static gboolean
948 text_selection_changed_event_listener (GSignalInvocationHint * signal_hint,
949                                        guint n_param_values,
950                                        const GValue * param_values,
951                                        gpointer data)
952 {
953   AtkObject *accessible;
954   GSignalQuery signal_query;
955   const gchar *name, *minor;
956   gint detail1 = 0, detail2 = 0;
957
958   g_signal_query (signal_hint->signal_id, &signal_query);
959   name = signal_query.signal_name;
960
961   accessible = ATK_OBJECT (g_value_get_object (&param_values[0]));
962   minor = g_quark_to_string (signal_hint->detail);
963
964   if (G_VALUE_TYPE (&param_values[1]) == G_TYPE_INT)
965     detail1 = g_value_get_int (&param_values[1]);
966
967   if (G_VALUE_TYPE (&param_values[2]) == G_TYPE_INT)
968     detail2 = g_value_get_int (&param_values[2]);
969
970   emit_event (accessible, ITF_EVENT_OBJECT, name, minor, detail1, detail2,
971               DBUS_TYPE_STRING_AS_STRING, "", append_basic);
972   return TRUE;
973 }
974
975 /*---------------------------------------------------------------------------*/
976
977 /*
978  * Children changed signal converter and forwarder.
979  *
980  * Klass (Interface) org.a11y.atspi.Event.Object
981  * Major is the signal name.
982  * Minor is 'add' or 'remove'
983  * detail1 is the index.
984  * detail2 is 0.
985  * any_data is the child reference.
986  */
987 static gboolean
988 children_changed_event_listener (GSignalInvocationHint * signal_hint,
989                                  guint n_param_values,
990                                  const GValue * param_values, gpointer data)
991 {
992   GSignalQuery signal_query;
993   const gchar *name, *minor;
994   gint detail1 = 0, detail2 = 0;
995
996   AtkObject *accessible, *ao=NULL;
997   gpointer child;
998
999   g_signal_query (signal_hint->signal_id, &signal_query);
1000   name = signal_query.signal_name;
1001
1002   accessible = ATK_OBJECT (g_value_get_object (&param_values[0]));
1003   minor = g_quark_to_string (signal_hint->detail);
1004
1005   detail1 = g_value_get_uint (param_values + 1);
1006   child = g_value_get_pointer (param_values + 2);
1007
1008   if (ATK_IS_OBJECT (child))
1009     {
1010       ao = ATK_OBJECT (child);
1011       emit_event (accessible, ITF_EVENT_OBJECT, name, minor, detail1, detail2,
1012                   "(so)", ao, append_object);
1013     }
1014   else if ((minor != NULL) && (strcmp (minor, "add") == 0))
1015     {
1016       ao = atk_object_ref_accessible_child (accessible, 
1017                                             detail1);
1018       emit_event (accessible, ITF_EVENT_OBJECT, name, minor, detail1, detail2,
1019                   "(so)", ao, append_object);
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------------------------------------------------------------------------*/