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 "accessible.h"
34 #include "application.h"
36 #include <bonobo-activation/bonobo-activation-register.h>
38 #undef SPI_BRIDGE_DEBUG
40 #define DBG(a,b) if(_dbg>=(a))b
44 static CORBA_Environment ev;
45 static Accessibility_Registry registry = NULL;
46 static SpiApplication *this_app = NULL;
47 static gboolean registry_died = FALSE;
48 static guint toplevel_handler;
51 static GQuark atk_quark_property_changed_name;
52 static GQuark atk_quark_property_changed_description;
53 static GQuark atk_quark_property_changed_parent;
54 static GQuark atk_quark_property_changed_role;
55 static GQuark atk_quark_property_changed_table_caption;
56 static GQuark atk_quark_property_changed_table_column_description;
57 static GQuark atk_quark_property_changed_table_row_description;
58 static guint atk_signal_property_changed;
61 static guint atk_signal_text_changed;
62 static guint atk_signal_child_changed;
65 static guint atk_signal_text_selection_changed;
66 static guint atk_signal_active_descendant_changed;
67 static guint atk_signal_row_reordered;
68 static guint atk_signal_row_inserted;
69 static guint atk_signal_row_deleted;
70 static guint atk_signal_column_reordered;
71 static guint atk_signal_column_inserted;
72 static guint atk_signal_column_deleted;
75 #define ATK_BRIDGE_RESERVED_CONTEXT_SIZE 16
78 ATK_BRIDGE_CONTEXT_TYPE_NONE = 0,
79 ATK_BRIDGE_CONTEXT_TYPE_STRING,
80 ATK_BRIDGE_CONTEXT_TYPE_OBJECT
81 } AtkBridgeEventContextType;
87 } AtkBridgeEventContextData;
90 AtkBridgeEventContextType _type;
91 AtkBridgeEventContextData _data;
92 } AtkBridgeEventContext;
94 static Accessibility_Registry spi_atk_bridge_get_registry (void);
95 static void spi_atk_bridge_do_registration (void);
96 static void spi_atk_bridge_toplevel_added (AtkObject *object,
100 static void spi_atk_bridge_exit_func (void);
101 static void spi_atk_register_event_listeners (void);
102 static void spi_atk_bridge_focus_tracker (AtkObject *object);
103 static void spi_atk_bridge_register_application (Accessibility_Registry registry);
104 static gboolean spi_atk_bridge_property_event_listener (GSignalInvocationHint *signal_hint,
105 guint n_param_values,
106 const GValue *param_values,
109 spi_atk_bridge_window_event_listener (GSignalInvocationHint *signal_hint,
110 guint n_param_values,
111 const GValue *param_values,
114 spi_atk_bridge_state_event_listener (GSignalInvocationHint *signal_hint,
115 guint n_param_values,
116 const GValue *param_values,
118 static gboolean spi_atk_bridge_signal_listener (GSignalInvocationHint *signal_hint,
119 guint n_param_values,
120 const GValue *param_values,
122 static gint spi_atk_bridge_key_listener (AtkKeyEventStruct *event,
125 /* For automatic libgnome init */
126 extern void gnome_accessibility_module_init (void);
127 extern void gnome_accessibility_module_shutdown (void);
129 static int atk_bridge_initialized = FALSE;
130 static guint atk_bridge_focus_tracker_id = 0;
131 static guint atk_bridge_key_event_listener_id = 0;
132 static GArray *listener_ids = NULL;
135 * These exported symbols are hooked by gnome-program
136 * to provide automatic module initialization and shutdown.
138 extern void gnome_accessibility_module_init (void);
139 extern void gnome_accessibility_module_shutdown (void);
142 atk_bridge_init_event_type_consts ()
144 atk_signal_child_changed = g_signal_lookup ("child_changed",
146 atk_signal_text_changed = g_signal_lookup ("text_changed",
151 atk_bridge_init (gint *argc, gchar **argv[])
153 if (atk_bridge_initialized)
157 atk_bridge_initialized = TRUE;
159 _dbg = g_ascii_digit_value (g_getenv ("AT_SPI_DEBUG"));
161 if (!bonobo_init (argc, argv ? *argv : NULL))
163 g_error ("Could not initialize Bonobo");
167 * We only want to enable the bridge for top level
168 * applications, we detect bonobo components by seeing
169 * if they were activated with the intention of extracting
170 * an impl. by IID - very solid.
172 if (bonobo_activation_iid_get ())
174 DBG (1, g_message ("Found Bonobo component\n"));
175 toplevel_handler = g_signal_connect (atk_get_root (),
176 "children-changed::add",
177 (GCallback) spi_atk_bridge_toplevel_added,
182 spi_atk_bridge_do_registration ();
185 atk_bridge_init_event_type_consts ();
191 spi_atk_bridge_do_registration (void)
193 CORBA_Environment ev;
195 CORBA_exception_init(&ev);
197 if (spi_atk_bridge_get_registry () == CORBA_OBJECT_NIL)
199 g_error ("Could not locate registry");
204 /* Create the accessible application server object */
206 this_app = spi_application_new (atk_get_root ());
208 DBG (1, g_message ("About to register application\n"));
210 spi_atk_bridge_register_application (spi_atk_bridge_get_registry ());
212 g_atexit (spi_atk_bridge_exit_func);
214 DBG (1, g_message ("Application registered & listening\n"));
219 spi_atk_bridge_toplevel_added (AtkObject *object,
223 g_signal_handler_disconnect (object, toplevel_handler);
224 spi_atk_bridge_do_registration ();
228 spi_atk_bridge_register_application (Accessibility_Registry registry)
230 Accessibility_Registry_registerApplication (spi_atk_bridge_get_registry (),
231 BONOBO_OBJREF (this_app),
233 spi_atk_register_event_listeners ();
236 static Accessibility_Registry
237 spi_atk_bridge_get_registry ()
239 CORBA_Environment ev;
241 if (registry_died || (registry == NULL)) {
242 CORBA_exception_init (&ev);
244 DBG (1, g_warning ("registry died! restarting..."));
245 registry = bonobo_activation_activate_from_id (
246 "OAFIID:Accessibility_Registry:1.0", 0, NULL, &ev);
248 if (ev._major != CORBA_NO_EXCEPTION)
250 g_error ("Accessibility app error: exception during "
251 "registry activation from id: %s\n",
252 CORBA_exception_id (&ev));
253 CORBA_exception_free (&ev);
256 if (registry_died && registry) {
257 registry_died = FALSE;
258 spi_atk_bridge_register_application (registry);
265 gtk_module_init (gint *argc, gchar **argv[])
267 return atk_bridge_init (argc, argv);
271 add_signal_listener (const char *signal_name)
275 id = atk_add_global_event_listener (
276 spi_atk_bridge_signal_listener, signal_name);
278 g_array_append_val (listener_ids, id);
282 spi_atk_register_event_listeners (void)
285 * kludge to make sure the Atk interface types are registered, otherwise
286 * the AtkText signal handlers below won't get registered
289 GObject *ao = g_object_new (ATK_TYPE_OBJECT, NULL);
290 AtkObject *bo = atk_no_op_object_new (ao);
292 /* Register for focus event notifications, and register app with central registry */
294 listener_ids = g_array_sized_new (FALSE, TRUE, sizeof (guint), 16);
296 atk_bridge_focus_tracker_id = atk_add_focus_tracker (spi_atk_bridge_focus_tracker);
298 id = atk_add_global_event_listener (spi_atk_bridge_property_event_listener,
299 "Gtk:AtkObject:property-change");
300 g_array_append_val (listener_ids, id);
301 id = atk_add_global_event_listener (spi_atk_bridge_window_event_listener,
303 g_array_append_val (listener_ids, id);
304 id = atk_add_global_event_listener (spi_atk_bridge_window_event_listener,
306 g_array_append_val (listener_ids, id);
307 id = atk_add_global_event_listener (spi_atk_bridge_window_event_listener,
309 g_array_append_val (listener_ids, id);
310 id = atk_add_global_event_listener (spi_atk_bridge_window_event_listener,
312 g_array_append_val (listener_ids, id);
313 id = atk_add_global_event_listener (spi_atk_bridge_window_event_listener,
315 g_array_append_val (listener_ids, id);
316 id = atk_add_global_event_listener (spi_atk_bridge_window_event_listener,
318 g_array_append_val (listener_ids, id);
319 id = atk_add_global_event_listener (spi_atk_bridge_window_event_listener,
320 "window:deactivate");
321 g_array_append_val (listener_ids, id);
322 id = atk_add_global_event_listener (spi_atk_bridge_state_event_listener,
323 "Gtk:AtkObject:state-change");
324 g_array_append_val (listener_ids, id);
326 add_signal_listener ("Gtk:AtkObject:children-changed");
327 add_signal_listener ("Gtk:AtkObject:visible-data-changed");
328 add_signal_listener ("Gtk:AtkSelection:selection-changed");
329 add_signal_listener ("Gtk:AtkText:text-selection-changed");
330 add_signal_listener ("Gtk:AtkText:text-changed");
331 add_signal_listener ("Gtk:AtkText:text-caret-moved");
332 add_signal_listener ("Gtk:AtkTable:row-inserted");
333 add_signal_listener ("Gtk:AtkTable:row-reordered");
334 add_signal_listener ("Gtk:AtkTable:row-deleted");
335 add_signal_listener ("Gtk:AtkTable:column-inserted");
336 add_signal_listener ("Gtk:AtkTable:column-reordered");
337 add_signal_listener ("Gtk:AtkTable:column-deleted");
338 add_signal_listener ("Gtk:AtkTable:model-changed");
340 * May add the following listeners to implement preemptive key listening for GTK+
342 * atk_add_global_event_listener (spi_atk_bridge_widgetkey_listener, "Gtk:GtkWidget:key-press-event");
343 * atk_add_global_event_listener (spi_atk_bridge_widgetkey_listener, "Gtk:GtkWidget:key-release-event");
345 atk_bridge_key_event_listener_id = atk_add_key_event_listener (
346 spi_atk_bridge_key_listener, NULL);
348 g_object_unref (G_OBJECT (bo));
353 deregister_application (BonoboObject *app)
355 Accessibility_Registry registry = spi_atk_bridge_get_registry ();
356 Accessibility_Registry_deregisterApplication (registry, BONOBO_OBJREF (app), &ev);
358 registry = bonobo_object_release_unref (registry, &ev);
360 app = bonobo_object_unref (app);
364 spi_atk_bridge_exit_func (void)
366 BonoboObject *app = (BonoboObject *) this_app;
368 DBG (1, g_message ("exiting bridge\n"));
377 * FIXME: this may be incorrect for apps that do their own bonobo
378 * shutdown, until we can explicitly shutdown to get the ordering
381 if (!bonobo_is_initialized ())
383 DBG (1, g_warning ("Re-initializing bonobo\n"));
384 g_assert (bonobo_init (0, NULL));
385 g_assert (bonobo_activate ());
388 deregister_application (app);
390 DBG (1, g_message ("bridge exit func complete.\n"));
392 if (g_getenv ("AT_BRIDGE_SHUTDOWN"))
394 g_assert (!bonobo_debug_shutdown ());
399 gnome_accessibility_module_init (void)
401 atk_bridge_init (NULL, NULL);
403 g_print("Atk Accessibilty bridge initialized\n");
407 gnome_accessibility_module_shutdown (void)
409 BonoboObject *app = (BonoboObject *) this_app;
411 GArray *ids = listener_ids;
413 if (!atk_bridge_initialized)
417 atk_bridge_initialized = FALSE;
420 g_print("Atk Accessibilty bridge shutdown\n");
423 atk_remove_focus_tracker (atk_bridge_focus_tracker_id);
425 for (i = 0; ids && i < ids->len; i++)
427 atk_remove_global_event_listener (g_array_index (ids, guint, i));
430 atk_remove_key_event_listener (atk_bridge_key_event_listener_id);
432 deregister_application (app);
436 atk_bridge_event_context_init (CORBA_any *any,
437 AtkBridgeEventContext *ctx)
439 SpiAccessible *accessible;
445 case ATK_BRIDGE_CONTEXT_TYPE_OBJECT:
446 accessible = spi_accessible_new (ctx->_data.object);
447 spi_init_any_object (any, BONOBO_OBJREF (accessible));
450 case ATK_BRIDGE_CONTEXT_TYPE_STRING:
451 spi_init_any_string (any, &ctx->_data.string);
454 spi_init_any_nil (any);
459 spi_init_any_nil (any);
464 spi_atk_bridge_focus_tracker (AtkObject *object)
466 SpiAccessible *source;
467 Accessibility_Event e;
469 source = spi_accessible_new (object);
472 e.source = BONOBO_OBJREF (source);
475 spi_init_any_nil (&e.any_data);
476 Accessibility_Registry_notifyEvent (spi_atk_bridge_get_registry (), &e, &ev);
477 if (BONOBO_EX (&ev)) registry_died = TRUE;
479 Accessibility_Accessible_unref (e.source, &ev);
481 CORBA_exception_free (&ev);
485 AtkBridgeEventContext *
486 spi_atk_bridge_event_context_create (GObject *gobject,
489 GSignalQuery *signal_query,
492 AtkBridgeEventContext *ctx = g_new0 (AtkBridgeEventContext, 1);
494 if (signal_query->signal_id == atk_signal_child_changed)
496 ctx->_type = ATK_BRIDGE_CONTEXT_TYPE_OBJECT;
497 ctx->_data.object = atk_object_ref_accessible_child (ATK_OBJECT (gobject),
500 else */ if (signal_query->signal_id == atk_signal_text_changed)
502 ctx->_type = ATK_BRIDGE_CONTEXT_TYPE_STRING;
503 ctx->_data.string = atk_text_get_text (ATK_TEXT (gobject),
505 (gint) detail1+detail2);
509 ctx->_type = ATK_BRIDGE_CONTEXT_TYPE_NONE;
515 spi_atk_bridge_event_context_free (AtkBridgeEventContext *ctx)
517 if (ctx->_type == ATK_BRIDGE_CONTEXT_TYPE_OBJECT)
518 g_object_unref (ctx->_data.object);
523 spi_atk_emit_eventv (GObject *gobject,
524 unsigned long detail1,
525 unsigned long detail2,
526 AtkBridgeEventContext *context,
527 const char *format, ...)
530 Accessibility_Event e;
531 SpiAccessible *source;
533 #ifdef SPI_BRIDGE_DEBUG
537 va_start (args, format);
539 if (ATK_IS_IMPLEMENTOR (gobject))
541 aobject = atk_implementor_ref_accessible (ATK_IMPLEMENTOR (gobject));
542 source = spi_accessible_new (aobject);
543 g_object_unref (G_OBJECT (aobject));
545 else if (ATK_IS_OBJECT (gobject))
547 aobject = ATK_OBJECT (gobject);
548 source = spi_accessible_new (aobject);
554 g_error ("received property-change event from non-AtkImplementor");
559 e.type = g_strdup_vprintf (format, args);
560 e.source = BONOBO_OBJREF (source);
563 #ifdef SPI_BRIDGE_DEBUG
564 s = Accessibility_Accessible__get_name (BONOBO_OBJREF (source), &ev);
565 g_warning ("Emitting event '%s' (%lu, %lu) on %s",
566 e.type, e.detail1, e.detail2, s);
569 CORBA_exception_init (&ev);
570 atk_bridge_event_context_init (&e.any_data, context);
571 Accessibility_Registry_notifyEvent (spi_atk_bridge_get_registry (), &e, &ev);
572 /* I haven't freed any_data._value when it's a char*, does it leak ? */
573 #ifdef SPI_BRIDGE_DEBUG
574 if (ev._major != CORBA_NO_EXCEPTION)
575 g_warning ("error emitting event %s, (%d) %s",
578 CORBA_exception_id(&ev));
580 if (BONOBO_EX (&ev)) registry_died = TRUE;
581 Accessibility_Accessible_unref (e.source, &ev);
583 CORBA_exception_free (&ev);
593 spi_atk_bridge_property_event_listener (GSignalInvocationHint *signal_hint,
594 guint n_param_values,
595 const GValue *param_values,
598 AtkPropertyValues *values;
601 #ifdef SPI_BRIDGE_DEBUG
602 GSignalQuery signal_query;
606 g_signal_query (signal_hint->signal_id, &signal_query);
607 name = signal_query.signal_name;
609 s2 = g_type_name (G_OBJECT_TYPE (g_value_get_object (param_values + 0)));
610 s = atk_object_get_name (ATK_OBJECT (g_value_get_object (param_values + 0)));
611 values = (AtkPropertyValues*) g_value_get_pointer (param_values + 1);
612 DBG (2, g_message ("Received (property) signal %s:%s:%s from object %s (gail %s)\n",
613 g_type_name (signal_query.itype), name, values->property_name, s, s2));
617 gobject = g_value_get_object (param_values + 0);
618 values = (AtkPropertyValues*) g_value_get_pointer (param_values + 1);
620 spi_atk_emit_eventv (gobject, 0, 0, NULL,
621 "object:property-change:%s", values->property_name);
627 spi_atk_bridge_state_event_listener (GSignalInvocationHint *signal_hint,
628 guint n_param_values,
629 const GValue *param_values,
633 gchar *property_name;
635 unsigned long detail1;
636 #ifdef SPI_BRIDGE_DEBUG
637 GSignalQuery signal_query;
640 g_signal_query (signal_hint->signal_id, &signal_query);
641 name = signal_query.signal_name;
642 fprintf (stderr, "Received (state) signal %s:%s\n",
643 g_type_name (signal_query.itype), name);
646 gobject = g_value_get_object (param_values + 0);
647 property_name = g_strdup (g_value_get_string (param_values + 1));
648 detail1 = (g_value_get_boolean (param_values + 2))
650 type = g_strdup_printf ("object:state-changed:%s", property_name);
651 spi_atk_emit_eventv (gobject,
656 g_free (property_name);
663 spi_init_keystroke_from_atk_key_event (Accessibility_DeviceEvent *keystroke,
664 AtkKeyEventStruct *event)
669 g_print ("event %c (%d)\n", (int) event->keyval, (int) event->keycode);
675 g_print ("WARNING: NULL key event!");
678 keystroke->id = (CORBA_long) event->keyval;
679 keystroke->hw_code = (CORBA_short) event->keycode;
680 keystroke->timestamp = (CORBA_unsigned_long) event->timestamp;
681 keystroke->modifiers = (CORBA_unsigned_short) (event->state & 0xFFFF);
684 keystroke->event_string = CORBA_string_dup (event->string);
685 keystroke->is_text = CORBA_TRUE;
689 keystroke->event_string = CORBA_string_dup ("");
690 keystroke->is_text = CORBA_FALSE;
694 case (ATK_KEY_EVENT_PRESS):
695 keystroke->type = Accessibility_KEY_PRESSED_EVENT;
697 case (ATK_KEY_EVENT_RELEASE):
698 keystroke->type = Accessibility_KEY_RELEASED_EVENT;
705 g_print ("key_event type %d; val=%d code=%d modifiers=%x name=%s is_text=%d, time=%lx\n",
706 (int) keystroke->type, (int) keystroke->id, (int) keystroke->hw_code,
707 (int) keystroke->modifiers,
708 keystroke->event_string, (int) keystroke->is_text, (unsigned long) keystroke->timestamp);
713 spi_atk_bridge_key_listener (AtkKeyEventStruct *event, gpointer data)
715 CORBA_boolean result;
716 Accessibility_DeviceEvent key_event;
717 Accessibility_DeviceEventController controller;
720 g_warning ("failure: pre-listener get dec\n");
723 Accessibility_Registry_getDeviceEventController (
724 spi_atk_bridge_get_registry (), &ev);
728 g_warning ("failure: no deviceeventcontroller found\n");
729 CORBA_exception_free (&ev);
730 registry_died = TRUE;
736 spi_init_keystroke_from_atk_key_event (&key_event, event);
738 result = Accessibility_DeviceEventController_notifyListenersSync (
739 controller, &key_event, &ev);
741 bonobo_object_release_unref (controller, &ev);
742 CORBA_exception_free (&ev);
749 spi_atk_bridge_signal_listener (GSignalInvocationHint *signal_hint,
750 guint n_param_values,
751 const GValue *param_values,
755 GSignalQuery signal_query;
758 AtkBridgeEventContext *ctx = NULL;
760 gint detail1 = 0, detail2 = 0;
761 #ifdef SPI_BRIDGE_DEBUG
765 g_signal_query (signal_hint->signal_id, &signal_query);
767 name = signal_query.signal_name;
768 if (signal_hint->detail)
769 detail = g_quark_to_string (signal_hint->detail);
773 #ifdef SPI_BRIDGE_DEBUG
774 s2 = g_type_name (G_OBJECT_TYPE (g_value_get_object (param_values + 0)));
775 s = atk_object_get_name (ATK_OBJECT (g_value_get_object (param_values + 0)));
776 fprintf (stderr, "Received signal %s:%s detail: %s from object %s (gail %s)\n",
777 g_type_name (signal_query.itype), name,
778 detail ? detail : "<NULL>", s ? s : "<NULL>" , s2);
781 gobject = g_value_get_object (param_values + 0);
782 if (G_VALUE_TYPE (param_values + 1) == G_TYPE_INT)
783 detail1 = g_value_get_int (param_values + 1);
784 if (G_VALUE_TYPE (param_values + 2) == G_TYPE_INT)
785 detail2 = g_value_get_int (param_values + 2);
787 /* build some event context data, depending on the type */
788 ctx = spi_atk_bridge_event_context_create (gobject,
794 spi_atk_emit_eventv (gobject, detail1, detail2, ctx,
795 "object:%s:%s", name, detail);
797 spi_atk_emit_eventv (gobject, detail1, detail2, ctx,
801 spi_atk_bridge_event_context_free (ctx);
807 spi_atk_bridge_window_event_listener (GSignalInvocationHint *signal_hint,
808 guint n_param_values,
809 const GValue *param_values,
813 GSignalQuery signal_query;
814 AtkBridgeEventContext ctx;
816 const gchar *name, *s;
817 #ifdef SPI_BRIDGE_DEBUG
821 g_signal_query (signal_hint->signal_id, &signal_query);
823 name = signal_query.signal_name;
825 #ifdef SPI_BRIDGE_DEBUG
826 s2 = g_type_name (G_OBJECT_TYPE (g_value_get_object (param_values + 0)));
827 s = atk_object_get_name (ATK_OBJECT (g_value_get_object (param_values + 0)));
828 fprintf (stderr, "Received signal %s:%s from object %s (gail %s)\n",
829 g_type_name (signal_query.itype), name, s ? s : "<NULL>" , s2);
832 gobject = g_value_get_object (param_values + 0);
833 ctx._type = ATK_BRIDGE_CONTEXT_TYPE_STRING;
834 s = atk_object_get_name (ATK_OBJECT (gobject));
835 ctx._data.string = (gchar *) s;
836 /* cast from const silences compiler */
837 spi_atk_emit_eventv (gobject, 0, 0, &ctx, "window:%s", name);
838 /* don't free the context, it's on the stack */