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.
8 * This library is free software; you can redistribute it and/or
9 * modify it under the terms of the GNU Library General Public
10 * License as published by the Free Software Foundation; either
11 * version 2 of the License, or (at your option) any later version.
13 * This library is distributed in the hope that it will be useful,
14 * but WITHOUT ANY WARRANTY; without even the implied warranty of
15 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
16 * Library General Public License for more details.
18 * You should have received a copy of the GNU Library General Public
19 * License along with this library; if not, write to the
20 * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
21 * Boston, MA 02111-1307, USA.
24 #include "atspi-private.h"
30 AtspiEventListenerCB callback;
32 GDestroyNotify callback_destroyed;
38 G_DEFINE_TYPE (AtspiEventListener, atspi_event_listener, G_TYPE_OBJECT)
41 atspi_event_listener_init (AtspiEventListener *listener)
46 atspi_event_listener_class_init (AtspiEventListenerClass *klass)
51 remove_datum (const AtspiEvent *event, void *user_data)
53 AtspiEventListenerSimpleCB cb = user_data;
60 GDestroyNotify callback_destroyed;
63 static GHashTable *callbacks;
66 callback_ref (void *callback, GDestroyNotify callback_destroyed)
72 callbacks = g_hash_table_new (g_direct_hash, g_direct_equal);
77 info = g_hash_table_lookup (callbacks, callback);
80 info = g_new (CallbackInfo, 1);
83 info->callback = callback;
84 info->callback_destroyed = callback_destroyed;
86 g_hash_table_insert (callbacks, callback, info);
93 callback_unref (gpointer callback)
99 info = g_hash_table_lookup (callbacks, callback);
102 g_warning ("Atspi: Dereferencing invalid callback %p\n", callback);
106 if (info->ref_count == 0)
109 /* TODO: Figure out why this seg faults from Python */
110 if (info->callback_destroyed)
111 (*info->callback_destroyed) (info->callback);
114 g_hash_table_remove (callbacks, callback);
119 * atspi_event_listener_new_simple:
120 * @callback: (scope notified): An #AtspiEventListenerSimpleCB to be called
121 * when an event is fired.
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 * Returns: (transfer full): A new #AtspiEventListener.
128 atspi_event_listener_new_simple (AtspiEventListenerSimpleCB callback,
129 GDestroyNotify callback_destroyed)
131 AtspiEventListener *listener = g_object_new (ATSPI_TYPE_EVENT_LISTENER, NULL);
132 listener->callback = remove_datum;
133 callback_ref (remove_datum, callback_destroyed);
134 listener->user_data = callback;
135 listener->cb_destroyed = callback_destroyed;
139 static GList *event_listeners = NULL;
142 convert_name_from_dbus (const char *name)
144 gchar *ret = g_malloc (g_utf8_strlen (name, -1) * 2 + 1);
145 const char *p = name;
157 *q++ = tolower (*p++);
167 cache_process_children_changed (AtspiEvent *event)
169 AtspiAccessible *child;
171 if (!G_VALUE_HOLDS (&event->any_data, ATSPI_TYPE_ACCESSIBLE) ||
172 !event->source->children ||
173 atspi_state_set_contains (event->source->states, ATSPI_STATE_MANAGES_DESCENDANTS))
176 child = g_value_get_object (&event->any_data);
178 if (!strncmp (event->type, "object:children-changed:add", 27))
180 if (g_list_find (event->source->children, child))
182 GList *new_list = g_list_insert (event->source->children, g_object_ref (child), event->detail1);
184 event->source->children = new_list;
186 else if (g_list_find (event->source->children, child))
188 event->source->children = g_list_remove (event->source->children, child);
189 if (child == child->parent.app->root)
190 g_object_run_dispose (G_OBJECT (child->parent.app));
191 g_object_unref (child);
196 cache_process_property_change (AtspiEvent *event)
198 if (!strcmp (event->type, "object:property-change:accessible-parent"))
200 if (event->source->accessible_parent)
201 g_object_unref (event->source->accessible_parent);
202 if (G_VALUE_HOLDS (&event->any_data, ATSPI_TYPE_ACCESSIBLE))
204 event->source->accessible_parent = g_value_dup_object (&event->any_data);
205 _atspi_accessible_add_cache (event->source, ATSPI_CACHE_PARENT);
209 event->source->accessible_parent = NULL;
210 event->source->cached_properties &= ~ATSPI_CACHE_PARENT;
213 else if (!strcmp (event->type, "object:property-change:accessible-name"))
215 if (event->source->name)
216 g_free (event->source->name);
217 if (G_VALUE_HOLDS_STRING (&event->any_data))
219 event->source->name = g_value_dup_string (&event->any_data);
220 _atspi_accessible_add_cache (event->source, ATSPI_CACHE_NAME);
224 event->source->name = NULL;
225 event->source->cached_properties &= ~ATSPI_CACHE_NAME;
228 else if (!strcmp (event->type, "object:property-change:accessible-description"))
230 if (event->source->description)
231 g_free (event->source->description);
232 if (G_VALUE_HOLDS_STRING (&event->any_data))
234 event->source->description = g_value_dup_string (&event->any_data);
235 _atspi_accessible_add_cache (event->source, ATSPI_CACHE_DESCRIPTION);
239 event->source->description = NULL;
240 event->source->cached_properties &= ~ATSPI_CACHE_DESCRIPTION;
246 cache_process_state_changed (AtspiEvent *event)
248 if (event->source->states)
249 atspi_state_set_set_by_name (event->source->states, event->type + 21,
254 demarshal_rect (DBusMessageIter *iter, AtspiRect *rect)
256 dbus_int32_t x, y, width, height;
257 DBusMessageIter iter_struct;
259 dbus_message_iter_recurse (iter, &iter_struct);
260 if (dbus_message_iter_get_arg_type (&iter_struct) != DBUS_TYPE_INT32) return FALSE;
261 dbus_message_iter_get_basic (&iter_struct, &x);
262 dbus_message_iter_next (&iter_struct);
263 if (dbus_message_iter_get_arg_type (&iter_struct) != DBUS_TYPE_INT32) return FALSE;
264 dbus_message_iter_get_basic (&iter_struct, &y);
265 dbus_message_iter_next (&iter_struct);
266 if (dbus_message_iter_get_arg_type (&iter_struct) != DBUS_TYPE_INT32) return FALSE;
267 dbus_message_iter_get_basic (&iter_struct, &width);
268 dbus_message_iter_next (&iter_struct);
269 if (dbus_message_iter_get_arg_type (&iter_struct) != DBUS_TYPE_INT32) return FALSE;
270 dbus_message_iter_get_basic (&iter_struct, &height);
274 rect->height = height;
279 strdup_and_adjust_for_dbus (const char *s)
281 gchar *d = g_strdup (s);
292 memmove (p, p + 1, g_utf8_strlen (p, -1));
300 p [1] = toupper (p [1]);
304 d [0] = toupper (d [0]);
309 convert_event_type_to_dbus (const char *eventType, char **categoryp, char **namep, char **detailp, char **matchrule)
311 gchar *tmp = strdup_and_adjust_for_dbus (eventType);
312 char *category = NULL, *name = NULL, *detail = NULL;
313 char *saveptr = NULL;
315 if (tmp == NULL) return FALSE;
316 category = strtok_r (tmp, ":", &saveptr);
317 if (category) category = g_strdup (category);
318 if (!category) goto oom;
319 name = strtok_r (NULL, ":", &saveptr);
322 name = g_strdup (name);
324 detail = strtok_r (NULL, ":", &saveptr);
325 if (detail) detail = g_strdup (detail);
329 *matchrule = g_strdup_printf ("type='signal',interface='org.a11y.atspi.Event.%s'", category);
330 if (!*matchrule) goto oom;
331 if (name && name [0])
333 gchar *new_str = g_strconcat (*matchrule, ",member='", name, "'", NULL);
337 *matchrule = new_str;
340 if (detail && detail [0])
342 gchar *new_str = g_strconcat (*matchrule, ",arg0='", detail, "'", NULL);
346 *matchrule = new_str;
350 if (categoryp) *categoryp = category;
351 else g_free (category);
352 if (namep) *namep = name;
353 else if (name) g_free (name);
354 if (detailp) *detailp = detail;
355 else if (detail) g_free (detail);
359 if (tmp) g_free (tmp);
360 if (category) g_free (category);
361 if (name) g_free (name);
362 if (detail) g_free (detail);
367 listener_entry_free (EventListenerEntry *e)
369 gpointer callback = (e->callback == remove_datum ? e->user_data : e->callback);
370 g_free (e->category);
372 if (e->detail) g_free (e->detail);
373 callback_unref (callback);
378 * atspi_event_listener_register:
379 * @listener: The #AtspiEventListener to register against an event type.
380 * @event_type: a character string indicating the type of events for which
381 * notification is requested. Format is
382 * EventClass:major_type:minor_type:detail
383 * where all subfields other than EventClass are optional.
384 * EventClasses include "object", "window", "mouse",
385 * and toolkit events (e.g. "Gtk", "AWT").
386 * Examples: "focus:", "Gtk:GtkWidget:button_press_event".
388 * Legal object event types:
390 * (property change events)
392 * object:property-change
393 * object:property-change:accessible-name
394 * object:property-change:accessible-description
395 * object:property-change:accessible-parent
396 * object:property-change:accessible-value
397 * object:property-change:accessible-role
398 * object:property-change:accessible-table-caption
399 * object:property-change:accessible-table-column-description
400 * object:property-change:accessible-table-column-header
401 * object:property-change:accessible-table-row-description
402 * object:property-change:accessible-table-row-header
403 * object:property-change:accessible-table-summary
405 * (other object events)
407 * object:state-changed
408 * object:children-changed
409 * object:visible-data-changed
410 * object:selection-changed
411 * object:text-selection-changed
412 * object:text-changed
413 * object:text-caret-moved
414 * object:row-inserted
415 * object:row-reordered
417 * object:column-inserted
418 * object:column-reordered
419 * object:column-deleted
420 * object:model-changed
421 * object:active-descendant-changed
431 * window:desktop-create
432 * window:desktop-destroy
455 * NOTE: this string may be UTF-8, but should not contain byte value 56
456 * (ascii ':'), except as a delimiter, since non-UTF-8 string
457 * delimiting functions are used internally.
458 * In general, listening to
459 * toolkit-specific events is not recommended.
461 * Add an in-process callback function to an existing AtspiEventListener.
463 * Returns: #TRUE if successful, otherwise #FALSE.
466 atspi_event_listener_register (AtspiEventListener *listener,
467 const gchar *event_type,
470 /* TODO: Keep track of which events have been registered, so that we
471 * deregister all of them when the event listener is destroyed */
473 return atspi_event_listener_register_from_callback (listener->callback,
475 listener->cb_destroyed,
480 * atspi_event_listener_register_from_callback:
481 * @callback: (scope notified): the #AtspiEventListenerCB to be registered against
483 * @user_data: (closure): User data to be passed to the callback.
484 * @callback_destroyed: A #GDestroyNotify called when the callback is destroyed.
485 * @event_type: a character string indicating the type of events for which
486 * notification is requested. See #atspi_event_listener_register
487 * for a description of the format.
490 atspi_event_listener_register_from_callback (AtspiEventListenerCB callback,
492 GDestroyNotify callback_destroyed,
493 const gchar *event_type,
496 EventListenerEntry *e;
500 DBusMessage *message, *reply;
509 g_warning (_("called atspi_event_listener_register_from_callback with a NULL event_type"));
513 e = g_new (EventListenerEntry, 1);
514 if (!e) return FALSE;
515 e->callback = callback;
516 e->user_data = user_data;
517 e->callback_destroyed = callback_destroyed;
518 callback_ref (callback == remove_datum ? user_data : callback,
520 if (!convert_event_type_to_dbus (event_type, &e->category, &e->name, &e->detail, &matchrule))
525 new_list = g_list_prepend (event_listeners, e);
528 listener_entry_free (e);
531 event_listeners = new_list;
532 dbus_error_init (&d_error);
533 dbus_bus_add_match (_atspi_bus(), matchrule, &d_error);
536 g_warning ("Atspi: Adding match: %s", d_error.message);
537 /* TODO: Set error */
540 dbus_error_init (&d_error);
541 message = dbus_message_new_method_call (atspi_bus_registry,
543 atspi_interface_registry,
547 dbus_message_append_args (message, DBUS_TYPE_STRING, &event_type, DBUS_TYPE_INVALID);
548 reply = _atspi_dbus_send_with_reply_and_block (message, error);
550 dbus_message_unref (reply);
556 * atspi_event_listener_register_no_data:
557 * @callback: (scope notified): the #AtspiEventListenerSimpleCB to be
558 * registered against an event type.
559 * @callback_destroyed: A #GDestroyNotify called when the callback is destroyed.
560 * @event_type: a character string indicating the type of events for which
561 * notification is requested. Format is
562 * EventClass:major_type:minor_type:detail
563 * where all subfields other than EventClass are optional.
564 * EventClasses include "object", "window", "mouse",
565 * and toolkit events (e.g. "Gtk", "AWT").
566 * Examples: "focus:", "Gtk:GtkWidget:button_press_event".
568 * Like atspi_event_listener_register, but callback takes no user_data.
571 atspi_event_listener_register_no_data (AtspiEventListenerSimpleCB callback,
572 GDestroyNotify callback_destroyed,
573 const gchar *event_type,
576 return atspi_event_listener_register_from_callback (remove_datum, callback,
582 is_superset (const gchar *super, const gchar *sub)
584 if (!super || !super [0])
586 return (strcmp (super, sub) == 0);
590 * atspi_event_listener_deregister:
591 * @listener: The #AtspiEventListener to deregister.
592 * @event_type: a string specifying the event type for which this
593 * listener is to be deregistered.
595 * deregisters an #AtspiEventListener from the registry, for a specific
598 * Returns: #TRUE if successful, otherwise #FALSE.
601 atspi_event_listener_deregister (AtspiEventListener *listener,
602 const gchar *event_type,
605 return atspi_event_listener_deregister_from_callback (listener->callback,
611 * atspi_event_listener_deregister_from_callback:
612 * @callback: (scope call): the #AtspiEventListenerCB registered against an
614 * @user_data: (closure): User data that was passed in for this callback.
615 * @event_type: a string specifying the event type for which this
616 * listener is to be deregistered.
618 * deregisters an #AtspiEventListenerCB from the registry, for a specific
621 * Returns: #TRUE if successful, otherwise #FALSE.
624 atspi_event_listener_deregister_from_callback (AtspiEventListenerCB callback,
626 const gchar *event_type,
629 char *category, *name, *detail, *matchrule;
632 if (!convert_event_type_to_dbus (event_type, &category, &name, &detail, &matchrule))
641 for (l = event_listeners; l;)
643 EventListenerEntry *e = l->data;
644 if (e->callback == callback &&
645 e->user_data == user_data &&
646 is_superset (category, e->category) &&
647 is_superset (name, e->name) &&
648 is_superset (detail, e->detail))
650 gboolean need_replace;
652 DBusMessage *message, *reply;
653 need_replace = (l == event_listeners);
654 l = g_list_remove (l, e);
657 dbus_error_init (&d_error);
658 dbus_bus_remove_match (_atspi_bus(), matchrule, &d_error);
659 dbus_error_init (&d_error);
660 message = dbus_message_new_method_call (atspi_bus_registry,
662 atspi_interface_registry,
666 dbus_message_append_args (message, DBUS_TYPE_STRING, &event_type, DBUS_TYPE_INVALID);
667 reply = _atspi_dbus_send_with_reply_and_block (message, error);
668 dbus_message_unref (reply);
670 listener_entry_free (e);
672 else l = g_list_next (l);
676 if (detail) g_free (detail);
682 * atspi_event_listener_deregister_no_data:
683 * @callback: (scope call): the #AtspiEventListenerSimpleCB registered against
685 * @event_type: a string specifying the event type for which this
686 * listener is to be deregistered.
688 * deregisters an #AtspiEventListenerSimpleCB from the registry, for a specific
691 * Returns: #TRUE if successful, otherwise #FALSE.
694 atspi_event_listener_deregister_no_data (AtspiEventListenerSimpleCB callback,
695 const gchar *event_type,
698 return atspi_event_listener_deregister_from_callback (remove_datum, callback,
704 atspi_event_copy (AtspiEvent *src)
706 AtspiEvent *dst = g_new0 (AtspiEvent, 1);
707 dst->type = g_strdup (src->type);
708 dst->source = g_object_ref (src->source);
709 dst->detail1 = src->detail1;
710 dst->detail2 = src->detail2;
711 g_value_init (&dst->any_data, G_VALUE_TYPE (&src->any_data));
712 g_value_copy (&src->any_data, &dst->any_data);
717 atspi_event_free (AtspiEvent *event)
719 g_object_unref (event->source);
720 g_free (event->type);
721 g_value_unset (&event->any_data);
726 _atspi_send_event (AtspiEvent *e)
728 char *category, *name, *detail;
731 /* Ensure that the value is set to avoid a Python exception */
732 /* TODO: Figure out how to do this without using a private field */
733 if (e->any_data.g_type == 0)
735 g_value_init (&e->any_data, G_TYPE_INT);
736 g_value_set_int (&e->any_data, 0);
739 if (!convert_event_type_to_dbus (e->type, &category, &name, &detail, NULL))
741 g_warning ("Atspi: Couldn't parse event: %s\n", e->type);
744 for (l = event_listeners; l; l = g_list_next (l))
746 EventListenerEntry *entry = l->data;
747 if (!strcmp (category, entry->category) &&
748 (entry->name == NULL || !strcmp (name, entry->name)) &&
749 (entry->detail == NULL || !strcmp (detail, entry->detail)))
751 entry->callback (atspi_event_copy (e), entry->user_data);
754 if (detail) g_free (detail);
760 atspi_dbus_handle_event (DBusConnection *bus, DBusMessage *message, void *data)
763 const char *category = dbus_message_get_interface (message);
764 const char *member = dbus_message_get_member (message);
765 const char *signature = dbus_message_get_signature (message);
767 gchar *converted_type;
768 DBusMessageIter iter, iter_variant;
769 dbus_message_iter_init (message, &iter);
771 dbus_int32_t detail1, detail2;
774 if (strcmp (signature, "siiv(so)") != 0)
776 g_warning (_("Got invalid signature %s for signal %s from interface %s\n"), signature, member, category);
777 return DBUS_HANDLER_RESULT_HANDLED;
780 memset (&e, 0, sizeof (e));
784 category = g_utf8_strrchr (category, -1, '.');
785 if (category == NULL)
788 return DBUS_HANDLER_RESULT_NOT_YET_HANDLED;
792 dbus_message_iter_get_basic (&iter, &detail);
793 dbus_message_iter_next (&iter);
794 dbus_message_iter_get_basic (&iter, &detail1);
796 dbus_message_iter_next (&iter);
797 dbus_message_iter_get_basic (&iter, &detail2);
799 dbus_message_iter_next (&iter);
801 converted_type = convert_name_from_dbus (category);
802 name = convert_name_from_dbus (member);
803 detail = convert_name_from_dbus (detail);
805 if (strcasecmp (category, name) != 0)
807 p = g_strconcat (converted_type, ":", name, NULL);
810 g_free (converted_type);
814 else if (detail [0] == '\0')
816 p = g_strconcat (converted_type, ":", NULL);
819 g_free (converted_type);
824 if (detail[0] != '\0')
826 p = g_strconcat (converted_type, ":", detail, NULL);
829 g_free (converted_type);
833 e.type = converted_type;
834 e.source = _atspi_ref_accessible (dbus_message_get_sender(message), dbus_message_get_path(message));
836 dbus_message_iter_recurse (&iter, &iter_variant);
837 switch (dbus_message_iter_get_arg_type (&iter_variant))
839 case DBUS_TYPE_STRUCT:
842 if (demarshal_rect (&iter_variant, &rect))
844 g_value_init (&e.any_data, ATSPI_TYPE_RECT);
845 g_value_set_boxed (&e.any_data, &rect);
849 AtspiAccessible *accessible;
850 accessible = _atspi_dbus_return_accessible_from_iter (&iter_variant);
851 g_value_init (&e.any_data, ATSPI_TYPE_ACCESSIBLE);
852 g_value_set_instance (&e.any_data, accessible);
853 g_object_unref (accessible); /* value now owns it */
857 case DBUS_TYPE_STRING:
859 dbus_message_iter_get_basic (&iter_variant, &p);
860 g_value_init (&e.any_data, G_TYPE_STRING);
861 g_value_set_string (&e.any_data, p);
868 if (!strncmp (e.type, "object:children-changed", 23))
870 cache_process_children_changed (&e);
872 else if (!strncmp (e.type, "object:property-change", 22))
874 cache_process_property_change (&e);
876 else if (!strncmp (e.type, "object:state-changed", 20))
878 cache_process_state_changed (&e);
881 _atspi_send_event (&e);
883 g_free (converted_type);
886 g_object_unref (e.source);
887 g_value_unset (&e.any_data);
888 return DBUS_HANDLER_RESULT_HANDLED;
891 G_DEFINE_BOXED_TYPE (AtspiEvent, atspi_event, atspi_event_copy, atspi_event_free)