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"
29 AtspiEventListenerCB callback;
31 GDestroyNotify callback_destroyed;
37 G_DEFINE_TYPE (AtspiEventListener, atspi_event_listener, G_TYPE_OBJECT)
40 atspi_event_listener_init (AtspiEventListener *listener)
45 atspi_event_listener_class_init (AtspiEventListenerClass *klass)
50 remove_datum (const AtspiEvent *event, void *user_data)
52 AtspiEventListenerSimpleCB cb = user_data;
59 GDestroyNotify callback_destroyed;
62 static GHashTable *callbacks;
65 callback_ref (void *callback, GDestroyNotify callback_destroyed)
71 callbacks = g_hash_table_new (g_direct_hash, g_direct_equal);
76 info = g_hash_table_lookup (callbacks, callback);
79 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 (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 event->source->cached_properties |= 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 event->source->cached_properties |= 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 event->source->cached_properties |= 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;
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)
469 /* TODO: Keep track of which events have been registered, so that we
470 * deregister all of them when the event listener is destroyed */
472 return atspi_event_listener_register_from_callback (listener->callback,
474 listener->cb_destroyed,
479 * atspi_event_listener_register_from_callback:
480 * @callback: (scope notified): the #AtspiEventListenerCB to be registered against
482 * @user_data: (closure): User data to be passed to the callback.
483 * @callback_destroyed: A #GDestroyNotify called when the callback is destroyed.
484 * @event_type: a character string indicating the type of events for which
485 * notification is requested. See #atspi_event_listener_register
486 * for a description of the format.
489 atspi_event_listener_register_from_callback (AtspiEventListenerCB callback,
491 GDestroyNotify callback_destroyed,
492 const gchar *event_type)
494 EventListenerEntry *e;
498 DBusMessage *message, *reply;
505 e = g_new (EventListenerEntry, 1);
506 if (!e) return FALSE;
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 (&error);
525 dbus_bus_add_match (_atspi_bus(), matchrule, &error);
528 g_warning ("Atspi: Adding match: %s", error.message);
531 dbus_error_init (&error);
532 message = dbus_message_new_method_call (atspi_bus_registry,
534 atspi_interface_registry,
538 dbus_message_append_args (message, DBUS_TYPE_STRING, &event_type, DBUS_TYPE_INVALID);
539 reply = _atspi_dbus_send_with_reply_and_block (message);
541 dbus_message_unref (reply);
547 * atspi_event_listener_register_no_data:
548 * @callback: (scope notified): the #AtspiEventListenerSimpleCB to be
549 * registered against an event type.
550 * @callback_destroyed: A #GDestroyNotify called when the callback is destroyed.
551 * @event_type: a character string indicating the type of events for which
552 * notification is requested. Format is
553 * EventClass:major_type:minor_type:detail
554 * where all subfields other than EventClass are optional.
555 * EventClasses include "object", "window", "mouse",
556 * and toolkit events (e.g. "Gtk", "AWT").
557 * Examples: "focus:", "Gtk:GtkWidget:button_press_event".
559 * Like atspi_event_listener_register, but callback takes no user_data.
562 atspi_event_listener_register_no_data (AtspiEventListenerSimpleCB callback,
563 GDestroyNotify callback_destroyed,
564 const gchar *event_type)
566 return atspi_event_listener_register_from_callback (remove_datum, callback, callback_destroyed, event_type);
570 is_superset (const gchar *super, const gchar *sub)
572 if (!super || !super [0])
574 return (strcmp (super, sub) == 0);
578 * atspi_event_listener_deregister:
579 * @listener: The #AtspiEventListener to deregister.
580 * @event_type: a string specifying the event type for which this
581 * listener is to be deregistered.
583 * deregisters an #AtspiEventListener from the registry, for a specific
586 * Returns: #TRUE if successful, otherwise #FALSE.
589 atspi_event_listener_deregister (AtspiEventListener *listener,
590 const gchar *event_type)
592 atspi_event_listener_deregister_from_callback (listener->callback, listener->user_data, event_type);
596 * atspi_event_listener_deregister_from_callback:
597 * @callback: (scope call): the #AtspiEventListenerCB registered against an
599 * @user_data: (closure): User data that was passed in for this callback.
600 * @event_type: a string specifying the event type for which this
601 * listener is to be deregistered.
603 * deregisters an #AtspiEventListenerCB from the registry, for a specific
606 * Returns: #TRUE if successful, otherwise #FALSE.
609 atspi_event_listener_deregister_from_callback (AtspiEventListenerCB callback,
611 const gchar *event_type)
613 char *category, *name, *detail, *matchrule;
616 if (!convert_event_type_to_dbus (event_type, &category, &name, &detail, &matchrule))
625 for (l = event_listeners; l;)
627 EventListenerEntry *e = l->data;
628 if (e->callback == callback &&
629 e->user_data == user_data &&
630 is_superset (category, e->category) &&
631 is_superset (name, e->name) &&
632 is_superset (detail, e->detail))
634 gboolean need_replace;
636 DBusMessage *message, *reply;
637 need_replace = (l == event_listeners);
638 l = g_list_remove (l, e);
641 dbus_error_init (&error);
642 dbus_bus_remove_match (_atspi_bus(), matchrule, &error);
643 dbus_error_init (&error);
644 message = dbus_message_new_method_call (atspi_bus_registry,
646 atspi_interface_registry,
650 dbus_message_append_args (message, DBUS_TYPE_STRING, &event_type, DBUS_TYPE_INVALID);
651 reply = _atspi_dbus_send_with_reply_and_block (message);
652 dbus_message_unref (reply);
654 listener_entry_free (e);
656 else l = g_list_next (l);
660 if (detail) g_free (detail);
666 * atspi_event_listener_deregister_no_data:
667 * @callback: (scope call): the #AtspiEventListenerSimpleCB registered against
669 * @event_type: a string specifying the event type for which this
670 * listener is to be deregistered.
672 * deregisters an #AtspiEventListenerSimpleCB from the registry, for a specific
675 * Returns: #TRUE if successful, otherwise #FALSE.
678 atspi_event_listener_deregister_no_data (AtspiEventListenerSimpleCB callback,
679 const gchar *event_type)
681 return atspi_event_listener_deregister_from_callback (remove_datum, callback,
686 atspi_event_copy (AtspiEvent *src)
688 AtspiEvent *dst = g_new0 (AtspiEvent, 1);
689 dst->type = g_strdup (src->type);
690 dst->source = g_object_ref (src->source);
691 dst->detail1 = src->detail1;
692 dst->detail2 = src->detail2;
693 g_value_init (&dst->any_data, G_VALUE_TYPE (&src->any_data));
694 g_value_copy (&src->any_data, &dst->any_data);
699 atspi_event_free (AtspiEvent *event)
701 g_object_unref (event->source);
702 g_free (event->type);
703 g_value_unset (&event->any_data);
708 _atspi_send_event (AtspiEvent *e)
710 char *category, *name, *detail;
713 /* Ensure that the value is set to avoid a Python exception */
714 /* TODO: Figure out how to do this without using a private field */
715 if (e->any_data.g_type == 0)
717 g_value_init (&e->any_data, G_TYPE_INT);
718 g_value_set_int (&e->any_data, 0);
721 if (!convert_event_type_to_dbus (e->type, &category, &name, &detail, NULL))
723 g_warning ("Atspi: Couldn't parse event: %s\n", e->type);
726 for (l = event_listeners; l; l = g_list_next (l))
728 EventListenerEntry *entry = l->data;
729 if (!strcmp (category, entry->category) &&
730 (entry->name == NULL || !strcmp (name, entry->name)) &&
731 (entry->detail == NULL || !strcmp (detail, entry->detail)))
733 entry->callback (atspi_event_copy (e), entry->user_data);
736 if (detail) g_free (detail);
742 atspi_dbus_handle_event (DBusConnection *bus, DBusMessage *message, void *data)
745 const char *category = dbus_message_get_interface (message);
746 const char *member = dbus_message_get_member (message);
747 const char *signature = dbus_message_get_signature (message);
749 gchar *converted_type;
750 DBusMessageIter iter, iter_variant;
751 dbus_message_iter_init (message, &iter);
753 dbus_int32_t detail1, detail2;
756 if (strcmp (signature, "siiv(so)") != 0)
758 g_warning (_("Got invalid signature %s for signal %s from interface %s\n"), signature, member, category);
762 memset (&e, 0, sizeof (e));
766 category = g_utf8_strrchr (category, -1, '.');
767 if (category == NULL)
770 return DBUS_HANDLER_RESULT_NOT_YET_HANDLED;
774 dbus_message_iter_get_basic (&iter, &detail);
775 dbus_message_iter_next (&iter);
776 dbus_message_iter_get_basic (&iter, &detail1);
778 dbus_message_iter_next (&iter);
779 dbus_message_iter_get_basic (&iter, &detail2);
781 dbus_message_iter_next (&iter);
783 converted_type = convert_name_from_dbus (category);
784 name = convert_name_from_dbus (member);
785 detail = convert_name_from_dbus (detail);
787 if (strcasecmp (category, name) != 0)
789 p = g_strconcat (converted_type, ":", name, NULL);
792 g_free (converted_type);
796 else if (detail [0] == '\0')
798 p = g_strconcat (converted_type, ":", NULL);
801 g_free (converted_type);
806 if (detail[0] != '\0')
808 p = g_strconcat (converted_type, ":", detail, NULL);
811 g_free (converted_type);
815 e.type = converted_type;
816 e.source = _atspi_ref_accessible (dbus_message_get_sender(message), dbus_message_get_path(message));
818 dbus_message_iter_recurse (&iter, &iter_variant);
819 switch (dbus_message_iter_get_arg_type (&iter_variant))
821 case DBUS_TYPE_STRUCT:
824 if (demarshal_rect (&iter_variant, &rect))
826 g_value_init (&e.any_data, ATSPI_TYPE_RECT);
827 g_value_set_boxed (&e.any_data, &rect);
831 AtspiAccessible *accessible;
832 accessible = _atspi_dbus_return_accessible_from_iter (&iter_variant);
833 g_value_init (&e.any_data, ATSPI_TYPE_ACCESSIBLE);
834 g_value_set_instance (&e.any_data, accessible);
835 g_object_unref (accessible); /* value now owns it */
839 case DBUS_TYPE_STRING:
841 dbus_message_iter_get_basic (&iter_variant, &p);
842 g_value_init (&e.any_data, G_TYPE_STRING);
843 g_value_set_string (&e.any_data, p);
850 if (!strncmp (e.type, "object:children-changed", 23))
852 cache_process_children_changed (&e);
854 else if (!strncmp (e.type, "object:property-change", 22))
856 cache_process_property_change (&e);
858 else if (!strncmp (e.type, "object:state-changed", 20))
860 cache_process_state_changed (&e);
863 _atspi_send_event (&e);
865 g_free (converted_type);
868 g_object_unref (e.source);
869 g_value_unset (&e.any_data);
870 return DBUS_HANDLER_RESULT_HANDLED;
873 G_DEFINE_BOXED_TYPE (AtspiEvent, atspi_event, atspi_event_copy, atspi_event_free)