2 * AT-SPI - Assistive Technology Service Provider Interface
3 * (Gnome Accessibility Project; http://developer.gnome.org/projects/gap)
5 * Copyright 2001, 2002, 2003 Sun Microsystems Inc.,
6 * Copyright 2001, 2002, 2003 Ximian, Inc.
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.
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.
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.
27 #include <libbonobo.h>
28 #include <orbit/orbit.h>
30 #include <atk/atkobject.h>
31 #include <atk/atknoopobject.h>
32 #include <libspi/Accessibility.h>
33 #include <libspi/spi-private.h>
34 #include "accessible.h"
35 #include "application.h"
37 #include <bonobo-activation/bonobo-activation-register.h>
39 #undef SPI_BRIDGE_DEBUG
41 #define DBG(a,b) if(_dbg>=(a))b
44 static CORBA_Environment ev;
45 static Accessibility_Registry registry = CORBA_OBJECT_NIL;
46 static Accessibility_DeviceEventController device_event_controller = CORBA_OBJECT_NIL;
47 static SpiApplication *this_app = NULL;
48 static gboolean registry_died = FALSE;
49 static gboolean atk_listeners_registered = FALSE;
50 static guint toplevel_handler;
53 static GQuark atk_quark_property_changed_name;
54 static GQuark atk_quark_property_changed_description;
55 static GQuark atk_quark_property_changed_parent;
56 static GQuark atk_quark_property_changed_role;
57 static GQuark atk_quark_property_changed_table_caption;
58 static GQuark atk_quark_property_changed_table_column_description;
59 static GQuark atk_quark_property_changed_table_row_description;
62 static guint atk_signal_text_changed;
63 static guint atk_signal_children_changed;
64 static guint atk_signal_active_descendant_changed;
67 static guint atk_signal_text_selection_changed;
68 static guint atk_signal_row_reordered;
69 static guint atk_signal_row_inserted;
70 static guint atk_signal_row_deleted;
71 static guint atk_signal_column_reordered;
72 static guint atk_signal_column_inserted;
73 static guint atk_signal_column_deleted;
76 static guint atk_signal_link_selected;
78 static Accessibility_Registry spi_atk_bridge_get_registry (void);
79 static void spi_atk_bridge_do_registration (void);
80 static void spi_atk_bridge_toplevel_added (AtkObject *object,
84 static void spi_atk_bridge_exit_func (void);
85 static void spi_atk_register_event_listeners (void);
86 static void spi_atk_bridge_focus_tracker (AtkObject *object);
87 static void spi_atk_bridge_register_application (Accessibility_Registry registry);
88 static gboolean spi_atk_bridge_property_event_listener (GSignalInvocationHint *signal_hint,
90 const GValue *param_values,
93 spi_atk_bridge_window_event_listener (GSignalInvocationHint *signal_hint,
95 const GValue *param_values,
98 spi_atk_bridge_state_event_listener (GSignalInvocationHint *signal_hint,
100 const GValue *param_values,
102 static gboolean spi_atk_bridge_signal_listener (GSignalInvocationHint *signal_hint,
103 guint n_param_values,
104 const GValue *param_values,
106 static gint spi_atk_bridge_key_listener (AtkKeyEventStruct *event,
109 /* For automatic libgnome init */
110 extern void gnome_accessibility_module_init (void);
111 extern void gnome_accessibility_module_shutdown (void);
113 static int atk_bridge_initialized = FALSE;
114 static guint atk_bridge_focus_tracker_id = 0;
115 static guint atk_bridge_key_event_listener_id = 0;
116 static GArray *listener_ids = NULL;
119 * These exported symbols are hooked by gnome-program
120 * to provide automatic module initialization and shutdown.
122 extern void gnome_accessibility_module_init (void);
123 extern void gnome_accessibility_module_shutdown (void);
126 spi_atk_bridge_init_event_type_consts ()
128 atk_signal_children_changed = g_signal_lookup ("children_changed",
130 atk_signal_text_changed = g_signal_lookup ("text_changed",
132 atk_signal_active_descendant_changed =
133 g_signal_lookup ("active_descendant_changed",
135 atk_signal_link_selected = g_signal_lookup ("link_selected",
140 atk_bridge_init (gint *argc, gchar **argv[])
142 const char *debug_env_string = g_getenv ("AT_SPI_DEBUG");
144 if (atk_bridge_initialized)
148 atk_bridge_initialized = TRUE;
150 if (debug_env_string)
151 _dbg = (int) g_ascii_strtod (debug_env_string, NULL);
153 if (!bonobo_init (argc, argv ? *argv : NULL))
155 g_error ("Could not initialize Bonobo");
159 * We only want to enable the bridge for top level
160 * applications, we detect bonobo components by seeing
161 * if they were activated with the intention of extracting
162 * an impl. by IID - very solid.
164 if (bonobo_activation_iid_get ())
166 DBG (1, g_message ("Found Bonobo component\n"));
167 toplevel_handler = g_signal_connect (atk_get_root (),
168 "children-changed::add",
169 (GCallback) spi_atk_bridge_toplevel_added,
174 spi_atk_bridge_do_registration ();
177 spi_atk_bridge_init_event_type_consts ();
184 spi_atk_bridge_do_registration (void)
186 CORBA_Environment ev;
188 CORBA_exception_init(&ev);
190 if (spi_atk_bridge_get_registry () == CORBA_OBJECT_NIL)
192 g_error ("Could not locate registry");
197 /* Create the accessible application server object */
199 this_app = spi_application_new (atk_get_root ());
201 DBG (1, g_message ("About to register application\n"));
203 spi_atk_bridge_register_application (spi_atk_bridge_get_registry ());
205 g_atexit (spi_atk_bridge_exit_func);
207 DBG (1, g_message ("Application registered & listening\n"));
212 spi_atk_bridge_toplevel_added (AtkObject *object,
216 g_signal_handler_disconnect (object, toplevel_handler);
217 spi_atk_bridge_do_registration ();
221 spi_atk_bridge_register_application (Accessibility_Registry registry)
223 Accessibility_Registry_registerApplication (spi_atk_bridge_get_registry (),
224 BONOBO_OBJREF (this_app),
226 spi_atk_register_event_listeners ();
229 static Accessibility_Registry
230 spi_atk_bridge_get_registry (void)
232 CORBA_Environment ev;
234 if (registry_died || (registry == NULL)) {
235 CORBA_exception_init (&ev);
237 DBG (1, g_warning ("registry died! restarting..."));
238 registry = bonobo_activation_activate_from_id (
239 "OAFIID:Accessibility_Registry:1.0", 0, NULL, &ev);
241 if (ev._major != CORBA_NO_EXCEPTION)
243 g_error ("Accessibility app error: exception during "
244 "registry activation from id: %s\n",
245 CORBA_exception_id (&ev));
246 CORBA_exception_free (&ev);
249 if (registry_died && registry) {
250 registry_died = FALSE;
251 spi_atk_bridge_register_application (registry);
257 static Accessibility_DeviceEventController
258 spi_atk_bridget_get_dec (void)
260 CORBA_Environment ev;
262 if (device_event_controller != CORBA_OBJECT_NIL)
264 if (ORBit_small_get_connection_status (device_event_controller)
265 == ORBIT_CONNECTION_CONNECTED)
266 return device_event_controller;
269 CORBA_exception_init (&ev);
271 device_event_controller =
272 Accessibility_Registry_getDeviceEventController (
273 spi_atk_bridge_get_registry (), &ev);
277 g_warning ("failure: no deviceeventcontroller found\n");
278 registry_died = TRUE;
279 device_event_controller = CORBA_OBJECT_NIL;
282 return device_event_controller;
286 gtk_module_init (gint *argc, gchar **argv[])
288 return atk_bridge_init (argc, argv);
292 add_signal_listener (const char *signal_name)
296 id = atk_add_global_event_listener (
297 spi_atk_bridge_signal_listener, signal_name);
299 g_array_append_val (listener_ids, id);
303 spi_atk_register_event_listeners (void)
306 * kludge to make sure the Atk interface types are registered, otherwise
307 * the AtkText signal handlers below won't get registered
310 GObject *ao = g_object_new (ATK_TYPE_OBJECT, NULL);
311 AtkObject *bo = atk_no_op_object_new (ao);
314 if (atk_listeners_registered) return;
316 atk_listeners_registered = TRUE;
318 /* Register for focus event notifications, and register app with central registry */
320 listener_ids = g_array_sized_new (FALSE, TRUE, sizeof (guint), 16);
322 atk_bridge_focus_tracker_id = atk_add_focus_tracker (spi_atk_bridge_focus_tracker);
324 id = atk_add_global_event_listener (spi_atk_bridge_property_event_listener,
325 "Gtk:AtkObject:property-change");
326 g_array_append_val (listener_ids, id);
327 id = atk_add_global_event_listener (spi_atk_bridge_window_event_listener,
329 g_array_append_val (listener_ids, id);
330 id = atk_add_global_event_listener (spi_atk_bridge_window_event_listener,
332 g_array_append_val (listener_ids, id);
333 id = atk_add_global_event_listener (spi_atk_bridge_window_event_listener,
335 g_array_append_val (listener_ids, id);
336 id = atk_add_global_event_listener (spi_atk_bridge_window_event_listener,
338 g_array_append_val (listener_ids, id);
339 id = atk_add_global_event_listener (spi_atk_bridge_window_event_listener,
341 g_array_append_val (listener_ids, id);
342 id = atk_add_global_event_listener (spi_atk_bridge_window_event_listener,
344 g_array_append_val (listener_ids, id);
345 id = atk_add_global_event_listener (spi_atk_bridge_window_event_listener,
346 "window:deactivate");
347 g_array_append_val (listener_ids, id);
348 id = atk_add_global_event_listener (spi_atk_bridge_state_event_listener,
349 "Gtk:AtkObject:state-change");
350 g_array_append_val (listener_ids, id);
352 add_signal_listener ("Gtk:AtkObject:children-changed");
353 add_signal_listener ("Gtk:AtkObject:visible-data-changed");
354 add_signal_listener ("Gtk:AtkObject:active-descendant-changed");
355 add_signal_listener ("Gtk:AtkSelection:selection-changed");
356 add_signal_listener ("Gtk:AtkText:text-selection-changed");
357 add_signal_listener ("Gtk:AtkText:text-changed");
358 add_signal_listener ("Gtk:AtkText:text-caret-moved");
359 add_signal_listener ("Gtk:AtkTable:row-inserted");
360 add_signal_listener ("Gtk:AtkTable:row-reordered");
361 add_signal_listener ("Gtk:AtkTable:row-deleted");
362 add_signal_listener ("Gtk:AtkTable:column-inserted");
363 add_signal_listener ("Gtk:AtkTable:column-reordered");
364 add_signal_listener ("Gtk:AtkTable:column-deleted");
365 add_signal_listener ("Gtk:AtkTable:model-changed");
366 add_signal_listener ("Gtk:AtkHypertext:link-selected");
368 * May add the following listeners to implement preemptive key listening for GTK+
370 * atk_add_global_event_listener (spi_atk_bridge_widgetkey_listener, "Gtk:GtkWidget:key-press-event");
371 * atk_add_global_event_listener (spi_atk_bridge_widgetkey_listener, "Gtk:GtkWidget:key-release-event");
373 atk_bridge_key_event_listener_id = atk_add_key_event_listener (
374 spi_atk_bridge_key_listener, NULL);
376 g_object_unref (G_OBJECT (bo));
381 deregister_application (BonoboObject *app)
383 Accessibility_Registry registry = spi_atk_bridge_get_registry ();
384 Accessibility_Registry_deregisterApplication (registry, BONOBO_OBJREF (app), &ev);
386 device_event_controller = bonobo_object_release_unref (device_event_controller, &ev);
387 registry = bonobo_object_release_unref (registry, &ev);
389 app = bonobo_object_unref (app);
393 spi_atk_bridge_exit_func (void)
395 BonoboObject *app = (BonoboObject *) this_app;
397 DBG (1, g_message ("exiting bridge\n"));
406 * FIXME: this may be incorrect for apps that do their own bonobo
407 * shutdown, until we can explicitly shutdown to get the ordering
410 if (!bonobo_is_initialized ())
412 DBG (1, g_warning ("Re-initializing bonobo\n"));
413 g_assert (bonobo_init (0, NULL));
414 g_assert (bonobo_activate ());
417 deregister_application (app);
419 DBG (1, g_message ("bridge exit func complete.\n"));
421 if (g_getenv ("AT_BRIDGE_SHUTDOWN"))
423 g_assert (!bonobo_debug_shutdown ());
428 gnome_accessibility_module_init (void)
430 atk_bridge_init (NULL, NULL);
432 g_print("Atk Accessibilty bridge initialized\n");
436 gnome_accessibility_module_shutdown (void)
438 BonoboObject *app = (BonoboObject *) this_app;
440 GArray *ids = listener_ids;
442 if (!atk_bridge_initialized)
446 atk_bridge_initialized = FALSE;
449 g_print("Atk Accessibilty bridge shutdown\n");
452 atk_remove_focus_tracker (atk_bridge_focus_tracker_id);
454 for (i = 0; ids && i < ids->len; i++)
456 atk_remove_global_event_listener (g_array_index (ids, guint, i));
459 atk_remove_key_event_listener (atk_bridge_key_event_listener_id);
461 deregister_application (app);
465 spi_atk_bridge_focus_tracker (AtkObject *object)
467 SpiAccessible *source;
468 Accessibility_Event e;
470 source = spi_accessible_new (object);
473 e.source = BONOBO_OBJREF (source);
476 spi_init_any_nil (&e.any_data);
478 CORBA_exception_init (&ev);
479 Accessibility_Registry_notifyEvent (spi_atk_bridge_get_registry (), &e, &ev);
481 registry_died = TRUE;
483 bonobo_object_unref (source);
485 CORBA_exception_free (&ev);
489 spi_atk_emit_eventv (const GObject *gobject,
493 const char *format, ...)
496 Accessibility_Event e;
497 SpiAccessible *source;
499 #ifdef SPI_BRIDGE_DEBUG
503 va_start (args, format);
505 if (ATK_IS_IMPLEMENTOR (gobject))
507 aobject = atk_implementor_ref_accessible (ATK_IMPLEMENTOR (gobject));
508 source = spi_accessible_new (aobject);
509 g_object_unref (G_OBJECT (aobject));
511 else if (ATK_IS_OBJECT (gobject))
513 aobject = ATK_OBJECT (gobject);
514 source = spi_accessible_new (aobject);
520 DBG (0, g_warning ("received property-change event from non-AtkImplementor"));
525 e.type = g_strdup_vprintf (format, args);
526 e.source = BONOBO_OBJREF (source);
529 if (any) e.any_data = *any;
530 else spi_init_any_nil (&e.any_data);
532 #ifdef SPI_BRIDGE_DEBUG
533 s = Accessibility_Accessible__get_name (BONOBO_OBJREF (source), &ev);
534 g_warning ("Emitting event '%s' (%lu, %lu) on %s",
535 e.type, e.detail1, e.detail2, s);
538 CORBA_exception_init (&ev);
539 Accessibility_Registry_notifyEvent (spi_atk_bridge_get_registry (),
541 #ifdef SPI_BRIDGE_DEBUG
542 if (ev._major != CORBA_NO_EXCEPTION)
543 g_warning ("error emitting event %s, (%d) %s",
546 CORBA_exception_id(&ev));
548 if (BONOBO_EX (&ev)) registry_died = TRUE;
549 Accessibility_Accessible_unref (e.source, &ev);
551 CORBA_exception_free (&ev);
561 spi_atk_bridge_property_event_listener (GSignalInvocationHint *signal_hint,
562 guint n_param_values,
563 const GValue *param_values,
566 AtkPropertyValues *values;
569 #ifdef SPI_BRIDGE_DEBUG
570 GSignalQuery signal_query;
574 g_signal_query (signal_hint->signal_id, &signal_query);
575 name = signal_query.signal_name;
577 s2 = g_type_name (G_OBJECT_TYPE (g_value_get_object (param_values + 0)));
578 s = atk_object_get_name (ATK_OBJECT (g_value_get_object (param_values + 0)));
579 values = (AtkPropertyValues*) g_value_get_pointer (param_values + 1);
580 DBG (2, g_message ("Received (property) signal %s:%s:%s from object %s (gail %s)\n",
581 g_type_name (signal_query.itype), name, values->property_name, s, s2));
585 gobject = g_value_get_object (param_values + 0);
586 values = (AtkPropertyValues*) g_value_get_pointer (param_values + 1);
588 spi_atk_emit_eventv (gobject, 0, 0, NULL,
589 "object:property-change:%s", values->property_name);
595 spi_atk_bridge_state_event_listener (GSignalInvocationHint *signal_hint,
596 guint n_param_values,
597 const GValue *param_values,
601 gchar *property_name;
603 unsigned long detail1;
604 #ifdef SPI_BRIDGE_DEBUG
605 GSignalQuery signal_query;
608 g_signal_query (signal_hint->signal_id, &signal_query);
609 name = signal_query.signal_name;
610 fprintf (stderr, "Received (state) signal %s:%s\n",
611 g_type_name (signal_query.itype), name);
614 gobject = g_value_get_object (param_values + 0);
615 property_name = g_strdup (g_value_get_string (param_values + 1));
616 detail1 = (g_value_get_boolean (param_values + 2))
618 type = g_strdup_printf ("object:state-changed:%s", property_name);
619 spi_atk_emit_eventv (gobject,
624 g_free (property_name);
630 spi_init_keystroke_from_atk_key_event (Accessibility_DeviceEvent *keystroke,
631 AtkKeyEventStruct *event)
636 g_print ("event %c (%d)\n", (int) event->keyval, (int) event->keycode);
642 g_print ("WARNING: NULL key event!");
645 keystroke->id = (CORBA_long) event->keyval;
646 keystroke->hw_code = (CORBA_short) event->keycode;
647 keystroke->timestamp = (CORBA_unsigned_long) event->timestamp;
648 keystroke->modifiers = (CORBA_unsigned_short) (event->state & 0xFFFF);
651 keystroke->event_string = CORBA_string_dup (event->string);
652 keystroke->is_text = CORBA_TRUE;
656 keystroke->event_string = CORBA_string_dup ("");
657 keystroke->is_text = CORBA_FALSE;
661 case (ATK_KEY_EVENT_PRESS):
662 keystroke->type = Accessibility_KEY_PRESSED_EVENT;
664 case (ATK_KEY_EVENT_RELEASE):
665 keystroke->type = Accessibility_KEY_RELEASED_EVENT;
672 g_print ("key_event type %d; val=%d code=%d modifiers=%x name=%s is_text=%d, time=%lx\n",
673 (int) keystroke->type, (int) keystroke->id, (int) keystroke->hw_code,
674 (int) keystroke->modifiers,
675 keystroke->event_string, (int) keystroke->is_text, (unsigned long) keystroke->timestamp);
680 spi_atk_bridge_key_listener (AtkKeyEventStruct *event, gpointer data)
682 CORBA_boolean result;
683 Accessibility_DeviceEvent key_event;
685 CORBA_exception_init (&ev);
687 spi_init_keystroke_from_atk_key_event (&key_event, event);
689 result = Accessibility_DeviceEventController_notifyListenersSync (
690 spi_atk_bridget_get_dec (), &key_event, &ev);
692 CORBA_exception_free (&ev);
698 spi_atk_bridge_signal_listener (GSignalInvocationHint *signal_hint,
699 guint n_param_values,
700 const GValue *param_values,
704 GSignalQuery signal_query;
711 gint detail1 = 0, detail2 = 0;
712 SpiAccessible *s_ao = NULL;
713 #ifdef SPI_BRIDGE_DEBUG
717 g_signal_query (signal_hint->signal_id, &signal_query);
719 name = signal_query.signal_name;
720 if (signal_hint->detail)
721 detail = g_quark_to_string (signal_hint->detail);
725 #ifdef SPI_BRIDGE_DEBUG
726 s2 = g_type_name (G_OBJECT_TYPE (g_value_get_object (param_values + 0)));
727 s = atk_object_get_name (ATK_OBJECT (g_value_get_object (param_values + 0)));
728 fprintf (stderr, "Received signal %s:%s detail: %s from object %s (gail %s)\n",
729 g_type_name (signal_query.itype), name,
730 detail ? detail : "<NULL>", s ? s : "<NULL>" , s2);
733 gobject = g_value_get_object (param_values + 0);
735 if (signal_query.signal_id == atk_signal_active_descendant_changed)
737 gpointer child = g_value_get_pointer (param_values + 1);
739 g_return_val_if_fail (ATK_IS_OBJECT (child), TRUE);
741 ao = ATK_OBJECT (child);
743 detail1 = atk_object_get_index_in_parent (ao);
744 s_ao = spi_accessible_new (ao);
745 c_obj = BONOBO_OBJREF (s_ao);
746 spi_init_any_object (&any, &c_obj);
748 else if (signal_query.signal_id == atk_signal_link_selected)
750 if (G_VALUE_TYPE (param_values + 1) == G_TYPE_INT)
751 detail1 = g_value_get_int (param_values + 1);
752 spi_init_any_nil (&any);
754 else if ((signal_query.signal_id == atk_signal_children_changed) && gobject)
756 ao = atk_object_ref_accessible_child (ATK_OBJECT (gobject),
760 s_ao = spi_accessible_new (ao);
761 c_obj = BONOBO_OBJREF (s_ao);
762 spi_init_any_object (&any, &c_obj);
767 spi_init_any_nil (&any);
772 if (n_param_values >= 2)
774 if (G_VALUE_TYPE (param_values + 1) == G_TYPE_INT)
775 detail1 = g_value_get_int (param_values + 1);
776 if (n_param_values >= 3)
778 if (G_VALUE_TYPE (param_values + 2) == G_TYPE_INT)
779 detail2 = g_value_get_int (param_values + 2);
783 if (signal_query.signal_id == atk_signal_text_changed)
785 sp = atk_text_get_text (ATK_TEXT (gobject),
788 spi_init_any_string (&any, &sp);
792 spi_init_any_nil (&any);
797 spi_atk_emit_eventv (gobject, detail1, detail2, &any,
798 "object:%s:%s", name, detail);
800 spi_atk_emit_eventv (gobject, detail1, detail2, &any,
810 spi_atk_bridge_window_event_listener (GSignalInvocationHint *signal_hint,
811 guint n_param_values,
812 const GValue *param_values,
816 GSignalQuery signal_query;
818 const gchar *name, *s;
819 #ifdef SPI_BRIDGE_DEBUG
823 g_signal_query (signal_hint->signal_id, &signal_query);
825 name = signal_query.signal_name;
827 #ifdef SPI_BRIDGE_DEBUG
828 s2 = g_type_name (G_OBJECT_TYPE (g_value_get_object (param_values + 0)));
829 s = atk_object_get_name (ATK_OBJECT (g_value_get_object (param_values + 0)));
830 fprintf (stderr, "Received signal %s:%s from object %s (gail %s)\n",
831 g_type_name (signal_query.itype), name, s ? s : "<NULL>" , s2);
834 gobject = g_value_get_object (param_values + 0);
836 s = atk_object_get_name (ATK_OBJECT (gobject));
837 spi_init_any_string (&any, (char **) &s);
839 spi_atk_emit_eventv (gobject, 0, 0, &any,