2 * AT-SPI - Assistive Technology Service Provider Interface
3 * (Gnome Accessibility Project; http://developer.gnome.org/projects/gap)
5 * Copyright 2002 Ximian Inc.
6 * Copyright 2002 Sun Microsystems, Inc.
7 * Copyright 2010, 2011 Novell, Inc.
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.
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.
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.
25 #include "atspi-private.h"
31 AtspiEventListenerCB callback;
33 GDestroyNotify callback_destroyed;
39 G_DEFINE_TYPE (AtspiEventListener, atspi_event_listener, G_TYPE_OBJECT)
42 atspi_event_listener_init (AtspiEventListener *listener)
47 atspi_event_listener_class_init (AtspiEventListenerClass *klass)
52 remove_datum (const AtspiEvent *event, void *user_data)
54 AtspiEventListenerSimpleCB cb = user_data;
61 GDestroyNotify callback_destroyed;
64 static GHashTable *callbacks;
67 callback_ref (void *callback, GDestroyNotify callback_destroyed)
73 callbacks = g_hash_table_new (g_direct_hash, g_direct_equal);
78 info = g_hash_table_lookup (callbacks, callback);
81 info = g_new (CallbackInfo, 1);
82 info->callback = callback;
83 info->callback_destroyed = callback_destroyed;
85 g_hash_table_insert (callbacks, callback, info);
92 callback_unref (gpointer callback)
98 info = g_hash_table_lookup (callbacks, callback);
101 g_warning ("Atspi: Dereferencing invalid callback %p\n", callback);
105 if (info->ref_count == 0)
108 /* TODO: Figure out why this seg faults from Python */
109 if (info->callback_destroyed)
110 (*info->callback_destroyed) (info->callback);
113 g_hash_table_remove (callbacks, callback);
118 * atspi_event_listener_new_simple:
119 * @callback: (scope notified): An #AtspiEventListenerSimpleCB to be called
120 * when an event is fired.
121 * @callback_destroyed: A #GDestroyNotify called when the listener is freed
122 * and data associated with the callback should be freed. Can be NULL.
124 * Returns: (transfer full): A new #AtspiEventListener.
127 atspi_event_listener_new_simple (AtspiEventListenerSimpleCB callback,
128 GDestroyNotify callback_destroyed)
130 AtspiEventListener *listener = g_object_new (ATSPI_TYPE_EVENT_LISTENER, NULL);
131 listener->callback = remove_datum;
132 callback_ref (remove_datum, callback_destroyed);
133 listener->user_data = callback;
134 listener->cb_destroyed = callback_destroyed;
138 static GList *event_listeners = NULL;
141 convert_name_from_dbus (const char *name)
143 gchar *ret = g_malloc (g_utf8_strlen (name, -1) * 2 + 1);
144 const char *p = name;
156 *q++ = tolower (*p++);
166 cache_process_children_changed (AtspiEvent *event)
168 AtspiAccessible *child;
170 if (!G_VALUE_HOLDS (&event->any_data, ATSPI_TYPE_ACCESSIBLE) ||
171 !event->source->children ||
172 atspi_state_set_contains (event->source->states, ATSPI_STATE_MANAGES_DESCENDANTS))
175 child = g_value_get_object (&event->any_data);
177 if (!strncmp (event->type, "object:children-changed:add", 27))
179 if (g_list_find (event->source->children, child))
181 GList *new_list = g_list_insert (event->source->children, g_object_ref (child), event->detail1);
183 event->source->children = new_list;
185 else if (g_list_find (event->source->children, child))
187 event->source->children = g_list_remove (event->source->children, child);
188 if (child == child->parent.app->root)
189 g_object_run_dispose (G_OBJECT (child->parent.app));
190 g_object_unref (child);
195 cache_process_property_change (AtspiEvent *event)
197 if (!strcmp (event->type, "object:property-change:accessible-parent"))
199 if (event->source->accessible_parent)
200 g_object_unref (event->source->accessible_parent);
201 if (G_VALUE_HOLDS (&event->any_data, ATSPI_TYPE_ACCESSIBLE))
203 event->source->accessible_parent = g_value_dup_object (&event->any_data);
204 _atspi_accessible_add_cache (event->source, ATSPI_CACHE_PARENT);
208 event->source->accessible_parent = NULL;
209 event->source->cached_properties &= ~ATSPI_CACHE_PARENT;
212 else if (!strcmp (event->type, "object:property-change:accessible-name"))
214 if (event->source->name)
215 g_free (event->source->name);
216 if (G_VALUE_HOLDS_STRING (&event->any_data))
218 event->source->name = g_value_dup_string (&event->any_data);
219 _atspi_accessible_add_cache (event->source, ATSPI_CACHE_NAME);
223 event->source->name = NULL;
224 event->source->cached_properties &= ~ATSPI_CACHE_NAME;
227 else if (!strcmp (event->type, "object:property-change:accessible-description"))
229 if (event->source->description)
230 g_free (event->source->description);
231 if (G_VALUE_HOLDS_STRING (&event->any_data))
233 event->source->description = g_value_dup_string (&event->any_data);
234 _atspi_accessible_add_cache (event->source, ATSPI_CACHE_DESCRIPTION);
238 event->source->description = NULL;
239 event->source->cached_properties &= ~ATSPI_CACHE_DESCRIPTION;
245 cache_process_state_changed (AtspiEvent *event)
247 if (event->source->states)
248 atspi_state_set_set_by_name (event->source->states, event->type + 21,
253 demarshal_rect (DBusMessageIter *iter, AtspiRect *rect)
255 dbus_int32_t x, y, width, height;
256 DBusMessageIter iter_struct;
258 dbus_message_iter_recurse (iter, &iter_struct);
259 if (dbus_message_iter_get_arg_type (&iter_struct) != DBUS_TYPE_INT32) return FALSE;
260 dbus_message_iter_get_basic (&iter_struct, &x);
261 dbus_message_iter_next (&iter_struct);
262 if (dbus_message_iter_get_arg_type (&iter_struct) != DBUS_TYPE_INT32) return FALSE;
263 dbus_message_iter_get_basic (&iter_struct, &y);
264 dbus_message_iter_next (&iter_struct);
265 if (dbus_message_iter_get_arg_type (&iter_struct) != DBUS_TYPE_INT32) return FALSE;
266 dbus_message_iter_get_basic (&iter_struct, &width);
267 dbus_message_iter_next (&iter_struct);
268 if (dbus_message_iter_get_arg_type (&iter_struct) != DBUS_TYPE_INT32) return FALSE;
269 dbus_message_iter_get_basic (&iter_struct, &height);
273 rect->height = height;
278 strdup_and_adjust_for_dbus (const char *s)
280 gchar *d = g_strdup (s);
291 memmove (p, p + 1, g_utf8_strlen (p, -1));
299 p [1] = toupper (p [1]);
303 d [0] = toupper (d [0]);
308 convert_event_type_to_dbus (const char *eventType, char **categoryp, char **namep, char **detailp, char **matchrule)
310 gchar *tmp = strdup_and_adjust_for_dbus (eventType);
311 char *category = NULL, *name = NULL, *detail = NULL;
312 char *saveptr = NULL;
314 if (tmp == NULL) return FALSE;
315 category = strtok_r (tmp, ":", &saveptr);
316 if (category) category = g_strdup (category);
317 if (!category) goto oom;
318 name = strtok_r (NULL, ":", &saveptr);
321 name = g_strdup (name);
323 detail = strtok_r (NULL, ":", &saveptr);
324 if (detail) detail = g_strdup (detail);
328 *matchrule = g_strdup_printf ("type='signal',interface='org.a11y.atspi.Event.%s'", category);
329 if (!*matchrule) goto oom;
330 if (name && name [0])
332 gchar *new_str = g_strconcat (*matchrule, ",member='", name, "'", NULL);
334 *matchrule = new_str;
336 if (detail && detail [0])
338 gchar *new_str = g_strconcat (*matchrule, ",arg0='", detail, "'", NULL);
340 *matchrule = new_str;
343 if (categoryp) *categoryp = category;
344 else g_free (category);
345 if (namep) *namep = name;
346 else if (name) g_free (name);
347 if (detailp) *detailp = detail;
348 else if (detail) g_free (detail);
352 if (tmp) g_free (tmp);
353 if (category) g_free (category);
354 if (name) g_free (name);
355 if (detail) g_free (detail);
360 listener_entry_free (EventListenerEntry *e)
362 gpointer callback = (e->callback == remove_datum ? e->user_data : e->callback);
363 g_free (e->category);
365 if (e->detail) g_free (e->detail);
366 callback_unref (callback);
371 * atspi_event_listener_register:
372 * @listener: The #AtspiEventListener to register against an event type.
373 * @event_type: a character string indicating the type of events for which
374 * notification is requested. Format is
375 * EventClass:major_type:minor_type:detail
376 * where all subfields other than EventClass are optional.
377 * EventClasses include "object", "window", "mouse",
378 * and toolkit events (e.g. "Gtk", "AWT").
379 * Examples: "focus:", "Gtk:GtkWidget:button_press_event".
381 * Legal object event types:
383 * (property change events)
385 * object:property-change
386 * object:property-change:accessible-name
387 * object:property-change:accessible-description
388 * object:property-change:accessible-parent
389 * object:property-change:accessible-value
390 * object:property-change:accessible-role
391 * object:property-change:accessible-table-caption
392 * object:property-change:accessible-table-column-description
393 * object:property-change:accessible-table-column-header
394 * object:property-change:accessible-table-row-description
395 * object:property-change:accessible-table-row-header
396 * object:property-change:accessible-table-summary
398 * (other object events)
400 * object:state-changed
401 * object:children-changed
402 * object:visible-data-changed
403 * object:selection-changed
404 * object:text-selection-changed
405 * object:text-changed
406 * object:text-caret-moved
407 * object:row-inserted
408 * object:row-reordered
410 * object:column-inserted
411 * object:column-reordered
412 * object:column-deleted
413 * object:model-changed
414 * object:active-descendant-changed
424 * window:desktop-create
425 * window:desktop-destroy
448 * NOTE: this string may be UTF-8, but should not contain byte value 56
449 * (ascii ':'), except as a delimiter, since non-UTF-8 string
450 * delimiting functions are used internally.
451 * In general, listening to
452 * toolkit-specific events is not recommended.
454 * Add an in-process callback function to an existing AtspiEventListener.
456 * Returns: #TRUE if successful, otherwise #FALSE.
459 atspi_event_listener_register (AtspiEventListener *listener,
460 const gchar *event_type,
463 /* TODO: Keep track of which events have been registered, so that we
464 * deregister all of them when the event listener is destroyed */
466 return atspi_event_listener_register_from_callback (listener->callback,
468 listener->cb_destroyed,
473 * atspi_event_listener_register_from_callback:
474 * @callback: (scope notified): the #AtspiEventListenerCB to be registered against
476 * @user_data: (closure): User data to be passed to the callback.
477 * @callback_destroyed: A #GDestroyNotify called when the callback is destroyed.
478 * @event_type: a character string indicating the type of events for which
479 * notification is requested. See #atspi_event_listener_register
480 * for a description of the format.
483 atspi_event_listener_register_from_callback (AtspiEventListenerCB callback,
485 GDestroyNotify callback_destroyed,
486 const gchar *event_type,
489 EventListenerEntry *e;
493 DBusMessage *message, *reply;
502 g_warning ("called atspi_event_listener_register_from_callback with a NULL event_type");
506 e = g_new (EventListenerEntry, 1);
507 e->callback = callback;
508 e->user_data = user_data;
509 e->callback_destroyed = callback_destroyed;
510 callback_ref (callback == remove_datum ? user_data : callback,
512 if (!convert_event_type_to_dbus (event_type, &e->category, &e->name, &e->detail, &matchrule))
517 new_list = g_list_prepend (event_listeners, e);
520 listener_entry_free (e);
523 event_listeners = new_list;
524 dbus_error_init (&d_error);
525 dbus_bus_add_match (_atspi_bus(), matchrule, &d_error);
528 g_warning ("Atspi: Adding match: %s", d_error.message);
529 /* TODO: Set error */
532 dbus_error_init (&d_error);
533 message = dbus_message_new_method_call (atspi_bus_registry,
535 atspi_interface_registry,
539 dbus_message_append_args (message, DBUS_TYPE_STRING, &event_type, DBUS_TYPE_INVALID);
540 reply = _atspi_dbus_send_with_reply_and_block (message, error);
542 dbus_message_unref (reply);
548 * atspi_event_listener_register_no_data:
549 * @callback: (scope notified): the #AtspiEventListenerSimpleCB to be
550 * registered against an event type.
551 * @callback_destroyed: A #GDestroyNotify called when the callback is destroyed.
552 * @event_type: a character string indicating the type of events for which
553 * notification is requested. Format is
554 * EventClass:major_type:minor_type:detail
555 * where all subfields other than EventClass are optional.
556 * EventClasses include "object", "window", "mouse",
557 * and toolkit events (e.g. "Gtk", "AWT").
558 * Examples: "focus:", "Gtk:GtkWidget:button_press_event".
560 * Like atspi_event_listener_register, but callback takes no user_data.
563 atspi_event_listener_register_no_data (AtspiEventListenerSimpleCB callback,
564 GDestroyNotify callback_destroyed,
565 const gchar *event_type,
568 return atspi_event_listener_register_from_callback (remove_datum, callback,
574 is_superset (const gchar *super, const gchar *sub)
576 if (!super || !super [0])
578 return (strcmp (super, sub) == 0);
582 * atspi_event_listener_deregister:
583 * @listener: The #AtspiEventListener to deregister.
584 * @event_type: a string specifying the event type for which this
585 * listener is to be deregistered.
587 * deregisters an #AtspiEventListener from the registry, for a specific
590 * Returns: #TRUE if successful, otherwise #FALSE.
593 atspi_event_listener_deregister (AtspiEventListener *listener,
594 const gchar *event_type,
597 return atspi_event_listener_deregister_from_callback (listener->callback,
603 * atspi_event_listener_deregister_from_callback:
604 * @callback: (scope call): the #AtspiEventListenerCB registered against an
606 * @user_data: (closure): User data that was passed in for this callback.
607 * @event_type: a string specifying the event type for which this
608 * listener is to be deregistered.
610 * deregisters an #AtspiEventListenerCB from the registry, for a specific
613 * Returns: #TRUE if successful, otherwise #FALSE.
616 atspi_event_listener_deregister_from_callback (AtspiEventListenerCB callback,
618 const gchar *event_type,
621 char *category, *name, *detail, *matchrule;
624 if (!convert_event_type_to_dbus (event_type, &category, &name, &detail, &matchrule))
633 for (l = event_listeners; l;)
635 EventListenerEntry *e = l->data;
636 if (e->callback == callback &&
637 e->user_data == user_data &&
638 is_superset (category, e->category) &&
639 is_superset (name, e->name) &&
640 is_superset (detail, e->detail))
642 gboolean need_replace;
644 DBusMessage *message, *reply;
645 need_replace = (l == event_listeners);
646 l = g_list_remove (l, e);
649 dbus_error_init (&d_error);
650 dbus_bus_remove_match (_atspi_bus(), matchrule, &d_error);
651 dbus_error_init (&d_error);
652 message = dbus_message_new_method_call (atspi_bus_registry,
654 atspi_interface_registry,
658 dbus_message_append_args (message, DBUS_TYPE_STRING, &event_type, DBUS_TYPE_INVALID);
659 reply = _atspi_dbus_send_with_reply_and_block (message, error);
660 dbus_message_unref (reply);
662 listener_entry_free (e);
664 else l = g_list_next (l);
668 if (detail) g_free (detail);
674 * atspi_event_listener_deregister_no_data:
675 * @callback: (scope call): the #AtspiEventListenerSimpleCB registered against
677 * @event_type: a string specifying the event type for which this
678 * listener is to be deregistered.
680 * deregisters an #AtspiEventListenerSimpleCB from the registry, for a specific
683 * Returns: #TRUE if successful, otherwise #FALSE.
686 atspi_event_listener_deregister_no_data (AtspiEventListenerSimpleCB callback,
687 const gchar *event_type,
690 return atspi_event_listener_deregister_from_callback (remove_datum, callback,
696 atspi_event_copy (AtspiEvent *src)
698 AtspiEvent *dst = g_new0 (AtspiEvent, 1);
699 dst->type = g_strdup (src->type);
700 dst->source = g_object_ref (src->source);
701 dst->detail1 = src->detail1;
702 dst->detail2 = src->detail2;
703 g_value_init (&dst->any_data, G_VALUE_TYPE (&src->any_data));
704 g_value_copy (&src->any_data, &dst->any_data);
709 atspi_event_free (AtspiEvent *event)
711 g_object_unref (event->source);
712 g_free (event->type);
713 g_value_unset (&event->any_data);
718 _atspi_send_event (AtspiEvent *e)
720 char *category, *name, *detail;
723 /* Ensure that the value is set to avoid a Python exception */
724 /* TODO: Figure out how to do this without using a private field */
725 if (e->any_data.g_type == 0)
727 g_value_init (&e->any_data, G_TYPE_INT);
728 g_value_set_int (&e->any_data, 0);
731 if (!convert_event_type_to_dbus (e->type, &category, &name, &detail, NULL))
733 g_warning ("Atspi: Couldn't parse event: %s\n", e->type);
736 for (l = event_listeners; l; l = g_list_next (l))
738 EventListenerEntry *entry = l->data;
739 if (!strcmp (category, entry->category) &&
740 (entry->name == NULL || !strcmp (name, entry->name)) &&
741 (entry->detail == NULL || !strcmp (detail, entry->detail)))
743 entry->callback (atspi_event_copy (e), entry->user_data);
746 if (detail) g_free (detail);
752 atspi_dbus_handle_event (DBusConnection *bus, DBusMessage *message, void *data)
755 const char *category = dbus_message_get_interface (message);
756 const char *member = dbus_message_get_member (message);
757 const char *signature = dbus_message_get_signature (message);
759 gchar *converted_type;
760 DBusMessageIter iter, iter_variant;
761 dbus_message_iter_init (message, &iter);
763 dbus_int32_t detail1, detail2;
766 if (strcmp (signature, "siiv(so)") != 0)
768 g_warning ("Got invalid signature %s for signal %s from interface %s\n", signature, member, category);
769 return DBUS_HANDLER_RESULT_HANDLED;
772 memset (&e, 0, sizeof (e));
776 category = g_utf8_strrchr (category, -1, '.');
777 if (category == NULL)
780 return DBUS_HANDLER_RESULT_NOT_YET_HANDLED;
784 dbus_message_iter_get_basic (&iter, &detail);
785 dbus_message_iter_next (&iter);
786 dbus_message_iter_get_basic (&iter, &detail1);
788 dbus_message_iter_next (&iter);
789 dbus_message_iter_get_basic (&iter, &detail2);
791 dbus_message_iter_next (&iter);
793 converted_type = convert_name_from_dbus (category);
794 name = convert_name_from_dbus (member);
795 detail = convert_name_from_dbus (detail);
797 if (strcasecmp (category, name) != 0)
799 p = g_strconcat (converted_type, ":", name, NULL);
800 g_free (converted_type);
803 else if (detail [0] == '\0')
805 p = g_strconcat (converted_type, ":", NULL);
806 g_free (converted_type);
810 if (detail[0] != '\0')
812 p = g_strconcat (converted_type, ":", detail, NULL);
813 g_free (converted_type);
816 e.type = converted_type;
817 e.source = _atspi_ref_accessible (dbus_message_get_sender(message), dbus_message_get_path(message));
819 dbus_message_iter_recurse (&iter, &iter_variant);
820 switch (dbus_message_iter_get_arg_type (&iter_variant))
822 case DBUS_TYPE_STRUCT:
825 if (demarshal_rect (&iter_variant, &rect))
827 g_value_init (&e.any_data, ATSPI_TYPE_RECT);
828 g_value_set_boxed (&e.any_data, &rect);
832 AtspiAccessible *accessible;
833 accessible = _atspi_dbus_return_accessible_from_iter (&iter_variant);
834 g_value_init (&e.any_data, ATSPI_TYPE_ACCESSIBLE);
835 g_value_set_instance (&e.any_data, accessible);
836 g_object_unref (accessible); /* value now owns it */
840 case DBUS_TYPE_STRING:
842 dbus_message_iter_get_basic (&iter_variant, &p);
843 g_value_init (&e.any_data, G_TYPE_STRING);
844 g_value_set_string (&e.any_data, p);
851 if (!strncmp (e.type, "object:children-changed", 23))
853 cache_process_children_changed (&e);
855 else if (!strncmp (e.type, "object:property-change", 22))
857 cache_process_property_change (&e);
859 else if (!strncmp (e.type, "object:state-changed", 20))
861 cache_process_state_changed (&e);
864 _atspi_send_event (&e);
866 g_free (converted_type);
869 g_object_unref (e.source);
870 g_value_unset (&e.any_data);
871 return DBUS_HANDLER_RESULT_HANDLED;
874 G_DEFINE_BOXED_TYPE (AtspiEvent, atspi_event, atspi_event_copy, atspi_event_free)