atk-bridge/bridge.c

   1 /*
   2  * AT-SPI - Assistive Technology Service Provider Interface
   3  * (Gnome Accessibility Project; http://developer.gnome.org/projects/gap)
   4  *
   5  * Copyright 2001 Sun Microsystems Inc.
   6  *
   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.
  11  *
  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.
  16  *
  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.
  21  */
  22
  23 #include <stdio.h>
  24 #include <stdlib.h>
  25 #include <stdarg.h>
  26 #include <libbonobo.h>
  27 #include <orbit/orbit.h>
  28 #include <atk/atk.h>
  29 #include <atk/atkobject.h>
  30 #include <atk/atknoopobject.h>
  31 #include <libspi/Accessibility.h>
  32 #include "accessible.h"
  33 #include "application.h"
  34
  35 #undef SPI_BRIDGE_DEBUG
  36
  37 static CORBA_Environment ev;
  38 static Accessibility_Registry registry;
  39 static SpiApplication *this_app = NULL;
  40
  41 static void     spi_atk_bridge_exit_func               (void);
  42 static void     spi_atk_register_event_listeners       (void);
  43 static gboolean spi_atk_bridge_idle_init               (gpointer               user_data);
  44 static void     spi_atk_bridge_focus_tracker           (AtkObject             *object);
  45 static gboolean spi_atk_bridge_property_event_listener (GSignalInvocationHint *signal_hint,
  46                                                         guint                  n_param_values,
  47                                                         const GValue          *param_values,
  48                                                         gpointer               data);
  49 static gboolean spi_atk_bridge_signal_listener         (GSignalInvocationHint *signal_hint,
  50                                                         guint                  n_param_values,
  51                                                         const GValue          *param_values,
  52                                                         gpointer               data);
  53 static gint     spi_atk_bridge_key_listener            (AtkKeyEventStruct     *event,
  54                                                         gpointer               data);
  55
  56 /* For automatic libgnome init */
  57 extern void gnome_accessibility_module_init     (void);
  58 extern void gnome_accessibility_module_shutdown (void);
  59
  60 static int     atk_bridge_initialized = FALSE;
  61 static guint   atk_bridge_focus_tracker_id = 0;
  62 static guint   atk_bridge_key_event_listener_id = 0;
  63 static guint   idle_init_id = 0;
  64 static GArray *listener_ids = NULL;
  65
  66 /*
  67  *   These exported symbols are hooked by gnome-program
  68  * to provide automatic module initialization and shutdown.
  69  */
  70 extern void gnome_accessibility_module_init     (void);
  71 extern void gnome_accessibility_module_shutdown (void);
  72
  73 int
  74 gtk_module_init (gint *argc, gchar **argv[])
  75 {
  76   CORBA_Environment ev;
  77
  78   if (atk_bridge_initialized)
  79     {
  80       return 0;
  81     }
  82   atk_bridge_initialized = TRUE;
  83
  84   if (!bonobo_init (argc, *argv))
  85     {
  86       g_error ("Could not initialize Bonobo");
  87     }
  88
  89   CORBA_exception_init(&ev);
  90
  91   registry = bonobo_activation_activate_from_id (
  92           "OAFIID:Accessibility_Registry:proto0.1", 0, NULL, &ev);
  93
  94   if (ev._major != CORBA_NO_EXCEPTION)
  95     {
  96       g_error ("Accessibility app error: exception during "
  97                "registry activation from id: %s\n",
  98                CORBA_exception_id (&ev));
  99       CORBA_exception_free (&ev);
 100     }
 101
 102   if (CORBA_Object_is_nil (registry, &ev))
 103     {
 104       g_error ("Could not locate registry");
 105     }
 106
 107   bonobo_activate ();
 108
 109   /* Create the accessible application server object */
 110
 111   this_app = spi_application_new (atk_get_root ());
 112
 113   fprintf (stderr, "About to register application\n");
 114
 115   Accessibility_Registry_registerApplication (registry,
 116                                               BONOBO_OBJREF (this_app),
 117                                               &ev);
 118
 119   g_atexit (spi_atk_bridge_exit_func);
 120
 121   idle_init_id = g_idle_add (spi_atk_bridge_idle_init, NULL);
 122
 123   return 0;
 124 }
 125
 126 static gboolean
 127 spi_atk_bridge_idle_init (gpointer user_data)
 128 {
 129   idle_init_id = 0;
 130
 131   spi_atk_register_event_listeners ();
 132
 133   fprintf (stderr, "Application registered & listening\n");
 134
 135   return FALSE;
 136 }
 137
 138 static void
 139 add_signal_listener (const char *signal_name)
 140 {
 141   guint id;
 142
 143   id = atk_add_global_event_listener (
 144     spi_atk_bridge_signal_listener, signal_name);
 145
 146   g_array_append_val (listener_ids, id);
 147 }
 148
 149 static void
 150 spi_atk_register_event_listeners (void)
 151 {
 152   /*
 153    * kludge to make sure the Atk interface types are registered, otherwise
 154    * the AtkText signal handlers below won't get registered
 155    */
 156   guint      id;
 157   GObject   *ao = g_object_new (ATK_TYPE_OBJECT, NULL);
 158   AtkObject *bo = atk_no_op_object_new (ao);
 159
 160   /* Register for focus event notifications, and register app with central registry  */
 161
 162   listener_ids = g_array_sized_new (FALSE, TRUE, sizeof (guint), 16);
 163
 164   atk_bridge_focus_tracker_id = atk_add_focus_tracker (spi_atk_bridge_focus_tracker);
 165
 166   id = atk_add_global_event_listener (spi_atk_bridge_property_event_listener,
 167                                       "Gtk:AtkObject:property-change");
 168   g_array_append_val (listener_ids, id);
 169
 170   add_signal_listener ("Gtk:AtkObject:children-changed");
 171   add_signal_listener ("Gtk:AtkObject:visible-data-changed");
 172   add_signal_listener ("Gtk:AtkSelection:selection-changed");
 173   add_signal_listener ("Gtk:AtkText:text-selection-changed");
 174   add_signal_listener ("Gtk:AtkText:text-changed");
 175   add_signal_listener ("Gtk:AtkText:text-caret-moved");
 176   add_signal_listener ("Gtk:AtkTable:row-inserted");
 177   add_signal_listener ("Gtk:AtkTable:row-reordered");
 178   add_signal_listener ("Gtk:AtkTable:row-deleted");
 179   add_signal_listener ("Gtk:AtkTable:column-inserted");
 180   add_signal_listener ("Gtk:AtkTable:column-reordered");
 181   add_signal_listener ("Gtk:AtkTable:column-deleted");
 182   add_signal_listener ("Gtk:AtkTable:model-changed");
 183 /*
 184  * May add the following listeners to implement preemptive key listening for GTK+
 185  *
 186  * atk_add_global_event_listener (spi_atk_bridge_widgetkey_listener, "Gtk:GtkWidget:key-press-event");
 187  * atk_add_global_event_listener (spi_atk_bridge_widgetkey_listener, "Gtk:GtkWidget:key-release-event");
 188  */
 189   atk_bridge_key_event_listener_id = atk_add_key_event_listener (
 190     spi_atk_bridge_key_listener, NULL);
 191
 192   g_object_unref (G_OBJECT (bo));
 193   g_object_unref (ao);
 194 }
 195
 196 static void
 197 deregister_application (BonoboObject *app)
 198 {
 199   Accessibility_Registry_deregisterApplication (
 200           registry, BONOBO_OBJREF (app), &ev);
 201
 202   registry = bonobo_object_release_unref (registry, &ev);
 203
 204   app = bonobo_object_unref (app);
 205 }
 206
 207 static void
 208 spi_atk_bridge_exit_func (void)
 209 {
 210   BonoboObject *app = (BonoboObject *) this_app;
 211
 212   fprintf (stderr, "exiting bridge\n");
 213
 214   if (!app)
 215     {
 216       return;
 217     }
 218   this_app = NULL;
 219
 220   /*
 221    *  FIXME: this may be incorrect for apps that do their own bonobo
 222    *  shutdown, until we can explicitly shutdown to get the ordering
 223    *  right.
 224    */
 225   if (!bonobo_is_initialized ())
 226     {
 227       fprintf (stderr, "Re-initializing bonobo\n");
 228       g_assert (bonobo_init (0, NULL));
 229       g_assert (bonobo_activate ());
 230     }
 231
 232   deregister_application (app);
 233
 234   fprintf (stderr, "bridge exit func complete.\n");
 235
 236   if (g_getenv ("AT_BRIDGE_SHUTDOWN"))
 237     {
 238       g_assert (!bonobo_debug_shutdown ());
 239     }
 240 }
 241
 242 void
 243 gnome_accessibility_module_init (void)
 244 {
 245   gtk_module_init (NULL, NULL);
 246
 247   g_print("Atk Accessibilty bridge initialized\n");
 248 }
 249
 250 void
 251 gnome_accessibility_module_shutdown (void)
 252 {
 253   BonoboObject *app = (BonoboObject *) this_app;
 254
 255   if (!atk_bridge_initialized)
 256     {
 257       return;
 258     }
 259   atk_bridge_initialized = FALSE;
 260   this_app = NULL;
 261
 262   g_print("Atk Accessibilty bridge shutdown\n");
 263
 264   if (idle_init_id)
 265     {
 266       g_source_remove (idle_init_id);
 267       idle_init_id = 0;
 268     }
 269   else
 270     {
 271       int     i;
 272       GArray *ids = listener_ids;
 273
 274       listener_ids = NULL;
 275       atk_remove_focus_tracker (atk_bridge_focus_tracker_id);
 276
 277       for (i = 0; ids && i < ids->len; i++)
 278         {
 279           atk_remove_global_event_listener (g_array_index (ids, guint, i));
 280         }
 281
 282       atk_remove_key_event_listener (atk_bridge_key_event_listener_id);
 283     }
 284
 285   deregister_application (app);
 286 }
 287
 288 static void
 289 spi_atk_bridge_focus_tracker (AtkObject *object)
 290 {
 291   SpiAccessible *source;
 292   Accessibility_Event e;
 293
 294   source = spi_accessible_new (object);
 295
 296   e.type = "focus:";
 297   e.source = BONOBO_OBJREF (source);
 298   e.detail1 = 0;
 299   e.detail2 = 0;
 300
 301   Accessibility_Registry_notifyEvent (registry, &e, &ev);
 302
 303   CORBA_exception_free (&ev);
 304 }
 305
 306 static void
 307 spi_atk_emit_eventv (GObject      *gobject,
 308                      unsigned long detail1,
 309                      unsigned long detail2,
 310                      const char   *format, ...)
 311 {
 312   va_list             args;
 313   Accessibility_Event e;
 314   SpiAccessible      *source;
 315   AtkObject          *aobject;
 316 #ifdef SPI_BRIDGE_DEBUG
 317   CORBA_string s;
 318 #endif
 319
 320   va_start (args, format);
 321
 322   if (ATK_IS_IMPLEMENTOR (gobject))
 323     {
 324       aobject = atk_implementor_ref_accessible (ATK_IMPLEMENTOR (gobject));
 325       source  = spi_accessible_new (aobject);
 326       g_object_unref (G_OBJECT (aobject));
 327     }
 328   else if (ATK_IS_OBJECT (gobject))
 329     {
 330       aobject = ATK_OBJECT (gobject);
 331       source  = spi_accessible_new (aobject);
 332     }
 333   else
 334     {
 335       aobject = NULL;
 336       source  = NULL;
 337       g_error ("received property-change event from non-AtkImplementor");
 338     }
 339
 340   if (source != NULL)
 341     {
 342       e.type = g_strdup_vprintf (format, args);
 343       e.source = BONOBO_OBJREF (source);
 344       e.detail1 = detail1;
 345       e.detail2 = detail2;
 346
 347 #ifdef SPI_BRIDGE_DEBUG
 348       s = Accessibility_Accessible__get_name (BONOBO_OBJREF (source), &ev);
 349       g_warning ("Emitting event '%s' (%lu, %lu) on %s",
 350                  e.type, e.detail1, e.detail2, s);
 351       CORBA_free (s);
 352 #endif
 353
 354       Accessibility_Registry_notifyEvent (registry, &e, &ev);
 355
 356       CORBA_exception_free (&ev);
 357
 358       g_free (e.type);
 359     }
 360
 361   va_end (args);
 362 }
 363
 364 static gboolean
 365 spi_atk_bridge_property_event_listener (GSignalInvocationHint *signal_hint,
 366                                         guint n_param_values,
 367                                         const GValue *param_values,
 368                                         gpointer data)
 369 {
 370   AtkPropertyValues *values;
 371   GObject *gobject;
 372
 373 #ifdef SPI_BRIDGE_DEBUG
 374   GSignalQuery signal_query;
 375   const gchar *name;
 376   gchar *s, *s2;
 377
 378   g_signal_query (signal_hint->signal_id, &signal_query);
 379   name = signal_query.signal_name;
 380
 381   s2 = g_type_name (G_OBJECT_TYPE (g_value_get_object (param_values + 0)));
 382   s = atk_object_get_name (ATK_OBJECT (g_value_get_object (param_values + 0)));
 383   fprintf (stderr, "Received (property) signal %s:%s from object %s (gail %s)\n",
 384            g_type_name (signal_query.itype), name, s, s2);
 385 #endif
 386
 387   gobject = g_value_get_object (param_values + 0);
 388   values = (AtkPropertyValues*) g_value_get_pointer (param_values + 1);
 389
 390   spi_atk_emit_eventv (gobject, 0, 0, "object:property-change:%s", values->property_name);
 391
 392   return TRUE;
 393 }
 394
 395 #if THIS_WILL_EVER_BE_USED
 396 static gboolean
 397 spi_atk_bridge_state_event_listener (GSignalInvocationHint *signal_hint,
 398                                      guint n_param_values,
 399                                      const GValue *param_values,
 400                                      gpointer data)
 401 {
 402   GObject *gobject;
 403   AtkPropertyValues *values;
 404 #ifdef SPI_BRIDGE_DEBUG
 405   GSignalQuery signal_query;
 406   const gchar *name;
 407
 408   g_signal_query (signal_hint->signal_id, &signal_query);
 409   name = signal_query.signal_name;
 410   fprintf (stderr, "Received (state) signal %s:%s\n",
 411            g_type_name (signal_query.itype), name);
 412 #endif
 413
 414   gobject = g_value_get_object (param_values + 0);
 415   values = (AtkPropertyValues*) g_value_get_pointer (param_values + 1);
 416
 417   spi_atk_emit_eventv (gobject,
 418                        (unsigned long) values->old_value.data[0].v_ulong,
 419                        (unsigned long) values->new_value.data[0].v_ulong,
 420                        "object:%s:?", values->property_name);
 421
 422   return TRUE;
 423 }
 424 #endif
 425
 426 static void
 427 spi_init_keystroke_from_atk_key_event (Accessibility_DeviceEvent  *keystroke,
 428                                        AtkKeyEventStruct          *event)
 429 {
 430 #ifdef SPI_DEBUG
 431   if (event)
 432     {
 433       g_print ("event %c (%d)\n", (int) event->keyval, (int) event->keycode);
 434     }
 435   else
 436 #endif
 437   if (!event)
 438     {
 439       g_print ("WARNING: NULL key event!");
 440     }
 441
 442   keystroke->id        = (CORBA_long) event->keyval;
 443   keystroke->hw_code   = (CORBA_short) event->keycode;
 444   keystroke->timestamp = (CORBA_unsigned_long) event->timestamp;
 445   keystroke->modifiers = (CORBA_unsigned_short) (event->state & 0xFFFF);
 446   if (event->string)
 447     {
 448       keystroke->event_string = CORBA_string_dup (event->string);
 449       keystroke->is_text = CORBA_TRUE;
 450     }
 451   else
 452     {
 453       keystroke->event_string = CORBA_string_dup ("");
 454       keystroke->is_text = CORBA_FALSE;
 455     }
 456   switch (event->type)
 457     {
 458     case (ATK_KEY_EVENT_PRESS):
 459       keystroke->type = Accessibility_KEY_PRESSED;
 460       break;
 461     case (ATK_KEY_EVENT_RELEASE):
 462       keystroke->type = Accessibility_KEY_RELEASED;
 463       break;
 464     default:
 465       keystroke->type = 0;
 466       break;
 467     }
 468 #if 0
 469   g_print ("key_event type %d; val=%d code=%d modifiers=%x name=%s is_text=%d, time=%lx\n",
 470            (int) keystroke->type, (int) keystroke->id, (int) keystroke->hw_code,
 471            (int) keystroke->modifiers,
 472            keystroke->event_string, (int) keystroke->is_text, (unsigned long) keystroke->timestamp);
 473 #endif
 474 }
 475
 476 static gint
 477 spi_atk_bridge_key_listener (AtkKeyEventStruct *event, gpointer data)
 478 {
 479   CORBA_boolean             result;
 480   Accessibility_DeviceEvent key_event;
 481   Accessibility_DeviceEventController controller =
 482     Accessibility_Registry_getDeviceEventController (registry, &ev);
 483
 484   if (BONOBO_EX (&ev))
 485     {
 486       g_warning ("failure: no deviceeventcontroller found\n");
 487       CORBA_exception_free (&ev);
 488       result = FALSE;
 489     }
 490   else
 491     {
 492
 493       spi_init_keystroke_from_atk_key_event (&key_event, event);
 494
 495       result = Accessibility_DeviceEventController_notifyListenersSync (
 496         controller, &key_event, &ev);
 497
 498       CORBA_exception_free (&ev);
 499     }
 500
 501   return result;
 502 }
 503
 504 static gboolean
 505 spi_atk_bridge_signal_listener (GSignalInvocationHint *signal_hint,
 506                                 guint n_param_values,
 507                                 const GValue *param_values,
 508                                 gpointer data)
 509 {
 510   GObject *gobject;
 511   GSignalQuery signal_query;
 512   const gchar *name;
 513   gint detail1 = 0, detail2 = 0;
 514 #ifdef SPI_BRIDGE_DEBUG
 515   gchar *s, *s2;
 516 #endif
 517
 518   g_signal_query (signal_hint->signal_id, &signal_query);
 519
 520   name = signal_query.signal_name;
 521
 522 #ifdef SPI_BRIDGE_DEBUG
 523   s2 = g_type_name (G_OBJECT_TYPE (g_value_get_object (param_values + 0)));
 524   s = atk_object_get_name (ATK_OBJECT (g_value_get_object (param_values + 0)));
 525   fprintf (stderr, "Received signal %s:%s from object %s (gail %s)\n",
 526            g_type_name (signal_query.itype), name, s, s2);
 527 #endif
 528
 529   gobject = g_value_get_object (param_values + 0);
 530   if (G_VALUE_TYPE (param_values + 1) == G_TYPE_INT)
 531     detail1 = g_value_get_int (param_values + 1);
 532   if (G_VALUE_TYPE (param_values + 2) == G_TYPE_INT)
 533     detail2 = g_value_get_int (param_values + 2);
 534
 535   spi_atk_emit_eventv (gobject, detail1, detail2, "object:%s", name);
 536
 537   return TRUE;
 538 }