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