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:
119 * @callback: (scope notified): An #AtspiEventListenerSimpleCB to be called
120 * when an event is fired.
121 * @user_data: (closure): data to pass to the callback.
122 * @callback_destroyed: A #GDestroyNotify called when the listener is freed
123 * and data associated with the callback should be freed. Can be NULL.
125 * Creates a new #AtspiEventListener associated with a specified @callback.
127 * Returns: (transfer full): A new #AtspiEventListener.
130 atspi_event_listener_new (AtspiEventListenerCB callback,
132 GDestroyNotify callback_destroyed)
134 AtspiEventListener *listener = g_object_new (ATSPI_TYPE_EVENT_LISTENER, NULL);
135 listener->callback = callback;
136 callback_ref (callback, callback_destroyed);
137 listener->user_data = user_data;
138 listener->cb_destroyed = callback_destroyed;
143 * atspi_event_listener_new_simple:
144 * @callback: (scope notified): An #AtspiEventListenerSimpleCB to be called
145 * when an event is fired.
146 * @callback_destroyed: A #GDestroyNotify called when the listener is freed
147 * and data associated with the callback should be freed. Can be NULL.
149 * Creates a new #AtspiEventListener associated with a specified @callback.
150 * Returns: (transfer full): A new #AtspiEventListener.
153 atspi_event_listener_new_simple (AtspiEventListenerSimpleCB callback,
154 GDestroyNotify callback_destroyed)
156 AtspiEventListener *listener = g_object_new (ATSPI_TYPE_EVENT_LISTENER, NULL);
157 listener->callback = remove_datum;
158 callback_ref (remove_datum, callback_destroyed);
159 listener->user_data = callback;
160 listener->cb_destroyed = callback_destroyed;
164 static GList *event_listeners = NULL;
167 convert_name_from_dbus (const char *name)
169 gchar *ret = g_malloc (g_utf8_strlen (name, -1) * 2 + 1);
170 const char *p = name;
182 *q++ = tolower (*p++);
192 cache_process_children_changed (AtspiEvent *event)
194 AtspiAccessible *child;
196 if (!G_VALUE_HOLDS (&event->any_data, ATSPI_TYPE_ACCESSIBLE) ||
197 !(event->source->cached_properties & ATSPI_CACHE_CHILDREN) ||
198 atspi_state_set_contains (event->source->states, ATSPI_STATE_MANAGES_DESCENDANTS))
201 child = g_value_get_object (&event->any_data);
203 if (!strncmp (event->type, "object:children-changed:add", 27))
205 if (g_list_find (event->source->children, child))
207 GList *new_list = g_list_insert (event->source->children, g_object_ref (child), event->detail1);
209 event->source->children = new_list;
211 else if (g_list_find (event->source->children, child))
213 event->source->children = g_list_remove (event->source->children, child);
214 if (child == child->parent.app->root)
215 g_object_run_dispose (G_OBJECT (child->parent.app));
216 g_object_unref (child);
221 cache_process_property_change (AtspiEvent *event)
223 if (!strcmp (event->type, "object:property-change:accessible-parent"))
225 if (event->source->accessible_parent)
226 g_object_unref (event->source->accessible_parent);
227 if (G_VALUE_HOLDS (&event->any_data, ATSPI_TYPE_ACCESSIBLE))
229 event->source->accessible_parent = g_value_dup_object (&event->any_data);
230 _atspi_accessible_add_cache (event->source, ATSPI_CACHE_PARENT);
234 event->source->accessible_parent = NULL;
235 event->source->cached_properties &= ~ATSPI_CACHE_PARENT;
238 else if (!strcmp (event->type, "object:property-change:accessible-name"))
240 if (event->source->name)
241 g_free (event->source->name);
242 if (G_VALUE_HOLDS_STRING (&event->any_data))
244 event->source->name = g_value_dup_string (&event->any_data);
245 _atspi_accessible_add_cache (event->source, ATSPI_CACHE_NAME);
249 event->source->name = NULL;
250 event->source->cached_properties &= ~ATSPI_CACHE_NAME;
253 else if (!strcmp (event->type, "object:property-change:accessible-description"))
255 if (event->source->description)
256 g_free (event->source->description);
257 if (G_VALUE_HOLDS_STRING (&event->any_data))
259 event->source->description = g_value_dup_string (&event->any_data);
260 _atspi_accessible_add_cache (event->source, ATSPI_CACHE_DESCRIPTION);
264 event->source->description = NULL;
265 event->source->cached_properties &= ~ATSPI_CACHE_DESCRIPTION;
271 cache_process_state_changed (AtspiEvent *event)
273 if (event->source->states)
274 atspi_state_set_set_by_name (event->source->states, event->type + 21,
279 demarshal_rect (DBusMessageIter *iter, AtspiRect *rect)
281 dbus_int32_t x, y, width, height;
282 DBusMessageIter iter_struct;
284 dbus_message_iter_recurse (iter, &iter_struct);
285 if (dbus_message_iter_get_arg_type (&iter_struct) != DBUS_TYPE_INT32) return FALSE;
286 dbus_message_iter_get_basic (&iter_struct, &x);
287 dbus_message_iter_next (&iter_struct);
288 if (dbus_message_iter_get_arg_type (&iter_struct) != DBUS_TYPE_INT32) return FALSE;
289 dbus_message_iter_get_basic (&iter_struct, &y);
290 dbus_message_iter_next (&iter_struct);
291 if (dbus_message_iter_get_arg_type (&iter_struct) != DBUS_TYPE_INT32) return FALSE;
292 dbus_message_iter_get_basic (&iter_struct, &width);
293 dbus_message_iter_next (&iter_struct);
294 if (dbus_message_iter_get_arg_type (&iter_struct) != DBUS_TYPE_INT32) return FALSE;
295 dbus_message_iter_get_basic (&iter_struct, &height);
299 rect->height = height;
304 strdup_and_adjust_for_dbus (const char *s)
306 gchar *d = g_strdup (s);
317 memmove (p, p + 1, g_utf8_strlen (p, -1));
325 p [1] = toupper (p [1]);
329 d [0] = toupper (d [0]);
334 convert_event_type_to_dbus (const char *eventType, char **categoryp, char **namep, char **detailp, char **matchrule)
336 gchar *tmp = strdup_and_adjust_for_dbus (eventType);
337 char *category = NULL, *name = NULL, *detail = NULL;
338 char *saveptr = NULL;
340 if (tmp == NULL) return FALSE;
341 category = strtok_r (tmp, ":", &saveptr);
342 if (category) category = g_strdup (category);
343 if (!category) goto oom;
344 name = strtok_r (NULL, ":", &saveptr);
347 name = g_strdup (name);
349 detail = strtok_r (NULL, ":", &saveptr);
350 if (detail) detail = g_strdup (detail);
354 *matchrule = g_strdup_printf ("type='signal',interface='org.a11y.atspi.Event.%s'", category);
355 if (!*matchrule) goto oom;
356 if (name && name [0])
358 gchar *new_str = g_strconcat (*matchrule, ",member='", name, "'", NULL);
360 *matchrule = new_str;
362 if (detail && detail [0])
364 gchar *new_str = g_strconcat (*matchrule, ",arg0='", detail, "'", NULL);
366 *matchrule = new_str;
369 if (categoryp) *categoryp = category;
370 else g_free (category);
371 if (namep) *namep = name;
372 else if (name) g_free (name);
373 if (detailp) *detailp = detail;
374 else if (detail) g_free (detail);
378 if (tmp) g_free (tmp);
379 if (category) g_free (category);
380 if (name) g_free (name);
381 if (detail) g_free (detail);
386 listener_entry_free (EventListenerEntry *e)
388 gpointer callback = (e->callback == remove_datum ? (gpointer)e->user_data : (gpointer)e->callback);
389 g_free (e->category);
391 if (e->detail) g_free (e->detail);
392 callback_unref (callback);
397 * atspi_event_listener_register:
398 * @listener: The #AtspiEventListener to register against an event type.
399 * @event_type: a character string indicating the type of events for which
400 * notification is requested. Format is
401 * EventClass:major_type:minor_type:detail
402 * where all subfields other than EventClass are optional.
403 * EventClasses include "object", "window", "mouse",
404 * and toolkit events (e.g. "Gtk", "AWT").
405 * Examples: "focus:", "Gtk:GtkWidget:button_press_event".
407 * Adds an in-process callback function to an existing #AtspiEventListener.
409 * Legal object event types:
411 * (property change events)
413 * object:property-change
414 * object:property-change:accessible-name
415 * object:property-change:accessible-description
416 * object:property-change:accessible-parent
417 * object:property-change:accessible-value
418 * object:property-change:accessible-role
419 * object:property-change:accessible-table-caption
420 * object:property-change:accessible-table-column-description
421 * object:property-change:accessible-table-column-header
422 * object:property-change:accessible-table-row-description
423 * object:property-change:accessible-table-row-header
424 * object:property-change:accessible-table-summary
426 * (other object events)
428 * object:state-changed
429 * object:children-changed
430 * object:visible-data-changed
431 * object:selection-changed
432 * object:text-selection-changed
433 * object:text-changed
434 * object:text-caret-moved
435 * object:row-inserted
436 * object:row-reordered
438 * object:column-inserted
439 * object:column-reordered
440 * object:column-deleted
441 * object:model-changed
442 * object:active-descendant-changed
452 * window:desktop-create
453 * window:desktop-destroy
476 * NOTE: this character string may be UTF-8, but should not contain byte
478 * (ascii ':'), except as a delimiter, since non-UTF-8 string
479 * delimiting functions are used internally.
480 * In general, listening to
481 * toolkit-specific events is not recommended.
484 * Returns: #TRUE if successful, otherwise #FALSE.
487 atspi_event_listener_register (AtspiEventListener *listener,
488 const gchar *event_type,
491 /* TODO: Keep track of which events have been registered, so that we
492 * deregister all of them when the event listener is destroyed */
494 return atspi_event_listener_register_from_callback (listener->callback,
496 listener->cb_destroyed,
501 * atspi_event_listener_register_from_callback:
502 * @callback: (scope notified): the #AtspiEventListenerCB to be registered
503 * against an event type.
504 * @user_data: (closure): User data to be passed to the callback.
505 * @callback_destroyed: A #GDestroyNotify called when the callback is destroyed.
506 * @event_type: a character string indicating the type of events for which
507 * notification is requested. See #atspi_event_listener_register
508 * for a description of the format.
510 * Registers an #AtspiEventListenerCB against an @event_type.
512 * Returns: #TRUE if successfull, otherwise #FALSE.
516 atspi_event_listener_register_from_callback (AtspiEventListenerCB callback,
518 GDestroyNotify callback_destroyed,
519 const gchar *event_type,
522 EventListenerEntry *e;
526 DBusMessage *message, *reply;
535 g_warning ("called atspi_event_listener_register_from_callback with a NULL event_type");
539 e = g_new (EventListenerEntry, 1);
540 e->callback = callback;
541 e->user_data = user_data;
542 e->callback_destroyed = callback_destroyed;
543 callback_ref (callback == remove_datum ? (gpointer)user_data : (gpointer)callback,
545 if (!convert_event_type_to_dbus (event_type, &e->category, &e->name, &e->detail, &matchrule))
550 new_list = g_list_prepend (event_listeners, e);
553 listener_entry_free (e);
556 event_listeners = new_list;
557 dbus_error_init (&d_error);
558 dbus_bus_add_match (_atspi_bus(), matchrule, &d_error);
561 g_warning ("Atspi: Adding match: %s", d_error.message);
562 /* TODO: Set error */
565 dbus_error_init (&d_error);
566 message = dbus_message_new_method_call (atspi_bus_registry,
568 atspi_interface_registry,
572 dbus_message_append_args (message, DBUS_TYPE_STRING, &event_type, DBUS_TYPE_INVALID);
573 reply = _atspi_dbus_send_with_reply_and_block (message, error);
575 dbus_message_unref (reply);
581 * atspi_event_listener_register_no_data:
582 * @callback: (scope notified): the #AtspiEventListenerSimpleCB to be
583 * registered against an event type.
584 * @callback_destroyed: A #GDestroyNotify called when the callback is destroyed.
585 * @event_type: a character string indicating the type of events for which
586 * notification is requested. Format is
587 * EventClass:major_type:minor_type:detail
588 * where all subfields other than EventClass are optional.
589 * EventClasses include "object", "window", "mouse",
590 * and toolkit events (e.g. "Gtk", "AWT").
591 * Examples: "focus:", "Gtk:GtkWidget:button_press_event".
593 * Registers an #AtspiEventListenetSimpleCB. The method is similar to
594 * #atspi_event_listener_register, but @callback takes no user_data.
596 * Returns: #TRUE if successfull, otherwise #FALSE.
599 atspi_event_listener_register_no_data (AtspiEventListenerSimpleCB callback,
600 GDestroyNotify callback_destroyed,
601 const gchar *event_type,
604 return atspi_event_listener_register_from_callback (remove_datum, callback,
610 is_superset (const gchar *super, const gchar *sub)
612 if (!super || !super [0])
614 return (strcmp (super, sub) == 0);
618 * atspi_event_listener_deregister:
619 * @listener: The #AtspiEventListener to deregister.
620 * @event_type: a string specifying the event type for which this
621 * listener is to be deregistered.
623 * Deregisters an #AtspiEventListener from the registry, for a specific
626 * Returns: #TRUE if successful, otherwise #FALSE.
629 atspi_event_listener_deregister (AtspiEventListener *listener,
630 const gchar *event_type,
633 return atspi_event_listener_deregister_from_callback (listener->callback,
639 * atspi_event_listener_deregister_from_callback:
640 * @callback: (scope call): the #AtspiEventListenerCB registered against an
642 * @user_data: (closure): User data that was passed in for this callback.
643 * @event_type: a string specifying the event type for which this
644 * listener is to be deregistered.
646 * Deregisters an #AtspiEventListenerCB from the registry, for a specific
649 * Returns: #TRUE if successful, otherwise #FALSE.
652 atspi_event_listener_deregister_from_callback (AtspiEventListenerCB callback,
654 const gchar *event_type,
657 char *category, *name, *detail, *matchrule;
660 if (!convert_event_type_to_dbus (event_type, &category, &name, &detail, &matchrule))
669 for (l = event_listeners; l;)
671 EventListenerEntry *e = l->data;
672 if (e->callback == callback &&
673 e->user_data == user_data &&
674 is_superset (category, e->category) &&
675 is_superset (name, e->name) &&
676 is_superset (detail, e->detail))
678 gboolean need_replace;
680 DBusMessage *message, *reply;
681 need_replace = (l == event_listeners);
682 l = g_list_remove (l, e);
685 dbus_error_init (&d_error);
686 dbus_bus_remove_match (_atspi_bus(), matchrule, &d_error);
687 dbus_error_init (&d_error);
688 message = dbus_message_new_method_call (atspi_bus_registry,
690 atspi_interface_registry,
694 dbus_message_append_args (message, DBUS_TYPE_STRING, &event_type, DBUS_TYPE_INVALID);
695 reply = _atspi_dbus_send_with_reply_and_block (message, error);
696 dbus_message_unref (reply);
698 listener_entry_free (e);
700 else l = g_list_next (l);
704 if (detail) g_free (detail);
710 * atspi_event_listener_deregister_no_data:
711 * @callback: (scope call): the #AtspiEventListenerSimpleCB registered against
713 * @event_type: a string specifying the event type for which this
714 * listener is to be deregistered.
716 * deregisters an #AtspiEventListenerSimpleCB from the registry, for a specific
719 * Returns: #TRUE if successful, otherwise #FALSE.
722 atspi_event_listener_deregister_no_data (AtspiEventListenerSimpleCB callback,
723 const gchar *event_type,
726 return atspi_event_listener_deregister_from_callback (remove_datum, callback,
732 atspi_event_copy (AtspiEvent *src)
734 AtspiEvent *dst = g_new0 (AtspiEvent, 1);
735 dst->type = g_strdup (src->type);
736 dst->source = g_object_ref (src->source);
737 dst->detail1 = src->detail1;
738 dst->detail2 = src->detail2;
739 g_value_init (&dst->any_data, G_VALUE_TYPE (&src->any_data));
740 g_value_copy (&src->any_data, &dst->any_data);
745 atspi_event_free (AtspiEvent *event)
747 g_object_unref (event->source);
748 g_free (event->type);
749 g_value_unset (&event->any_data);
754 _atspi_send_event (AtspiEvent *e)
756 char *category, *name, *detail;
759 /* Ensure that the value is set to avoid a Python exception */
760 /* TODO: Figure out how to do this without using a private field */
761 if (e->any_data.g_type == 0)
763 g_value_init (&e->any_data, G_TYPE_INT);
764 g_value_set_int (&e->any_data, 0);
767 if (!convert_event_type_to_dbus (e->type, &category, &name, &detail, NULL))
769 g_warning ("Atspi: Couldn't parse event: %s\n", e->type);
772 for (l = event_listeners; l; l = g_list_next (l))
774 EventListenerEntry *entry = l->data;
775 if (!strcmp (category, entry->category) &&
776 (entry->name == NULL || !strcmp (name, entry->name)) &&
777 (entry->detail == NULL || !strcmp (detail, entry->detail)))
779 entry->callback (atspi_event_copy (e), entry->user_data);
782 if (detail) g_free (detail);
788 _atspi_dbus_handle_event (DBusConnection *bus, DBusMessage *message, void *data)
791 const char *category = dbus_message_get_interface (message);
792 const char *member = dbus_message_get_member (message);
793 const char *signature = dbus_message_get_signature (message);
795 gchar *converted_type;
796 DBusMessageIter iter, iter_variant;
797 dbus_message_iter_init (message, &iter);
799 dbus_int32_t detail1, detail2;
802 if (strcmp (signature, "siiv(so)") != 0)
804 g_warning ("Got invalid signature %s for signal %s from interface %s\n", signature, member, category);
805 return DBUS_HANDLER_RESULT_HANDLED;
808 memset (&e, 0, sizeof (e));
812 category = g_utf8_strrchr (category, -1, '.');
813 if (category == NULL)
816 return DBUS_HANDLER_RESULT_NOT_YET_HANDLED;
820 dbus_message_iter_get_basic (&iter, &detail);
821 dbus_message_iter_next (&iter);
822 dbus_message_iter_get_basic (&iter, &detail1);
824 dbus_message_iter_next (&iter);
825 dbus_message_iter_get_basic (&iter, &detail2);
827 dbus_message_iter_next (&iter);
829 converted_type = convert_name_from_dbus (category);
830 name = convert_name_from_dbus (member);
831 detail = convert_name_from_dbus (detail);
833 if (strcasecmp (category, name) != 0)
835 p = g_strconcat (converted_type, ":", name, NULL);
836 g_free (converted_type);
839 else if (detail [0] == '\0')
841 p = g_strconcat (converted_type, ":", NULL);
842 g_free (converted_type);
846 if (detail[0] != '\0')
848 p = g_strconcat (converted_type, ":", detail, NULL);
849 g_free (converted_type);
852 e.type = converted_type;
853 e.source = _atspi_ref_accessible (dbus_message_get_sender(message), dbus_message_get_path(message));
855 dbus_message_iter_recurse (&iter, &iter_variant);
856 switch (dbus_message_iter_get_arg_type (&iter_variant))
858 case DBUS_TYPE_STRUCT:
861 if (demarshal_rect (&iter_variant, &rect))
863 g_value_init (&e.any_data, ATSPI_TYPE_RECT);
864 g_value_set_boxed (&e.any_data, &rect);
868 AtspiAccessible *accessible;
869 accessible = _atspi_dbus_return_accessible_from_iter (&iter_variant);
870 g_value_init (&e.any_data, ATSPI_TYPE_ACCESSIBLE);
871 g_value_set_instance (&e.any_data, accessible);
872 g_object_unref (accessible); /* value now owns it */
876 case DBUS_TYPE_STRING:
878 dbus_message_iter_get_basic (&iter_variant, &p);
879 g_value_init (&e.any_data, G_TYPE_STRING);
880 g_value_set_string (&e.any_data, p);
887 if (!strncmp (e.type, "object:children-changed", 23))
889 cache_process_children_changed (&e);
891 else if (!strncmp (e.type, "object:property-change", 22))
893 cache_process_property_change (&e);
895 else if (!strncmp (e.type, "object:state-changed", 20))
897 cache_process_state_changed (&e);
900 _atspi_send_event (&e);
902 g_free (converted_type);
905 g_object_unref (e.source);
906 g_value_unset (&e.any_data);
907 return DBUS_HANDLER_RESULT_HANDLED;
910 G_DEFINE_BOXED_TYPE (AtspiEvent, atspi_event, atspi_event_copy, atspi_event_free)