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;
137 static GList *event_listeners = NULL;
140 convert_name_from_dbus (const char *name)
142 gchar *ret = g_malloc (g_utf8_strlen (name, -1) * 2 + 1);
143 const char *p = name;
155 *q++ = tolower (*p++);
165 cache_process_children_changed (AtspiEvent *event)
167 AtspiAccessible *child;
169 if (!G_VALUE_HOLDS (&event->any_data, ATSPI_TYPE_ACCESSIBLE) ||
170 !event->source->children ||
171 atspi_state_set_contains (event->source->states, ATSPI_STATE_MANAGES_DESCENDANTS))
174 child = g_value_get_object (&event->any_data);
176 if (!strncmp (event->type, "object:children-changed:add", 27))
178 GList *new_list = g_list_insert (event->source->children, g_object_ref (child), event->detail1);
180 event->source->children = new_list;
182 else if (g_list_find (event->source->children, child))
184 event->source->children = g_list_remove (event->source->children, child);
189 cache_process_property_change (AtspiEvent *event)
191 if (!strcmp (event->type, "object:property-change:accessible-parent"))
193 if (event->source->accessible_parent)
194 g_object_unref (event->source->accessible_parent);
195 if (G_VALUE_HOLDS (&event->any_data, ATSPI_TYPE_ACCESSIBLE))
197 event->source->accessible_parent = g_value_dup_object (&event->any_data);
198 event->source->cached_properties |= ATSPI_CACHE_PARENT;
202 event->source->accessible_parent = NULL;
203 event->source->cached_properties &= ~ATSPI_CACHE_PARENT;
206 else if (!strcmp (event->type, "object:property-change:accessible-name"))
208 if (event->source->name)
209 g_free (event->source->name);
210 if (G_VALUE_HOLDS_STRING (&event->any_data))
212 event->source->name = g_value_dup_string (&event->any_data);
213 event->source->cached_properties |= ATSPI_CACHE_NAME;
217 event->source->name = NULL;
218 event->source->cached_properties &= ~ATSPI_CACHE_NAME;
221 else if (!strcmp (event->type, "object:property-change:accessible-description"))
223 if (event->source->description)
224 g_free (event->source->description);
225 if (G_VALUE_HOLDS_STRING (&event->any_data))
227 event->source->description = g_value_dup_string (&event->any_data);
228 event->source->cached_properties |= ATSPI_CACHE_DESCRIPTION;
232 event->source->description = NULL;
233 event->source->cached_properties &= ~ATSPI_CACHE_DESCRIPTION;
239 cache_process_state_changed (AtspiEvent *event)
241 atspi_state_set_set_by_name (event->source->states, event->type + 21, event->detail1);
245 demarshal_rect (DBusMessageIter *iter, AtspiRect *rect)
247 dbus_int32_t x, y, width, height;
248 DBusMessageIter iter_struct;
250 dbus_message_iter_recurse (iter, &iter_struct);
251 if (dbus_message_iter_get_arg_type (&iter_struct) != DBUS_TYPE_INT32) return FALSE;
252 dbus_message_iter_get_basic (&iter_struct, &x);
253 dbus_message_iter_next (&iter_struct);
254 if (dbus_message_iter_get_arg_type (&iter_struct) != DBUS_TYPE_INT32) return FALSE;
255 dbus_message_iter_get_basic (&iter_struct, &y);
256 dbus_message_iter_next (&iter_struct);
257 if (dbus_message_iter_get_arg_type (&iter_struct) != DBUS_TYPE_INT32) return FALSE;
258 dbus_message_iter_get_basic (&iter_struct, &width);
259 dbus_message_iter_next (&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, &height);
265 rect->height = height;
270 strdup_and_adjust_for_dbus (const char *s)
272 gchar *d = g_strdup (s);
282 memmove (p, p + 1, g_utf8_strlen (p, -1));
287 p [1] = toupper (p [1]);
291 d [0] = toupper (d [0]);
296 convert_event_type_to_dbus (const char *eventType, char **categoryp, char **namep, char **detailp, char **matchrule)
298 gchar *tmp = strdup_and_adjust_for_dbus (eventType);
299 char *category = NULL, *name = NULL, *detail = NULL;
300 char *saveptr = NULL;
303 if (tmp == NULL) return FALSE;
304 category = strtok_r (tmp, ":", &saveptr);
305 if (category) category = g_strdup (category);
306 if (!category) goto oom;
307 name = strtok_r (NULL, ":", &saveptr);
310 name = g_strdup (name);
312 detail = strtok_r (NULL, ":", &saveptr);
313 if (detail) detail = g_strdup (detail);
317 *matchrule = g_strdup_printf ("type='signal',interface='org.a11y.atspi.Event.%s'", category);
318 if (!*matchrule) goto oom;
319 if (name && name [0])
321 gchar *new_str = g_strconcat (*matchrule, ",member='", name, "'", NULL);
325 *matchrule = new_str;
328 if (detail && detail [0])
330 gchar *new_str = g_strconcat (*matchrule, ",arg0='", detail, "'", NULL);
334 *matchrule = new_str;
338 if (categoryp) *categoryp = category;
339 else g_free (category);
340 if (namep) *namep = name;
341 else if (name) g_free (name);
342 if (detailp) *detailp = detail;
343 else if (detail) g_free (detail);
347 if (tmp) g_free (tmp);
348 if (category) g_free (category);
349 if (name) g_free (name);
350 if (detail) g_free (detail);
355 listener_entry_free (EventListenerEntry *e)
357 gpointer callback = (e->callback = remove_datum ? e->user_data : e->callback);
358 g_free (e->category);
360 if (e->detail) g_free (e->detail);
361 callback_unref (callback);
366 * atspi_event_listener_register:
367 * @listener: The #AtspiEventListener to register against an event type.
368 * @user_data: (closure): User data to be passed to the callback.
369 * @callback_destroyed: A #GDestroyNotify called when the callback is destroyed.
370 * @event_type: a character string indicating the type of events for which
371 * notification is requested. Format is
372 * EventClass:major_type:minor_type:detail
373 * where all subfields other than EventClass are optional.
374 * EventClasses include "object", "window", "mouse",
375 * and toolkit events (e.g. "Gtk", "AWT").
376 * Examples: "focus:", "Gtk:GtkWidget:button_press_event".
378 * Legal object event types:
380 * (property change events)
382 * object:property-change
383 * object:property-change:accessible-name
384 * object:property-change:accessible-description
385 * object:property-change:accessible-parent
386 * object:property-change:accessible-value
387 * object:property-change:accessible-role
388 * object:property-change:accessible-table-caption
389 * object:property-change:accessible-table-column-description
390 * object:property-change:accessible-table-column-header
391 * object:property-change:accessible-table-row-description
392 * object:property-change:accessible-table-row-header
393 * object:property-change:accessible-table-summary
395 * (other object events)
397 * object:state-changed
398 * object:children-changed
399 * object:visible-data-changed
400 * object:selection-changed
401 * object:text-selection-changed
402 * object:text-changed
403 * object:text-caret-moved
404 * object:row-inserted
405 * object:row-reordered
407 * object:column-inserted
408 * object:column-reordered
409 * object:column-deleted
410 * object:model-changed
411 * object:active-descendant-changed
421 * window:desktop-create
422 * window:desktop-destroy
445 * NOTE: this string may be UTF-8, but should not contain byte value 56
446 * (ascii ':'), except as a delimiter, since non-UTF-8 string
447 * delimiting functions are used internally.
448 * In general, listening to
449 * toolkit-specific events is not recommended.
451 * Add an in-process callback function to an existing AtspiEventListener.
453 * Returns: #TRUE if successful, otherwise #FALSE.
456 atspi_event_listener_register (AtspiEventListener *listener,
457 const gchar *event_type)
459 /* TODO: Keep track of which events have been registered, so that we
460 * deregister all of them when the event listener is destroyed */
462 return atspi_event_listener_register_from_callback (listener->callback,
464 listener->cb_destroyed,
469 * atspi_event_listener_register_from_callback:
470 * @callback: (scope notified): the #AtspiEventListenerCB to be registered against
472 * @user_data: (closure): User data to be passed to the callback.
473 * @callback_destroyed: A #GDestroyNotify called when the callback is destroyed.
474 * @event_type: a character string indicating the type of events for which
475 * notification is requested. See #atspi_event_listener_register
476 * for a description of the format.
479 atspi_event_listener_register_from_callback (AtspiEventListenerCB callback,
481 GDestroyNotify callback_destroyed,
482 const gchar *event_type)
484 EventListenerEntry *e;
488 DBusMessage *message, *reply;
495 e = g_new (EventListenerEntry, 1);
496 if (!e) return FALSE;
497 e->callback = callback;
498 e->user_data = user_data;
499 e->callback_destroyed = callback_destroyed;
500 callback_ref (callback == remove_datum ? user_data : callback,
502 if (!convert_event_type_to_dbus (event_type, &e->category, &e->name, &e->detail, &matchrule))
507 new_list = g_list_prepend (event_listeners, e);
510 listener_entry_free (e);
513 event_listeners = new_list;
514 dbus_error_init (&error);
515 dbus_bus_add_match (_atspi_bus(), matchrule, &error);
518 g_warning ("Atspi: Adding match: %s", error.message);
521 dbus_error_init (&error);
522 message = dbus_message_new_method_call (atspi_bus_registry,
524 atspi_interface_registry,
528 dbus_message_append_args (message, DBUS_TYPE_STRING, &event_type, DBUS_TYPE_INVALID);
529 reply = _atspi_dbus_send_with_reply_and_block (message);
530 dbus_message_unref (reply);
536 * atspi_event_listener_register_no_data:
537 * @callback: (scope notified): the #AtspiEventListenerSimpleCB to be
538 * registered against an event type.
539 * @callback_destroyed: A #GDestroyNotify called when the callback is destroyed.
540 * @event_type: a character string indicating the type of events for which
541 * notification is requested. Format is
542 * EventClass:major_type:minor_type:detail
543 * where all subfields other than EventClass are optional.
544 * EventClasses include "object", "window", "mouse",
545 * and toolkit events (e.g. "Gtk", "AWT").
546 * Examples: "focus:", "Gtk:GtkWidget:button_press_event".
548 * Like atspi_event_listener_register, but callback takes no user_data.
551 atspi_event_listener_register_no_data (AtspiEventListenerSimpleCB callback,
552 GDestroyNotify callback_destroyed,
553 const gchar *event_type)
555 return atspi_event_listener_register_from_callback (remove_datum, callback, callback_destroyed, event_type);
559 is_superset (const gchar *super, const gchar *sub)
561 if (!super || !super [0])
563 return (strcmp (super, sub) == 0);
567 * atspi_event_listener_deregister:
568 * @listener: The #AtspiEventListener to deregister.
569 * @event_type: a string specifying the event type for which this
570 * listener is to be deregistered.
572 * deregisters an #AtspiEventListener from the registry, for a specific
575 * Returns: #TRUE if successful, otherwise #FALSE.
578 atspi_event_listener_deregister (AtspiEventListener *listener,
579 const gchar *event_type)
581 atspi_event_listener_deregister_from_callback (listener->callback, listener->user_data, event_type);
585 * atspi_event_listener_deregister_from_callback:
586 * @callback: (scope call): the #AtspiEventListenerCB registered against an
588 * @user_data: (closure): User data that was passed in for this callback.
589 * @event_type: a string specifying the event type for which this
590 * listener is to be deregistered.
592 * deregisters an #AtspiEventListenerCB from the registry, for a specific
595 * Returns: #TRUE if successful, otherwise #FALSE.
598 atspi_event_listener_deregister_from_callback (AtspiEventListenerCB callback,
600 const gchar *event_type)
602 char *category, *name, *detail, *matchrule;
605 if (!convert_event_type_to_dbus (event_type, &category, &name, &detail, &matchrule))
614 for (l = event_listeners; l;)
616 EventListenerEntry *e = l->data;
617 if (e->callback == callback &&
618 e->user_data == user_data &&
619 is_superset (category, e->category) &&
620 is_superset (name, e->name) &&
621 is_superset (detail, e->detail))
624 DBusMessage *message, *reply;
625 l = g_list_remove (l, e);
626 dbus_error_init (&error);
627 dbus_bus_remove_match (_atspi_bus(), matchrule, &error);
628 dbus_error_init (&error);
629 message = dbus_message_new_method_call (atspi_bus_registry,
631 atspi_interface_registry,
635 dbus_message_append_args (message, DBUS_TYPE_STRING, &event_type, DBUS_TYPE_INVALID);
636 reply = _atspi_dbus_send_with_reply_and_block (message);
637 dbus_message_unref (reply);
639 listener_entry_free (e);
641 else l = g_list_next (l);
645 if (detail) g_free (detail);
651 * atspi_event_listener_deregister_no_data:
652 * @callback: (scope call): the #AtspiEventListenerSimpleCB registered against
654 * @event_type: a string specifying the event type for which this
655 * listener is to be deregistered.
657 * deregisters an #AtspiEventListenerSimpleCB from the registry, for a specific
660 * Returns: #TRUE if successful, otherwise #FALSE.
663 atspi_event_listener_deregister_no_data (AtspiEventListenerSimpleCB callback,
664 const gchar *event_type)
666 return atspi_event_listener_deregister_from_callback (remove_datum, callback,
671 _atspi_send_event (AtspiEvent *e)
673 char *category, *name, *detail;
676 /* Ensure that the value is set to avoid a Python exception */
677 /* TODO: Figure out how to do this without using a private field */
678 if (e->any_data.g_type == 0)
679 g_value_set_int (&e->any_data, 0);
681 if (!convert_event_type_to_dbus (e->type, &category, &name, &detail, NULL))
683 g_warning ("Atspi: Couldn't parse event: %s\n", e->type);
686 for (l = event_listeners; l; l = g_list_next (l))
688 EventListenerEntry *entry = l->data;
689 if (!strcmp (category, entry->category) &&
690 (entry->name == NULL || !strcmp (name, entry->name)) &&
691 (entry->detail == NULL || !strcmp (detail, entry->detail)))
693 entry->callback (e, entry->user_data);
696 if (detail) g_free (detail);
702 atspi_dbus_handle_event (DBusConnection *bus, DBusMessage *message, void *data)
705 const char *category = dbus_message_get_interface (message);
706 const char *member = dbus_message_get_member (message);
708 gchar *converted_type;
709 DBusMessageIter iter, iter_variant;
710 dbus_message_iter_init (message, &iter);
712 dbus_int32_t detail1, detail2;
715 memset (&e, 0, sizeof (e));
719 category = g_utf8_strrchr (category, -1, '.');
720 if (category == NULL)
723 return DBUS_HANDLER_RESULT_NOT_YET_HANDLED;
727 g_return_val_if_fail (dbus_message_iter_get_arg_type (&iter) == DBUS_TYPE_STRING, DBUS_HANDLER_RESULT_NOT_YET_HANDLED);
728 dbus_message_iter_get_basic (&iter, &detail);
729 dbus_message_iter_next (&iter);
730 /* TODO: Return error indicating invalid arguments in next line */
731 g_return_val_if_fail (dbus_message_iter_get_arg_type (&iter) == DBUS_TYPE_INT32, DBUS_HANDLER_RESULT_NOT_YET_HANDLED);
732 dbus_message_iter_get_basic (&iter, &detail1);
734 dbus_message_iter_next (&iter);
735 g_return_val_if_fail (dbus_message_iter_get_arg_type (&iter) == DBUS_TYPE_INT32, DBUS_HANDLER_RESULT_NOT_YET_HANDLED);
736 dbus_message_iter_get_basic (&iter, &detail2);
738 dbus_message_iter_next (&iter);
740 converted_type = convert_name_from_dbus (category);
741 name = convert_name_from_dbus (member);
742 detail = convert_name_from_dbus (detail);
744 if (strcasecmp (category, name) != 0)
746 p = g_strconcat (converted_type, ":", name, NULL);
749 g_free (converted_type);
753 if (detail[0] != '\0')
755 p = g_strconcat (converted_type, ":", detail, NULL);
758 g_free (converted_type);
762 e.type = converted_type;
763 e.source = _atspi_ref_accessible (dbus_message_get_sender(message), dbus_message_get_path(message));
765 dbus_message_iter_recurse (&iter, &iter_variant);
766 switch (dbus_message_iter_get_arg_type (&iter_variant))
768 case DBUS_TYPE_STRUCT:
771 if (demarshal_rect (&iter_variant, &rect))
773 g_value_init (&e.any_data, ATSPI_TYPE_RECT);
774 g_value_set_boxed (&e.any_data, &rect);
778 AtspiAccessible *accessible;
779 accessible = _atspi_dbus_return_accessible_from_iter (&iter_variant);
780 g_value_init (&e.any_data, ATSPI_TYPE_ACCESSIBLE);
781 g_value_set_instance (&e.any_data, accessible);
785 case DBUS_TYPE_STRING:
787 dbus_message_iter_get_basic (&iter_variant, &p);
788 g_value_set_string (&e.any_data, p);
794 _atspi_send_event (&e);
796 if (!strcmp (e.type, "children-changed"))
798 cache_process_children_changed (&e);
800 else if (!strcmp (e.type, "property-change"))
802 cache_process_property_change (&e);
804 else if (!strcmp (e.type, "state-changed"))
806 cache_process_state_changed (&e);
809 g_free (converted_type);
812 g_object_unref (e.source);
813 g_value_unset (&e.any_data);
814 return DBUS_HANDLER_RESULT_HANDLED;
818 atspi_event_copy (AtspiEvent *src)
820 AtspiEvent *dst = g_new0 (AtspiEvent, 1);
821 dst->type = g_strdup (src->type);
822 dst->detail1 = src->detail1;
823 dst->detail2 = src->detail2;
824 g_value_copy (&dst->any_data, &src->any_data);
828 atspi_event_free (AtspiEvent *event)
830 g_object_unref (event->source);
831 g_free (event->type);
832 g_value_unset (&event->any_data);
836 G_DEFINE_BOXED_TYPE (AtspiEvent, atspi_event, atspi_event_copy, atspi_event_free)