atspi/atspi-event-listener.c

   1 /*
   2  * AT-SPI - Assistive Technology Service Provider Interface
   3  * (Gnome Accessibility Project; http://developer.gnome.org/projects/gap)
   4  *
   5  * Copyright 2002 Ximian Inc.
   6  * Copyright 2002 Sun Microsystems, Inc.
   7  * Copyright 2010, 2011 Novell, 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 "atspi-private.h"
  26 #include "atspi-accessible-private.h"
  27 #include <string.h>
  28 #include <ctype.h>
  29
  30 typedef struct
  31 {
  32   AtspiEventListenerCB callback;
  33   void *user_data;
  34   GDestroyNotify callback_destroyed;
  35   char *event_type;
  36   char *category;
  37   char *name;
  38   char *detail;
  39   GArray *properties;
  40 } EventListenerEntry;
  41
  42 G_DEFINE_TYPE (AtspiEventListener, atspi_event_listener, G_TYPE_OBJECT)
  43
  44 void
  45 atspi_event_listener_init (AtspiEventListener *listener)
  46 {
  47 }
  48
  49 void
  50 atspi_event_listener_class_init (AtspiEventListenerClass *klass)
  51 {
  52 }
  53
  54 static void
  55 remove_datum (AtspiEvent *event, void *user_data)
  56 {
  57   AtspiEventListenerSimpleCB cb = user_data;
  58   cb (event);
  59 }
  60
  61 typedef struct
  62 {
  63   gpointer callback;
  64   GDestroyNotify callback_destroyed;
  65   gint ref_count;
  66 } CallbackInfo;
  67 static GHashTable *callbacks;
  68
  69 void
  70 callback_ref (void *callback, GDestroyNotify callback_destroyed)
  71 {
  72   CallbackInfo *info;
  73
  74   if (!callbacks)
  75   {
  76     callbacks = g_hash_table_new (g_direct_hash, g_direct_equal);
  77     if (!callbacks)
  78       return;
  79   }
  80
  81   info = g_hash_table_lookup (callbacks, callback);
  82   if (!info)
  83   {
  84     info = g_new (CallbackInfo, 1);
  85     info->callback = callback;
  86     info->callback_destroyed = callback_destroyed;
  87     info->ref_count = 1;
  88     g_hash_table_insert (callbacks, callback, info);
  89   }
  90   else
  91     info->ref_count++;
  92 }
  93
  94 void
  95 callback_unref (gpointer callback)
  96 {
  97   CallbackInfo *info;
  98
  99   if (!callbacks)
 100     return;
 101   info = g_hash_table_lookup (callbacks, callback);
 102   if (!info)
 103   {
 104     g_warning ("Atspi: Dereferencing invalid callback %p\n", callback);
 105     return;
 106   }
 107   info->ref_count--;
 108   if (info->ref_count == 0)
 109   {
 110 #if 0
 111     /* TODO: Figure out why this seg faults from Python */
 112     if (info->callback_destroyed)
 113       (*info->callback_destroyed) (info->callback);
 114 #endif
 115     g_free (info);
 116     g_hash_table_remove (callbacks, callback);
 117   }
 118 }
 119
 120 /**
 121  * atspi_event_listener_new:
 122  * @callback: (scope notified): An #AtspiEventListenerCB to be called
 123  * when an event is fired.
 124  * @user_data: (closure): data to pass to the callback.
 125  * @callback_destroyed: A #GDestroyNotify called when the listener is freed
 126  * and data associated with the callback should be freed.  Can be NULL.
 127  *
 128  * Creates a new #AtspiEventListener associated with a specified @callback.
 129  *
 130  * Returns: (transfer full): A new #AtspiEventListener.
 131  */
 132 AtspiEventListener *
 133 atspi_event_listener_new (AtspiEventListenerCB callback,
 134                                  gpointer user_data,
 135                                  GDestroyNotify callback_destroyed)
 136 {
 137   AtspiEventListener *listener = g_object_new (ATSPI_TYPE_EVENT_LISTENER, NULL);
 138   listener->callback = callback;
 139   callback_ref (callback, callback_destroyed);
 140   listener->user_data = user_data;
 141   listener->cb_destroyed = callback_destroyed;
 142   return listener;
 143 }
 144
 145 /**
 146  * atspi_event_listener_new_simple: (skip)
 147  * @callback: (scope notified): An #AtspiEventListenerSimpleCB to be called
 148  * when an event is fired.
 149  * @callback_destroyed: A #GDestroyNotify called when the listener is freed
 150  * and data associated with the callback should be freed.  Can be NULL.
 151  *
 152  * Creates a new #AtspiEventListener associated with a specified @callback.
 153  * Returns: (transfer full): A new #AtspiEventListener.
 154  **/
 155 AtspiEventListener *
 156 atspi_event_listener_new_simple (AtspiEventListenerSimpleCB callback,
 157                                  GDestroyNotify callback_destroyed)
 158 {
 159   AtspiEventListener *listener = g_object_new (ATSPI_TYPE_EVENT_LISTENER, NULL);
 160   listener->callback = remove_datum;
 161   callback_ref (remove_datum, callback_destroyed);
 162   listener->user_data = callback;
 163   listener->cb_destroyed = callback_destroyed;
 164   return listener;
 165 }
 166
 167 static GList *event_listeners = NULL;
 168
 169 static gchar *
 170 convert_name_from_dbus (const char *name, gboolean path_hack)
 171 {
 172   gchar *ret = g_malloc (g_utf8_strlen (name, -1) * 2 + 1);
 173   const char *p = name;
 174   gchar *q = ret;
 175
 176   if (!ret)
 177     return NULL;
 178
 179   while (*p)
 180   {
 181     if (isupper (*p))
 182     {
 183       if (q > ret)
 184         *q++ = '-';
 185       *q++ = tolower (*p++);
 186     }
 187     else if (path_hack && *p == '/')
 188     {
 189       *q++ = ':';
 190       p++;
 191     }
 192     else
 193       *q++ = *p++;
 194   }
 195   *q = '\0';
 196   return ret;
 197 }
 198
 199 static void
 200 cache_process_children_changed (AtspiEvent *event)
 201 {
 202   AtspiAccessible *child;
 203
 204   if (!G_VALUE_HOLDS (&event->any_data, ATSPI_TYPE_ACCESSIBLE) ||
 205       !(event->source->cached_properties & ATSPI_CACHE_CHILDREN) ||
 206       atspi_state_set_contains (event->source->states, ATSPI_STATE_MANAGES_DESCENDANTS))
 207     return;
 208
 209   child = g_value_get_object (&event->any_data);
 210
 211   if (!strncmp (event->type, "object:children-changed:add", 27))
 212   {
 213     g_ptr_array_remove (event->source->children, child); /* just to be safe */
 214     if (event->detail1 < 0 || event->detail1 > event->source->children->len)
 215     {
 216       event->source->cached_properties &= ~ATSPI_CACHE_CHILDREN;
 217       return;
 218     }
 219     /* Unfortunately, there's no g_ptr_array_insert or similar */
 220     g_ptr_array_add (event->source->children, NULL);
 221     memmove (event->source->children->pdata + event->detail1 + 1,
 222              event->source->children->pdata + event->detail1,
 223              (event->source->children->len - event->detail1 - 1) * sizeof (gpointer));
 224     g_ptr_array_index (event->source->children, event->detail1) = g_object_ref (child);
 225   }
 226   else
 227   {
 228     g_ptr_array_remove (event->source->children, child);
 229     if (child == child->parent.app->root)
 230       g_object_run_dispose (G_OBJECT (child->parent.app));
 231   }
 232 }
 233
 234 static void
 235 cache_process_property_change (AtspiEvent *event)
 236 {
 237   if (!strcmp (event->type, "object:property-change:accessible-parent"))
 238   {
 239     if (event->source->accessible_parent)
 240       g_object_unref (event->source->accessible_parent);
 241     if (G_VALUE_HOLDS (&event->any_data, ATSPI_TYPE_ACCESSIBLE))
 242     {
 243       event->source->accessible_parent = g_value_dup_object (&event->any_data);
 244       _atspi_accessible_add_cache (event->source, ATSPI_CACHE_PARENT);
 245     }
 246     else
 247     {
 248       event->source->accessible_parent = NULL;
 249       event->source->cached_properties &= ~ATSPI_CACHE_PARENT;
 250     }
 251   }
 252   else if (!strcmp (event->type, "object:property-change:accessible-name"))
 253   {
 254     if (event->source->name)
 255       g_free (event->source->name);
 256     if (G_VALUE_HOLDS_STRING (&event->any_data))
 257     {
 258       event->source->name = g_value_dup_string (&event->any_data);
 259       _atspi_accessible_add_cache (event->source, ATSPI_CACHE_NAME);
 260     }
 261     else
 262     {
 263       event->source->name = NULL;
 264       event->source->cached_properties &= ~ATSPI_CACHE_NAME;
 265     }
 266   }
 267   else if (!strcmp (event->type, "object:property-change:accessible-description"))
 268   {
 269     if (event->source->description)
 270       g_free (event->source->description);
 271     if (G_VALUE_HOLDS_STRING (&event->any_data))
 272     {
 273       event->source->description = g_value_dup_string (&event->any_data);
 274       _atspi_accessible_add_cache (event->source, ATSPI_CACHE_DESCRIPTION);
 275     }
 276     else
 277     {
 278       event->source->description = NULL;
 279       event->source->cached_properties &= ~ATSPI_CACHE_DESCRIPTION;
 280     }
 281   }
 282   else if (!strcmp (event->type, "object:property-change:accessible-role"))
 283   {
 284     if (G_VALUE_HOLDS_INT (&event->any_data))
 285     {
 286       event->source->role = g_value_get_int (&event->any_data);
 287       _atspi_accessible_add_cache (event->source, ATSPI_CACHE_ROLE);
 288     }
 289     else
 290     {
 291       event->source->cached_properties &= ~ATSPI_CACHE_ROLE;
 292     }
 293   }
 294 }
 295
 296 static void
 297 cache_process_state_changed (AtspiEvent *event)
 298 {
 299   if (event->source->states)
 300     atspi_state_set_set_by_name (event->source->states, event->type + 21,
 301                                  event->detail1);
 302 }
 303
 304 static dbus_bool_t
 305 demarshal_rect (DBusMessageIter *iter, AtspiRect *rect)
 306 {
 307   dbus_int32_t x, y, width, height;
 308   DBusMessageIter iter_struct;
 309
 310   dbus_message_iter_recurse (iter, &iter_struct);
 311   if (dbus_message_iter_get_arg_type (&iter_struct) != DBUS_TYPE_INT32) return FALSE;
 312   dbus_message_iter_get_basic (&iter_struct, &x);
 313   dbus_message_iter_next (&iter_struct);
 314   if (dbus_message_iter_get_arg_type (&iter_struct) != DBUS_TYPE_INT32) return FALSE;
 315   dbus_message_iter_get_basic (&iter_struct, &y);
 316   dbus_message_iter_next (&iter_struct);
 317   if (dbus_message_iter_get_arg_type (&iter_struct) != DBUS_TYPE_INT32) return FALSE;
 318   dbus_message_iter_get_basic (&iter_struct, &width);
 319   dbus_message_iter_next (&iter_struct);
 320   if (dbus_message_iter_get_arg_type (&iter_struct) != DBUS_TYPE_INT32) return FALSE;
 321   dbus_message_iter_get_basic (&iter_struct, &height);
 322   rect->x = x;
 323   rect->y = y;
 324   rect->width = width;
 325   rect->height = height;
 326   return TRUE;
 327 }
 328
 329 static gchar *
 330 strdup_and_adjust_for_dbus (const char *s)
 331 {
 332   gchar *d = g_strdup (s);
 333   gchar *p;
 334   int parts = 0;
 335
 336   if (!d)
 337     return NULL;
 338
 339   for (p = d; *p; p++)
 340   {
 341     if (*p == '-')
 342     {
 343       memmove (p, p + 1, g_utf8_strlen (p, -1));
 344       *p = toupper (*p);
 345     }
 346     else if (*p == ':')
 347     {
 348       parts++;
 349       if (parts == 2)
 350         break;
 351       p [1] = toupper (p [1]);
 352     }
 353   }
 354
 355   d [0] = toupper (d [0]);
 356   return d;
 357 }
 358
 359 static gboolean
 360 convert_event_type_to_dbus (const char *eventType, char **categoryp, char **namep, char **detailp, GPtrArray **matchrule_array)
 361 {
 362   gchar *tmp = strdup_and_adjust_for_dbus (eventType);
 363   char *category = NULL, *name = NULL, *detail = NULL;
 364   char *saveptr = NULL;
 365
 366   if (tmp == NULL) return FALSE;
 367   category = strtok_r (tmp, ":", &saveptr);
 368   if (category) category = g_strdup (category);
 369   name = strtok_r (NULL, ":", &saveptr);
 370   if (name)
 371   {
 372     name = g_strdup (name);
 373     detail = strtok_r (NULL, ":", &saveptr);
 374     if (detail) detail = g_strdup (detail);
 375   }
 376   if (matchrule_array)
 377   {
 378     gchar *matchrule;
 379     matchrule = g_strdup_printf ("type='signal',interface='org.a11y.atspi.Event.%s'", category);
 380     if (name && name [0])
 381     {
 382       gchar *new_str = g_strconcat (matchrule, ",member='", name, "'", NULL);
 383       g_free (matchrule);
 384       matchrule = new_str;
 385     }
 386     (*matchrule_array) = g_ptr_array_new ();
 387     if (detail && detail [0])
 388     {
 389       gchar *new_str = g_strconcat (matchrule, ",arg0='", detail, "'", NULL);
 390       g_ptr_array_add (*matchrule_array, new_str);
 391       new_str = g_strconcat (matchrule, ",arg0path='", detail, "/'", NULL);
 392       g_ptr_array_add (*matchrule_array, new_str);
 393       g_free (matchrule);
 394     }
 395     else
 396       g_ptr_array_add (*matchrule_array, matchrule);
 397   }
 398   if (categoryp) *categoryp = category;
 399   else g_free (category);
 400   if (namep) *namep = name;
 401   else if (name) g_free (name);
 402   if (detailp) *detailp = detail;
 403   else if (detail) g_free (detail);
 404   g_free (tmp);
 405   return TRUE;
 406 }
 407
 408 static void
 409 listener_entry_free (EventListenerEntry *e)
 410 {
 411   gpointer callback = (e->callback == remove_datum ? (gpointer)e->user_data : (gpointer)e->callback);
 412   g_free (e->event_type);
 413   g_free (e->category);
 414   g_free (e->name);
 415   if (e->detail) g_free (e->detail);
 416   callback_unref (callback);
 417   g_free (e);
 418 }
 419
 420 /**
 421  * atspi_event_listener_register:
 422  * @listener: The #AtspiEventListener to register against an event type.
 423  * @event_type: a character string indicating the type of events for which
 424  *            notification is requested.  Format is
 425  *            EventClass:major_type:minor_type:detail
 426  *            where all subfields other than EventClass are optional.
 427  *            EventClasses include "object", "window", "mouse",
 428  *            and toolkit events (e.g. "Gtk", "AWT").
 429  *            Examples: "focus:", "Gtk:GtkWidget:button_press_event".
 430  *
 431  * Adds an in-process callback function to an existing #AtspiEventListener.
 432  *
 433  * Legal object event types:
 434  *
 435  *    (property change events)
 436  *
 437  *            object:property-change
 438  *            object:property-change:accessible-name
 439  *            object:property-change:accessible-description
 440  *            object:property-change:accessible-parent
 441  *            object:property-change:accessible-value
 442  *            object:property-change:accessible-role
 443  *            object:property-change:accessible-table-caption
 444  *            object:property-change:accessible-table-column-description
 445  *            object:property-change:accessible-table-column-header
 446  *            object:property-change:accessible-table-row-description
 447  *            object:property-change:accessible-table-row-header
 448  *            object:property-change:accessible-table-summary
 449  *
 450  *    (other object events)
 451  *
 452  *            object:state-changed
 453  *            object:children-changed
 454  *            object:visible-data-changed
 455  *            object:selection-changed
 456  *            object:text-selection-changed
 457  *            object:text-changed
 458  *            object:text-caret-moved
 459  *            object:row-inserted
 460  *            object:row-reordered
 461  *            object:row-deleted
 462  *            object:column-inserted
 463  *            object:column-reordered
 464  *            object:column-deleted
 465  *            object:model-changed
 466  *            object:active-descendant-changed
 467  *
 468  *  (window events)
 469  *
 470  *            window:minimize
 471  *            window:maximize
 472  *            window:restore
 473  *            window:close
 474  *            window:create
 475  *            window:reparent
 476  *            window:desktop-create
 477  *            window:desktop-destroy
 478  *            window:activate
 479  *            window:deactivate
 480  *            window:raise
 481  *            window:lower
 482  *            window:move
 483  *            window:resize
 484  *            window:shade
 485  *            window:unshade
 486  *            window:restyle
 487  *
 488  *  (other events)
 489  *
 490  *            focus:
 491  *            mouse:abs
 492  *            mouse:rel
 493  *            mouse:b1p
 494  *            mouse:b1r
 495  *            mouse:b2p
 496  *            mouse:b2r
 497  *            mouse:b3p
 498  *            mouse:b3r
 499  *
 500  * NOTE: this character string may be UTF-8, but should not contain byte
 501  * value 56
 502  *            (ascii ':'), except as a delimiter, since non-UTF-8 string
 503  *            delimiting functions are used internally.
 504  *            In general, listening to
 505  *            toolkit-specific events is not recommended.
 506  *
 507  *
 508  * Returns: #TRUE if successful, otherwise #FALSE.
 509  **/
 510 gboolean
 511 atspi_event_listener_register (AtspiEventListener *listener,
 512                                              const gchar              *event_type,
 513                                              GError **error)
 514 {
 515   /* TODO: Keep track of which events have been registered, so that we
 516  * deregister all of them when the event listener is destroyed */
 517
 518   return atspi_event_listener_register_from_callback (listener->callback,
 519                                                       listener->user_data,
 520                                                       listener->cb_destroyed,
 521                                                       event_type, error);
 522 }
 523
 524 /**
 525  * atspi_event_listener_register_full:
 526  * @listener: The #AtspiEventListener to register against an event type.
 527  * @event_type: a character string indicating the type of events for which
 528  *            notification is requested.  See #atspi_event_listener_register
 529  * for a description of the format and legal event types.
 530 * @properties: (element-type gchar*) (transfer none) (allow-none): a list of
 531  *             properties that should be sent along with the event. The
 532  *             properties are valued for the duration of the event callback.k
 533  *             TODO: Document.
 534  *
 535  * Adds an in-process callback function to an existing #AtspiEventListener.
 536  *
 537  * Returns: #TRUE if successful, otherwise #FALSE.
 538  **/
 539 gboolean
 540 atspi_event_listener_register_full (AtspiEventListener *listener,
 541                                              const gchar              *event_type,
 542                                              GArray *properties,
 543                                              GError **error)
 544 {
 545   /* TODO: Keep track of which events have been registered, so that we
 546  * deregister all of them when the event listener is destroyed */
 547
 548   return atspi_event_listener_register_from_callback_full (listener->callback,
 549                                                            listener->user_data,
 550                                                            listener->cb_destroyed,
 551                                                            event_type,
 552                                                            properties,
 553                                                            error);
 554 }
 555
 556 static gboolean
 557 notify_event_registered (EventListenerEntry *e)
 558 {
 559
 560   if (e->properties)
 561     dbind_method_call_reentrant (_atspi_bus (), atspi_bus_registry,
 562                                  atspi_path_registry,
 563                                  atspi_interface_registry,
 564                                  "RegisterEvent",
 565                                  NULL, "sas", e->event_type,
 566                                  e->properties);
 567   else
 568     dbind_method_call_reentrant (_atspi_bus (), atspi_bus_registry,
 569                                  atspi_path_registry,
 570                                  atspi_interface_registry,
 571                                  "RegisterEvent",
 572                                  NULL, "s", e->event_type);
 573
 574   return TRUE;
 575 }
 576
 577 /**
 578  * atspi_event_listener_register_from_callback:
 579  * @callback: (scope notified): the #AtspiEventListenerCB to be registered
 580  * against an event type.
 581  * @user_data: (closure): User data to be passed to the callback.
 582  * @callback_destroyed: A #GDestroyNotify called when the callback is destroyed.
 583  * @event_type: a character string indicating the type of events for which
 584  *            notification is requested.  See #atspi_event_listener_register
 585  * for a description of the format.
 586  *
 587  * Registers an #AtspiEventListenerCB against an @event_type.
 588  *
 589  * Returns: #TRUE if successfull, otherwise #FALSE.
 590  *
 591  **/
 592 gboolean
 593 atspi_event_listener_register_from_callback (AtspiEventListenerCB callback,
 594                                              void *user_data,
 595                                              GDestroyNotify callback_destroyed,
 596                                              const gchar              *event_type,
 597                                              GError **error)
 598 {
 599   return atspi_event_listener_register_from_callback_full (callback,
 600                                                            user_data,
 601                                                            callback_destroyed,
 602                                                            event_type, NULL,
 603                                                            error);
 604 }
 605
 606 static GArray *
 607 copy_event_properties (GArray *src)
 608 {
 609   gint i;
 610
 611   GArray *dst = g_array_new (FALSE, FALSE, sizeof (char *));
 612
 613   if (!src)
 614     return dst;
 615   for (i = 0; i < src->len; i++)
 616     {
 617       gchar *dup = g_strdup (g_array_index (src, char *, i));
 618     g_array_append_val (dst, dup);
 619     }
 620   return dst;
 621 }
 622
 623 gboolean
 624 atspi_event_listener_register_from_callback_full (AtspiEventListenerCB callback,
 625                                                   void *user_data,
 626                                                   GDestroyNotify callback_destroyed,
 627                                                   const gchar              *event_type,
 628                                                   GArray *properties,
 629                                                   GError **error)
 630 {
 631   EventListenerEntry *e;
 632   DBusError d_error;
 633   GPtrArray *matchrule_array;
 634   gint i;
 635
 636   if (!callback)
 637     {
 638       return FALSE;
 639     }
 640
 641   if (!event_type)
 642   {
 643     g_warning ("called atspi_event_listener_register_from_callback with a NULL event_type");
 644     return FALSE;
 645   }
 646
 647   e = g_new (EventListenerEntry, 1);
 648   e->event_type = g_strdup (event_type);
 649   e->callback = callback;
 650   e->user_data = user_data;
 651   e->callback_destroyed = callback_destroyed;
 652   callback_ref (callback == remove_datum ? (gpointer)user_data : (gpointer)callback,
 653                 callback_destroyed);
 654   if (!convert_event_type_to_dbus (event_type, &e->category, &e->name, &e->detail, &matchrule_array))
 655   {
 656     g_free (e);
 657     return FALSE;
 658   }
 659   e->properties = copy_event_properties (properties);
 660   event_listeners = g_list_prepend (event_listeners, e);
 661   for (i = 0; i < matchrule_array->len; i++)
 662   {
 663     char *matchrule = g_ptr_array_index (matchrule_array, i);
 664     dbus_error_init (&d_error);
 665     dbus_bus_add_match (_atspi_bus(), matchrule, &d_error);
 666     if (dbus_error_is_set (&d_error))
 667       {
 668         g_warning ("Atspi: Adding match: %s", d_error.message);
 669         dbus_error_free (&d_error);
 670         /* TODO: Set error */
 671       }
 672
 673     g_free (matchrule);
 674   }
 675   g_ptr_array_free (matchrule_array, TRUE);
 676
 677   notify_event_registered (e);
 678   return TRUE;
 679 }
 680
 681 void
 682 _atspi_reregister_event_listeners ()
 683 {
 684   GList *l;
 685   EventListenerEntry *e;
 686
 687   for (l = event_listeners; l; l = l->next)
 688     {
 689       e = l->data;
 690       notify_event_registered (e);
 691     }
 692 }
 693
 694 /**
 695  * atspi_event_listener_register_no_data: (skip)
 696  * @callback: (scope notified): the #AtspiEventListenerSimpleCB to be
 697  *            registered against an event type.
 698  * @callback_destroyed: A #GDestroyNotify called when the callback is destroyed.
 699  * @event_type: a character string indicating the type of events for which
 700  *            notification is requested.  Format is
 701  *            EventClass:major_type:minor_type:detail
 702  *            where all subfields other than EventClass are optional.
 703  *            EventClasses include "object", "window", "mouse",
 704  *            and toolkit events (e.g. "Gtk", "AWT").
 705  *            Examples: "focus:", "Gtk:GtkWidget:button_press_event".
 706  *
 707  * Registers an #AtspiEventListenetSimpleCB. The method is similar to
 708  * #atspi_event_listener_register, but @callback takes no user_data.
 709  *
 710  * Returns: #TRUE if successfull, otherwise #FALSE.
 711  **/
 712 gboolean
 713 atspi_event_listener_register_no_data (AtspiEventListenerSimpleCB callback,
 714                                  GDestroyNotify callback_destroyed,
 715                                  const gchar              *event_type,
 716                                  GError **error)
 717 {
 718   return atspi_event_listener_register_from_callback (remove_datum, callback,
 719                                                       callback_destroyed,
 720                                                       event_type, error);
 721 }
 722
 723 static gboolean
 724 is_superset (const gchar *super, const gchar *sub)
 725 {
 726   if (!super || !super [0])
 727     return TRUE;
 728   return (strcmp (super, sub) == 0);
 729 }
 730
 731 /**
 732  * atspi_event_listener_deregister:
 733  * @listener: The #AtspiEventListener to deregister.
 734  * @event_type: a string specifying the event type for which this
 735  *             listener is to be deregistered.
 736  *
 737  * Deregisters an #AtspiEventListener from the registry, for a specific
 738  *             event type.
 739  *
 740  * Returns: #TRUE if successful, otherwise #FALSE.
 741  **/
 742 gboolean
 743 atspi_event_listener_deregister (AtspiEventListener *listener,
 744                                                const gchar              *event_type,
 745                                                GError **error)
 746 {
 747   return atspi_event_listener_deregister_from_callback (listener->callback,
 748                                                         listener->user_data,
 749                                                         event_type, error);
 750 }
 751
 752 /**
 753  * atspi_event_listener_deregister_from_callback:
 754  * @callback: (scope call): the #AtspiEventListenerCB registered against an
 755  *            event type.
 756  * @user_data: (closure): User data that was passed in for this callback.
 757  * @event_type: a string specifying the event type for which this
 758  *             listener is to be deregistered.
 759  *
 760  * Deregisters an #AtspiEventListenerCB from the registry, for a specific
 761  *             event type.
 762  *
 763  * Returns: #TRUE if successful, otherwise #FALSE.
 764  **/
 765 gboolean
 766 atspi_event_listener_deregister_from_callback (AtspiEventListenerCB callback,
 767                                                void *user_data,
 768                                                const gchar              *event_type,
 769                                                GError **error)
 770 {
 771   char *category, *name, *detail;
 772   GPtrArray *matchrule_array;
 773   gint i;
 774   GList *l;
 775
 776   if (!convert_event_type_to_dbus (event_type, &category, &name, &detail, &matchrule_array))
 777   {
 778     return FALSE;
 779   }
 780   if (!callback)
 781     {
 782       return FALSE;
 783     }
 784
 785   for (l = event_listeners; l;)
 786   {
 787     EventListenerEntry *e = l->data;
 788     if (e->callback == callback &&
 789         e->user_data == user_data &&
 790         is_superset (category, e->category) &&
 791         is_superset (name, e->name) &&
 792         is_superset (detail, e->detail))
 793     {
 794       gboolean need_replace;
 795       DBusMessage *message, *reply;
 796       need_replace = (l == event_listeners);
 797       l = g_list_remove (l, e);
 798       if (need_replace)
 799         event_listeners = l;
 800       for (i = 0; i < matchrule_array->len; i++)
 801       {
 802         char *matchrule = g_ptr_array_index (matchrule_array, i);
 803         dbus_bus_remove_match (_atspi_bus(), matchrule, NULL);
 804       }
 805       message = dbus_message_new_method_call (atspi_bus_registry,
 806             atspi_path_registry,
 807             atspi_interface_registry,
 808             "DeregisterEvent");
 809       if (!message)
 810       return FALSE;
 811       dbus_message_append_args (message, DBUS_TYPE_STRING, &event_type, DBUS_TYPE_INVALID);
 812       reply = _atspi_dbus_send_with_reply_and_block (message, error);
 813       if (reply)
 814         dbus_message_unref (reply);
 815
 816       listener_entry_free (e);
 817     }
 818     else l = g_list_next (l);
 819   }
 820   g_free (category);
 821   g_free (name);
 822   if (detail) g_free (detail);
 823   for (i = 0; i < matchrule_array->len; i++)
 824     g_free (g_ptr_array_index (matchrule_array, i));
 825   g_ptr_array_free (matchrule_array, TRUE);
 826   return TRUE;
 827 }
 828
 829 /**
 830  * atspi_event_listener_deregister_no_data: (skip)
 831  * @callback: (scope call): the #AtspiEventListenerSimpleCB registered against
 832  *            an event type.
 833  * @event_type: a string specifying the event type for which this
 834  *             listener is to be deregistered.
 835  *
 836  * deregisters an #AtspiEventListenerSimpleCB from the registry, for a specific
 837  *             event type.
 838  *
 839  * Returns: #TRUE if successful, otherwise #FALSE.
 840  **/
 841 gboolean
 842 atspi_event_listener_deregister_no_data (AtspiEventListenerSimpleCB callback,
 843                                    const gchar              *event_type,
 844                                    GError **error)
 845 {
 846   return atspi_event_listener_deregister_from_callback (remove_datum, callback,
 847                                                         event_type,
 848                                                         error);
 849 }
 850
 851 static AtspiEvent *
 852 atspi_event_copy (AtspiEvent *src)
 853 {
 854   AtspiEvent *dst = g_new0 (AtspiEvent, 1);
 855   dst->type = g_strdup (src->type);
 856   dst->source = g_object_ref (src->source);
 857   dst->detail1 = src->detail1;
 858   dst->detail2 = src->detail2;
 859   g_value_init (&dst->any_data, G_VALUE_TYPE (&src->any_data));
 860   g_value_copy (&src->any_data, &dst->any_data);
 861   return dst;
 862 }
 863
 864 static void
 865 atspi_event_free (AtspiEvent *event)
 866 {
 867   g_object_unref (event->source);
 868   g_free (event->type);
 869   g_value_unset (&event->any_data);
 870   g_free (event);
 871 }
 872
 873 static gboolean
 874 detail_matches_listener (const char *event_detail, const char *listener_detail)
 875 {
 876   if (!listener_detail)
 877     return TRUE;
 878
 879   if (!event_detail)
 880     return (listener_detail ? FALSE : TRUE);
 881
 882   return !(listener_detail [strcspn (listener_detail, ":")] == '\0'
 883                ? strncmp (listener_detail, event_detail,
 884                           strcspn (event_detail, ":"))
 885                : strcmp (listener_detail, event_detail));
 886 }
 887
 888 void
 889 _atspi_send_event (AtspiEvent *e)
 890 {
 891   char *category, *name, *detail;
 892   GList *l;
 893   GList *called_listeners = NULL;
 894
 895   /* Ensure that the value is set to avoid a Python exception */
 896   /* TODO: Figure out how to do this without using a private field */
 897   if (e->any_data.g_type == 0)
 898   {
 899     g_value_init (&e->any_data, G_TYPE_INT);
 900     g_value_set_int (&e->any_data, 0);
 901   }
 902
 903   if (!convert_event_type_to_dbus (e->type, &category, &name, &detail, NULL))
 904   {
 905     g_warning ("Atspi: Couldn't parse event: %s\n", e->type);
 906     return;
 907   }
 908   for (l = event_listeners; l; l = g_list_next (l))
 909   {
 910     EventListenerEntry *entry = l->data;
 911     if (!strcmp (category, entry->category) &&
 912         (entry->name == NULL || !strcmp (name, entry->name)) &&
 913         detail_matches_listener (detail, entry->detail))
 914     {
 915       GList *l2;
 916       for (l2 = called_listeners; l2; l2 = l2->next)
 917       {
 918         EventListenerEntry *e2 = l2->data;
 919         if (entry->callback == e2->callback && entry->user_data == e2->user_data)
 920           break;
 921       }
 922       if (!l2)
 923       {
 924         entry->callback (atspi_event_copy (e), entry->user_data);
 925         called_listeners = g_list_prepend (called_listeners, entry);
 926       }
 927     }
 928   }
 929   if (detail) g_free (detail);
 930   g_free (name);
 931   g_free (category);
 932   g_list_free (called_listeners);
 933 }
 934
 935 DBusHandlerResult
 936 _atspi_dbus_handle_event (DBusConnection *bus, DBusMessage *message, void *data)
 937 {
 938   char *detail = NULL;
 939   const char *category = dbus_message_get_interface (message);
 940   const char *member = dbus_message_get_member (message);
 941   const char *signature = dbus_message_get_signature (message);
 942   gchar *name;
 943   gchar *converted_type;
 944   DBusMessageIter iter, iter_variant;
 945   dbus_message_iter_init (message, &iter);
 946   AtspiEvent e;
 947   dbus_int32_t detail1, detail2;
 948   char *p;
 949   GHashTable *cache = NULL;
 950
 951   if (strcmp (signature, "siiv(so)") != 0 &&
 952       strcmp (signature, "siiva{sv}") != 0)
 953   {
 954     g_warning ("Got invalid signature %s for signal %s from interface %s\n", signature, member, category);
 955     return DBUS_HANDLER_RESULT_HANDLED;
 956   }
 957
 958   memset (&e, 0, sizeof (e));
 959
 960   if (category)
 961   {
 962     category = g_utf8_strrchr (category, -1, '.');
 963     if (category == NULL)
 964     {
 965       // TODO: Error
 966       return DBUS_HANDLER_RESULT_NOT_YET_HANDLED;
 967     }
 968     category++;
 969   }
 970   dbus_message_iter_get_basic (&iter, &detail);
 971   dbus_message_iter_next (&iter);
 972   dbus_message_iter_get_basic (&iter, &detail1);
 973   e.detail1 = detail1;
 974   dbus_message_iter_next (&iter);
 975   dbus_message_iter_get_basic (&iter, &detail2);
 976   e.detail2 = detail2;
 977   dbus_message_iter_next (&iter);
 978
 979   converted_type = convert_name_from_dbus (category, FALSE);
 980   name = convert_name_from_dbus (member, FALSE);
 981   detail = convert_name_from_dbus (detail, TRUE);
 982
 983   if (strcasecmp  (category, name) != 0)
 984   {
 985     p = g_strconcat (converted_type, ":", name, NULL);
 986     g_free (converted_type);
 987     converted_type = p;
 988   }
 989   else if (detail [0] == '\0')
 990   {
 991     p = g_strconcat (converted_type, ":",  NULL);
 992     g_free (converted_type);
 993     converted_type = p;
 994   }
 995
 996   if (detail[0] != '\0')
 997   {
 998     p = g_strconcat (converted_type, ":", detail, NULL);
 999     g_free (converted_type);
1000     converted_type = p;
1001   }
1002   e.type = converted_type;
1003   e.source = _atspi_ref_accessible (dbus_message_get_sender(message), dbus_message_get_path(message));
1004   if (e.source == NULL)
1005   {
1006     g_warning ("Got no valid source accessible for signal for signal %s from interface %s\n", member, category);
1007     return DBUS_HANDLER_RESULT_HANDLED;
1008   }
1009
1010   dbus_message_iter_recurse (&iter, &iter_variant);
1011   switch (dbus_message_iter_get_arg_type (&iter_variant))
1012   {
1013     case DBUS_TYPE_STRUCT:
1014     {
1015       AtspiRect rect;
1016       if (demarshal_rect (&iter_variant, &rect))
1017       {
1018         g_value_init (&e.any_data, ATSPI_TYPE_RECT);
1019         g_value_set_boxed (&e.any_data, &rect);
1020       }
1021       else
1022       {
1023         AtspiAccessible *accessible;
1024         accessible = _atspi_dbus_return_accessible_from_iter (&iter_variant);
1025         g_value_init (&e.any_data, ATSPI_TYPE_ACCESSIBLE);
1026         g_value_set_instance (&e.any_data, accessible);
1027         if (accessible)
1028           g_object_unref (accessible);  /* value now owns it */
1029       }
1030       break;
1031     }
1032     case DBUS_TYPE_STRING:
1033     {
1034       dbus_message_iter_get_basic (&iter_variant, &p);
1035       g_value_init (&e.any_data, G_TYPE_STRING);
1036       g_value_set_string (&e.any_data, p);
1037       break;
1038     }
1039   default:
1040     break;
1041   }
1042
1043   dbus_message_iter_next (&iter);
1044   if (dbus_message_iter_get_arg_type (&iter) == DBUS_TYPE_ARRAY)
1045   {
1046     /* new form -- parse properties sent with event */
1047     cache = _atspi_dbus_update_cache_from_dict (e.source, &iter);
1048   }
1049
1050   if (!strncmp (e.type, "object:children-changed", 23))
1051   {
1052     cache_process_children_changed (&e);
1053   }
1054   else if (!strncmp (e.type, "object:property-change", 22))
1055   {
1056     cache_process_property_change (&e);
1057   }
1058   else if (!strncmp (e.type, "object:state-changed", 20))
1059   {
1060     cache_process_state_changed (&e);
1061   }
1062   else if (!strncmp (e.type, "focus", 5))
1063   {
1064     /* BGO#663992 - TODO: figure out the real problem */
1065     e.source->cached_properties &= ~(ATSPI_CACHE_STATES);
1066   }
1067
1068   _atspi_send_event (&e);
1069
1070   if (cache)
1071     _atspi_accessible_unref_cache (e.source);
1072
1073   g_free (converted_type);
1074   g_free (name);
1075   g_free (detail);
1076   g_object_unref (e.source);
1077   g_value_unset (&e.any_data);
1078   return DBUS_HANDLER_RESULT_HANDLED;
1079 }
1080
1081 G_DEFINE_BOXED_TYPE (AtspiEvent, atspi_event, atspi_event_copy, atspi_event_free)