2002-09-13 Michael Meeks <michael@ximian.com>
[platform/upstream/at-spi2-core.git] / atk-bridge / bridge.c
1 /*
2  * AT-SPI - Assistive Technology Service Provider Interface
3  * (Gnome Accessibility Project; http://developer.gnome.org/projects/gap)
4  *
5  * Copyright 2001, 2002 Sun Microsystems Inc.,
6  * Copyright 2001, 2002 Ximian, Inc.
7  *
8  * This library is free software; you can redistribute it and/or
9  * modify it under the terms of the GNU Library General Public
10  * License as published by the Free Software Foundation; either
11  * version 2 of the License, or (at your option) any later version.
12  *
13  * This library is distributed in the hope that it will be useful,
14  * but WITHOUT ANY WARRANTY; without even the implied warranty of
15  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
16  * Library General Public License for more details.
17  *
18  * You should have received a copy of the GNU Library General Public
19  * License along with this library; if not, write to the
20  * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
21  * Boston, MA 02111-1307, USA.
22  */
23
24 #include <stdio.h>
25 #include <stdlib.h>
26 #include <stdarg.h>
27 #include <libbonobo.h>
28 #include <orbit/orbit.h>
29 #include <atk/atk.h>
30 #include <atk/atkobject.h>
31 #include <atk/atknoopobject.h>
32 #include <libspi/Accessibility.h>
33 #include "accessible.h"
34 #include "application.h"
35
36 #include <bonobo-activation/bonobo-activation-register.h>
37
38 #undef SPI_BRIDGE_DEBUG
39
40 static CORBA_Environment ev;
41 static Accessibility_Registry registry = NULL;
42 static SpiApplication *this_app = NULL;
43 static gboolean registry_died = FALSE;
44
45 static Accessibility_Registry spi_atk_bridge_get_registry (void);
46 static void     spi_atk_bridge_exit_func               (void);
47 static void     spi_atk_register_event_listeners       (void);
48 static void     spi_atk_bridge_focus_tracker           (AtkObject             *object);
49 static void     spi_atk_bridge_register_application    (Accessibility_Registry registry);
50 static gboolean spi_atk_bridge_property_event_listener (GSignalInvocationHint *signal_hint,
51                                                         guint                  n_param_values,
52                                                         const GValue          *param_values,
53                                                         gpointer               data);
54 static gboolean
55 spi_atk_bridge_window_event_listener (GSignalInvocationHint *signal_hint,
56                                 guint n_param_values,
57                                 const GValue *param_values,
58                                 gpointer data);
59 static gboolean
60 spi_atk_bridge_state_event_listener (GSignalInvocationHint *signal_hint,
61                                      guint n_param_values,
62                                      const GValue *param_values,
63                                      gpointer data);
64 static gboolean spi_atk_bridge_signal_listener         (GSignalInvocationHint *signal_hint,
65                                                         guint                  n_param_values,
66                                                         const GValue          *param_values,
67                                                         gpointer               data);
68 static gint     spi_atk_bridge_key_listener            (AtkKeyEventStruct     *event,
69                                                         gpointer               data);
70
71 /* For automatic libgnome init */
72 extern void gnome_accessibility_module_init     (void);
73 extern void gnome_accessibility_module_shutdown (void);
74
75 static int     atk_bridge_initialized = FALSE;
76 static guint   atk_bridge_focus_tracker_id = 0;
77 static guint   atk_bridge_key_event_listener_id = 0;
78 static GArray *listener_ids = NULL;
79
80 /*
81  *   These exported symbols are hooked by gnome-program
82  * to provide automatic module initialization and shutdown.
83  */
84 extern void gnome_accessibility_module_init     (void);
85 extern void gnome_accessibility_module_shutdown (void);
86
87 static int
88 atk_bridge_init (gint *argc, gchar **argv[])
89 {
90   CORBA_Environment ev;
91
92   if (atk_bridge_initialized)
93     {
94       return 0;
95     }
96   atk_bridge_initialized = TRUE;
97
98   if (!bonobo_init (argc, argv ? *argv : NULL))
99     {
100       g_error ("Could not initialize Bonobo");
101     }
102
103   /*
104    *   We only want to enable the bridge for top level
105    * applications, we detect bonobo components by seeing
106    * if they were activated with the intention of extracting
107    * an impl. by IID - very solid.
108    */
109   if (bonobo_activation_iid_get ())
110           return 0;
111
112   CORBA_exception_init(&ev);
113
114   if (spi_atk_bridge_get_registry () == CORBA_OBJECT_NIL)
115     {
116       g_error ("Could not locate registry");
117     }
118
119   bonobo_activate ();
120
121   /* Create the accessible application server object */
122
123   this_app = spi_application_new (atk_get_root ());
124
125   fprintf (stderr, "About to register application\n");
126
127   spi_atk_bridge_register_application (spi_atk_bridge_get_registry ());
128   
129   g_atexit (spi_atk_bridge_exit_func);
130
131   fprintf (stderr, "Application registered & listening\n");
132
133   return 0;
134 }
135
136 static void
137 spi_atk_bridge_register_application (Accessibility_Registry registry)
138 {
139   Accessibility_Registry_registerApplication (spi_atk_bridge_get_registry (),
140                                               BONOBO_OBJREF (this_app),
141                                               &ev);
142   spi_atk_register_event_listeners ();
143 }
144
145 static Accessibility_Registry
146 spi_atk_bridge_get_registry ()
147 {
148   CORBA_Environment ev;
149
150   if (registry_died || (registry == NULL)) {
151           CORBA_exception_init (&ev);
152           if (registry_died) g_warning ("registry died! restarting...");
153           registry = bonobo_activation_activate_from_id (
154                   "OAFIID:Accessibility_Registry:1.0", 0, NULL, &ev);
155           
156           if (ev._major != CORBA_NO_EXCEPTION)
157           {
158                   g_error ("Accessibility app error: exception during "
159                            "registry activation from id: %s\n",
160                            CORBA_exception_id (&ev));
161                   CORBA_exception_free (&ev);
162           }
163           
164           if (registry_died && registry) {
165                   registry_died = FALSE;
166                   spi_atk_bridge_register_application (registry);
167           }
168   }
169   return registry;
170 }
171
172 int
173 gtk_module_init (gint *argc, gchar **argv[])
174 {
175         return atk_bridge_init (argc, argv);
176 }
177
178 static void
179 add_signal_listener (const char *signal_name)
180 {
181   guint id;
182
183   id = atk_add_global_event_listener (
184     spi_atk_bridge_signal_listener, signal_name);
185
186   g_array_append_val (listener_ids, id);
187 }
188
189 static void
190 spi_atk_register_event_listeners (void)
191 {
192   /*
193    * kludge to make sure the Atk interface types are registered, otherwise
194    * the AtkText signal handlers below won't get registered
195    */
196   guint      id;
197   GObject   *ao = g_object_new (ATK_TYPE_OBJECT, NULL);
198   AtkObject *bo = atk_no_op_object_new (ao);
199   
200   /* Register for focus event notifications, and register app with central registry  */
201
202   listener_ids = g_array_sized_new (FALSE, TRUE, sizeof (guint), 16);
203
204   atk_bridge_focus_tracker_id = atk_add_focus_tracker (spi_atk_bridge_focus_tracker);
205
206   id = atk_add_global_event_listener (spi_atk_bridge_property_event_listener,
207                                       "Gtk:AtkObject:property-change");
208   g_array_append_val (listener_ids, id);
209   id = atk_add_global_event_listener (spi_atk_bridge_window_event_listener,
210                                       "window:create");
211   g_array_append_val (listener_ids, id);
212   id = atk_add_global_event_listener (spi_atk_bridge_window_event_listener,
213                                       "window:destroy");
214   g_array_append_val (listener_ids, id);
215   id = atk_add_global_event_listener (spi_atk_bridge_window_event_listener,
216                                       "window:minimize");
217   g_array_append_val (listener_ids, id);
218   id = atk_add_global_event_listener (spi_atk_bridge_window_event_listener,
219                                       "window:maximize");
220   g_array_append_val (listener_ids, id);
221   id = atk_add_global_event_listener (spi_atk_bridge_window_event_listener,
222                                       "window:restore");
223   g_array_append_val (listener_ids, id);
224   id = atk_add_global_event_listener (spi_atk_bridge_window_event_listener,
225                                       "window:activate");
226   g_array_append_val (listener_ids, id);
227   id = atk_add_global_event_listener (spi_atk_bridge_window_event_listener,
228                                       "window:deactivate");
229   g_array_append_val (listener_ids, id);
230   id = atk_add_global_event_listener (spi_atk_bridge_state_event_listener,
231                                       "Gtk:AtkObject:state-change");
232   g_array_append_val (listener_ids, id);
233
234   add_signal_listener ("Gtk:AtkObject:children-changed");
235   add_signal_listener ("Gtk:AtkObject:visible-data-changed");
236   add_signal_listener ("Gtk:AtkSelection:selection-changed");
237   add_signal_listener ("Gtk:AtkText:text-selection-changed");
238   add_signal_listener ("Gtk:AtkText:text-changed");
239   add_signal_listener ("Gtk:AtkText:text-caret-moved");
240   add_signal_listener ("Gtk:AtkTable:row-inserted");
241   add_signal_listener ("Gtk:AtkTable:row-reordered");
242   add_signal_listener ("Gtk:AtkTable:row-deleted");
243   add_signal_listener ("Gtk:AtkTable:column-inserted");
244   add_signal_listener ("Gtk:AtkTable:column-reordered");
245   add_signal_listener ("Gtk:AtkTable:column-deleted");
246   add_signal_listener ("Gtk:AtkTable:model-changed");
247 /*
248  * May add the following listeners to implement preemptive key listening for GTK+
249  *
250  * atk_add_global_event_listener (spi_atk_bridge_widgetkey_listener, "Gtk:GtkWidget:key-press-event");
251  * atk_add_global_event_listener (spi_atk_bridge_widgetkey_listener, "Gtk:GtkWidget:key-release-event");
252  */
253   atk_bridge_key_event_listener_id = atk_add_key_event_listener (
254     spi_atk_bridge_key_listener, NULL);
255   
256   g_object_unref (G_OBJECT (bo));
257   g_object_unref (ao);
258 }
259
260 static void
261 deregister_application (BonoboObject *app)
262 {
263   Accessibility_Registry registry = spi_atk_bridge_get_registry ();     
264   Accessibility_Registry_deregisterApplication (registry, BONOBO_OBJREF (app), &ev);
265
266   registry = bonobo_object_release_unref (registry, &ev);
267   
268   app = bonobo_object_unref (app);
269 }
270
271 static void
272 spi_atk_bridge_exit_func (void)
273 {
274   BonoboObject *app = (BonoboObject *) this_app;
275
276   fprintf (stderr, "exiting bridge\n");
277
278   if (!app)
279     {
280       return;
281     }
282   this_app = NULL;
283
284   /*
285    *  FIXME: this may be incorrect for apps that do their own bonobo
286    *  shutdown, until we can explicitly shutdown to get the ordering
287    *  right.
288    */
289   if (!bonobo_is_initialized ())
290     {
291       fprintf (stderr, "Re-initializing bonobo\n");
292       g_assert (bonobo_init (0, NULL));
293       g_assert (bonobo_activate ());
294     }
295   
296   deregister_application (app);
297
298   fprintf (stderr, "bridge exit func complete.\n");
299
300   if (g_getenv ("AT_BRIDGE_SHUTDOWN"))
301     {
302       g_assert (!bonobo_debug_shutdown ());
303     }
304 }
305
306 void
307 gnome_accessibility_module_init (void)
308 {
309   atk_bridge_init (NULL, NULL);
310
311   g_print("Atk Accessibilty bridge initialized\n");
312 }
313
314 void
315 gnome_accessibility_module_shutdown (void)
316 {
317   BonoboObject *app = (BonoboObject *) this_app;
318   int     i;
319   GArray *ids = listener_ids;
320   
321   if (!atk_bridge_initialized)
322     {
323       return;
324     }
325   atk_bridge_initialized = FALSE;
326   this_app = NULL;
327
328   g_print("Atk Accessibilty bridge shutdown\n");
329
330   listener_ids = NULL;
331   atk_remove_focus_tracker (atk_bridge_focus_tracker_id);
332   
333   for (i = 0; ids && i < ids->len; i++)
334   {
335           atk_remove_global_event_listener (g_array_index (ids, guint, i));
336   }
337   
338   atk_remove_key_event_listener (atk_bridge_key_event_listener_id);
339
340   deregister_application (app);
341 }
342
343 static void
344 spi_atk_bridge_focus_tracker (AtkObject *object)
345 {
346   SpiAccessible *source;
347   Accessibility_Event e;
348
349   source = spi_accessible_new (object);
350
351   e.type = "focus:";
352   e.source = BONOBO_OBJREF (source);
353   e.detail1 = 0;
354   e.detail2 = 0;
355
356   Accessibility_Registry_notifyEvent (spi_atk_bridge_get_registry (), &e, &ev);
357   if (BONOBO_EX (&ev)) registry_died = TRUE;
358   
359   Accessibility_Accessible_unref (e.source, &ev);
360   
361   CORBA_exception_free (&ev);
362 }
363
364 static void
365 spi_atk_emit_eventv (GObject      *gobject,
366                      unsigned long detail1,
367                      unsigned long detail2,
368                      const char   *format, ...)
369 {
370   va_list             args;
371   Accessibility_Event e;
372   SpiAccessible      *source;
373   AtkObject          *aobject;
374 #ifdef SPI_BRIDGE_DEBUG
375   CORBA_string s;
376 #endif
377   
378   va_start (args, format);
379   
380   if (ATK_IS_IMPLEMENTOR (gobject))
381     {
382       aobject = atk_implementor_ref_accessible (ATK_IMPLEMENTOR (gobject));
383       source  = spi_accessible_new (aobject);
384       g_object_unref (G_OBJECT (aobject));
385     }
386   else if (ATK_IS_OBJECT (gobject))
387     {
388       aobject = ATK_OBJECT (gobject);
389       source  = spi_accessible_new (aobject);
390     }
391   else
392     {
393       aobject = NULL;
394       source  = NULL;
395       g_error ("received property-change event from non-AtkImplementor");
396     }
397
398   if (source != NULL)
399     {
400       e.type = g_strdup_vprintf (format, args);
401       e.source = BONOBO_OBJREF (source);
402       e.detail1 = detail1;
403       e.detail2 = detail2;
404
405 #ifdef SPI_BRIDGE_DEBUG
406       s = Accessibility_Accessible__get_name (BONOBO_OBJREF (source), &ev);
407       g_warning ("Emitting event '%s' (%lu, %lu) on %s",
408                  e.type, e.detail1, e.detail2, s);
409       CORBA_free (s);
410 #endif
411
412       Accessibility_Registry_notifyEvent (spi_atk_bridge_get_registry (), &e, &ev);
413 #ifdef SPI_BRIDGE_DEBUG
414       if (ev._major != CORBA_NO_EXCEPTION)
415               g_warning ("error emitting event %s, (%d) %s",
416                          e.type,
417                          ev._major,
418                          CORBA_exception_id(&ev));
419 #endif        
420       if (BONOBO_EX (&ev)) registry_died = TRUE;
421       Accessibility_Accessible_unref (e.source, &ev);
422
423       CORBA_exception_free (&ev);
424
425       g_free (e.type);
426     }
427
428   va_end (args);
429
430 }
431
432 static gboolean
433 spi_atk_bridge_property_event_listener (GSignalInvocationHint *signal_hint,
434                                         guint n_param_values,
435                                         const GValue *param_values,
436                                         gpointer data)
437 {
438   AtkPropertyValues *values;
439   GObject *gobject;
440
441 #ifdef SPI_BRIDGE_DEBUG
442   GSignalQuery signal_query;
443   const gchar *name;
444   const gchar *s, *s2;
445   
446   g_signal_query (signal_hint->signal_id, &signal_query);
447   name = signal_query.signal_name;
448
449   s2 = g_type_name (G_OBJECT_TYPE (g_value_get_object (param_values + 0)));
450   s = atk_object_get_name (ATK_OBJECT (g_value_get_object (param_values + 0)));
451   values = (AtkPropertyValues*) g_value_get_pointer (param_values + 1);
452   fprintf (stderr, "Received (property) signal %s:%s:%s from object %s (gail %s)\n",
453            g_type_name (signal_query.itype), name, values->property_name, s, s2);
454   
455 #endif
456
457   gobject = g_value_get_object (param_values + 0);
458   values = (AtkPropertyValues*) g_value_get_pointer (param_values + 1);
459
460   spi_atk_emit_eventv (gobject, 0, 0, "object:property-change:%s", values->property_name);
461
462   return TRUE;
463 }
464
465 static gboolean
466 spi_atk_bridge_state_event_listener (GSignalInvocationHint *signal_hint,
467                                      guint n_param_values,
468                                      const GValue *param_values,
469                                      gpointer data)
470 {
471   GObject *gobject;
472   gchar *property_name;
473   gchar *type;
474   unsigned long detail1;
475 #ifdef SPI_BRIDGE_DEBUG
476   GSignalQuery signal_query;
477   const gchar *name;
478   
479   g_signal_query (signal_hint->signal_id, &signal_query);
480   name = signal_query.signal_name;
481   fprintf (stderr, "Received (state) signal %s:%s\n",
482            g_type_name (signal_query.itype), name);
483 #endif
484
485   gobject = g_value_get_object (param_values + 0);
486   property_name = g_strdup (g_value_get_string (param_values + 1));
487   detail1 = (g_value_get_boolean (param_values + 2))
488     ? 1 : 0;
489   type = g_strdup_printf ("object:state-changed:%s", property_name);
490   spi_atk_emit_eventv (gobject, 
491                        detail1,
492                        0,
493                        type);
494   g_free (property_name);
495   g_free (type);
496   return TRUE;
497 }
498
499
500 static void
501 spi_init_keystroke_from_atk_key_event (Accessibility_DeviceEvent  *keystroke,
502                                        AtkKeyEventStruct          *event)
503 {
504 #ifdef SPI_DEBUG
505   if (event)
506     {
507       g_print ("event %c (%d)\n", (int) event->keyval, (int) event->keycode);
508     }
509   else
510 #endif
511   if (!event)
512     {
513       g_print ("WARNING: NULL key event!");
514     }
515   
516   keystroke->id        = (CORBA_long) event->keyval;
517   keystroke->hw_code   = (CORBA_short) event->keycode;
518   keystroke->timestamp = (CORBA_unsigned_long) event->timestamp;
519   keystroke->modifiers = (CORBA_unsigned_short) (event->state & 0xFFFF);
520   if (event->string)
521     {
522       keystroke->event_string = CORBA_string_dup (event->string);
523       keystroke->is_text = CORBA_TRUE;
524     }
525   else
526     {
527       keystroke->event_string = CORBA_string_dup ("");
528       keystroke->is_text = CORBA_FALSE;
529     }
530   switch (event->type)
531     {
532     case (ATK_KEY_EVENT_PRESS):
533       keystroke->type = Accessibility_KEY_PRESSED_EVENT;
534       break;
535     case (ATK_KEY_EVENT_RELEASE):
536       keystroke->type = Accessibility_KEY_RELEASED_EVENT;
537       break;
538     default:
539       keystroke->type = 0;
540       break;
541     }
542 #if 0  
543   g_print ("key_event type %d; val=%d code=%d modifiers=%x name=%s is_text=%d, time=%lx\n",
544            (int) keystroke->type, (int) keystroke->id, (int) keystroke->hw_code,
545            (int) keystroke->modifiers,
546            keystroke->event_string, (int) keystroke->is_text, (unsigned long) keystroke->timestamp);
547 #endif
548 }
549
550 static gint
551 spi_atk_bridge_key_listener (AtkKeyEventStruct *event, gpointer data)
552 {
553   CORBA_boolean             result;
554   Accessibility_DeviceEvent key_event;
555   Accessibility_DeviceEventController controller;
556         
557   if (BONOBO_EX (&ev))
558         g_warning ("failure: pre-listener get dec\n");
559
560   controller =
561     Accessibility_Registry_getDeviceEventController (
562             spi_atk_bridge_get_registry (), &ev);
563
564   if (BONOBO_EX (&ev))
565     {
566       g_warning ("failure: no deviceeventcontroller found\n");
567       CORBA_exception_free (&ev);
568       registry_died = TRUE;
569       result = FALSE;
570     }
571   else
572     {
573
574       spi_init_keystroke_from_atk_key_event (&key_event, event);
575
576       result = Accessibility_DeviceEventController_notifyListenersSync (
577         controller, &key_event, &ev);
578
579       bonobo_object_release_unref (controller, &ev);
580       CORBA_exception_free (&ev);
581     }
582
583   return result;
584 }
585
586 static gboolean
587 spi_atk_bridge_signal_listener (GSignalInvocationHint *signal_hint,
588                                 guint n_param_values,
589                                 const GValue *param_values,
590                                 gpointer data)
591 {
592   GObject *gobject;
593   GSignalQuery signal_query;
594   const gchar *name;
595   const gchar *detail;
596   
597   gint detail1 = 0, detail2 = 0;
598 #ifdef SPI_BRIDGE_DEBUG
599   const gchar *s, *s2;
600 #endif
601   
602   g_signal_query (signal_hint->signal_id, &signal_query);
603
604   name = signal_query.signal_name;
605   if (signal_hint->detail)
606     detail = g_quark_to_string (signal_hint->detail);
607   else
608     detail = NULL;
609
610 #ifdef SPI_BRIDGE_DEBUG
611   s2 = g_type_name (G_OBJECT_TYPE (g_value_get_object (param_values + 0)));
612   s = atk_object_get_name (ATK_OBJECT (g_value_get_object (param_values + 0)));
613   fprintf (stderr, "Received signal %s:%s detail: %s from object %s (gail %s)\n",
614            g_type_name (signal_query.itype), name, 
615                         detail ? detail : "<NULL>", s ? s : "<NULL>" , s2);
616 #endif
617
618   gobject = g_value_get_object (param_values + 0);
619   if (G_VALUE_TYPE (param_values + 1) == G_TYPE_INT)
620     detail1 = g_value_get_int (param_values + 1);
621   if (G_VALUE_TYPE (param_values + 2) == G_TYPE_INT)
622     detail2 = g_value_get_int (param_values + 2);
623   
624   if (detail)
625     spi_atk_emit_eventv (gobject, detail1, detail2, "object:%s:%s", name, detail);
626   else
627     spi_atk_emit_eventv (gobject, detail1, detail2, "object:%s", name);
628
629   return TRUE;
630 }
631
632 static gboolean
633 spi_atk_bridge_window_event_listener (GSignalInvocationHint *signal_hint,
634                                 guint n_param_values,
635                                 const GValue *param_values,
636                                 gpointer data)
637 {
638   GObject *gobject;
639   GSignalQuery signal_query;
640   const gchar *name;
641 #ifdef SPI_BRIDGE_DEBUG
642   const gchar *s, *s2;
643 #endif
644   
645   g_signal_query (signal_hint->signal_id, &signal_query);
646
647   name = signal_query.signal_name;
648
649 #ifdef SPI_BRIDGE_DEBUG
650   s2 = g_type_name (G_OBJECT_TYPE (g_value_get_object (param_values + 0)));
651   s = atk_object_get_name (ATK_OBJECT (g_value_get_object (param_values + 0)));
652   fprintf (stderr, "Received signal %s:%s from object %s (gail %s)\n",
653            g_type_name (signal_query.itype), name, s ? s : "<NULL>" , s2);
654 #endif
655
656   gobject = g_value_get_object (param_values + 0);
657   spi_atk_emit_eventv (gobject, 0, 0, "window:%s", name);
658
659   return TRUE;
660 }