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,
51 static gboolean spi_atk_bridge_signal_listener (GSignalInvocationHint *signal_hint,
53 const GValue *param_values,
55 static gint spi_atk_bridge_key_listener (AtkKeyEventStruct *event,
58 /* For automatic libgnome init */
59 extern void gnome_accessibility_module_init (void);
60 extern void gnome_accessibility_module_shutdown (void);
62 static int atk_bridge_initialized = FALSE;
63 static guint atk_bridge_focus_tracker_id = 0;
64 static guint atk_bridge_key_event_listener_id = 0;
65 static guint idle_init_id = 0;
66 static GArray *listener_ids = NULL;
69 * These exported symbols are hooked by gnome-program
70 * to provide automatic module initialization and shutdown.
72 extern void gnome_accessibility_module_init (void);
73 extern void gnome_accessibility_module_shutdown (void);
76 atk_bridge_init (gint *argc, gchar **argv[])
80 if (atk_bridge_initialized)
84 atk_bridge_initialized = TRUE;
86 if (!bonobo_init (argc, argv ? *argv : NULL))
88 g_error ("Could not initialize Bonobo");
92 * We only want to enable the bridge for top level
93 * applications, we detect bonobo components by seeing
94 * if they were activated with the intention of extracting
95 * an impl. by IID - very solid.
97 if (bonobo_activation_iid_get ())
100 CORBA_exception_init(&ev);
102 registry = bonobo_activation_activate_from_id (
103 "OAFIID:Accessibility_Registry:proto0.1", 0, NULL, &ev);
105 if (ev._major != CORBA_NO_EXCEPTION)
107 g_error ("Accessibility app error: exception during "
108 "registry activation from id: %s\n",
109 CORBA_exception_id (&ev));
110 CORBA_exception_free (&ev);
113 if (registry == CORBA_OBJECT_NIL)
115 g_error ("Could not locate registry");
120 /* Create the accessible application server object */
122 this_app = spi_application_new (atk_get_root ());
124 fprintf (stderr, "About to register application\n");
126 Accessibility_Registry_registerApplication (registry,
127 BONOBO_OBJREF (this_app),
130 g_atexit (spi_atk_bridge_exit_func);
132 idle_init_id = g_idle_add (spi_atk_bridge_idle_init, NULL);
138 gtk_module_init (gint *argc, gchar **argv[])
140 return atk_bridge_init (argc, argv);
144 spi_atk_bridge_idle_init (gpointer user_data)
148 spi_atk_register_event_listeners ();
150 fprintf (stderr, "Application registered & listening\n");
156 add_signal_listener (const char *signal_name)
160 id = atk_add_global_event_listener (
161 spi_atk_bridge_signal_listener, signal_name);
163 g_array_append_val (listener_ids, id);
167 spi_atk_register_event_listeners (void)
170 * kludge to make sure the Atk interface types are registered, otherwise
171 * the AtkText signal handlers below won't get registered
174 GObject *ao = g_object_new (ATK_TYPE_OBJECT, NULL);
175 AtkObject *bo = atk_no_op_object_new (ao);
177 /* Register for focus event notifications, and register app with central registry */
179 listener_ids = g_array_sized_new (FALSE, TRUE, sizeof (guint), 16);
181 atk_bridge_focus_tracker_id = atk_add_focus_tracker (spi_atk_bridge_focus_tracker);
183 id = atk_add_global_event_listener (spi_atk_bridge_property_event_listener,
184 "Gtk:AtkObject:property-change");
185 g_array_append_val (listener_ids, id);
187 add_signal_listener ("Gtk:AtkObject:children-changed");
188 add_signal_listener ("Gtk:AtkObject:visible-data-changed");
189 add_signal_listener ("Gtk:AtkSelection:selection-changed");
190 add_signal_listener ("Gtk:AtkText:text-selection-changed");
191 add_signal_listener ("Gtk:AtkText:text-changed");
192 add_signal_listener ("Gtk:AtkText:text-caret-moved");
193 add_signal_listener ("Gtk:AtkTable:row-inserted");
194 add_signal_listener ("Gtk:AtkTable:row-reordered");
195 add_signal_listener ("Gtk:AtkTable:row-deleted");
196 add_signal_listener ("Gtk:AtkTable:column-inserted");
197 add_signal_listener ("Gtk:AtkTable:column-reordered");
198 add_signal_listener ("Gtk:AtkTable:column-deleted");
199 add_signal_listener ("Gtk:AtkTable:model-changed");
201 * May add the following listeners to implement preemptive key listening for GTK+
203 * atk_add_global_event_listener (spi_atk_bridge_widgetkey_listener, "Gtk:GtkWidget:key-press-event");
204 * atk_add_global_event_listener (spi_atk_bridge_widgetkey_listener, "Gtk:GtkWidget:key-release-event");
206 atk_bridge_key_event_listener_id = atk_add_key_event_listener (
207 spi_atk_bridge_key_listener, NULL);
209 g_object_unref (G_OBJECT (bo));
214 deregister_application (BonoboObject *app)
216 Accessibility_Registry_deregisterApplication (
217 registry, BONOBO_OBJREF (app), &ev);
219 registry = bonobo_object_release_unref (registry, &ev);
221 app = bonobo_object_unref (app);
225 spi_atk_bridge_exit_func (void)
227 BonoboObject *app = (BonoboObject *) this_app;
229 fprintf (stderr, "exiting bridge\n");
238 * FIXME: this may be incorrect for apps that do their own bonobo
239 * shutdown, until we can explicitly shutdown to get the ordering
242 if (!bonobo_is_initialized ())
244 fprintf (stderr, "Re-initializing bonobo\n");
245 g_assert (bonobo_init (0, NULL));
246 g_assert (bonobo_activate ());
249 deregister_application (app);
251 fprintf (stderr, "bridge exit func complete.\n");
253 if (g_getenv ("AT_BRIDGE_SHUTDOWN"))
255 g_assert (!bonobo_debug_shutdown ());
260 gnome_accessibility_module_init (void)
262 atk_bridge_init (NULL, NULL);
264 g_print("Atk Accessibilty bridge initialized\n");
268 gnome_accessibility_module_shutdown (void)
270 BonoboObject *app = (BonoboObject *) this_app;
272 if (!atk_bridge_initialized)
276 atk_bridge_initialized = FALSE;
279 g_print("Atk Accessibilty bridge shutdown\n");
283 g_source_remove (idle_init_id);
289 GArray *ids = listener_ids;
292 atk_remove_focus_tracker (atk_bridge_focus_tracker_id);
294 for (i = 0; ids && i < ids->len; i++)
296 atk_remove_global_event_listener (g_array_index (ids, guint, i));
299 atk_remove_key_event_listener (atk_bridge_key_event_listener_id);
302 deregister_application (app);
306 spi_atk_bridge_focus_tracker (AtkObject *object)
308 SpiAccessible *source;
309 Accessibility_Event e;
311 source = spi_accessible_new (object);
314 e.source = BONOBO_OBJREF (source);
318 Accessibility_Registry_notifyEvent (registry, &e, &ev);
320 CORBA_exception_free (&ev);
324 spi_atk_emit_eventv (GObject *gobject,
325 unsigned long detail1,
326 unsigned long detail2,
327 const char *format, ...)
330 Accessibility_Event e;
331 SpiAccessible *source;
333 #ifdef SPI_BRIDGE_DEBUG
337 va_start (args, format);
339 if (ATK_IS_IMPLEMENTOR (gobject))
341 aobject = atk_implementor_ref_accessible (ATK_IMPLEMENTOR (gobject));
342 source = spi_accessible_new (aobject);
343 g_object_unref (G_OBJECT (aobject));
345 else if (ATK_IS_OBJECT (gobject))
347 aobject = ATK_OBJECT (gobject);
348 source = spi_accessible_new (aobject);
354 g_error ("received property-change event from non-AtkImplementor");
359 e.type = g_strdup_vprintf (format, args);
360 e.source = BONOBO_OBJREF (source);
364 #ifdef SPI_BRIDGE_DEBUG
365 s = Accessibility_Accessible__get_name (BONOBO_OBJREF (source), &ev);
366 g_warning ("Emitting event '%s' (%lu, %lu) on %s",
367 e.type, e.detail1, e.detail2, s);
371 Accessibility_Registry_notifyEvent (registry, &e, &ev);
373 CORBA_exception_free (&ev);
382 spi_atk_bridge_property_event_listener (GSignalInvocationHint *signal_hint,
383 guint n_param_values,
384 const GValue *param_values,
387 AtkPropertyValues *values;
390 #ifdef SPI_BRIDGE_DEBUG
391 GSignalQuery signal_query;
395 g_signal_query (signal_hint->signal_id, &signal_query);
396 name = signal_query.signal_name;
398 s2 = g_type_name (G_OBJECT_TYPE (g_value_get_object (param_values + 0)));
399 s = atk_object_get_name (ATK_OBJECT (g_value_get_object (param_values + 0)));
400 values = (AtkPropertyValues*) g_value_get_pointer (param_values + 1);
401 fprintf (stderr, "Received (property) signal %s:%s:%s from object %s (gail %s)\n",
402 g_type_name (signal_query.itype), name, values->property_name, s, s2);
406 gobject = g_value_get_object (param_values + 0);
407 values = (AtkPropertyValues*) g_value_get_pointer (param_values + 1);
409 spi_atk_emit_eventv (gobject, 0, 0, "object:property-change:%s", values->property_name);
414 #if THIS_WILL_EVER_BE_USED
416 spi_atk_bridge_state_event_listener (GSignalInvocationHint *signal_hint,
417 guint n_param_values,
418 const GValue *param_values,
422 AtkPropertyValues *values;
423 #ifdef SPI_BRIDGE_DEBUG
424 GSignalQuery signal_query;
427 g_signal_query (signal_hint->signal_id, &signal_query);
428 name = signal_query.signal_name;
429 fprintf (stderr, "Received (state) signal %s:%s\n",
430 g_type_name (signal_query.itype), name);
433 gobject = g_value_get_object (param_values + 0);
434 values = (AtkPropertyValues*) g_value_get_pointer (param_values + 1);
436 spi_atk_emit_eventv (gobject,
437 (unsigned long) values->old_value.data[0].v_ulong,
438 (unsigned long) values->new_value.data[0].v_ulong,
439 "object:%s:?", values->property_name);
446 spi_init_keystroke_from_atk_key_event (Accessibility_DeviceEvent *keystroke,
447 AtkKeyEventStruct *event)
452 g_print ("event %c (%d)\n", (int) event->keyval, (int) event->keycode);
458 g_print ("WARNING: NULL key event!");
461 keystroke->id = (CORBA_long) event->keyval;
462 keystroke->hw_code = (CORBA_short) event->keycode;
463 keystroke->timestamp = (CORBA_unsigned_long) event->timestamp;
464 keystroke->modifiers = (CORBA_unsigned_short) (event->state & 0xFFFF);
467 keystroke->event_string = CORBA_string_dup (event->string);
468 keystroke->is_text = CORBA_TRUE;
472 keystroke->event_string = CORBA_string_dup ("");
473 keystroke->is_text = CORBA_FALSE;
477 case (ATK_KEY_EVENT_PRESS):
478 keystroke->type = Accessibility_KEY_PRESSED;
480 case (ATK_KEY_EVENT_RELEASE):
481 keystroke->type = Accessibility_KEY_RELEASED;
488 g_print ("key_event type %d; val=%d code=%d modifiers=%x name=%s is_text=%d, time=%lx\n",
489 (int) keystroke->type, (int) keystroke->id, (int) keystroke->hw_code,
490 (int) keystroke->modifiers,
491 keystroke->event_string, (int) keystroke->is_text, (unsigned long) keystroke->timestamp);
496 spi_atk_bridge_key_listener (AtkKeyEventStruct *event, gpointer data)
498 CORBA_boolean result;
499 Accessibility_DeviceEvent key_event;
500 Accessibility_DeviceEventController controller =
501 Accessibility_Registry_getDeviceEventController (registry, &ev);
505 g_warning ("failure: no deviceeventcontroller found\n");
506 CORBA_exception_free (&ev);
512 spi_init_keystroke_from_atk_key_event (&key_event, event);
514 result = Accessibility_DeviceEventController_notifyListenersSync (
515 controller, &key_event, &ev);
517 CORBA_exception_free (&ev);
524 spi_atk_bridge_signal_listener (GSignalInvocationHint *signal_hint,
525 guint n_param_values,
526 const GValue *param_values,
530 GSignalQuery signal_query;
532 gint detail1 = 0, detail2 = 0;
533 #ifdef SPI_BRIDGE_DEBUG
537 g_signal_query (signal_hint->signal_id, &signal_query);
539 name = signal_query.signal_name;
541 #ifdef SPI_BRIDGE_DEBUG
542 s2 = g_type_name (G_OBJECT_TYPE (g_value_get_object (param_values + 0)));
543 s = atk_object_get_name (ATK_OBJECT (g_value_get_object (param_values + 0)));
544 fprintf (stderr, "Received signal %s:%s from object %s (gail %s)\n",
545 g_type_name (signal_query.itype), name, s, s2);
548 gobject = g_value_get_object (param_values + 0);
549 if (G_VALUE_TYPE (param_values + 1) == G_TYPE_INT)
550 detail1 = g_value_get_int (param_values + 1);
551 if (G_VALUE_TYPE (param_values + 2) == G_TYPE_INT)
552 detail2 = g_value_get_int (param_values + 2);
554 spi_atk_emit_eventv (gobject, detail1, detail2, "object:%s", name);