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 /*
 146  * May add the following listeners to implement preemptive key listening for GTK+
 147  *
 148  * atk_add_global_event_listener (bridge_widgetkey_listener, "Gtk:GtkWidget:key-press-event");
 149  * atk_add_global_event_listener (bridge_widgetkey_listener, "Gtk:GtkWidget:key-release-event");
 150  */
 151   atk_add_key_event_listener    (bridge_key_listener, NULL);
 152
 153   g_object_unref (G_OBJECT (bo));
 154   g_object_unref (ao);
 155 }
 156
 157 static void
 158 bridge_exit_func (void)
 159 {
 160   BonoboObject *app = (BonoboObject *) this_app;
 161
 162   fprintf (stderr, "exiting bridge\n");
 163
 164   if (!app)
 165     {
 166       return;
 167     }
 168   this_app = NULL;
 169
 170   /*
 171    *  FIXME: this may be incorrect for apps that do their own bonobo
 172    *  shutdown, until we can explicitly shutdown to get the ordering
 173    *  right.
 174    */
 175   if (!bonobo_is_initialized ())
 176     {
 177       fprintf (stderr, "Re-initializing bonobo\n");
 178       g_assert (bonobo_init (0, NULL));
 179       g_assert (bonobo_activate ());
 180     }
 181
 182   Accessibility_Registry_deregisterApplication (
 183           registry, BONOBO_OBJREF (app), &ev);
 184
 185   bonobo_object_release_unref (registry, &ev);
 186
 187   bonobo_object_unref (app);
 188
 189   fprintf (stderr, "bridge exit func complete.\n");
 190
 191   if (g_getenv ("AT_BRIDGE_SHUTDOWN"))
 192     {
 193       g_assert (!bonobo_debug_shutdown ());
 194     }
 195 }
 196
 197 static void
 198 bridge_focus_tracker (AtkObject *object)
 199 {
 200   SpiAccessible *source;
 201   Accessibility_Event e;
 202
 203   source = spi_accessible_new (object);
 204
 205   e.type = "focus:";
 206   e.source = BONOBO_OBJREF (source);
 207   e.detail1 = 0;
 208   e.detail2 = 0;
 209
 210   Accessibility_Registry_notifyEvent (registry, &e, &ev);
 211
 212   CORBA_exception_free (&ev);
 213 }
 214
 215 static void
 216 emit_eventv (GObject      *gobject,
 217              unsigned long detail1,
 218              unsigned long detail2,
 219              const char   *format, ...)
 220 {
 221   va_list             args;
 222   Accessibility_Event e;
 223   SpiAccessible      *source;
 224   AtkObject          *aobject;
 225 #ifdef SPI_BRIDGE_DEBUG
 226   CORBA_string s;
 227 #endif
 228
 229   va_start (args, format);
 230
 231   if (ATK_IS_IMPLEMENTOR (gobject))
 232     {
 233       aobject = atk_implementor_ref_accessible (ATK_IMPLEMENTOR (gobject));
 234       source  = spi_accessible_new (aobject);
 235       g_object_unref (G_OBJECT (aobject));
 236     }
 237   else if (ATK_IS_OBJECT (gobject))
 238     {
 239       aobject = ATK_OBJECT (gobject);
 240       source  = spi_accessible_new (aobject);
 241     }
 242   else
 243     {
 244       aobject = NULL;
 245       source  = NULL;
 246       g_error ("received property-change event from non-AtkImplementor");
 247     }
 248
 249   if (source != NULL)
 250     {
 251       e.type = g_strdup_vprintf (format, args);
 252       e.source = BONOBO_OBJREF (source);
 253       e.detail1 = detail1;
 254       e.detail2 = detail2;
 255
 256 #ifdef SPI_BRIDGE_DEBUG
 257       s = Accessibility_Accessible__get_name (BONOBO_OBJREF (source), &ev);
 258       g_warning ("Emitting event '%s' (%lu, %lu) on %s",
 259                  e.type, e.detail1, e.detail2, s);
 260       CORBA_free (s);
 261 #endif
 262
 263       Accessibility_Registry_notifyEvent (registry, &e, &ev);
 264
 265       CORBA_exception_free (&ev);
 266
 267       g_free (e.type);
 268     }
 269
 270   va_end (args);
 271 }
 272
 273 static gboolean
 274 bridge_property_event_listener (GSignalInvocationHint *signal_hint,
 275                                 guint n_param_values,
 276                                 const GValue *param_values,
 277                                 gpointer data)
 278 {
 279   AtkPropertyValues *values;
 280   GObject *gobject;
 281
 282 #ifdef SPI_BRIDGE_DEBUG
 283   GSignalQuery signal_query;
 284   const gchar *name;
 285   gchar *s, *s2;
 286
 287   g_signal_query (signal_hint->signal_id, &signal_query);
 288   name = signal_query.signal_name;
 289
 290   s2 = g_type_name (G_OBJECT_TYPE (g_value_get_object (param_values + 0)));
 291   s = atk_object_get_name (ATK_OBJECT (g_value_get_object (param_values + 0)));
 292   fprintf (stderr, "Received (property) signal %s:%s from object %s (gail %s)\n",
 293            g_type_name (signal_query.itype), name, s, s2);
 294 #endif
 295
 296   gobject = g_value_get_object (param_values + 0);
 297   values = (AtkPropertyValues*) g_value_get_pointer (param_values + 1);
 298
 299   emit_eventv (gobject, 0, 0, "object:property-change:%s", values->property_name);
 300
 301   return TRUE;
 302 }
 303
 304 static gboolean
 305 bridge_state_event_listener (GSignalInvocationHint *signal_hint,
 306                              guint n_param_values,
 307                              const GValue *param_values,
 308                              gpointer data)
 309 {
 310   GObject *gobject;
 311   AtkPropertyValues *values;
 312 #ifdef SPI_BRIDGE_DEBUG
 313   GSignalQuery signal_query;
 314   const gchar *name;
 315
 316   g_signal_query (signal_hint->signal_id, &signal_query);
 317   name = signal_query.signal_name;
 318   fprintf (stderr, "Received (state) signal %s:%s\n",
 319            g_type_name (signal_query.itype), name);
 320 #endif
 321
 322   gobject = g_value_get_object (param_values + 0);
 323   values = (AtkPropertyValues*) g_value_get_pointer (param_values + 1);
 324
 325   emit_eventv (gobject,
 326                (unsigned long) values->old_value.data[0].v_ulong,
 327                (unsigned long) values->new_value.data[0].v_ulong,
 328                "object:%s:?", values->property_name);
 329
 330   return TRUE;
 331 }
 332
 333 static void
 334 accessibility_init_keystroke_from_atk_key_event (Accessibility_DeviceEvent  *keystroke,
 335                                                  AtkKeyEventStruct          *event)
 336 {
 337 #ifdef SPI_DEBUG
 338   if (event)
 339     {
 340       g_print ("event %c (%d)\n", (int) event->keyval, (int) event->keycode);
 341     }
 342   else
 343 #endif
 344   if (!event)
 345     {
 346       g_print ("WARNING: NULL key event!");
 347     }
 348
 349   keystroke->id        = (CORBA_long) event->keyval;
 350   keystroke->hw_code   = (CORBA_short) event->keycode;
 351   keystroke->timestamp = (CORBA_unsigned_long) event->timestamp;
 352   keystroke->modifiers = (CORBA_unsigned_short) (event->state & 0xFFFF);
 353
 354   switch (event->type)
 355     {
 356     case (ATK_KEY_EVENT_PRESS):
 357       keystroke->type = Accessibility_KEY_PRESSED;
 358       break;
 359     case (ATK_KEY_EVENT_RELEASE):
 360       keystroke->type = Accessibility_KEY_RELEASED;
 361       break;
 362     default:
 363       keystroke->type = 0;
 364       break;
 365     }
 366 }
 367
 368 static gint
 369 bridge_key_listener (AtkKeyEventStruct *event, gpointer data)
 370 {
 371   CORBA_boolean             result;
 372   Accessibility_DeviceEvent key_event;
 373   Accessibility_DeviceEventController controller =
 374     Accessibility_Registry_getDeviceEventController (registry, &ev);
 375
 376   if (BONOBO_EX (&ev))
 377     {
 378       CORBA_exception_free (&ev);
 379       result = FALSE;
 380     }
 381   else
 382     {
 383
 384       accessibility_init_keystroke_from_atk_key_event (&key_event, event);
 385
 386       result = Accessibility_DeviceEventController_notifyListenersSync (
 387         controller, &key_event, &ev);
 388
 389       CORBA_exception_free (&ev);
 390     }
 391
 392   return result;
 393 }
 394
 395 static gboolean
 396 bridge_signal_listener (GSignalInvocationHint *signal_hint,
 397                         guint n_param_values,
 398                         const GValue *param_values,
 399                         gpointer data)
 400 {
 401   GObject *gobject;
 402   GSignalQuery signal_query;
 403   const gchar *name;
 404 #ifdef SPI_BRIDGE_DEBUG
 405   gchar *s, *s2;
 406 #endif
 407
 408   g_signal_query (signal_hint->signal_id, &signal_query);
 409
 410   name = signal_query.signal_name;
 411
 412 #ifdef SPI_BRIDGE_DEBUG
 413   s2 = g_type_name (G_OBJECT_TYPE (g_value_get_object (param_values + 0)));
 414   s = atk_object_get_name (ATK_OBJECT (g_value_get_object (param_values + 0)));
 415   fprintf (stderr, "Received signal %s:%s from object %s (gail %s)\n",
 416            g_type_name (signal_query.itype), name, s, s2);
 417 #endif
 418
 419   gobject = g_value_get_object (param_values + 0);
 420
 421   emit_eventv (gobject, 0, 0, "object:%s", name);
 422
 423   return TRUE;
 424 }
 425
 426
 427
 428
 429
 430
 431