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 gboolean spi_atk_bridge_idle_init (gpointer user_data);
46 static void spi_atk_bridge_focus_tracker (AtkObject *object);
47 static gboolean spi_atk_bridge_property_event_listener (GSignalInvocationHint *signal_hint,
49 const GValue *param_values,
52 spi_atk_bridge_window_event_listener (GSignalInvocationHint *signal_hint,
54 const GValue *param_values,
56 static gboolean spi_atk_bridge_signal_listener (GSignalInvocationHint *signal_hint,
58 const GValue *param_values,
60 static gint spi_atk_bridge_key_listener (AtkKeyEventStruct *event,
63 /* For automatic libgnome init */
64 extern void gnome_accessibility_module_init (void);
65 extern void gnome_accessibility_module_shutdown (void);
67 static int atk_bridge_initialized = FALSE;
68 static guint atk_bridge_focus_tracker_id = 0;
69 static guint atk_bridge_key_event_listener_id = 0;
70 static guint idle_init_id = 0;
71 static GArray *listener_ids = NULL;
74 * These exported symbols are hooked by gnome-program
75 * to provide automatic module initialization and shutdown.
77 extern void gnome_accessibility_module_init (void);
78 extern void gnome_accessibility_module_shutdown (void);
81 atk_bridge_init (gint *argc, gchar **argv[])
85 if (atk_bridge_initialized)
89 atk_bridge_initialized = TRUE;
91 if (!bonobo_init (argc, argv ? *argv : NULL))
93 g_error ("Could not initialize Bonobo");
97 * We only want to enable the bridge for top level
98 * applications, we detect bonobo components by seeing
99 * if they were activated with the intention of extracting
100 * an impl. by IID - very solid.
102 if (bonobo_activation_iid_get ())
105 CORBA_exception_init(&ev);
107 registry = bonobo_activation_activate_from_id (
108 "OAFIID:Accessibility_Registry:proto0.1", 0, NULL, &ev);
110 if (ev._major != CORBA_NO_EXCEPTION)
112 g_error ("Accessibility app error: exception during "
113 "registry activation from id: %s\n",
114 CORBA_exception_id (&ev));
115 CORBA_exception_free (&ev);
118 if (registry == CORBA_OBJECT_NIL)
120 g_error ("Could not locate registry");
125 /* Create the accessible application server object */
127 this_app = spi_application_new (atk_get_root ());
129 fprintf (stderr, "About to register application\n");
131 Accessibility_Registry_registerApplication (registry,
132 BONOBO_OBJREF (this_app),
135 g_atexit (spi_atk_bridge_exit_func);
137 idle_init_id = g_idle_add (spi_atk_bridge_idle_init, NULL);
143 gtk_module_init (gint *argc, gchar **argv[])
145 return atk_bridge_init (argc, argv);
149 spi_atk_bridge_idle_init (gpointer user_data)
153 spi_atk_register_event_listeners ();
155 fprintf (stderr, "Application registered & listening\n");
161 add_signal_listener (const char *signal_name)
165 id = atk_add_global_event_listener (
166 spi_atk_bridge_signal_listener, signal_name);
168 g_array_append_val (listener_ids, id);
172 spi_atk_register_event_listeners (void)
175 * kludge to make sure the Atk interface types are registered, otherwise
176 * the AtkText signal handlers below won't get registered
179 GObject *ao = g_object_new (ATK_TYPE_OBJECT, NULL);
180 AtkObject *bo = atk_no_op_object_new (ao);
182 /* Register for focus event notifications, and register app with central registry */
184 listener_ids = g_array_sized_new (FALSE, TRUE, sizeof (guint), 16);
186 atk_bridge_focus_tracker_id = atk_add_focus_tracker (spi_atk_bridge_focus_tracker);
188 id = atk_add_global_event_listener (spi_atk_bridge_property_event_listener,
189 "Gtk:AtkObject:property-change");
190 g_array_append_val (listener_ids, id);
191 id = atk_add_global_event_listener (spi_atk_bridge_window_event_listener,
193 g_array_append_val (listener_ids, id);
194 id = atk_add_global_event_listener (spi_atk_bridge_window_event_listener,
196 g_array_append_val (listener_ids, id);
197 id = atk_add_global_event_listener (spi_atk_bridge_window_event_listener,
199 g_array_append_val (listener_ids, id);
200 id = atk_add_global_event_listener (spi_atk_bridge_window_event_listener,
202 g_array_append_val (listener_ids, id);
203 id = atk_add_global_event_listener (spi_atk_bridge_window_event_listener,
205 g_array_append_val (listener_ids, id);
207 add_signal_listener ("Gtk:AtkObject:state-change");
208 add_signal_listener ("Gtk:AtkObject:children-changed");
209 add_signal_listener ("Gtk:AtkObject:visible-data-changed");
210 add_signal_listener ("Gtk:AtkSelection:selection-changed");
211 add_signal_listener ("Gtk:AtkText:text-selection-changed");
212 add_signal_listener ("Gtk:AtkText:text-changed");
213 add_signal_listener ("Gtk:AtkText:text-caret-moved");
214 add_signal_listener ("Gtk:AtkTable:row-inserted");
215 add_signal_listener ("Gtk:AtkTable:row-reordered");
216 add_signal_listener ("Gtk:AtkTable:row-deleted");
217 add_signal_listener ("Gtk:AtkTable:column-inserted");
218 add_signal_listener ("Gtk:AtkTable:column-reordered");
219 add_signal_listener ("Gtk:AtkTable:column-deleted");
220 add_signal_listener ("Gtk:AtkTable:model-changed");
222 * May add the following listeners to implement preemptive key listening for GTK+
224 * atk_add_global_event_listener (spi_atk_bridge_widgetkey_listener, "Gtk:GtkWidget:key-press-event");
225 * atk_add_global_event_listener (spi_atk_bridge_widgetkey_listener, "Gtk:GtkWidget:key-release-event");
227 atk_bridge_key_event_listener_id = atk_add_key_event_listener (
228 spi_atk_bridge_key_listener, NULL);
230 g_object_unref (G_OBJECT (bo));
235 deregister_application (BonoboObject *app)
237 Accessibility_Registry_deregisterApplication (
238 registry, BONOBO_OBJREF (app), &ev);
240 registry = bonobo_object_release_unref (registry, &ev);
242 app = bonobo_object_unref (app);
246 spi_atk_bridge_exit_func (void)
248 BonoboObject *app = (BonoboObject *) this_app;
250 fprintf (stderr, "exiting bridge\n");
259 * FIXME: this may be incorrect for apps that do their own bonobo
260 * shutdown, until we can explicitly shutdown to get the ordering
263 if (!bonobo_is_initialized ())
265 fprintf (stderr, "Re-initializing bonobo\n");
266 g_assert (bonobo_init (0, NULL));
267 g_assert (bonobo_activate ());
270 deregister_application (app);
272 fprintf (stderr, "bridge exit func complete.\n");
274 if (g_getenv ("AT_BRIDGE_SHUTDOWN"))
276 g_assert (!bonobo_debug_shutdown ());
281 gnome_accessibility_module_init (void)
283 atk_bridge_init (NULL, NULL);
285 g_print("Atk Accessibilty bridge initialized\n");
289 gnome_accessibility_module_shutdown (void)
291 BonoboObject *app = (BonoboObject *) this_app;
293 if (!atk_bridge_initialized)
297 atk_bridge_initialized = FALSE;
300 g_print("Atk Accessibilty bridge shutdown\n");
304 g_source_remove (idle_init_id);
310 GArray *ids = listener_ids;
313 atk_remove_focus_tracker (atk_bridge_focus_tracker_id);
315 for (i = 0; ids && i < ids->len; i++)
317 atk_remove_global_event_listener (g_array_index (ids, guint, i));
320 atk_remove_key_event_listener (atk_bridge_key_event_listener_id);
323 deregister_application (app);
327 spi_atk_bridge_focus_tracker (AtkObject *object)
329 SpiAccessible *source;
330 Accessibility_Event e;
332 source = spi_accessible_new (object);
335 e.source = BONOBO_OBJREF (source);
339 Accessibility_Registry_notifyEvent (registry, &e, &ev);
341 CORBA_exception_free (&ev);
345 spi_atk_emit_eventv (GObject *gobject,
346 unsigned long detail1,
347 unsigned long detail2,
348 const char *format, ...)
351 Accessibility_Event e;
352 SpiAccessible *source;
354 #ifdef SPI_BRIDGE_DEBUG
358 va_start (args, format);
360 if (ATK_IS_IMPLEMENTOR (gobject))
362 aobject = atk_implementor_ref_accessible (ATK_IMPLEMENTOR (gobject));
363 source = spi_accessible_new (aobject);
364 g_object_unref (G_OBJECT (aobject));
366 else if (ATK_IS_OBJECT (gobject))
368 aobject = ATK_OBJECT (gobject);
369 source = spi_accessible_new (aobject);
375 g_error ("received property-change event from non-AtkImplementor");
380 e.type = g_strdup_vprintf (format, args);
381 e.source = BONOBO_OBJREF (source);
385 #ifdef SPI_BRIDGE_DEBUG
386 s = Accessibility_Accessible__get_name (BONOBO_OBJREF (source), &ev);
387 g_warning ("Emitting event '%s' (%lu, %lu) on %s",
388 e.type, e.detail1, e.detail2, s);
392 Accessibility_Registry_notifyEvent (registry, &e, &ev);
394 CORBA_exception_free (&ev);
403 spi_atk_bridge_property_event_listener (GSignalInvocationHint *signal_hint,
404 guint n_param_values,
405 const GValue *param_values,
408 AtkPropertyValues *values;
411 #ifdef SPI_BRIDGE_DEBUG
412 GSignalQuery signal_query;
416 g_signal_query (signal_hint->signal_id, &signal_query);
417 name = signal_query.signal_name;
419 s2 = g_type_name (G_OBJECT_TYPE (g_value_get_object (param_values + 0)));
420 s = atk_object_get_name (ATK_OBJECT (g_value_get_object (param_values + 0)));
421 values = (AtkPropertyValues*) g_value_get_pointer (param_values + 1);
422 fprintf (stderr, "Received (property) signal %s:%s:%s from object %s (gail %s)\n",
423 g_type_name (signal_query.itype), name, values->property_name, s, s2);
427 gobject = g_value_get_object (param_values + 0);
428 values = (AtkPropertyValues*) g_value_get_pointer (param_values + 1);
430 spi_atk_emit_eventv (gobject, 0, 0, "object:property-change:%s", values->property_name);
435 #if THIS_WILL_EVER_BE_USED
437 spi_atk_bridge_state_event_listener (GSignalInvocationHint *signal_hint,
438 guint n_param_values,
439 const GValue *param_values,
443 AtkPropertyValues *values;
444 #ifdef SPI_BRIDGE_DEBUG
445 GSignalQuery signal_query;
448 g_signal_query (signal_hint->signal_id, &signal_query);
449 name = signal_query.signal_name;
450 fprintf (stderr, "Received (state) signal %s:%s\n",
451 g_type_name (signal_query.itype), name);
454 gobject = g_value_get_object (param_values + 0);
455 values = (AtkPropertyValues*) g_value_get_pointer (param_values + 1);
457 spi_atk_emit_eventv (gobject,
458 (unsigned long) values->old_value.data[0].v_ulong,
459 (unsigned long) values->new_value.data[0].v_ulong,
460 "object:%s:?", values->property_name);
467 spi_init_keystroke_from_atk_key_event (Accessibility_DeviceEvent *keystroke,
468 AtkKeyEventStruct *event)
473 g_print ("event %c (%d)\n", (int) event->keyval, (int) event->keycode);
479 g_print ("WARNING: NULL key event!");
482 keystroke->id = (CORBA_long) event->keyval;
483 keystroke->hw_code = (CORBA_short) event->keycode;
484 keystroke->timestamp = (CORBA_unsigned_long) event->timestamp;
485 keystroke->modifiers = (CORBA_unsigned_short) (event->state & 0xFFFF);
488 keystroke->event_string = CORBA_string_dup (event->string);
489 keystroke->is_text = CORBA_TRUE;
493 keystroke->event_string = CORBA_string_dup ("");
494 keystroke->is_text = CORBA_FALSE;
498 case (ATK_KEY_EVENT_PRESS):
499 keystroke->type = Accessibility_KEY_PRESSED;
501 case (ATK_KEY_EVENT_RELEASE):
502 keystroke->type = Accessibility_KEY_RELEASED;
509 g_print ("key_event type %d; val=%d code=%d modifiers=%x name=%s is_text=%d, time=%lx\n",
510 (int) keystroke->type, (int) keystroke->id, (int) keystroke->hw_code,
511 (int) keystroke->modifiers,
512 keystroke->event_string, (int) keystroke->is_text, (unsigned long) keystroke->timestamp);
517 spi_atk_bridge_key_listener (AtkKeyEventStruct *event, gpointer data)
519 CORBA_boolean result;
520 Accessibility_DeviceEvent key_event;
521 Accessibility_DeviceEventController controller =
522 Accessibility_Registry_getDeviceEventController (registry, &ev);
526 g_warning ("failure: no deviceeventcontroller found\n");
527 CORBA_exception_free (&ev);
533 spi_init_keystroke_from_atk_key_event (&key_event, event);
535 result = Accessibility_DeviceEventController_notifyListenersSync (
536 controller, &key_event, &ev);
538 CORBA_exception_free (&ev);
545 spi_atk_bridge_signal_listener (GSignalInvocationHint *signal_hint,
546 guint n_param_values,
547 const GValue *param_values,
551 GSignalQuery signal_query;
553 gint detail1 = 0, detail2 = 0;
554 #ifdef SPI_BRIDGE_DEBUG
558 g_signal_query (signal_hint->signal_id, &signal_query);
560 name = signal_query.signal_name;
562 #ifdef SPI_BRIDGE_DEBUG
563 s2 = g_type_name (G_OBJECT_TYPE (g_value_get_object (param_values + 0)));
564 s = atk_object_get_name (ATK_OBJECT (g_value_get_object (param_values + 0)));
565 fprintf (stderr, "Received signal %s:%s from object %s (gail %s)\n",
566 g_type_name (signal_query.itype), name, s, s2);
569 gobject = g_value_get_object (param_values + 0);
570 if (G_VALUE_TYPE (param_values + 1) == G_TYPE_INT)
571 detail1 = g_value_get_int (param_values + 1);
572 if (G_VALUE_TYPE (param_values + 2) == G_TYPE_INT)
573 detail2 = g_value_get_int (param_values + 2);
575 spi_atk_emit_eventv (gobject, detail1, detail2, "object:%s", name);
583 spi_atk_bridge_window_event_listener (GSignalInvocationHint *signal_hint,
584 guint n_param_values,
585 const GValue *param_values,
589 GSignalQuery signal_query;
591 #ifdef SPI_BRIDGE_DEBUG
595 g_signal_query (signal_hint->signal_id, &signal_query);
597 name = signal_query.signal_name;
599 #ifdef SPI_BRIDGE_DEBUG
600 s2 = g_type_name (G_OBJECT_TYPE (g_value_get_object (param_values + 0)));
601 s = atk_object_get_name (ATK_OBJECT (g_value_get_object (param_values + 0)));
602 fprintf (stderr, "Received signal %s:%s from object %s (gail %s)\n",
603 g_type_name (signal_query.itype), name, s, s2);
606 gobject = g_value_get_object (param_values + 0);
607 spi_atk_emit_eventv (gobject, 0, 0, "window:%s", name);