2 * AT-SPI - Assistive Technology Service Provider Interface
3 * (Gnome Accessibility Project; http://developer.gnome.org/projects/gap)
5 * Copyright 2001, 2002 Sun Microsystems Inc.,
6 * Copyright 2001, 2002 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;
60 static guint atk_signal_property_changed;
63 static guint atk_signal_text_changed;
64 static guint atk_signal_child_changed;
65 static guint atk_signal_active_descendant_changed;
68 static guint atk_signal_text_selection_changed;
69 static guint atk_signal_row_reordered;
70 static guint atk_signal_row_inserted;
71 static guint atk_signal_row_deleted;
72 static guint atk_signal_column_reordered;
73 static guint atk_signal_column_inserted;
74 static guint atk_signal_column_deleted;
77 static Accessibility_Registry spi_atk_bridge_get_registry (void);
78 static void spi_atk_bridge_do_registration (void);
79 static void spi_atk_bridge_toplevel_added (AtkObject *object,
83 static void spi_atk_bridge_exit_func (void);
84 static void spi_atk_register_event_listeners (void);
85 static void spi_atk_bridge_focus_tracker (AtkObject *object);
86 static void spi_atk_bridge_register_application (Accessibility_Registry registry);
87 static gboolean spi_atk_bridge_property_event_listener (GSignalInvocationHint *signal_hint,
89 const GValue *param_values,
92 spi_atk_bridge_window_event_listener (GSignalInvocationHint *signal_hint,
94 const GValue *param_values,
97 spi_atk_bridge_state_event_listener (GSignalInvocationHint *signal_hint,
99 const GValue *param_values,
101 static gboolean spi_atk_bridge_signal_listener (GSignalInvocationHint *signal_hint,
102 guint n_param_values,
103 const GValue *param_values,
105 static gint spi_atk_bridge_key_listener (AtkKeyEventStruct *event,
108 /* For automatic libgnome init */
109 extern void gnome_accessibility_module_init (void);
110 extern void gnome_accessibility_module_shutdown (void);
112 static int atk_bridge_initialized = FALSE;
113 static guint atk_bridge_focus_tracker_id = 0;
114 static guint atk_bridge_key_event_listener_id = 0;
115 static GArray *listener_ids = NULL;
118 * These exported symbols are hooked by gnome-program
119 * to provide automatic module initialization and shutdown.
121 extern void gnome_accessibility_module_init (void);
122 extern void gnome_accessibility_module_shutdown (void);
125 spi_atk_bridge_init_event_type_consts ()
127 atk_signal_child_changed = g_signal_lookup ("child_changed",
129 atk_signal_text_changed = g_signal_lookup ("text_changed",
131 atk_signal_active_descendant_changed =
132 g_signal_lookup ("active_descendant_changed",
137 atk_bridge_init (gint *argc, gchar **argv[])
139 const char *debug_env_string = g_getenv ("AT_SPI_DEBUG");
141 if (atk_bridge_initialized)
145 atk_bridge_initialized = TRUE;
147 if (debug_env_string)
148 _dbg = (int) g_ascii_strtod (debug_env_string, NULL);
150 if (!bonobo_init (argc, argv ? *argv : NULL))
152 g_error ("Could not initialize Bonobo");
156 * We only want to enable the bridge for top level
157 * applications, we detect bonobo components by seeing
158 * if they were activated with the intention of extracting
159 * an impl. by IID - very solid.
161 if (bonobo_activation_iid_get ())
163 DBG (1, g_message ("Found Bonobo component\n"));
164 toplevel_handler = g_signal_connect (atk_get_root (),
165 "children-changed::add",
166 (GCallback) spi_atk_bridge_toplevel_added,
171 spi_atk_bridge_do_registration ();
174 spi_atk_bridge_init_event_type_consts ();
181 spi_atk_bridge_do_registration (void)
183 CORBA_Environment ev;
185 CORBA_exception_init(&ev);
187 if (spi_atk_bridge_get_registry () == CORBA_OBJECT_NIL)
189 g_error ("Could not locate registry");
194 /* Create the accessible application server object */
196 this_app = spi_application_new (atk_get_root ());
198 DBG (1, g_message ("About to register application\n"));
200 spi_atk_bridge_register_application (spi_atk_bridge_get_registry ());
202 g_atexit (spi_atk_bridge_exit_func);
204 DBG (1, g_message ("Application registered & listening\n"));
209 spi_atk_bridge_toplevel_added (AtkObject *object,
213 g_signal_handler_disconnect (object, toplevel_handler);
214 spi_atk_bridge_do_registration ();
218 spi_atk_bridge_register_application (Accessibility_Registry registry)
220 Accessibility_Registry_registerApplication (spi_atk_bridge_get_registry (),
221 BONOBO_OBJREF (this_app),
223 spi_atk_register_event_listeners ();
226 static Accessibility_Registry
227 spi_atk_bridge_get_registry (void)
229 CORBA_Environment ev;
231 if (registry_died || (registry == NULL)) {
232 CORBA_exception_init (&ev);
234 DBG (1, g_warning ("registry died! restarting..."));
235 registry = bonobo_activation_activate_from_id (
236 "OAFIID:Accessibility_Registry:1.0", 0, NULL, &ev);
238 if (ev._major != CORBA_NO_EXCEPTION)
240 g_error ("Accessibility app error: exception during "
241 "registry activation from id: %s\n",
242 CORBA_exception_id (&ev));
243 CORBA_exception_free (&ev);
246 if (registry_died && registry) {
247 registry_died = FALSE;
248 spi_atk_bridge_register_application (registry);
254 static Accessibility_DeviceEventController
255 spi_atk_bridget_get_dec (void)
257 CORBA_Environment ev;
259 if (device_event_controller != CORBA_OBJECT_NIL)
261 if (ORBit_small_get_connection_status (device_event_controller)
262 == ORBIT_CONNECTION_CONNECTED)
263 return device_event_controller;
266 CORBA_exception_init (&ev);
268 device_event_controller =
269 Accessibility_Registry_getDeviceEventController (
270 spi_atk_bridge_get_registry (), &ev);
274 g_warning ("failure: no deviceeventcontroller found\n");
275 registry_died = TRUE;
276 device_event_controller = CORBA_OBJECT_NIL;
279 return device_event_controller;
283 gtk_module_init (gint *argc, gchar **argv[])
285 return atk_bridge_init (argc, argv);
289 add_signal_listener (const char *signal_name)
293 id = atk_add_global_event_listener (
294 spi_atk_bridge_signal_listener, signal_name);
296 g_array_append_val (listener_ids, id);
300 spi_atk_register_event_listeners (void)
303 * kludge to make sure the Atk interface types are registered, otherwise
304 * the AtkText signal handlers below won't get registered
307 GObject *ao = g_object_new (ATK_TYPE_OBJECT, NULL);
308 AtkObject *bo = atk_no_op_object_new (ao);
311 if (atk_listeners_registered) return;
313 atk_listeners_registered = TRUE;
315 /* Register for focus event notifications, and register app with central registry */
317 listener_ids = g_array_sized_new (FALSE, TRUE, sizeof (guint), 16);
319 atk_bridge_focus_tracker_id = atk_add_focus_tracker (spi_atk_bridge_focus_tracker);
321 id = atk_add_global_event_listener (spi_atk_bridge_property_event_listener,
322 "Gtk:AtkObject:property-change");
323 g_array_append_val (listener_ids, id);
324 id = atk_add_global_event_listener (spi_atk_bridge_window_event_listener,
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,
343 "window:deactivate");
344 g_array_append_val (listener_ids, id);
345 id = atk_add_global_event_listener (spi_atk_bridge_state_event_listener,
346 "Gtk:AtkObject:state-change");
347 g_array_append_val (listener_ids, id);
349 add_signal_listener ("Gtk:AtkObject:children-changed");
350 add_signal_listener ("Gtk:AtkObject:visible-data-changed");
351 add_signal_listener ("Gtk:AtkObject:active-descendant-changed");
352 add_signal_listener ("Gtk:AtkSelection:selection-changed");
353 add_signal_listener ("Gtk:AtkText:text-selection-changed");
354 add_signal_listener ("Gtk:AtkText:text-changed");
355 add_signal_listener ("Gtk:AtkText:text-caret-moved");
356 add_signal_listener ("Gtk:AtkTable:row-inserted");
357 add_signal_listener ("Gtk:AtkTable:row-reordered");
358 add_signal_listener ("Gtk:AtkTable:row-deleted");
359 add_signal_listener ("Gtk:AtkTable:column-inserted");
360 add_signal_listener ("Gtk:AtkTable:column-reordered");
361 add_signal_listener ("Gtk:AtkTable:column-deleted");
362 add_signal_listener ("Gtk:AtkTable:model-changed");
364 * May add the following listeners to implement preemptive key listening for GTK+
366 * atk_add_global_event_listener (spi_atk_bridge_widgetkey_listener, "Gtk:GtkWidget:key-press-event");
367 * atk_add_global_event_listener (spi_atk_bridge_widgetkey_listener, "Gtk:GtkWidget:key-release-event");
369 atk_bridge_key_event_listener_id = atk_add_key_event_listener (
370 spi_atk_bridge_key_listener, NULL);
372 g_object_unref (G_OBJECT (bo));
377 deregister_application (BonoboObject *app)
379 Accessibility_Registry registry = spi_atk_bridge_get_registry ();
380 Accessibility_Registry_deregisterApplication (registry, BONOBO_OBJREF (app), &ev);
382 device_event_controller = bonobo_object_release_unref (device_event_controller, &ev);
383 registry = bonobo_object_release_unref (registry, &ev);
385 app = bonobo_object_unref (app);
389 spi_atk_bridge_exit_func (void)
391 BonoboObject *app = (BonoboObject *) this_app;
393 DBG (1, g_message ("exiting bridge\n"));
402 * FIXME: this may be incorrect for apps that do their own bonobo
403 * shutdown, until we can explicitly shutdown to get the ordering
406 if (!bonobo_is_initialized ())
408 DBG (1, g_warning ("Re-initializing bonobo\n"));
409 g_assert (bonobo_init (0, NULL));
410 g_assert (bonobo_activate ());
413 deregister_application (app);
415 DBG (1, g_message ("bridge exit func complete.\n"));
417 if (g_getenv ("AT_BRIDGE_SHUTDOWN"))
419 g_assert (!bonobo_debug_shutdown ());
424 gnome_accessibility_module_init (void)
426 atk_bridge_init (NULL, NULL);
428 g_print("Atk Accessibilty bridge initialized\n");
432 gnome_accessibility_module_shutdown (void)
434 BonoboObject *app = (BonoboObject *) this_app;
436 GArray *ids = listener_ids;
438 if (!atk_bridge_initialized)
442 atk_bridge_initialized = FALSE;
445 g_print("Atk Accessibilty bridge shutdown\n");
448 atk_remove_focus_tracker (atk_bridge_focus_tracker_id);
450 for (i = 0; ids && i < ids->len; i++)
452 atk_remove_global_event_listener (g_array_index (ids, guint, i));
455 atk_remove_key_event_listener (atk_bridge_key_event_listener_id);
457 deregister_application (app);
461 spi_atk_bridge_focus_tracker (AtkObject *object)
463 SpiAccessible *source;
464 Accessibility_Event e;
466 source = spi_accessible_new (object);
469 e.source = BONOBO_OBJREF (source);
472 spi_init_any_nil (&e.any_data);
474 CORBA_exception_init (&ev);
475 Accessibility_Registry_notifyEvent (spi_atk_bridge_get_registry (), &e, &ev);
477 registry_died = TRUE;
479 bonobo_object_unref (source);
481 CORBA_exception_free (&ev);
485 spi_atk_emit_eventv (const GObject *gobject,
489 const char *format, ...)
492 Accessibility_Event e;
493 SpiAccessible *source;
495 #ifdef SPI_BRIDGE_DEBUG
499 va_start (args, format);
501 if (ATK_IS_IMPLEMENTOR (gobject))
503 aobject = atk_implementor_ref_accessible (ATK_IMPLEMENTOR (gobject));
504 source = spi_accessible_new (aobject);
505 g_object_unref (G_OBJECT (aobject));
507 else if (ATK_IS_OBJECT (gobject))
509 aobject = ATK_OBJECT (gobject);
510 source = spi_accessible_new (aobject);
516 DBG (0, g_warning ("received property-change event from non-AtkImplementor"));
521 e.type = g_strdup_vprintf (format, args);
522 e.source = BONOBO_OBJREF (source);
525 if (any) e.any_data = *any;
526 else spi_init_any_nil (&e.any_data);
528 #ifdef SPI_BRIDGE_DEBUG
529 s = Accessibility_Accessible__get_name (BONOBO_OBJREF (source), &ev);
530 g_warning ("Emitting event '%s' (%lu, %lu) on %s",
531 e.type, e.detail1, e.detail2, s);
534 CORBA_exception_init (&ev);
535 Accessibility_Registry_notifyEvent (spi_atk_bridge_get_registry (),
537 #ifdef SPI_BRIDGE_DEBUG
538 if (ev._major != CORBA_NO_EXCEPTION)
539 g_warning ("error emitting event %s, (%d) %s",
542 CORBA_exception_id(&ev));
544 if (BONOBO_EX (&ev)) registry_died = TRUE;
545 Accessibility_Accessible_unref (e.source, &ev);
547 CORBA_exception_free (&ev);
557 spi_atk_bridge_property_event_listener (GSignalInvocationHint *signal_hint,
558 guint n_param_values,
559 const GValue *param_values,
562 AtkPropertyValues *values;
565 #ifdef SPI_BRIDGE_DEBUG
566 GSignalQuery signal_query;
570 g_signal_query (signal_hint->signal_id, &signal_query);
571 name = signal_query.signal_name;
573 s2 = g_type_name (G_OBJECT_TYPE (g_value_get_object (param_values + 0)));
574 s = atk_object_get_name (ATK_OBJECT (g_value_get_object (param_values + 0)));
575 values = (AtkPropertyValues*) g_value_get_pointer (param_values + 1);
576 DBG (2, g_message ("Received (property) signal %s:%s:%s from object %s (gail %s)\n",
577 g_type_name (signal_query.itype), name, values->property_name, s, s2));
581 gobject = g_value_get_object (param_values + 0);
582 values = (AtkPropertyValues*) g_value_get_pointer (param_values + 1);
584 spi_atk_emit_eventv (gobject, 0, 0, NULL,
585 "object:property-change:%s", values->property_name);
591 spi_atk_bridge_state_event_listener (GSignalInvocationHint *signal_hint,
592 guint n_param_values,
593 const GValue *param_values,
597 gchar *property_name;
599 unsigned long detail1;
600 #ifdef SPI_BRIDGE_DEBUG
601 GSignalQuery signal_query;
604 g_signal_query (signal_hint->signal_id, &signal_query);
605 name = signal_query.signal_name;
606 fprintf (stderr, "Received (state) signal %s:%s\n",
607 g_type_name (signal_query.itype), name);
610 gobject = g_value_get_object (param_values + 0);
611 property_name = g_strdup (g_value_get_string (param_values + 1));
612 detail1 = (g_value_get_boolean (param_values + 2))
614 type = g_strdup_printf ("object:state-changed:%s", property_name);
615 spi_atk_emit_eventv (gobject,
620 g_free (property_name);
626 spi_init_keystroke_from_atk_key_event (Accessibility_DeviceEvent *keystroke,
627 AtkKeyEventStruct *event)
632 g_print ("event %c (%d)\n", (int) event->keyval, (int) event->keycode);
638 g_print ("WARNING: NULL key event!");
641 keystroke->id = (CORBA_long) event->keyval;
642 keystroke->hw_code = (CORBA_short) event->keycode;
643 keystroke->timestamp = (CORBA_unsigned_long) event->timestamp;
644 keystroke->modifiers = (CORBA_unsigned_short) (event->state & 0xFFFF);
647 keystroke->event_string = CORBA_string_dup (event->string);
648 keystroke->is_text = CORBA_TRUE;
652 keystroke->event_string = CORBA_string_dup ("");
653 keystroke->is_text = CORBA_FALSE;
657 case (ATK_KEY_EVENT_PRESS):
658 keystroke->type = Accessibility_KEY_PRESSED_EVENT;
660 case (ATK_KEY_EVENT_RELEASE):
661 keystroke->type = Accessibility_KEY_RELEASED_EVENT;
668 g_print ("key_event type %d; val=%d code=%d modifiers=%x name=%s is_text=%d, time=%lx\n",
669 (int) keystroke->type, (int) keystroke->id, (int) keystroke->hw_code,
670 (int) keystroke->modifiers,
671 keystroke->event_string, (int) keystroke->is_text, (unsigned long) keystroke->timestamp);
676 spi_atk_bridge_key_listener (AtkKeyEventStruct *event, gpointer data)
678 CORBA_boolean result;
679 Accessibility_DeviceEvent key_event;
681 CORBA_exception_init (&ev);
683 spi_init_keystroke_from_atk_key_event (&key_event, event);
685 result = Accessibility_DeviceEventController_notifyListenersSync (
686 spi_atk_bridget_get_dec (), &key_event, &ev);
688 CORBA_exception_free (&ev);
694 spi_atk_bridge_signal_listener (GSignalInvocationHint *signal_hint,
695 guint n_param_values,
696 const GValue *param_values,
700 GSignalQuery signal_query;
707 gint detail1 = 0, detail2 = 0;
708 SpiAccessible *s_ao = NULL;
709 #ifdef SPI_BRIDGE_DEBUG
713 g_signal_query (signal_hint->signal_id, &signal_query);
715 name = signal_query.signal_name;
716 if (signal_hint->detail)
717 detail = g_quark_to_string (signal_hint->detail);
721 #ifdef SPI_BRIDGE_DEBUG
722 s2 = g_type_name (G_OBJECT_TYPE (g_value_get_object (param_values + 0)));
723 s = atk_object_get_name (ATK_OBJECT (g_value_get_object (param_values + 0)));
724 fprintf (stderr, "Received signal %s:%s detail: %s from object %s (gail %s)\n",
725 g_type_name (signal_query.itype), name,
726 detail ? detail : "<NULL>", s ? s : "<NULL>" , s2);
729 gobject = g_value_get_object (param_values + 0);
731 if (signal_query.signal_id == atk_signal_active_descendant_changed)
733 gpointer child = g_value_get_pointer (param_values + 1);
735 g_return_val_if_fail (ATK_IS_OBJECT (child), TRUE);
737 ao = ATK_OBJECT (child);
739 detail1 = atk_object_get_index_in_parent (ao);
740 s_ao = spi_accessible_new (ao);
741 c_obj = BONOBO_OBJREF (s_ao);
742 spi_init_any_object (&any, &c_obj);
746 if (G_VALUE_TYPE (param_values + 1) == G_TYPE_INT)
747 detail1 = g_value_get_int (param_values + 1);
748 if (G_VALUE_TYPE (param_values + 2) == G_TYPE_INT)
749 detail2 = g_value_get_int (param_values + 2);
751 if (signal_query.signal_id == atk_signal_text_changed)
753 sp = atk_text_get_text (ATK_TEXT (gobject),
756 spi_init_any_string (&any, &sp);
758 else if ((signal_query.signal_id == atk_signal_child_changed) && gobject)
760 ao = atk_object_ref_accessible_child (ATK_OBJECT (gobject),
764 s_ao = spi_accessible_new (ao);
765 c_obj = BONOBO_OBJREF (s_ao);
766 spi_init_any_object (&any, &c_obj);
771 spi_init_any_nil (&any);
776 spi_init_any_nil (&any);
781 spi_atk_emit_eventv (gobject, detail1, detail2, &any,
782 "object:%s:%s", name, detail);
784 spi_atk_emit_eventv (gobject, detail1, detail2, &any,
794 spi_atk_bridge_window_event_listener (GSignalInvocationHint *signal_hint,
795 guint n_param_values,
796 const GValue *param_values,
800 GSignalQuery signal_query;
802 const gchar *name, *s;
803 #ifdef SPI_BRIDGE_DEBUG
807 g_signal_query (signal_hint->signal_id, &signal_query);
809 name = signal_query.signal_name;
811 #ifdef SPI_BRIDGE_DEBUG
812 s2 = g_type_name (G_OBJECT_TYPE (g_value_get_object (param_values + 0)));
813 s = atk_object_get_name (ATK_OBJECT (g_value_get_object (param_values + 0)));
814 fprintf (stderr, "Received signal %s:%s from object %s (gail %s)\n",
815 g_type_name (signal_query.itype), name, s ? s : "<NULL>" , s2);
818 gobject = g_value_get_object (param_values + 0);
820 s = atk_object_get_name (ATK_OBJECT (gobject));
821 spi_init_any_string (&any, (char **) &s);
823 spi_atk_emit_eventv (gobject, 0, 0, &any,