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);
84 info->callback = callback;
85 info->callback_destroyed = callback_destroyed;
87 g_hash_table_insert (callbacks, callback, info);
94 callback_unref (gpointer callback)
100 info = g_hash_table_lookup (callbacks, callback);
103 g_warning ("Atspi: Dereferencing invalid callback %p\n", callback);
107 if (info->ref_count == 0)
110 /* TODO: Figure out why this seg faults from Python */
111 if (info->callback_destroyed)
112 (*info->callback_destroyed) (info->callback);
115 g_hash_table_remove (callbacks, callback);
120 * atspi_event_listener_new_simple:
121 * @callback: (scope notified): An #AtspiEventListenerSimpleCB to be called
122 * when an event is fired.
123 * @callback_destroyed: A #GDestroyNotify called when the listener is freed
124 * and data associated with the callback should be freed. Can be NULL.
126 * Returns: (transfer full): A new #AtspiEventListener.
129 atspi_event_listener_new_simple (AtspiEventListenerSimpleCB callback,
130 GDestroyNotify callback_destroyed)
132 AtspiEventListener *listener = g_object_new (ATSPI_TYPE_EVENT_LISTENER, NULL);
133 listener->callback = remove_datum;
134 callback_ref (remove_datum, callback_destroyed);
135 listener->user_data = callback;
136 listener->cb_destroyed = callback_destroyed;
140 static GList *event_listeners = NULL;
143 convert_name_from_dbus (const char *name)
145 gchar *ret = g_malloc (g_utf8_strlen (name, -1) * 2 + 1);
146 const char *p = name;
158 *q++ = tolower (*p++);
168 cache_process_children_changed (AtspiEvent *event)
170 AtspiAccessible *child;
172 if (!G_VALUE_HOLDS (&event->any_data, ATSPI_TYPE_ACCESSIBLE) ||
173 !event->source->children ||
174 atspi_state_set_contains (event->source->states, ATSPI_STATE_MANAGES_DESCENDANTS))
177 child = g_value_get_object (&event->any_data);
179 if (!strncmp (event->type, "object:children-changed:add", 27))
181 if (g_list_find (event->source->children, child))
183 GList *new_list = g_list_insert (event->source->children, g_object_ref (child), event->detail1);
185 event->source->children = new_list;
187 else if (g_list_find (event->source->children, child))
189 event->source->children = g_list_remove (event->source->children, child);
190 if (child == child->parent.app->root)
191 g_object_run_dispose (G_OBJECT (child->parent.app));
192 g_object_unref (child);
197 cache_process_property_change (AtspiEvent *event)
199 if (!strcmp (event->type, "object:property-change:accessible-parent"))
201 if (event->source->accessible_parent)
202 g_object_unref (event->source->accessible_parent);
203 if (G_VALUE_HOLDS (&event->any_data, ATSPI_TYPE_ACCESSIBLE))
205 event->source->accessible_parent = g_value_dup_object (&event->any_data);
206 _atspi_accessible_add_cache (event->source, ATSPI_CACHE_PARENT);
210 event->source->accessible_parent = NULL;
211 event->source->cached_properties &= ~ATSPI_CACHE_PARENT;
214 else if (!strcmp (event->type, "object:property-change:accessible-name"))
216 if (event->source->name)
217 g_free (event->source->name);
218 if (G_VALUE_HOLDS_STRING (&event->any_data))
220 event->source->name = g_value_dup_string (&event->any_data);
221 _atspi_accessible_add_cache (event->source, ATSPI_CACHE_NAME);
225 event->source->name = NULL;
226 event->source->cached_properties &= ~ATSPI_CACHE_NAME;
229 else if (!strcmp (event->type, "object:property-change:accessible-description"))
231 if (event->source->description)
232 g_free (event->source->description);
233 if (G_VALUE_HOLDS_STRING (&event->any_data))
235 event->source->description = g_value_dup_string (&event->any_data);
236 _atspi_accessible_add_cache (event->source, ATSPI_CACHE_DESCRIPTION);
240 event->source->description = NULL;
241 event->source->cached_properties &= ~ATSPI_CACHE_DESCRIPTION;
247 cache_process_state_changed (AtspiEvent *event)
249 if (event->source->states)
250 atspi_state_set_set_by_name (event->source->states, event->type + 21,
255 demarshal_rect (DBusMessageIter *iter, AtspiRect *rect)
257 dbus_int32_t x, y, width, height;
258 DBusMessageIter iter_struct;
260 dbus_message_iter_recurse (iter, &iter_struct);
261 if (dbus_message_iter_get_arg_type (&iter_struct) != DBUS_TYPE_INT32) return FALSE;
262 dbus_message_iter_get_basic (&iter_struct, &x);
263 dbus_message_iter_next (&iter_struct);
264 if (dbus_message_iter_get_arg_type (&iter_struct) != DBUS_TYPE_INT32) return FALSE;
265 dbus_message_iter_get_basic (&iter_struct, &y);
266 dbus_message_iter_next (&iter_struct);
267 if (dbus_message_iter_get_arg_type (&iter_struct) != DBUS_TYPE_INT32) return FALSE;
268 dbus_message_iter_get_basic (&iter_struct, &width);
269 dbus_message_iter_next (&iter_struct);
270 if (dbus_message_iter_get_arg_type (&iter_struct) != DBUS_TYPE_INT32) return FALSE;
271 dbus_message_iter_get_basic (&iter_struct, &height);
275 rect->height = height;
280 strdup_and_adjust_for_dbus (const char *s)
282 gchar *d = g_strdup (s);
293 memmove (p, p + 1, g_utf8_strlen (p, -1));
301 p [1] = toupper (p [1]);
305 d [0] = toupper (d [0]);
310 convert_event_type_to_dbus (const char *eventType, char **categoryp, char **namep, char **detailp, char **matchrule)
312 gchar *tmp = strdup_and_adjust_for_dbus (eventType);
313 char *category = NULL, *name = NULL, *detail = NULL;
314 char *saveptr = NULL;
316 if (tmp == NULL) return FALSE;
317 category = strtok_r (tmp, ":", &saveptr);
318 if (category) category = g_strdup (category);
319 if (!category) goto oom;
320 name = strtok_r (NULL, ":", &saveptr);
323 name = g_strdup (name);
325 detail = strtok_r (NULL, ":", &saveptr);
326 if (detail) detail = g_strdup (detail);
330 *matchrule = g_strdup_printf ("type='signal',interface='org.a11y.atspi.Event.%s'", category);
331 if (!*matchrule) goto oom;
332 if (name && name [0])
334 gchar *new_str = g_strconcat (*matchrule, ",member='", name, "'", NULL);
338 *matchrule = new_str;
341 if (detail && detail [0])
343 gchar *new_str = g_strconcat (*matchrule, ",arg0='", detail, "'", NULL);
347 *matchrule = new_str;
351 if (categoryp) *categoryp = category;
352 else g_free (category);
353 if (namep) *namep = name;
354 else if (name) g_free (name);
355 if (detailp) *detailp = detail;
356 else if (detail) g_free (detail);
360 if (tmp) g_free (tmp);
361 if (category) g_free (category);
362 if (name) g_free (name);
363 if (detail) g_free (detail);
368 listener_entry_free (EventListenerEntry *e)
370 gpointer callback = (e->callback == remove_datum ? e->user_data : e->callback);
371 g_free (e->category);
373 if (e->detail) g_free (e->detail);
374 callback_unref (callback);
379 * atspi_event_listener_register:
380 * @listener: The #AtspiEventListener to register against an event type.
381 * @event_type: a character string indicating the type of events for which
382 * notification is requested. Format is
383 * EventClass:major_type:minor_type:detail
384 * where all subfields other than EventClass are optional.
385 * EventClasses include "object", "window", "mouse",
386 * and toolkit events (e.g. "Gtk", "AWT").
387 * Examples: "focus:", "Gtk:GtkWidget:button_press_event".
389 * Legal object event types:
391 * (property change events)
393 * object:property-change
394 * object:property-change:accessible-name
395 * object:property-change:accessible-description
396 * object:property-change:accessible-parent
397 * object:property-change:accessible-value
398 * object:property-change:accessible-role
399 * object:property-change:accessible-table-caption
400 * object:property-change:accessible-table-column-description
401 * object:property-change:accessible-table-column-header
402 * object:property-change:accessible-table-row-description
403 * object:property-change:accessible-table-row-header
404 * object:property-change:accessible-table-summary
406 * (other object events)
408 * object:state-changed
409 * object:children-changed
410 * object:visible-data-changed
411 * object:selection-changed
412 * object:text-selection-changed
413 * object:text-changed
414 * object:text-caret-moved
415 * object:row-inserted
416 * object:row-reordered
418 * object:column-inserted
419 * object:column-reordered
420 * object:column-deleted
421 * object:model-changed
422 * object:active-descendant-changed
432 * window:desktop-create
433 * window:desktop-destroy
456 * NOTE: this string may be UTF-8, but should not contain byte value 56
457 * (ascii ':'), except as a delimiter, since non-UTF-8 string
458 * delimiting functions are used internally.
459 * In general, listening to
460 * toolkit-specific events is not recommended.
462 * Add an in-process callback function to an existing AtspiEventListener.
464 * Returns: #TRUE if successful, otherwise #FALSE.
467 atspi_event_listener_register (AtspiEventListener *listener,
468 const gchar *event_type,
471 /* TODO: Keep track of which events have been registered, so that we
472 * deregister all of them when the event listener is destroyed */
474 return atspi_event_listener_register_from_callback (listener->callback,
476 listener->cb_destroyed,
481 * atspi_event_listener_register_from_callback:
482 * @callback: (scope notified): the #AtspiEventListenerCB to be registered against
484 * @user_data: (closure): User data to be passed to the callback.
485 * @callback_destroyed: A #GDestroyNotify called when the callback is destroyed.
486 * @event_type: a character string indicating the type of events for which
487 * notification is requested. See #atspi_event_listener_register
488 * for a description of the format.
491 atspi_event_listener_register_from_callback (AtspiEventListenerCB callback,
493 GDestroyNotify callback_destroyed,
494 const gchar *event_type,
497 EventListenerEntry *e;
501 DBusMessage *message, *reply;
510 g_warning (_("called atspi_event_listener_register_from_callback with a NULL event_type"));
514 e = g_new (EventListenerEntry, 1);
515 if (!e) return FALSE;
516 e->callback = callback;
517 e->user_data = user_data;
518 e->callback_destroyed = callback_destroyed;
519 callback_ref (callback == remove_datum ? user_data : callback,
521 if (!convert_event_type_to_dbus (event_type, &e->category, &e->name, &e->detail, &matchrule))
526 new_list = g_list_prepend (event_listeners, e);
529 listener_entry_free (e);
532 event_listeners = new_list;
533 dbus_error_init (&d_error);
534 dbus_bus_add_match (_atspi_bus(), matchrule, &d_error);
537 g_warning ("Atspi: Adding match: %s", d_error.message);
538 /* TODO: Set error */
541 dbus_error_init (&d_error);
542 message = dbus_message_new_method_call (atspi_bus_registry,
544 atspi_interface_registry,
548 dbus_message_append_args (message, DBUS_TYPE_STRING, &event_type, DBUS_TYPE_INVALID);
549 reply = _atspi_dbus_send_with_reply_and_block (message, error);
551 dbus_message_unref (reply);
557 * atspi_event_listener_register_no_data:
558 * @callback: (scope notified): the #AtspiEventListenerSimpleCB to be
559 * registered against an event type.
560 * @callback_destroyed: A #GDestroyNotify called when the callback is destroyed.
561 * @event_type: a character string indicating the type of events for which
562 * notification is requested. Format is
563 * EventClass:major_type:minor_type:detail
564 * where all subfields other than EventClass are optional.
565 * EventClasses include "object", "window", "mouse",
566 * and toolkit events (e.g. "Gtk", "AWT").
567 * Examples: "focus:", "Gtk:GtkWidget:button_press_event".
569 * Like atspi_event_listener_register, but callback takes no user_data.
572 atspi_event_listener_register_no_data (AtspiEventListenerSimpleCB callback,
573 GDestroyNotify callback_destroyed,
574 const gchar *event_type,
577 return atspi_event_listener_register_from_callback (remove_datum, callback,
583 is_superset (const gchar *super, const gchar *sub)
585 if (!super || !super [0])
587 return (strcmp (super, sub) == 0);
591 * atspi_event_listener_deregister:
592 * @listener: The #AtspiEventListener to deregister.
593 * @event_type: a string specifying the event type for which this
594 * listener is to be deregistered.
596 * deregisters an #AtspiEventListener from the registry, for a specific
599 * Returns: #TRUE if successful, otherwise #FALSE.
602 atspi_event_listener_deregister (AtspiEventListener *listener,
603 const gchar *event_type,
606 return atspi_event_listener_deregister_from_callback (listener->callback,
612 * atspi_event_listener_deregister_from_callback:
613 * @callback: (scope call): the #AtspiEventListenerCB registered against an
615 * @user_data: (closure): User data that was passed in for this callback.
616 * @event_type: a string specifying the event type for which this
617 * listener is to be deregistered.
619 * deregisters an #AtspiEventListenerCB from the registry, for a specific
622 * Returns: #TRUE if successful, otherwise #FALSE.
625 atspi_event_listener_deregister_from_callback (AtspiEventListenerCB callback,
627 const gchar *event_type,
630 char *category, *name, *detail, *matchrule;
633 if (!convert_event_type_to_dbus (event_type, &category, &name, &detail, &matchrule))
642 for (l = event_listeners; l;)
644 EventListenerEntry *e = l->data;
645 if (e->callback == callback &&
646 e->user_data == user_data &&
647 is_superset (category, e->category) &&
648 is_superset (name, e->name) &&
649 is_superset (detail, e->detail))
651 gboolean need_replace;
653 DBusMessage *message, *reply;
654 need_replace = (l == event_listeners);
655 l = g_list_remove (l, e);
658 dbus_error_init (&d_error);
659 dbus_bus_remove_match (_atspi_bus(), matchrule, &d_error);
660 dbus_error_init (&d_error);
661 message = dbus_message_new_method_call (atspi_bus_registry,
663 atspi_interface_registry,
667 dbus_message_append_args (message, DBUS_TYPE_STRING, &event_type, DBUS_TYPE_INVALID);
668 reply = _atspi_dbus_send_with_reply_and_block (message, error);
669 dbus_message_unref (reply);
671 listener_entry_free (e);
673 else l = g_list_next (l);
677 if (detail) g_free (detail);
683 * atspi_event_listener_deregister_no_data:
684 * @callback: (scope call): the #AtspiEventListenerSimpleCB registered against
686 * @event_type: a string specifying the event type for which this
687 * listener is to be deregistered.
689 * deregisters an #AtspiEventListenerSimpleCB from the registry, for a specific
692 * Returns: #TRUE if successful, otherwise #FALSE.
695 atspi_event_listener_deregister_no_data (AtspiEventListenerSimpleCB callback,
696 const gchar *event_type,
699 return atspi_event_listener_deregister_from_callback (remove_datum, callback,
705 atspi_event_copy (AtspiEvent *src)
707 AtspiEvent *dst = g_new0 (AtspiEvent, 1);
708 dst->type = g_strdup (src->type);
709 dst->source = g_object_ref (src->source);
710 dst->detail1 = src->detail1;
711 dst->detail2 = src->detail2;
712 g_value_init (&dst->any_data, G_VALUE_TYPE (&src->any_data));
713 g_value_copy (&src->any_data, &dst->any_data);
718 atspi_event_free (AtspiEvent *event)
720 g_object_unref (event->source);
721 g_free (event->type);
722 g_value_unset (&event->any_data);
727 _atspi_send_event (AtspiEvent *e)
729 char *category, *name, *detail;
732 /* Ensure that the value is set to avoid a Python exception */
733 /* TODO: Figure out how to do this without using a private field */
734 if (e->any_data.g_type == 0)
736 g_value_init (&e->any_data, G_TYPE_INT);
737 g_value_set_int (&e->any_data, 0);
740 if (!convert_event_type_to_dbus (e->type, &category, &name, &detail, NULL))
742 g_warning ("Atspi: Couldn't parse event: %s\n", e->type);
745 for (l = event_listeners; l; l = g_list_next (l))
747 EventListenerEntry *entry = l->data;
748 if (!strcmp (category, entry->category) &&
749 (entry->name == NULL || !strcmp (name, entry->name)) &&
750 (entry->detail == NULL || !strcmp (detail, entry->detail)))
752 entry->callback (atspi_event_copy (e), entry->user_data);
755 if (detail) g_free (detail);
761 atspi_dbus_handle_event (DBusConnection *bus, DBusMessage *message, void *data)
764 const char *category = dbus_message_get_interface (message);
765 const char *member = dbus_message_get_member (message);
766 const char *signature = dbus_message_get_signature (message);
768 gchar *converted_type;
769 DBusMessageIter iter, iter_variant;
770 dbus_message_iter_init (message, &iter);
772 dbus_int32_t detail1, detail2;
775 if (strcmp (signature, "siiv(so)") != 0)
777 g_warning (_("Got invalid signature %s for signal %s from interface %s\n"), signature, member, category);
778 return DBUS_HANDLER_RESULT_HANDLED;
781 memset (&e, 0, sizeof (e));
785 category = g_utf8_strrchr (category, -1, '.');
786 if (category == NULL)
789 return DBUS_HANDLER_RESULT_NOT_YET_HANDLED;
793 dbus_message_iter_get_basic (&iter, &detail);
794 dbus_message_iter_next (&iter);
795 dbus_message_iter_get_basic (&iter, &detail1);
797 dbus_message_iter_next (&iter);
798 dbus_message_iter_get_basic (&iter, &detail2);
800 dbus_message_iter_next (&iter);
802 converted_type = convert_name_from_dbus (category);
803 name = convert_name_from_dbus (member);
804 detail = convert_name_from_dbus (detail);
806 if (strcasecmp (category, name) != 0)
808 p = g_strconcat (converted_type, ":", name, NULL);
811 g_free (converted_type);
815 else if (detail [0] == '\0')
817 p = g_strconcat (converted_type, ":", NULL);
820 g_free (converted_type);
825 if (detail[0] != '\0')
827 p = g_strconcat (converted_type, ":", detail, NULL);
830 g_free (converted_type);
834 e.type = converted_type;
835 e.source = _atspi_ref_accessible (dbus_message_get_sender(message), dbus_message_get_path(message));
837 dbus_message_iter_recurse (&iter, &iter_variant);
838 switch (dbus_message_iter_get_arg_type (&iter_variant))
840 case DBUS_TYPE_STRUCT:
843 if (demarshal_rect (&iter_variant, &rect))
845 g_value_init (&e.any_data, ATSPI_TYPE_RECT);
846 g_value_set_boxed (&e.any_data, &rect);
850 AtspiAccessible *accessible;
851 accessible = _atspi_dbus_return_accessible_from_iter (&iter_variant);
852 g_value_init (&e.any_data, ATSPI_TYPE_ACCESSIBLE);
853 g_value_set_instance (&e.any_data, accessible);
854 g_object_unref (accessible); /* value now owns it */
858 case DBUS_TYPE_STRING:
860 dbus_message_iter_get_basic (&iter_variant, &p);
861 g_value_init (&e.any_data, G_TYPE_STRING);
862 g_value_set_string (&e.any_data, p);
869 if (!strncmp (e.type, "object:children-changed", 23))
871 cache_process_children_changed (&e);
873 else if (!strncmp (e.type, "object:property-change", 22))
875 cache_process_property_change (&e);
877 else if (!strncmp (e.type, "object:state-changed", 20))
879 cache_process_state_changed (&e);
882 _atspi_send_event (&e);
884 g_free (converted_type);
887 g_object_unref (e.source);
888 g_value_unset (&e.any_data);
889 return DBUS_HANDLER_RESULT_HANDLED;
892 G_DEFINE_BOXED_TYPE (AtspiEvent, atspi_event, atspi_event_copy, atspi_event_free)