2 * AT-SPI - Assistive Technology Service Provider Interface
3 * (Gnome Accessibility Project; http://developer.gnome.org/projects/gap)
5 * Copyright 2001 Sun Microsystems Inc.
7 * This library is free software; you can redistribute it and/or
8 * modify it under the terms of the GNU Library General Public
9 * License as published by the Free Software Foundation; either
10 * version 2 of the License, or (at your option) any later version.
12 * This library is distributed in the hope that it will be useful,
13 * but WITHOUT ANY WARRANTY; without even the implied warranty of
14 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
15 * Library General Public License for more details.
17 * You should have received a copy of the GNU Library General Public
18 * License along with this library; if not, write to the
19 * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
20 * Boston, MA 02111-1307, USA.
26 #include <libbonobo.h>
27 #include <orbit/orbit.h>
29 #include <atk/atkobject.h>
30 #include <atk/atknoopobject.h>
31 #include <libspi/Accessibility.h>
32 #include "accessible.h"
33 #include "application.h"
35 #include <bonobo-activation/bonobo-activation-register.h>
37 #undef SPI_BRIDGE_DEBUG
39 static CORBA_Environment ev;
40 static Accessibility_Registry registry;
41 static SpiApplication *this_app = NULL;
43 static void spi_atk_bridge_exit_func (void);
44 static void spi_atk_register_event_listeners (void);
45 static void spi_atk_bridge_focus_tracker (AtkObject *object);
46 static gboolean spi_atk_bridge_property_event_listener (GSignalInvocationHint *signal_hint,
48 const GValue *param_values,
51 spi_atk_bridge_window_event_listener (GSignalInvocationHint *signal_hint,
53 const GValue *param_values,
56 spi_atk_bridge_state_event_listener (GSignalInvocationHint *signal_hint,
58 const GValue *param_values,
60 static gboolean spi_atk_bridge_signal_listener (GSignalInvocationHint *signal_hint,
62 const GValue *param_values,
64 static gint spi_atk_bridge_key_listener (AtkKeyEventStruct *event,
67 /* For automatic libgnome init */
68 extern void gnome_accessibility_module_init (void);
69 extern void gnome_accessibility_module_shutdown (void);
71 static int atk_bridge_initialized = FALSE;
72 static guint atk_bridge_focus_tracker_id = 0;
73 static guint atk_bridge_key_event_listener_id = 0;
74 static GArray *listener_ids = NULL;
77 * These exported symbols are hooked by gnome-program
78 * to provide automatic module initialization and shutdown.
80 extern void gnome_accessibility_module_init (void);
81 extern void gnome_accessibility_module_shutdown (void);
84 atk_bridge_init (gint *argc, gchar **argv[])
88 if (atk_bridge_initialized)
92 atk_bridge_initialized = TRUE;
94 if (!bonobo_init (argc, argv ? *argv : NULL))
96 g_error ("Could not initialize Bonobo");
100 * We only want to enable the bridge for top level
101 * applications, we detect bonobo components by seeing
102 * if they were activated with the intention of extracting
103 * an impl. by IID - very solid.
105 if (bonobo_activation_iid_get ())
108 CORBA_exception_init(&ev);
110 registry = bonobo_activation_activate_from_id (
111 "OAFIID:Accessibility_Registry:1.0", 0, NULL, &ev);
113 if (ev._major != CORBA_NO_EXCEPTION)
115 g_error ("Accessibility app error: exception during "
116 "registry activation from id: %s\n",
117 CORBA_exception_id (&ev));
118 CORBA_exception_free (&ev);
121 if (registry == CORBA_OBJECT_NIL)
123 g_error ("Could not locate registry");
128 /* Create the accessible application server object */
130 this_app = spi_application_new (atk_get_root ());
132 fprintf (stderr, "About to register application\n");
134 Accessibility_Registry_registerApplication (registry,
135 BONOBO_OBJREF (this_app),
138 g_atexit (spi_atk_bridge_exit_func);
140 spi_atk_register_event_listeners ();
142 fprintf (stderr, "Application registered & listening\n");
148 gtk_module_init (gint *argc, gchar **argv[])
150 return atk_bridge_init (argc, argv);
154 add_signal_listener (const char *signal_name)
158 id = atk_add_global_event_listener (
159 spi_atk_bridge_signal_listener, signal_name);
161 g_array_append_val (listener_ids, id);
165 spi_atk_register_event_listeners (void)
168 * kludge to make sure the Atk interface types are registered, otherwise
169 * the AtkText signal handlers below won't get registered
172 GObject *ao = g_object_new (ATK_TYPE_OBJECT, NULL);
173 AtkObject *bo = atk_no_op_object_new (ao);
175 /* Register for focus event notifications, and register app with central registry */
177 listener_ids = g_array_sized_new (FALSE, TRUE, sizeof (guint), 16);
179 atk_bridge_focus_tracker_id = atk_add_focus_tracker (spi_atk_bridge_focus_tracker);
181 id = atk_add_global_event_listener (spi_atk_bridge_property_event_listener,
182 "Gtk:AtkObject:property-change");
183 g_array_append_val (listener_ids, id);
184 id = atk_add_global_event_listener (spi_atk_bridge_window_event_listener,
186 g_array_append_val (listener_ids, id);
187 id = atk_add_global_event_listener (spi_atk_bridge_window_event_listener,
189 g_array_append_val (listener_ids, id);
190 id = atk_add_global_event_listener (spi_atk_bridge_window_event_listener,
192 g_array_append_val (listener_ids, id);
193 id = atk_add_global_event_listener (spi_atk_bridge_window_event_listener,
195 g_array_append_val (listener_ids, id);
196 id = atk_add_global_event_listener (spi_atk_bridge_window_event_listener,
198 g_array_append_val (listener_ids, id);
199 id = atk_add_global_event_listener (spi_atk_bridge_window_event_listener,
201 g_array_append_val (listener_ids, id);
202 id = atk_add_global_event_listener (spi_atk_bridge_window_event_listener,
203 "window:deactivate");
204 g_array_append_val (listener_ids, id);
205 id = atk_add_global_event_listener (spi_atk_bridge_state_event_listener,
206 "Gtk:AtkObject:state-change");
207 g_array_append_val (listener_ids, id);
209 add_signal_listener ("Gtk:AtkObject:children-changed");
210 add_signal_listener ("Gtk:AtkObject:visible-data-changed");
211 add_signal_listener ("Gtk:AtkSelection:selection-changed");
212 add_signal_listener ("Gtk:AtkText:text-selection-changed");
213 add_signal_listener ("Gtk:AtkText:text-changed");
214 add_signal_listener ("Gtk:AtkText:text-caret-moved");
215 add_signal_listener ("Gtk:AtkTable:row-inserted");
216 add_signal_listener ("Gtk:AtkTable:row-reordered");
217 add_signal_listener ("Gtk:AtkTable:row-deleted");
218 add_signal_listener ("Gtk:AtkTable:column-inserted");
219 add_signal_listener ("Gtk:AtkTable:column-reordered");
220 add_signal_listener ("Gtk:AtkTable:column-deleted");
221 add_signal_listener ("Gtk:AtkTable:model-changed");
223 * May add the following listeners to implement preemptive key listening for GTK+
225 * atk_add_global_event_listener (spi_atk_bridge_widgetkey_listener, "Gtk:GtkWidget:key-press-event");
226 * atk_add_global_event_listener (spi_atk_bridge_widgetkey_listener, "Gtk:GtkWidget:key-release-event");
228 atk_bridge_key_event_listener_id = atk_add_key_event_listener (
229 spi_atk_bridge_key_listener, NULL);
231 g_object_unref (G_OBJECT (bo));
236 deregister_application (BonoboObject *app)
238 Accessibility_Registry_deregisterApplication (
239 registry, BONOBO_OBJREF (app), &ev);
241 registry = bonobo_object_release_unref (registry, &ev);
243 app = bonobo_object_unref (app);
247 spi_atk_bridge_exit_func (void)
249 BonoboObject *app = (BonoboObject *) this_app;
251 fprintf (stderr, "exiting bridge\n");
260 * FIXME: this may be incorrect for apps that do their own bonobo
261 * shutdown, until we can explicitly shutdown to get the ordering
264 if (!bonobo_is_initialized ())
266 fprintf (stderr, "Re-initializing bonobo\n");
267 g_assert (bonobo_init (0, NULL));
268 g_assert (bonobo_activate ());
271 deregister_application (app);
273 fprintf (stderr, "bridge exit func complete.\n");
275 if (g_getenv ("AT_BRIDGE_SHUTDOWN"))
277 g_assert (!bonobo_debug_shutdown ());
282 gnome_accessibility_module_init (void)
284 atk_bridge_init (NULL, NULL);
286 g_print("Atk Accessibilty bridge initialized\n");
290 gnome_accessibility_module_shutdown (void)
292 BonoboObject *app = (BonoboObject *) this_app;
294 GArray *ids = listener_ids;
296 if (!atk_bridge_initialized)
300 atk_bridge_initialized = FALSE;
303 g_print("Atk Accessibilty bridge shutdown\n");
306 atk_remove_focus_tracker (atk_bridge_focus_tracker_id);
308 for (i = 0; ids && i < ids->len; i++)
310 atk_remove_global_event_listener (g_array_index (ids, guint, i));
313 atk_remove_key_event_listener (atk_bridge_key_event_listener_id);
315 deregister_application (app);
319 spi_atk_bridge_focus_tracker (AtkObject *object)
321 SpiAccessible *source;
322 Accessibility_Event e;
324 source = spi_accessible_new (object);
327 e.source = BONOBO_OBJREF (source);
331 Accessibility_Registry_notifyEvent (registry, &e, &ev);
332 Accessibility_Accessible_unref (e.source, &ev);
334 CORBA_exception_free (&ev);
338 spi_atk_emit_eventv (GObject *gobject,
339 unsigned long detail1,
340 unsigned long detail2,
341 const char *format, ...)
344 Accessibility_Event e;
345 SpiAccessible *source;
347 #ifdef SPI_BRIDGE_DEBUG
351 va_start (args, format);
353 if (ATK_IS_IMPLEMENTOR (gobject))
355 aobject = atk_implementor_ref_accessible (ATK_IMPLEMENTOR (gobject));
356 source = spi_accessible_new (aobject);
357 g_object_unref (G_OBJECT (aobject));
359 else if (ATK_IS_OBJECT (gobject))
361 aobject = ATK_OBJECT (gobject);
362 source = spi_accessible_new (aobject);
368 g_error ("received property-change event from non-AtkImplementor");
373 e.type = g_strdup_vprintf (format, args);
374 e.source = BONOBO_OBJREF (source);
378 #ifdef SPI_BRIDGE_DEBUG
379 s = Accessibility_Accessible__get_name (BONOBO_OBJREF (source), &ev);
380 g_warning ("Emitting event '%s' (%lu, %lu) on %s",
381 e.type, e.detail1, e.detail2, s);
385 Accessibility_Registry_notifyEvent (registry, &e, &ev);
386 Accessibility_Accessible_unref (e.source, &ev);
388 CORBA_exception_free (&ev);
398 spi_atk_bridge_property_event_listener (GSignalInvocationHint *signal_hint,
399 guint n_param_values,
400 const GValue *param_values,
403 AtkPropertyValues *values;
406 #ifdef SPI_BRIDGE_DEBUG
407 GSignalQuery signal_query;
411 g_signal_query (signal_hint->signal_id, &signal_query);
412 name = signal_query.signal_name;
414 s2 = g_type_name (G_OBJECT_TYPE (g_value_get_object (param_values + 0)));
415 s = atk_object_get_name (ATK_OBJECT (g_value_get_object (param_values + 0)));
416 values = (AtkPropertyValues*) g_value_get_pointer (param_values + 1);
417 fprintf (stderr, "Received (property) signal %s:%s:%s from object %s (gail %s)\n",
418 g_type_name (signal_query.itype), name, values->property_name, s, s2);
422 gobject = g_value_get_object (param_values + 0);
423 values = (AtkPropertyValues*) g_value_get_pointer (param_values + 1);
425 spi_atk_emit_eventv (gobject, 0, 0, "object:property-change:%s", values->property_name);
431 spi_atk_bridge_state_event_listener (GSignalInvocationHint *signal_hint,
432 guint n_param_values,
433 const GValue *param_values,
437 gchar *property_name;
439 unsigned long detail1;
440 #ifdef SPI_BRIDGE_DEBUG
441 GSignalQuery signal_query;
444 g_signal_query (signal_hint->signal_id, &signal_query);
445 name = signal_query.signal_name;
446 fprintf (stderr, "Received (state) signal %s:%s\n",
447 g_type_name (signal_query.itype), name);
450 gobject = g_value_get_object (param_values + 0);
451 property_name = g_strdup (g_value_get_string (param_values + 1));
452 detail1 = (g_value_get_boolean (param_values + 2))
454 type = g_strdup_printf ("object:state-changed:%s", property_name);
455 spi_atk_emit_eventv (gobject,
459 g_free (property_name);
466 spi_init_keystroke_from_atk_key_event (Accessibility_DeviceEvent *keystroke,
467 AtkKeyEventStruct *event)
472 g_print ("event %c (%d)\n", (int) event->keyval, (int) event->keycode);
478 g_print ("WARNING: NULL key event!");
481 keystroke->id = (CORBA_long) event->keyval;
482 keystroke->hw_code = (CORBA_short) event->keycode;
483 keystroke->timestamp = (CORBA_unsigned_long) event->timestamp;
484 keystroke->modifiers = (CORBA_unsigned_short) (event->state & 0xFFFF);
487 keystroke->event_string = CORBA_string_dup (event->string);
488 keystroke->is_text = CORBA_TRUE;
492 keystroke->event_string = CORBA_string_dup ("");
493 keystroke->is_text = CORBA_FALSE;
497 case (ATK_KEY_EVENT_PRESS):
498 keystroke->type = Accessibility_KEY_PRESSED_EVENT;
500 case (ATK_KEY_EVENT_RELEASE):
501 keystroke->type = Accessibility_KEY_RELEASED_EVENT;
508 g_print ("key_event type %d; val=%d code=%d modifiers=%x name=%s is_text=%d, time=%lx\n",
509 (int) keystroke->type, (int) keystroke->id, (int) keystroke->hw_code,
510 (int) keystroke->modifiers,
511 keystroke->event_string, (int) keystroke->is_text, (unsigned long) keystroke->timestamp);
516 spi_atk_bridge_key_listener (AtkKeyEventStruct *event, gpointer data)
518 CORBA_boolean result;
519 Accessibility_DeviceEvent key_event;
520 Accessibility_DeviceEventController controller;
523 g_warning ("failure: pre-listener get dec\n");
526 Accessibility_Registry_getDeviceEventController (registry, &ev);
530 g_warning ("failure: no deviceeventcontroller found\n");
531 CORBA_exception_free (&ev);
537 spi_init_keystroke_from_atk_key_event (&key_event, event);
539 result = Accessibility_DeviceEventController_notifyListenersSync (
540 controller, &key_event, &ev);
542 CORBA_exception_free (&ev);
549 spi_atk_bridge_signal_listener (GSignalInvocationHint *signal_hint,
550 guint n_param_values,
551 const GValue *param_values,
555 GSignalQuery signal_query;
557 gint detail1 = 0, detail2 = 0;
558 #ifdef SPI_BRIDGE_DEBUG
562 g_signal_query (signal_hint->signal_id, &signal_query);
564 name = signal_query.signal_name;
566 #ifdef SPI_BRIDGE_DEBUG
567 s2 = g_type_name (G_OBJECT_TYPE (g_value_get_object (param_values + 0)));
568 s = atk_object_get_name (ATK_OBJECT (g_value_get_object (param_values + 0)));
569 fprintf (stderr, "Received signal %s:%s from object %s (gail %s)\n",
570 g_type_name (signal_query.itype), name, s ? s : "<NULL>" , s2);
573 gobject = g_value_get_object (param_values + 0);
574 if (G_VALUE_TYPE (param_values + 1) == G_TYPE_INT)
575 detail1 = g_value_get_int (param_values + 1);
576 if (G_VALUE_TYPE (param_values + 2) == G_TYPE_INT)
577 detail2 = g_value_get_int (param_values + 2);
579 spi_atk_emit_eventv (gobject, detail1, detail2, "object:%s", name);
587 spi_atk_bridge_window_event_listener (GSignalInvocationHint *signal_hint,
588 guint n_param_values,
589 const GValue *param_values,
593 GSignalQuery signal_query;
595 #ifdef SPI_BRIDGE_DEBUG
599 g_signal_query (signal_hint->signal_id, &signal_query);
601 name = signal_query.signal_name;
603 #ifdef SPI_BRIDGE_DEBUG
604 s2 = g_type_name (G_OBJECT_TYPE (g_value_get_object (param_values + 0)));
605 s = atk_object_get_name (ATK_OBJECT (g_value_get_object (param_values + 0)));
606 fprintf (stderr, "Received signal %s:%s from object %s (gail %s)\n",
607 g_type_name (signal_query.itype), name, s ? s : "<NULL>" , s2);
610 gobject = g_value_get_object (param_values + 0);
611 spi_atk_emit_eventv (gobject, 0, 0, "window:%s", name);