atk-adaptor/event.c

   1 /*
   2  * AT-SPI - Assistive Technology Service Provider Interface
   3  * (Gnome Accessibility Project; http://developer.gnome.org/projects/gap)
   4  *
   5  * Copyright 2008, 2009, Codethink Ltd.
   6  * Copyright 2001, 2002, 2003 Sun Microsystems Inc.,
   7  * Copyright 2001, 2002, 2003 Ximian, Inc.
   8  *
   9  * This library is free software; you can redistribute it and/or
  10  * modify it under the terms of the GNU Library General Public
  11  * License as published by the Free Software Foundation; either
  12  * version 2 of the License, or (at your option) any later version.
  13  *
  14  * This library is distributed in the hope that it will be useful,
  15  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  16  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  17  * Library General Public License for more details.
  18  *
  19  * You should have received a copy of the GNU Library General Public
  20  * License along with this library; if not, write to the
  21  * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
  22  * Boston, MA 02111-1307, USA.
  23  */
  24
  25 #include <string.h>
  26
  27 #include <atk/atk.h>
  28 #include <droute/droute.h>
  29
  30 #include "bridge.h"
  31 #include "accessible-register.h"
  32
  33 #include "common/spi-dbus.h"
  34
  35 static GArray *listener_ids = NULL;
  36
  37 static gint atk_bridge_key_event_listener_id;
  38 static gint atk_bridge_focus_tracker_id;
  39
  40 /*---------------------------------------------------------------------------*/
  41
  42 #define ITF_EVENT_OBJECT   "org.freedesktop.atspi.Event.Object"
  43 #define ITF_EVENT_WINDOW   "org.freedesktop.atspi.Event.Window"
  44 #define ITF_EVENT_DOCUMENT "org.freedesktop.atspi.Event.Document"
  45 #define ITF_EVENT_FOCUS    "org.freedesktop.atspi.Event.Focus"
  46
  47 /*---------------------------------------------------------------------------*/
  48
  49 typedef struct _SpiReentrantCallClosure
  50 {
  51   GMainLoop   *loop;
  52   DBusMessage *reply;
  53 } SpiReentrantCallClosure;
  54
  55 static void
  56 set_reply (DBusPendingCall * pending, void *user_data)
  57 {
  58   SpiReentrantCallClosure* closure = (SpiReentrantCallClosure *) user_data;
  59
  60   closure->reply = dbus_pending_call_steal_reply (pending);
  61   g_main_loop_quit (closure->loop);
  62 }
  63
  64 static DBusMessage *
  65 send_and_allow_reentry (DBusConnection * bus, DBusMessage * message)
  66 {
  67   DBusPendingCall *pending;
  68   SpiReentrantCallClosure closure;
  69
  70   if (!dbus_connection_send_with_reply (bus, message, &pending, -1))
  71       return NULL;
  72   dbus_pending_call_set_notify (pending, set_reply, (void *) &closure, NULL);
  73   closure.loop = g_main_loop_new (NULL, FALSE);
  74
  75   g_main_loop_run  (closure.loop);
  76
  77   g_main_loop_unref (closure.loop);
  78   return closure.reply;
  79 }
  80
  81 /*---------------------------------------------------------------------------*/
  82
  83 /*
  84  * Functionality related to sending device events from the application.
  85  *
  86  * This is used for forwarding key events on to the registry daemon.
  87  */
  88
  89 static gboolean
  90 Accessibility_DeviceEventController_NotifyListenersSync (const
  91                                                          Accessibility_DeviceEvent
  92                                                          * key_event)
  93 {
  94   DBusMessage *message;
  95   DBusError error;
  96   dbus_bool_t consumed = FALSE;
  97
  98   message =
  99     dbus_message_new_method_call (SPI_DBUS_NAME_REGISTRY,
 100                                   SPI_DBUS_PATH_DEC,
 101                                   SPI_DBUS_INTERFACE_DEC,
 102                                   "NotifyListenersSync");
 103
 104   dbus_error_init (&error);
 105   if (spi_dbus_marshal_deviceEvent (message, key_event))
 106     {
 107       DBusMessage *reply =
 108         send_and_allow_reentry (spi_global_app_data->bus, message);
 109       if (reply)
 110         {
 111           DBusError error;
 112           dbus_error_init (&error);
 113           dbus_message_get_args (reply, &error, DBUS_TYPE_BOOLEAN, &consumed,
 114                                  DBUS_TYPE_INVALID);
 115           dbus_message_unref (reply);
 116         }
 117     }
 118   dbus_message_unref (message);
 119   return consumed;
 120 }
 121
 122 static void
 123 spi_init_keystroke_from_atk_key_event (Accessibility_DeviceEvent * keystroke,
 124                                        AtkKeyEventStruct * event)
 125 {
 126   keystroke->id = (dbus_int32_t) event->keyval;
 127   keystroke->hw_code = (dbus_int16_t) event->keycode;
 128   keystroke->timestamp = (dbus_uint32_t) event->timestamp;
 129   keystroke->modifiers = (dbus_uint16_t) (event->state & 0xFFFF);
 130   if (event->string)
 131     {
 132       gunichar c;
 133
 134       keystroke->event_string = g_strdup (event->string);
 135       c = g_utf8_get_char_validated (event->string, -1);
 136       if (c > 0 && g_unichar_isprint (c))
 137         keystroke->is_text = TRUE;
 138       else
 139         keystroke->is_text = FALSE;
 140     }
 141   else
 142     {
 143       keystroke->event_string = g_strdup ("");
 144       keystroke->is_text = FALSE;
 145     }
 146   switch (event->type)
 147     {
 148     case (ATK_KEY_EVENT_PRESS):
 149       keystroke->type = Accessibility_KEY_PRESSED_EVENT;
 150       break;
 151     case (ATK_KEY_EVENT_RELEASE):
 152       keystroke->type = Accessibility_KEY_RELEASED_EVENT;
 153       break;
 154     default:
 155       keystroke->type = 0;
 156       break;
 157     }
 158 #if 0
 159   g_print
 160     ("key_event type %d; val=%d code=%d modifiers=%x name=%s is_text=%d, time=%lx\n",
 161      (int) keystroke->type, (int) keystroke->id, (int) keystroke->hw_code,
 162      (int) keystroke->modifiers, keystroke->event_string,
 163      (int) keystroke->is_text, (unsigned long) keystroke->timestamp);
 164 #endif
 165 }
 166
 167
 168 static gint
 169 spi_atk_bridge_key_listener (AtkKeyEventStruct * event, gpointer data)
 170 {
 171   gboolean result;
 172   Accessibility_DeviceEvent key_event;
 173
 174   spi_init_keystroke_from_atk_key_event (&key_event, event);
 175
 176   result =
 177     Accessibility_DeviceEventController_NotifyListenersSync (&key_event);
 178
 179   if (key_event.event_string)
 180     g_free (key_event.event_string);
 181
 182   return result;
 183 }
 184
 185 /*---------------------------------------------------------------------------*/
 186
 187 static gchar *
 188 convert_signal_name (const gchar * s)
 189 {
 190   gchar *ret = g_strdup (s);
 191   gchar *t;
 192
 193   if (!ret)
 194     return NULL;
 195   ret[0] = toupper (ret[0]);
 196   while ((t = strchr (ret, '-')) != NULL)
 197     {
 198       memmove (t, t + 1, strlen (t));
 199       *t = toupper (*t);
 200     }
 201   return ret;
 202 }
 203
 204 static const void *
 205 replace_null (const gint type,
 206               const void *val)
 207 {
 208   switch (type)
 209     {
 210       case DBUS_TYPE_STRING:
 211       case DBUS_TYPE_OBJECT_PATH:
 212            if (!val)
 213               return "";
 214            else
 215               return val;
 216       default:
 217            return val;
 218     }
 219 }
 220
 221 static void
 222 append_basic (DBusMessageIter *iter,
 223               const char *type,
 224               const void *val)
 225 {
 226   DBusMessageIter sub;
 227
 228   dbus_message_iter_open_container(iter, DBUS_TYPE_VARIANT, type, &sub);
 229
 230     val = replace_null ((int) *type, val);
 231     dbus_message_iter_append_basic(&sub, (int) *type, &val);
 232
 233   dbus_message_iter_close_container(iter, &sub);
 234 }
 235
 236 static void
 237 append_rect (DBusMessageIter *iter,
 238              const char *type,
 239              const void *val)
 240 {
 241   DBusMessageIter variant, sub;
 242   const AtkRectangle *rect = (const AtkRectangle *) val;
 243
 244   dbus_message_iter_open_container(iter, DBUS_TYPE_VARIANT, type, &variant);
 245
 246     dbus_message_iter_open_container (&variant, DBUS_TYPE_STRUCT, NULL, &sub);
 247
 248       dbus_message_iter_append_basic (&sub, DBUS_TYPE_INT32, &(rect->x));
 249       dbus_message_iter_append_basic (&sub, DBUS_TYPE_INT32, &(rect->y));
 250       dbus_message_iter_append_basic (&sub, DBUS_TYPE_INT32, &(rect->width));
 251       dbus_message_iter_append_basic (&sub, DBUS_TYPE_INT32, &(rect->height));
 252
 253     dbus_message_iter_close_container (&variant, &sub);
 254
 255   dbus_message_iter_close_container(iter, &variant);
 256 }
 257
 258 static void
 259 append_object (DBusMessageIter *iter,
 260                const char *type,
 261                const void *val)
 262 {
 263   spi_object_append_v_reference (iter, ATK_OBJECT (val));
 264 }
 265
 266 static gchar *
 267 signal_name_to_dbus (const gchar *s)
 268 {
 269   gchar *ret = g_strdup (s);
 270   gchar *t;
 271
 272   if (!ret)
 273     return NULL;
 274   ret [0] = toupper (ret [0]);
 275   while ((t = strchr (ret, '-')) != NULL)
 276   {
 277     memmove (t, t + 1, strlen (t));
 278     *t = toupper (*t);
 279   }
 280   return ret;
 281 }
 282
 283 /*
 284  * Emits an AT-SPI event.
 285  * AT-SPI events names are split into three parts:
 286  * class:major:minor
 287  * This is mapped onto D-Bus events as:
 288  * D-Bus Interface:Signal Name:Detail argument
 289  *
 290  * Marshals a basic type into the 'any_data' attribute of
 291  * the AT-SPI event.
 292  */
 293 static void
 294 emit_event (AtkObject  *obj,
 295             const char *klass,
 296             const char *major,
 297             const char *minor,
 298             dbus_int32_t detail1,
 299             dbus_int32_t detail2,
 300             const char *type,
 301             const void *val,
 302             void (*append_variant) (DBusMessageIter *, const char *, const void *))
 303 {
 304   DBusConnection *bus = spi_global_app_data->bus;
 305   const char *path =  spi_register_object_to_path (spi_global_register,
 306                                                    G_OBJECT (obj));
 307
 308   gchar *cname, *t;
 309   DBusMessage *sig;
 310   DBusMessageIter iter, iter_struct;
 311
 312   if (!klass) klass = "";
 313   if (!major) major = "";
 314   if (!minor) minor = "";
 315   if (!type) type = "u";
 316
 317   /*
 318    * This is very annoying, but as '-' isn't a legal signal
 319    * name in D-Bus (Why not??!?) The names need converting
 320    * on this side, and again on the client side.
 321    */
 322   cname = signal_name_to_dbus (major);
 323   sig = dbus_message_new_signal(path, klass, cname);
 324   g_free(cname);
 325
 326   dbus_message_iter_init_append(sig, &iter);
 327
 328   dbus_message_iter_append_basic(&iter, DBUS_TYPE_STRING, &minor);
 329   dbus_message_iter_append_basic(&iter, DBUS_TYPE_INT32, &detail1);
 330   dbus_message_iter_append_basic(&iter, DBUS_TYPE_INT32, &detail2);
 331   append_variant (&iter, type, val);
 332   spi_object_append_reference (&iter, spi_global_app_data->root);
 333
 334   dbus_connection_send(bus, sig, NULL);
 335   dbus_message_unref(sig);
 336 }
 337
 338 /*---------------------------------------------------------------------------*/
 339
 340 /*
 341  * The focus listener handles the ATK 'focus' signal and forwards it
 342  * as the AT-SPI event, 'focus:'
 343  */
 344 static void
 345 focus_tracker (AtkObject * accessible)
 346 {
 347   emit_event (accessible, ITF_EVENT_FOCUS, "focus", "", 0, 0,
 348               DBUS_TYPE_INT32_AS_STRING, 0, append_basic);
 349 }
 350
 351 /*---------------------------------------------------------------------------*/
 352
 353 #define PCHANGE "PropertyChange"
 354
 355 /*
 356  * This handler handles the following ATK signals and
 357  * converts them to AT-SPI events:
 358  *
 359  * Gtk:AtkObject:property-change -> object:property-change:(property-name)
 360  *
 361  * The property-name is part of the ATK property-change signal.
 362  */
 363 static gboolean
 364 property_event_listener (GSignalInvocationHint * signal_hint,
 365                          guint n_param_values,
 366                          const GValue * param_values, gpointer data)
 367 {
 368   AtkObject *accessible;
 369   AtkPropertyValues *values;
 370
 371   const gchar *pname = NULL;
 372
 373   AtkObject *otemp;
 374   const gchar *s1, s2;
 375   gint i;
 376
 377   accessible = g_value_get_object (&param_values[0]);
 378   values = (AtkPropertyValues *) g_value_get_pointer (&param_values[1]);
 379
 380   pname = values[0].property_name;
 381
 382   /* TODO Could improve this control statement by matching
 383    * on only the end of the signal names,
 384    */
 385   if (strcmp (pname, "accessible-name") == 0)
 386     {
 387       s1 = atk_object_get_name (accessible);
 388       if (s1 != NULL)
 389         emit_event (accessible, ITF_EVENT_OBJECT, PCHANGE, pname, 0, 0,
 390                     DBUS_TYPE_STRING_AS_STRING, s1, append_basic);
 391     }
 392   else if (strcmp (pname, "accessible-description") == 0)
 393     {
 394       s1 = atk_object_get_description (accessible);
 395       if (s1 != NULL)
 396         emit_event (accessible, ITF_EVENT_OBJECT, PCHANGE, pname, 0, 0,
 397                     DBUS_TYPE_STRING_AS_STRING, s1, append_basic);
 398     }
 399   else if (strcmp (pname, "accessible-parent") == 0)
 400     {
 401       otemp = atk_object_get_parent (accessible);
 402       if (otemp != NULL)
 403         emit_event (accessible, ITF_EVENT_OBJECT, PCHANGE, pname, 0, 0,
 404                     "(so)", otemp, append_object);
 405     }
 406   else if (strcmp (pname, "accessible-role") == 0)
 407     {
 408       i = atk_object_get_role (accessible);
 409       emit_event (accessible, ITF_EVENT_OBJECT, PCHANGE, pname, 0, 0,
 410                     DBUS_TYPE_UINT32_AS_STRING, i, append_basic);
 411     }
 412   else if (strcmp (pname, "accessible-table-summary") == 0)
 413     {
 414       otemp = atk_table_get_summary (ATK_TABLE (accessible));
 415       if (otemp != NULL)
 416         emit_event (accessible, ITF_EVENT_OBJECT, PCHANGE, pname, 0, 0,
 417                     "(so)", otemp, append_object);
 418     }
 419   else if (strcmp (pname, "accessible-table-column-header") == 0)
 420     {
 421       i = g_value_get_int (&(values->new_value));
 422       otemp = atk_table_get_column_header (ATK_TABLE (accessible), i);
 423       if (otemp != NULL)
 424         emit_event (accessible, ITF_EVENT_OBJECT, PCHANGE, pname, 0, 0,
 425                     "(so)", otemp, append_object);
 426     }
 427   else if (strcmp (pname, "accessible-table-row-header") == 0)
 428     {
 429       i = g_value_get_int (&(values->new_value));
 430       otemp = atk_table_get_row_header (ATK_TABLE (accessible), i);
 431       if (otemp != NULL)
 432         emit_event (accessible, ITF_EVENT_OBJECT, PCHANGE, pname, 0, 0,
 433                     "(so)", otemp, append_object);
 434     }
 435   else if (strcmp (pname, "accessible-table-row-description") == 0)
 436     {
 437       i = g_value_get_int (&(values->new_value));
 438       s1 = atk_table_get_row_description (ATK_TABLE (accessible), i);
 439       emit_event (accessible, ITF_EVENT_OBJECT, PCHANGE, pname, 0, 0,
 440                   DBUS_TYPE_STRING_AS_STRING, s1, append_basic);
 441     }
 442   else if (strcmp (pname, "accessible-table-column-description") == 0)
 443     {
 444       i = g_value_get_int (&(values->new_value));
 445       s1 = atk_table_get_column_description (ATK_TABLE (accessible), i);
 446       emit_event (accessible, ITF_EVENT_OBJECT, PCHANGE, pname, 0, 0,
 447                   DBUS_TYPE_STRING_AS_STRING, s1, append_basic);
 448     }
 449   else if (strcmp (pname, "accessible-table-caption-object") == 0)
 450     {
 451       otemp = atk_table_get_caption (ATK_TABLE (accessible));
 452       emit_event (accessible, ITF_EVENT_OBJECT, PCHANGE, pname, 0, 0,
 453                   "(so)", otemp, append_object);
 454     }
 455   else
 456     {
 457       emit_event (accessible, ITF_EVENT_OBJECT, PCHANGE, pname, 0, 0,
 458             DBUS_TYPE_INT32_AS_STRING, 0, append_basic);
 459     }
 460   return TRUE;
 461 }
 462
 463 /*---------------------------------------------------------------------------*/
 464
 465 #define STATE_CHANGED "state-changed"
 466
 467 /*
 468  * The state event listener handles 'Gtk:AtkObject:state-change' ATK signals
 469  * and forwards them as object:state-changed:(param-name) AT-SPI events. Where
 470  * the param-name is part of the ATK state-change signal.
 471  */
 472 static gboolean
 473 state_event_listener (GSignalInvocationHint * signal_hint,
 474                       guint n_param_values,
 475                       const GValue * param_values, gpointer data)
 476 {
 477   AtkObject *accessible;
 478   gchar *pname;
 479   guint detail1;
 480
 481   accessible = ATK_OBJECT (g_value_get_object (&param_values[0]));
 482   pname = g_strdup (g_value_get_string (&param_values[1]));
 483
 484   /* TODO - Possibly ignore a change to the 'defunct' state.
 485    * This is because without reference counting defunct objects should be removed.
 486    */
 487   detail1 = (g_value_get_boolean (&param_values[2])) ? 1 : 0;
 488   emit_event (accessible, ITF_EVENT_OBJECT, STATE_CHANGED, pname, detail1, 0,
 489               DBUS_TYPE_INT32_AS_STRING, 0, append_basic);
 490   g_free (pname);
 491   return TRUE;
 492 }
 493
 494 /*---------------------------------------------------------------------------*/
 495
 496 /*
 497  * The window event listener handles the following ATK signals and forwards
 498  * them as AT-SPI events:
 499  *
 500  * window:create     -> window:create
 501  * window:destroy    -> window:destroy
 502  * window:minimize   -> window:minimize
 503  * window:maximize   -> window:maximize
 504  * window:activate   -> window:activate
 505  * window:deactivate -> window:deactivate
 506  */
 507 static gboolean
 508 window_event_listener (GSignalInvocationHint * signal_hint,
 509                        guint n_param_values,
 510                        const GValue * param_values, gpointer data)
 511 {
 512   AtkObject *accessible;
 513   GSignalQuery signal_query;
 514   const gchar *name, *s;
 515
 516   g_signal_query (signal_hint->signal_id, &signal_query);
 517   name = signal_query.signal_name;
 518
 519   accessible = ATK_OBJECT (g_value_get_object (&param_values[0]));
 520   s = atk_object_get_name (accessible);
 521   emit_event (accessible, ITF_EVENT_WINDOW, name, "", 0, 0,
 522               DBUS_TYPE_STRING_AS_STRING, s, append_basic);
 523
 524   return TRUE;
 525 }
 526
 527 /*---------------------------------------------------------------------------*/
 528
 529 /*
 530  * The document event listener handles the following ATK signals
 531  * and converts them to AT-SPI events:
 532  *
 533  * Gtk:AtkDocument:load-complete ->  document:load-complete
 534  * Gtk:AtkDocument:load-stopped  ->  document:load-stopped
 535  * Gtk:AtkDocument:reload        ->  document:reload
 536  */
 537 static gboolean
 538 document_event_listener (GSignalInvocationHint * signal_hint,
 539                          guint n_param_values,
 540                          const GValue * param_values, gpointer data)
 541 {
 542   AtkObject *accessible;
 543   GSignalQuery signal_query;
 544   const gchar *name, *s;
 545
 546   g_signal_query (signal_hint->signal_id, &signal_query);
 547   name = signal_query.signal_name;
 548
 549   accessible = ATK_OBJECT (g_value_get_object (&param_values[0]));
 550   s = atk_object_get_name (accessible);
 551   emit_event (accessible, ITF_EVENT_DOCUMENT, name, "", 0, 0,
 552               DBUS_TYPE_STRING_AS_STRING, s, append_basic);
 553
 554   return TRUE;
 555 }
 556
 557 /*---------------------------------------------------------------------------*/
 558
 559 /*
 560  * Signal handler for  "Gtk:AtkComponent:bounds-changed". Converts
 561  * this to an AT-SPI event - "object:bounds-changed".
 562  */
 563 static gboolean
 564 bounds_event_listener (GSignalInvocationHint * signal_hint,
 565                        guint n_param_values,
 566                        const GValue * param_values, gpointer data)
 567 {
 568   AtkObject *accessible;
 569   AtkRectangle *atk_rect;
 570   GSignalQuery signal_query;
 571   const gchar *name, *s;
 572
 573   g_signal_query (signal_hint->signal_id, &signal_query);
 574   name = signal_query.signal_name;
 575
 576   accessible = ATK_OBJECT (g_value_get_object (&param_values[0]));
 577
 578   if (G_VALUE_HOLDS_BOXED (param_values + 1))
 579   {
 580     atk_rect = g_value_get_boxed (param_values + 1);
 581
 582     emit_event (accessible, ITF_EVENT_OBJECT, name, "", 0, 0,
 583                 "(iiii)", atk_rect, append_rect);
 584   }
 585   return TRUE;
 586 }
 587
 588 /*---------------------------------------------------------------------------*/
 589
 590 /*
 591  * Handles the ATK signal 'Gtk:AtkObject:active-descendant-changed' and
 592  * converts it to the AT-SPI signal - 'object:active-descendant-changed'.
 593  *
 594  */
 595 static gboolean
 596 active_descendant_event_listener (GSignalInvocationHint * signal_hint,
 597                                   guint n_param_values,
 598                                   const GValue * param_values, gpointer data)
 599 {
 600   AtkObject *accessible;
 601   AtkObject *child;
 602   GSignalQuery signal_query;
 603   const gchar *name, *minor;
 604   gint detail1;
 605
 606   g_signal_query (signal_hint->signal_id, &signal_query);
 607   name = signal_query.signal_name;
 608
 609   accessible = ATK_OBJECT (g_value_get_object (&param_values[0]));
 610   child = ATK_OBJECT (g_value_get_pointer (&param_values[1]));
 611   g_return_val_if_fail (ATK_IS_OBJECT (child), TRUE);
 612   minor = g_quark_to_string (signal_hint->detail);
 613
 614   detail1 = atk_object_get_index_in_parent (child);
 615
 616   emit_event (accessible, ITF_EVENT_OBJECT, name, "", detail1, 0,
 617               "(so)", child, append_object);
 618   return TRUE;
 619 }
 620
 621 /*---------------------------------------------------------------------------*/
 622
 623 /*
 624  * Handles the ATK signal 'Gtk:AtkHypertext:link-selected' and
 625  * converts it to the AT-SPI signal - 'object:link-selected'
 626  *
 627  */
 628 static gboolean
 629 link_selected_event_listener (GSignalInvocationHint * signal_hint,
 630                               guint n_param_values,
 631                               const GValue * param_values, gpointer data)
 632 {
 633   AtkObject *accessible;
 634   GSignalQuery signal_query;
 635   const gchar *name, *minor;
 636   gint detail1;
 637
 638   g_signal_query (signal_hint->signal_id, &signal_query);
 639   name = signal_query.signal_name;
 640
 641   accessible = ATK_OBJECT (g_value_get_object (&param_values[0]));
 642   minor = g_quark_to_string (signal_hint->detail);
 643
 644   if (G_VALUE_TYPE (&param_values[1]) == G_TYPE_INT)
 645     detail1 = g_value_get_int (&param_values[1]);
 646
 647   emit_event (accessible, ITF_EVENT_OBJECT, name, minor, detail1, 0,
 648               DBUS_TYPE_INT32_AS_STRING, 0, append_basic);
 649   return TRUE;
 650 }
 651
 652 /*---------------------------------------------------------------------------*/
 653
 654 /*
 655  * Handles the ATK signal 'Gtk:AtkText:text-changed' and
 656  * converts it to the AT-SPI signal - 'object:text-changed'
 657  *
 658  */
 659 static gboolean
 660 text_changed_event_listener (GSignalInvocationHint * signal_hint,
 661                              guint n_param_values,
 662                              const GValue * param_values, gpointer data)
 663 {
 664   AtkObject *accessible;
 665   GSignalQuery signal_query;
 666   const gchar *name, *minor;
 667   gchar *selected;
 668   gint detail1, detail2;
 669
 670   g_signal_query (signal_hint->signal_id, &signal_query);
 671   name = signal_query.signal_name;
 672
 673   accessible = ATK_OBJECT (g_value_get_object (&param_values[0]));
 674   minor = g_quark_to_string (signal_hint->detail);
 675
 676   if (G_VALUE_TYPE (&param_values[1]) == G_TYPE_INT)
 677     detail1 = g_value_get_int (&param_values[1]);
 678
 679   if (G_VALUE_TYPE (&param_values[2]) == G_TYPE_INT)
 680     detail2 = g_value_get_int (&param_values[2]);
 681
 682   selected =
 683     atk_text_get_text (ATK_TEXT (accessible), detail1, detail1 + detail2);
 684
 685   emit_event (accessible, ITF_EVENT_OBJECT, name, minor, detail1, detail2,
 686               DBUS_TYPE_STRING_AS_STRING, selected, append_basic);
 687   return TRUE;
 688 }
 689
 690 /*---------------------------------------------------------------------------*/
 691
 692 /*
 693  * Handles the ATK signal 'Gtk:AtkText:text-selection-changed' and
 694  * converts it to the AT-SPI signal - 'object:text-selection-changed'
 695  *
 696  */
 697 static gboolean
 698 text_selection_changed_event_listener (GSignalInvocationHint * signal_hint,
 699                                        guint n_param_values,
 700                                        const GValue * param_values,
 701                                        gpointer data)
 702 {
 703   AtkObject *accessible;
 704   GSignalQuery signal_query;
 705   const gchar *name, *minor;
 706   gint detail1, detail2;
 707
 708   g_signal_query (signal_hint->signal_id, &signal_query);
 709   name = signal_query.signal_name;
 710
 711   accessible = ATK_OBJECT (g_value_get_object (&param_values[0]));
 712   minor = g_quark_to_string (signal_hint->detail);
 713
 714   if (G_VALUE_TYPE (&param_values[1]) == G_TYPE_INT)
 715     detail1 = g_value_get_int (&param_values[1]);
 716
 717   if (G_VALUE_TYPE (&param_values[2]) == G_TYPE_INT)
 718     detail2 = g_value_get_int (&param_values[2]);
 719
 720   emit_event (accessible, ITF_EVENT_OBJECT, name, minor, detail1, detail2,
 721               DBUS_TYPE_STRING_AS_STRING, "", append_basic);
 722   return TRUE;
 723 }
 724
 725 /*---------------------------------------------------------------------------*/
 726
 727 /*
 728  * Children changed signal converter and forwarder.
 729  *
 730  * Klass (Interface) org.freedesktop.atspi.Event.Object
 731  * Major is the signal name.
 732  * Minor is 'add' or 'remove'
 733  * detail1 is the index.
 734  * detail2 is 0.
 735  * any_data is the child reference.
 736  */
 737 static gboolean
 738 children_changed_event_listener (GSignalInvocationHint * signal_hint,
 739                                  guint n_param_values,
 740                                  const GValue * param_values, gpointer data)
 741 {
 742   GSignalQuery signal_query;
 743   const gchar *name, *minor;
 744   gint detail1, detail2 = 0;
 745
 746   AtkObject *accessible, *ao=NULL;
 747   gpointer child;
 748
 749   g_signal_query (signal_hint->signal_id, &signal_query);
 750   name = signal_query.signal_name;
 751
 752   accessible = ATK_OBJECT (g_value_get_object (&param_values[0]));
 753   minor = g_quark_to_string (signal_hint->detail);
 754
 755   detail1 = g_value_get_uint (param_values + 1);
 756   child = g_value_get_pointer (param_values + 2);
 757
 758   if (ATK_IS_OBJECT (child))
 759     {
 760       ao = ATK_OBJECT (child);
 761       emit_event (accessible, ITF_EVENT_OBJECT, name, minor, detail1, detail2,
 762                   "(so)", ao, append_object);
 763     }
 764   else if ((minor != NULL) && (strcmp (minor, "add") == 0))
 765     {
 766       ao = atk_object_ref_accessible_child (accessible,
 767                                             detail1);
 768       emit_event (accessible, ITF_EVENT_OBJECT, name, minor, detail1, detail2,
 769                   "(so)", ao, append_object);
 770     }
 771   else
 772     {
 773       emit_event (accessible, ITF_EVENT_OBJECT, name, minor, detail1, detail2,
 774                   "(so)", ao, append_object);
 775     }
 776
 777   return TRUE;
 778 }
 779
 780 /*---------------------------------------------------------------------------*/
 781
 782 static void
 783 toplevel_added_event_listener (AtkObject * accessible,
 784                                guint index, AtkObject * child)
 785 {
 786   emit_event (accessible, ITF_EVENT_OBJECT, "children-changed", "add", index, 0,
 787               "(so)", child, append_object);
 788 }
 789
 790 static void
 791 toplevel_removed_event_listener (AtkObject * accessible,
 792                                  guint index, AtkObject * child)
 793 {
 794   emit_event (accessible, ITF_EVENT_OBJECT, "children-changed", "remove", index, 0,
 795               "(so)", child, append_object);
 796 }
 797
 798 /*---------------------------------------------------------------------------*/
 799
 800 /*
 801  * Generic signal converter and forwarder.
 802  *
 803  * Klass (Interface) org.freedesktop.atspi.Event.Object
 804  * Major is the signal name.
 805  * Minor is NULL.
 806  * detail1 is 0.
 807  * detail2 is 0.
 808  * any_data is NULL.
 809  */
 810 static gboolean
 811 generic_event_listener (GSignalInvocationHint * signal_hint,
 812                         guint n_param_values,
 813                         const GValue * param_values, gpointer data)
 814 {
 815   AtkObject *accessible;
 816   GSignalQuery signal_query;
 817   const gchar *name;
 818   int detail1 = 0, detail2 = 0;
 819
 820   g_signal_query (signal_hint->signal_id, &signal_query);
 821   name = signal_query.signal_name;
 822
 823   accessible = ATK_OBJECT (g_value_get_object (&param_values[0]));
 824
 825   if (n_param_values > 1 && G_VALUE_TYPE (&param_values[1]) == G_TYPE_INT)
 826     detail1 = g_value_get_int (&param_values[1]);
 827
 828   if (n_param_values > 2 && G_VALUE_TYPE (&param_values[2]) == G_TYPE_INT)
 829     detail2 = g_value_get_int (&param_values[2]);
 830
 831   emit_event (accessible, ITF_EVENT_OBJECT, name, "", detail1, detail2,
 832               DBUS_TYPE_INT32_AS_STRING, 0, append_basic);
 833   return TRUE;
 834 }
 835
 836 /*---------------------------------------------------------------------------*/
 837
 838 /*
 839  * Registers the provided function as a handler for the given signal name
 840  * and stores the signal id returned so that the function may be
 841  * de-registered later.
 842  */
 843 static void
 844 add_signal_listener (GSignalEmissionHook listener, const char *signal_name)
 845 {
 846   guint id;
 847
 848   id = atk_add_global_event_listener (listener, signal_name);
 849   g_array_append_val (listener_ids, id);
 850 }
 851
 852 /*
 853  * Initialization for the signal handlers.
 854  *
 855  * Registers all required signal handlers.
 856  */
 857 void
 858 spi_atk_register_event_listeners (void)
 859 {
 860   /*
 861    * Kludge to make sure the Atk interface types are registered, otherwise
 862    * the AtkText signal handlers below won't get registered
 863    */
 864   GObject *ao = g_object_new (ATK_TYPE_OBJECT, NULL);
 865   AtkObject *bo = atk_no_op_object_new (ao);
 866
 867   g_object_unref (G_OBJECT (bo));
 868   g_object_unref (ao);
 869
 870   /* Register for focus event notifications, and register app with central registry  */
 871   listener_ids = g_array_sized_new (FALSE, TRUE, sizeof (guint), 16);
 872
 873   atk_bridge_focus_tracker_id = atk_add_focus_tracker (focus_tracker);
 874
 875   add_signal_listener (property_event_listener,
 876                        "Gtk:AtkObject:property-change");
 877   add_signal_listener (window_event_listener, "window:create");
 878   add_signal_listener (window_event_listener, "window:destroy");
 879   add_signal_listener (window_event_listener, "window:minimize");
 880   add_signal_listener (window_event_listener, "window:maximize");
 881   add_signal_listener (window_event_listener, "window:restore");
 882   add_signal_listener (window_event_listener, "window:activate");
 883   add_signal_listener (window_event_listener, "window:deactivate");
 884   add_signal_listener (document_event_listener,
 885                        "Gtk:AtkDocument:load-complete");
 886   add_signal_listener (document_event_listener, "Gtk:AtkDocument:reload");
 887   add_signal_listener (document_event_listener,
 888                        "Gtk:AtkDocument:load-stopped");
 889   /* TODO Fake this event on the client side */
 890   add_signal_listener (state_event_listener, "Gtk:AtkObject:state-change");
 891   /* TODO */
 892   add_signal_listener (active_descendant_event_listener,
 893                        "Gtk:AtkObject:active-descendant-changed");
 894   add_signal_listener (bounds_event_listener,
 895                        "Gtk:AtkComponent:bounds-changed");
 896   add_signal_listener (text_selection_changed_event_listener,
 897                        "Gtk:AtkText:text-selection-changed");
 898   add_signal_listener (text_changed_event_listener,
 899                        "Gtk:AtkText:text-changed");
 900   add_signal_listener (link_selected_event_listener,
 901                        "Gtk:AtkHypertext:link-selected");
 902   add_signal_listener (generic_event_listener,
 903                        "Gtk:AtkObject:visible-data-changed");
 904   add_signal_listener (generic_event_listener,
 905                        "Gtk:AtkSelection:selection-changed");
 906   add_signal_listener (generic_event_listener,
 907                        "Gtk:AtkText:text-attributes-changed");
 908   add_signal_listener (generic_event_listener,
 909                        "Gtk:AtkText:text-caret-moved");
 910   add_signal_listener (generic_event_listener, "Gtk:AtkTable:row-inserted");
 911   add_signal_listener (generic_event_listener, "Gtk:AtkTable:row-reordered");
 912   add_signal_listener (generic_event_listener, "Gtk:AtkTable:row-deleted");
 913   add_signal_listener (generic_event_listener,
 914                        "Gtk:AtkTable:column-inserted");
 915   add_signal_listener (generic_event_listener,
 916                        "Gtk:AtkTable:column-reordered");
 917   add_signal_listener (generic_event_listener, "Gtk:AtkTable:column-deleted");
 918   add_signal_listener (generic_event_listener, "Gtk:AtkTable:model-changed");
 919
 920   /* Children signal listeners */
 921   atk_add_global_event_listener (children_changed_event_listener,
 922                                  "Gtk:AtkObject:children-changed");
 923
 924 #if 0
 925   g_signal_connect (G_OBJECT (spi_global_app_data->root),
 926                     "children-changed::add",
 927                     (GCallback) toplevel_added_event_listener, NULL);
 928
 929   g_signal_connect (G_OBJECT (spi_global_app_data->root),
 930                     "children-changed::remove",
 931                     (GCallback) toplevel_removed_event_listener, NULL);
 932 #endif
 933
 934   /*
 935    * May add the following listeners to implement preemptive key listening for GTK+
 936    *
 937    * atk_add_global_event_listener (spi_atk_bridge_widgetkey_listener, "Gtk:GtkWidget:key-press-event");
 938    * atk_add_global_event_listener (spi_atk_bridge_widgetkey_listener, "Gtk:GtkWidget:key-release-event");
 939    */
 940   atk_bridge_key_event_listener_id =
 941     atk_add_key_event_listener (spi_atk_bridge_key_listener, NULL);
 942 }
 943
 944 /*---------------------------------------------------------------------------*/
 945
 946 /*
 947  * De-registers all ATK signal handlers.
 948  */
 949 void
 950 spi_atk_deregister_event_listeners (void)
 951 {
 952   gint i;
 953   GArray *ids = listener_ids;
 954   listener_ids = NULL;
 955
 956   if (atk_bridge_focus_tracker_id)
 957     atk_remove_focus_tracker (atk_bridge_focus_tracker_id);
 958
 959   for (i = 0; ids && i < ids->len; i++)
 960     {
 961       atk_remove_global_event_listener (g_array_index (ids, guint, i));
 962     }
 963
 964   if (atk_bridge_key_event_listener_id)
 965     atk_remove_key_event_listener (atk_bridge_key_event_listener_id);
 966 }
 967
 968 /*---------------------------------------------------------------------------*/
 969
 970 /*
 971  * TODO This function seems out of place here.
 972  *
 973  * Emits fake deactivate signals on all top-level windows.
 974  * Used when shutting down AT-SPI, ensuring that all
 975  * windows have been removed on the client side.
 976  */
 977 void
 978 spi_atk_tidy_windows (void)
 979 {
 980   AtkObject *root;
 981   gint n_children;
 982   gint i;
 983
 984   root = atk_get_root ();
 985   n_children = atk_object_get_n_accessible_children (root);
 986   for (i = 0; i < n_children; i++)
 987     {
 988       AtkObject *child;
 989       AtkStateSet *stateset;
 990       const gchar *name;
 991
 992       child = atk_object_ref_accessible_child (root, i);
 993       stateset = atk_object_ref_state_set (child);
 994
 995       name = atk_object_get_name (child);
 996       if (atk_state_set_contains_state (stateset, ATK_STATE_ACTIVE))
 997         {
 998           emit_event (child, ITF_EVENT_WINDOW, "deactivate", NULL, 0, 0,
 999                       DBUS_TYPE_STRING_AS_STRING, name, append_basic);
1000         }
1001       g_object_unref (stateset);
1002
1003       emit_event (child, ITF_EVENT_WINDOW, "destroy", NULL, 0, 0,
1004                   DBUS_TYPE_STRING_AS_STRING, name, append_basic);
1005       g_object_unref (child);
1006     }
1007 }
1008
1009 /*END------------------------------------------------------------------------*/