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