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