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 gboolean bridge_idle_init (gpointer user_data);
  42 static void bridge_focus_tracker (AtkObject *object);
  43 static void bridge_exit_func (void);
  44 static void register_atk_event_listeners (void);
  45 static gboolean bridge_property_event_listener (GSignalInvocationHint *signal_hint,
  46                                                 guint n_param_values,
  47                                                 const GValue *param_values,
  48                                                 gpointer data);
  49 static gboolean bridge_state_event_listener (GSignalInvocationHint *signal_hint,
  50                                              guint n_param_values,
  51                                              const GValue *param_values,
  52                                              gpointer data);
  53 static gboolean bridge_signal_listener (GSignalInvocationHint *signal_hint,
  54                                         guint n_param_values,
  55                                         const GValue *param_values,
  56                                         gpointer data);
  57
  58 static gint bridge_key_listener (AtkKeyEventStruct *event,
  59                                  gpointer data);
  60
  61 int
  62 gtk_module_init (gint *argc, gchar **argv[])
  63 {
  64   CORBA_Environment ev;
  65
  66   if (!bonobo_init (argc, *argv))
  67     {
  68       g_error ("Could not initialize Bonobo");
  69     }
  70
  71   CORBA_exception_init(&ev);
  72
  73   registry = bonobo_activation_activate_from_id (
  74           "OAFIID:Accessibility_Registry:proto0.1", 0, NULL, &ev);
  75
  76   if (ev._major != CORBA_NO_EXCEPTION)
  77     {
  78       g_error ("Accessibility app error: exception during "
  79                "registry activation from id: %s\n",
  80                CORBA_exception_id (&ev));
  81       CORBA_exception_free (&ev);
  82     }
  83
  84   if (CORBA_Object_is_nil (registry, &ev))
  85     {
  86       g_error ("Could not locate registry");
  87     }
  88
  89   bonobo_activate ();
  90
  91   /* Create the accessible application server object */
  92
  93   this_app = spi_application_new (atk_get_root ());
  94
  95   fprintf (stderr, "About to register application\n");
  96
  97   Accessibility_Registry_registerApplication (registry,
  98                                               BONOBO_OBJREF (this_app),
  99                                               &ev);
 100
 101   g_atexit (bridge_exit_func);
 102
 103   g_idle_add (bridge_idle_init, NULL);
 104
 105   return 0;
 106 }
 107
 108 static gboolean
 109 bridge_idle_init (gpointer user_data)
 110 {
 111   register_atk_event_listeners ();
 112
 113   fprintf (stderr, "Application registered & listening\n");
 114
 115   return FALSE;
 116 }
 117
 118 static void
 119 register_atk_event_listeners (void)
 120 {
 121   /*
 122    * kludge to make sure the Atk interface types are registered, otherwise
 123    * the AtkText signal handlers below won't get registered
 124    */
 125   GObject   *ao = g_object_new (ATK_TYPE_OBJECT, NULL);
 126   AtkObject *bo = atk_no_op_object_new (ao);
 127
 128   /* Register for focus event notifications, and register app with central registry  */
 129
 130   atk_add_focus_tracker (bridge_focus_tracker);
 131   atk_add_global_event_listener (bridge_property_event_listener, "Gtk:AtkObject:property-change");
 132   atk_add_global_event_listener (bridge_signal_listener, "Gtk:AtkObject:children-changed");
 133   atk_add_global_event_listener (bridge_signal_listener, "Gtk:AtkObject:visible-data-changed");
 134   atk_add_global_event_listener (bridge_signal_listener, "Gtk:AtkSelection:selection-changed");
 135   atk_add_global_event_listener (bridge_signal_listener, "Gtk:AtkText:text-selection-changed");
 136   atk_add_global_event_listener (bridge_signal_listener, "Gtk:AtkText:text-changed");
 137   atk_add_global_event_listener (bridge_signal_listener, "Gtk:AtkText:text-caret-moved");
 138   atk_add_global_event_listener (bridge_signal_listener, "Gtk:AtkTable:row-inserted");
 139   atk_add_global_event_listener (bridge_signal_listener, "Gtk:AtkTable:row-reordered");
 140   atk_add_global_event_listener (bridge_signal_listener, "Gtk:AtkTable:row-deleted");
 141   atk_add_global_event_listener (bridge_signal_listener, "Gtk:AtkTable:column-inserted");
 142   atk_add_global_event_listener (bridge_signal_listener, "Gtk:AtkTable:column-reordered");
 143   atk_add_global_event_listener (bridge_signal_listener, "Gtk:AtkTable:column-deleted");
 144   atk_add_global_event_listener (bridge_signal_listener, "Gtk:AtkTable:model-changed");
 145   atk_add_key_event_listener    (bridge_key_listener, NULL);
 146
 147   g_object_unref (G_OBJECT (bo));
 148   g_object_unref (ao);
 149 }
 150
 151 static void
 152 bridge_exit_func (void)
 153 {
 154   BonoboObject *app = (BonoboObject *) this_app;
 155
 156   fprintf (stderr, "exiting bridge\n");
 157
 158   if (!app)
 159     {
 160       return;
 161     }
 162   this_app = NULL;
 163
 164   /*
 165    *  FIXME: this may be incorrect for apps that do their own bonobo
 166    *  shutdown, until we can explicitly shutdown to get the ordering
 167    *  right.
 168    */
 169   if (!bonobo_is_initialized ())
 170     {
 171       fprintf (stderr, "Re-initializing bonobo\n");
 172       g_assert (bonobo_init (0, NULL));
 173       g_assert (bonobo_activate ());
 174     }
 175
 176   Accessibility_Registry_deregisterApplication (
 177           registry, BONOBO_OBJREF (app), &ev);
 178
 179   bonobo_object_release_unref (registry, &ev);
 180
 181   bonobo_object_unref (app);
 182
 183   fprintf (stderr, "bridge exit func complete.\n");
 184
 185   if (g_getenv ("AT_BRIDGE_SHUTDOWN"))
 186     {
 187       g_assert (!bonobo_debug_shutdown ());
 188     }
 189 }
 190
 191 static void
 192 bridge_focus_tracker (AtkObject *object)
 193 {
 194   SpiAccessible *source;
 195   Accessibility_Event e;
 196
 197   source = spi_accessible_new (object);
 198
 199   e.type = "focus:";
 200   e.source = BONOBO_OBJREF (source);
 201   e.detail1 = 0;
 202   e.detail2 = 0;
 203
 204   Accessibility_Registry_notifyEvent (registry, &e, &ev);
 205
 206   CORBA_exception_free (&ev);
 207 }
 208
 209 static void
 210 emit_eventv (GObject      *gobject,
 211              unsigned long detail1,
 212              unsigned long detail2,
 213              const char   *format, ...)
 214 {
 215   va_list             args;
 216   Accessibility_Event e;
 217   SpiAccessible      *source;
 218   AtkObject          *aobject;
 219 #ifdef SPI_BRIDGE_DEBUG
 220   CORBA_string s;
 221 #endif
 222
 223   va_start (args, format);
 224
 225   if (ATK_IS_IMPLEMENTOR (gobject))
 226     {
 227       aobject = atk_implementor_ref_accessible (ATK_IMPLEMENTOR (gobject));
 228       source  = spi_accessible_new (aobject);
 229       g_object_unref (G_OBJECT (aobject));
 230     }
 231   else if (ATK_IS_OBJECT (gobject))
 232     {
 233       aobject = ATK_OBJECT (gobject);
 234       source  = spi_accessible_new (aobject);
 235     }
 236   else
 237     {
 238       aobject = NULL;
 239       source  = NULL;
 240       g_error ("received property-change event from non-AtkImplementor");
 241     }
 242
 243   if (source != NULL)
 244     {
 245       e.type = g_strdup_vprintf (format, args);
 246       e.source = BONOBO_OBJREF (source);
 247       e.detail1 = detail1;
 248       e.detail2 = detail2;
 249
 250 #ifdef SPI_BRIDGE_DEBUG
 251       s = Accessibility_Accessible__get_name (BONOBO_OBJREF (source), &ev);
 252       g_warning ("Emitting event '%s' (%lu, %lu) on %s",
 253                  e.type, e.detail1, e.detail2, s);
 254       CORBA_free (s);
 255 #endif
 256
 257       Accessibility_Registry_notifyEvent (registry, &e, &ev);
 258
 259       CORBA_exception_free (&ev);
 260
 261       g_free (e.type);
 262     }
 263
 264   va_end (args);
 265 }
 266
 267 static gboolean
 268 bridge_property_event_listener (GSignalInvocationHint *signal_hint,
 269                                 guint n_param_values,
 270                                 const GValue *param_values,
 271                                 gpointer data)
 272 {
 273   AtkPropertyValues *values;
 274   GObject *gobject;
 275
 276 #ifdef SPI_BRIDGE_DEBUG
 277   GSignalQuery signal_query;
 278   const gchar *name;
 279   gchar *s, *s2;
 280
 281   g_signal_query (signal_hint->signal_id, &signal_query);
 282   name = signal_query.signal_name;
 283
 284   s2 = g_type_name (G_OBJECT_TYPE (g_value_get_object (param_values + 0)));
 285   s = atk_object_get_name (ATK_OBJECT (g_value_get_object (param_values + 0)));
 286   fprintf (stderr, "Received (property) signal %s:%s from object %s (gail %s)\n",
 287            g_type_name (signal_query.itype), name, s, s2);
 288 #endif
 289
 290   gobject = g_value_get_object (param_values + 0);
 291   values = (AtkPropertyValues*) g_value_get_pointer (param_values + 1);
 292
 293   emit_eventv (gobject, 0, 0, "object:property-change:%s", values->property_name);
 294
 295   return TRUE;
 296 }
 297
 298 static gboolean
 299 bridge_state_event_listener (GSignalInvocationHint *signal_hint,
 300                              guint n_param_values,
 301                              const GValue *param_values,
 302                              gpointer data)
 303 {
 304   GObject *gobject;
 305   AtkPropertyValues *values;
 306 #ifdef SPI_BRIDGE_DEBUG
 307   GSignalQuery signal_query;
 308   const gchar *name;
 309
 310   g_signal_query (signal_hint->signal_id, &signal_query);
 311   name = signal_query.signal_name;
 312   fprintf (stderr, "Received (state) signal %s:%s\n",
 313            g_type_name (signal_query.itype), name);
 314 #endif
 315
 316   gobject = g_value_get_object (param_values + 0);
 317   values = (AtkPropertyValues*) g_value_get_pointer (param_values + 1);
 318
 319   emit_eventv (gobject,
 320                (unsigned long) values->old_value.data[0].v_ulong,
 321                (unsigned long) values->new_value.data[0].v_ulong,
 322                "object:%s:?", values->property_name);
 323
 324   return TRUE;
 325 }
 326
 327 static void
 328 accessibility_init_keystroke_from_atk_key_event (Accessibility_KeyStroke *keystroke,
 329                                                  AtkKeyEventStruct       *event)
 330 {
 331 #ifdef SPI_DEBUG
 332   if (event)
 333     {
 334       g_print ("event %c (%d)\n", (int) event->keyval, (int) event->keycode);
 335     }
 336   else
 337 #endif
 338   if (!event)
 339     {
 340       g_print ("WARNING: NULL key event!");
 341     }
 342
 343   keystroke->keyID     = (CORBA_long) event->keyval;
 344   keystroke->keycode   = (CORBA_short) event->keycode;
 345   keystroke->timestamp = (CORBA_unsigned_long) event->timestamp;
 346   keystroke->modifiers = (CORBA_unsigned_short) (event->state & 0xFFFF);
 347
 348   switch (event->type)
 349     {
 350     case (ATK_KEY_EVENT_PRESS):
 351       keystroke->type = Accessibility_KEY_PRESSED;
 352       break;
 353     case (ATK_KEY_EVENT_RELEASE):
 354       keystroke->type = Accessibility_KEY_RELEASED;
 355       break;
 356     default:
 357       keystroke->type = 0;
 358       break;
 359     }
 360 }
 361
 362 static gint
 363 bridge_key_listener (AtkKeyEventStruct *event, gpointer data)
 364 {
 365   CORBA_boolean           result;
 366   Accessibility_KeyStroke key_event;
 367   Accessibility_DeviceEventController controller =
 368     Accessibility_Registry_getDeviceEventController (registry, &ev);
 369
 370   if (BONOBO_EX (&ev))
 371     {
 372       CORBA_exception_free (&ev);
 373       result = FALSE;
 374     }
 375   else
 376     {
 377
 378       accessibility_init_keystroke_from_atk_key_event (&key_event, event);
 379
 380   /* FIXME: this casting is just totaly bogus */
 381       result = Accessibility_DeviceEventController_notifyListenersSync (
 382         controller, (Accessibility_DeviceEvent *) &key_event, &ev);
 383
 384       CORBA_exception_free (&ev);
 385     }
 386
 387   return result;
 388 }
 389
 390 static gboolean
 391 bridge_signal_listener (GSignalInvocationHint *signal_hint,
 392                         guint n_param_values,
 393                         const GValue *param_values,
 394                         gpointer data)
 395 {
 396   GObject *gobject;
 397   GSignalQuery signal_query;
 398   const gchar *name;
 399 #ifdef SPI_BRIDGE_DEBUG
 400   gchar *s, *s2;
 401 #endif
 402
 403   g_signal_query (signal_hint->signal_id, &signal_query);
 404
 405   name = signal_query.signal_name;
 406
 407 #ifdef SPI_BRIDGE_DEBUG
 408   s2 = g_type_name (G_OBJECT_TYPE (g_value_get_object (param_values + 0)));
 409   s = atk_object_get_name (ATK_OBJECT (g_value_get_object (param_values + 0)));
 410   fprintf (stderr, "Received signal %s:%s from object %s (gail %s)\n",
 411            g_type_name (signal_query.itype), name, s, s2);
 412 #endif
 413
 414   gobject = g_value_get_object (param_values + 0);
 415
 416   emit_eventv (gobject, 0, 0, "object:%s", name);
 417
 418   return TRUE;
 419 }