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);
192 cache_process_property_change (AtspiEvent *event)
194 if (!strcmp (event->type, "object:property-change:accessible-parent"))
196 if (event->source->accessible_parent)
197 g_object_unref (event->source->accessible_parent);
198 if (G_VALUE_HOLDS (&event->any_data, ATSPI_TYPE_ACCESSIBLE))
200 event->source->accessible_parent = g_value_dup_object (&event->any_data);
201 event->source->cached_properties |= ATSPI_CACHE_PARENT;
205 event->source->accessible_parent = NULL;
206 event->source->cached_properties &= ~ATSPI_CACHE_PARENT;
209 else if (!strcmp (event->type, "object:property-change:accessible-name"))
211 if (event->source->name)
212 g_free (event->source->name);
213 if (G_VALUE_HOLDS_STRING (&event->any_data))
215 event->source->name = g_value_dup_string (&event->any_data);
216 event->source->cached_properties |= ATSPI_CACHE_NAME;
220 event->source->name = NULL;
221 event->source->cached_properties &= ~ATSPI_CACHE_NAME;
224 else if (!strcmp (event->type, "object:property-change:accessible-description"))
226 if (event->source->description)
227 g_free (event->source->description);
228 if (G_VALUE_HOLDS_STRING (&event->any_data))
230 event->source->description = g_value_dup_string (&event->any_data);
231 event->source->cached_properties |= ATSPI_CACHE_DESCRIPTION;
235 event->source->description = NULL;
236 event->source->cached_properties &= ~ATSPI_CACHE_DESCRIPTION;
242 cache_process_state_changed (AtspiEvent *event)
244 if (event->source->states)
245 atspi_state_set_set_by_name (event->source->states, event->type + 21,
250 demarshal_rect (DBusMessageIter *iter, AtspiRect *rect)
252 dbus_int32_t x, y, width, height;
253 DBusMessageIter iter_struct;
255 dbus_message_iter_recurse (iter, &iter_struct);
256 if (dbus_message_iter_get_arg_type (&iter_struct) != DBUS_TYPE_INT32) return FALSE;
257 dbus_message_iter_get_basic (&iter_struct, &x);
258 dbus_message_iter_next (&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, &y);
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, &width);
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, &height);
270 rect->height = height;
275 strdup_and_adjust_for_dbus (const char *s)
277 gchar *d = g_strdup (s);
288 memmove (p, p + 1, g_utf8_strlen (p, -1));
296 p [1] = toupper (p [1]);
300 d [0] = toupper (d [0]);
305 convert_event_type_to_dbus (const char *eventType, char **categoryp, char **namep, char **detailp, char **matchrule)
307 gchar *tmp = strdup_and_adjust_for_dbus (eventType);
308 char *category = NULL, *name = NULL, *detail = NULL;
309 char *saveptr = NULL;
312 if (tmp == NULL) return FALSE;
313 category = strtok_r (tmp, ":", &saveptr);
314 if (category) category = g_strdup (category);
315 if (!category) goto oom;
316 name = strtok_r (NULL, ":", &saveptr);
319 name = g_strdup (name);
321 detail = strtok_r (NULL, ":", &saveptr);
322 if (detail) detail = g_strdup (detail);
326 *matchrule = g_strdup_printf ("type='signal',interface='org.a11y.atspi.Event.%s'", category);
327 if (!*matchrule) goto oom;
328 if (name && name [0])
330 gchar *new_str = g_strconcat (*matchrule, ",member='", name, "'", NULL);
334 *matchrule = new_str;
337 if (detail && detail [0])
339 gchar *new_str = g_strconcat (*matchrule, ",arg0='", detail, "'", NULL);
343 *matchrule = new_str;
347 if (categoryp) *categoryp = category;
348 else g_free (category);
349 if (namep) *namep = name;
350 else if (name) g_free (name);
351 if (detailp) *detailp = detail;
352 else if (detail) g_free (detail);
356 if (tmp) g_free (tmp);
357 if (category) g_free (category);
358 if (name) g_free (name);
359 if (detail) g_free (detail);
364 listener_entry_free (EventListenerEntry *e)
366 gpointer callback = (e->callback = remove_datum ? e->user_data : e->callback);
367 g_free (e->category);
369 if (e->detail) g_free (e->detail);
370 callback_unref (callback);
375 * atspi_event_listener_register:
376 * @listener: The #AtspiEventListener to register against an event type.
377 * @user_data: (closure): User data to be passed to the callback.
378 * @callback_destroyed: A #GDestroyNotify called when the callback is destroyed.
379 * @event_type: a character string indicating the type of events for which
380 * notification is requested. Format is
381 * EventClass:major_type:minor_type:detail
382 * where all subfields other than EventClass are optional.
383 * EventClasses include "object", "window", "mouse",
384 * and toolkit events (e.g. "Gtk", "AWT").
385 * Examples: "focus:", "Gtk:GtkWidget:button_press_event".
387 * Legal object event types:
389 * (property change events)
391 * object:property-change
392 * object:property-change:accessible-name
393 * object:property-change:accessible-description
394 * object:property-change:accessible-parent
395 * object:property-change:accessible-value
396 * object:property-change:accessible-role
397 * object:property-change:accessible-table-caption
398 * object:property-change:accessible-table-column-description
399 * object:property-change:accessible-table-column-header
400 * object:property-change:accessible-table-row-description
401 * object:property-change:accessible-table-row-header
402 * object:property-change:accessible-table-summary
404 * (other object events)
406 * object:state-changed
407 * object:children-changed
408 * object:visible-data-changed
409 * object:selection-changed
410 * object:text-selection-changed
411 * object:text-changed
412 * object:text-caret-moved
413 * object:row-inserted
414 * object:row-reordered
416 * object:column-inserted
417 * object:column-reordered
418 * object:column-deleted
419 * object:model-changed
420 * object:active-descendant-changed
430 * window:desktop-create
431 * window:desktop-destroy
454 * NOTE: this string may be UTF-8, but should not contain byte value 56
455 * (ascii ':'), except as a delimiter, since non-UTF-8 string
456 * delimiting functions are used internally.
457 * In general, listening to
458 * toolkit-specific events is not recommended.
460 * Add an in-process callback function to an existing AtspiEventListener.
462 * Returns: #TRUE if successful, otherwise #FALSE.
465 atspi_event_listener_register (AtspiEventListener *listener,
466 const gchar *event_type)
468 /* TODO: Keep track of which events have been registered, so that we
469 * deregister all of them when the event listener is destroyed */
471 return atspi_event_listener_register_from_callback (listener->callback,
473 listener->cb_destroyed,
478 * atspi_event_listener_register_from_callback:
479 * @callback: (scope notified): the #AtspiEventListenerCB to be registered against
481 * @user_data: (closure): User data to be passed to the callback.
482 * @callback_destroyed: A #GDestroyNotify called when the callback is destroyed.
483 * @event_type: a character string indicating the type of events for which
484 * notification is requested. See #atspi_event_listener_register
485 * for a description of the format.
488 atspi_event_listener_register_from_callback (AtspiEventListenerCB callback,
490 GDestroyNotify callback_destroyed,
491 const gchar *event_type)
493 EventListenerEntry *e;
497 DBusMessage *message, *reply;
504 e = g_new (EventListenerEntry, 1);
505 if (!e) return FALSE;
506 e->callback = callback;
507 e->user_data = user_data;
508 e->callback_destroyed = callback_destroyed;
509 callback_ref (callback == remove_datum ? user_data : callback,
511 if (!convert_event_type_to_dbus (event_type, &e->category, &e->name, &e->detail, &matchrule))
516 new_list = g_list_prepend (event_listeners, e);
519 listener_entry_free (e);
522 event_listeners = new_list;
523 dbus_error_init (&error);
524 dbus_bus_add_match (_atspi_bus(), matchrule, &error);
527 g_warning ("Atspi: Adding match: %s", error.message);
530 dbus_error_init (&error);
531 message = dbus_message_new_method_call (atspi_bus_registry,
533 atspi_interface_registry,
537 dbus_message_append_args (message, DBUS_TYPE_STRING, &event_type, DBUS_TYPE_INVALID);
538 reply = _atspi_dbus_send_with_reply_and_block (message);
539 dbus_message_unref (reply);
545 * atspi_event_listener_register_no_data:
546 * @callback: (scope notified): the #AtspiEventListenerSimpleCB to be
547 * registered against an event type.
548 * @callback_destroyed: A #GDestroyNotify called when the callback is destroyed.
549 * @event_type: a character string indicating the type of events for which
550 * notification is requested. Format is
551 * EventClass:major_type:minor_type:detail
552 * where all subfields other than EventClass are optional.
553 * EventClasses include "object", "window", "mouse",
554 * and toolkit events (e.g. "Gtk", "AWT").
555 * Examples: "focus:", "Gtk:GtkWidget:button_press_event".
557 * Like atspi_event_listener_register, but callback takes no user_data.
560 atspi_event_listener_register_no_data (AtspiEventListenerSimpleCB callback,
561 GDestroyNotify callback_destroyed,
562 const gchar *event_type)
564 return atspi_event_listener_register_from_callback (remove_datum, callback, callback_destroyed, event_type);
568 is_superset (const gchar *super, const gchar *sub)
570 if (!super || !super [0])
572 return (strcmp (super, sub) == 0);
576 * atspi_event_listener_deregister:
577 * @listener: The #AtspiEventListener to deregister.
578 * @event_type: a string specifying the event type for which this
579 * listener is to be deregistered.
581 * deregisters an #AtspiEventListener from the registry, for a specific
584 * Returns: #TRUE if successful, otherwise #FALSE.
587 atspi_event_listener_deregister (AtspiEventListener *listener,
588 const gchar *event_type)
590 atspi_event_listener_deregister_from_callback (listener->callback, listener->user_data, event_type);
594 * atspi_event_listener_deregister_from_callback:
595 * @callback: (scope call): the #AtspiEventListenerCB registered against an
597 * @user_data: (closure): User data that was passed in for this callback.
598 * @event_type: a string specifying the event type for which this
599 * listener is to be deregistered.
601 * deregisters an #AtspiEventListenerCB from the registry, for a specific
604 * Returns: #TRUE if successful, otherwise #FALSE.
607 atspi_event_listener_deregister_from_callback (AtspiEventListenerCB callback,
609 const gchar *event_type)
611 char *category, *name, *detail, *matchrule;
614 if (!convert_event_type_to_dbus (event_type, &category, &name, &detail, &matchrule))
623 for (l = event_listeners; l;)
625 EventListenerEntry *e = l->data;
626 if (e->callback == callback &&
627 e->user_data == user_data &&
628 is_superset (category, e->category) &&
629 is_superset (name, e->name) &&
630 is_superset (detail, e->detail))
633 DBusMessage *message, *reply;
634 l = g_list_remove (l, e);
635 dbus_error_init (&error);
636 dbus_bus_remove_match (_atspi_bus(), matchrule, &error);
637 dbus_error_init (&error);
638 message = dbus_message_new_method_call (atspi_bus_registry,
640 atspi_interface_registry,
644 dbus_message_append_args (message, DBUS_TYPE_STRING, &event_type, DBUS_TYPE_INVALID);
645 reply = _atspi_dbus_send_with_reply_and_block (message);
646 dbus_message_unref (reply);
648 listener_entry_free (e);
650 else l = g_list_next (l);
654 if (detail) g_free (detail);
660 * atspi_event_listener_deregister_no_data:
661 * @callback: (scope call): the #AtspiEventListenerSimpleCB registered against
663 * @event_type: a string specifying the event type for which this
664 * listener is to be deregistered.
666 * deregisters an #AtspiEventListenerSimpleCB from the registry, for a specific
669 * Returns: #TRUE if successful, otherwise #FALSE.
672 atspi_event_listener_deregister_no_data (AtspiEventListenerSimpleCB callback,
673 const gchar *event_type)
675 return atspi_event_listener_deregister_from_callback (remove_datum, callback,
680 atspi_event_copy (AtspiEvent *src)
682 AtspiEvent *dst = g_new0 (AtspiEvent, 1);
683 dst->type = g_strdup (src->type);
684 dst->source = g_object_ref (src->source);
685 dst->detail1 = src->detail1;
686 dst->detail2 = src->detail2;
687 g_value_init (&dst->any_data, G_VALUE_TYPE (&src->any_data));
688 g_value_copy (&src->any_data, &dst->any_data);
693 atspi_event_free (AtspiEvent *event)
695 g_object_unref (event->source);
696 g_free (event->type);
697 g_value_unset (&event->any_data);
702 _atspi_send_event (AtspiEvent *e)
704 char *category, *name, *detail;
707 /* Ensure that the value is set to avoid a Python exception */
708 /* TODO: Figure out how to do this without using a private field */
709 if (e->any_data.g_type == 0)
711 g_value_init (&e->any_data, G_TYPE_INT);
712 g_value_set_int (&e->any_data, 0);
715 if (!convert_event_type_to_dbus (e->type, &category, &name, &detail, NULL))
717 g_warning ("Atspi: Couldn't parse event: %s\n", e->type);
720 for (l = event_listeners; l; l = g_list_next (l))
722 EventListenerEntry *entry = l->data;
723 if (!strcmp (category, entry->category) &&
724 (entry->name == NULL || !strcmp (name, entry->name)) &&
725 (entry->detail == NULL || !strcmp (detail, entry->detail)))
727 entry->callback (atspi_event_copy (e), entry->user_data);
730 if (detail) g_free (detail);
736 atspi_dbus_handle_event (DBusConnection *bus, DBusMessage *message, void *data)
739 const char *category = dbus_message_get_interface (message);
740 const char *member = dbus_message_get_member (message);
742 gchar *converted_type;
743 DBusMessageIter iter, iter_variant;
744 dbus_message_iter_init (message, &iter);
746 dbus_int32_t detail1, detail2;
749 memset (&e, 0, sizeof (e));
753 category = g_utf8_strrchr (category, -1, '.');
754 if (category == NULL)
757 return DBUS_HANDLER_RESULT_NOT_YET_HANDLED;
761 g_return_val_if_fail (dbus_message_iter_get_arg_type (&iter) == DBUS_TYPE_STRING, DBUS_HANDLER_RESULT_NOT_YET_HANDLED);
762 dbus_message_iter_get_basic (&iter, &detail);
763 dbus_message_iter_next (&iter);
764 /* TODO: Return error indicating invalid arguments in next line */
765 g_return_val_if_fail (dbus_message_iter_get_arg_type (&iter) == DBUS_TYPE_INT32, DBUS_HANDLER_RESULT_NOT_YET_HANDLED);
766 dbus_message_iter_get_basic (&iter, &detail1);
768 dbus_message_iter_next (&iter);
769 g_return_val_if_fail (dbus_message_iter_get_arg_type (&iter) == DBUS_TYPE_INT32, DBUS_HANDLER_RESULT_NOT_YET_HANDLED);
770 dbus_message_iter_get_basic (&iter, &detail2);
772 dbus_message_iter_next (&iter);
774 converted_type = convert_name_from_dbus (category);
775 name = convert_name_from_dbus (member);
776 detail = convert_name_from_dbus (detail);
778 if (strcasecmp (category, name) != 0)
780 p = g_strconcat (converted_type, ":", name, NULL);
783 g_free (converted_type);
787 if (detail[0] != '\0')
789 p = g_strconcat (converted_type, ":", detail, NULL);
792 g_free (converted_type);
796 e.type = converted_type;
797 e.source = _atspi_ref_accessible (dbus_message_get_sender(message), dbus_message_get_path(message));
799 dbus_message_iter_recurse (&iter, &iter_variant);
800 switch (dbus_message_iter_get_arg_type (&iter_variant))
802 case DBUS_TYPE_STRUCT:
805 if (demarshal_rect (&iter_variant, &rect))
807 g_value_init (&e.any_data, ATSPI_TYPE_RECT);
808 g_value_set_boxed (&e.any_data, &rect);
812 AtspiAccessible *accessible;
813 accessible = _atspi_dbus_return_accessible_from_iter (&iter_variant);
814 g_value_init (&e.any_data, ATSPI_TYPE_ACCESSIBLE);
815 g_value_set_instance (&e.any_data, accessible);
819 case DBUS_TYPE_STRING:
821 dbus_message_iter_get_basic (&iter_variant, &p);
822 g_value_init (&e.any_data, G_TYPE_STRING);
823 g_value_set_string (&e.any_data, p);
829 _atspi_send_event (&e);
831 if (!strncmp (e.type, "object:children-changed", 23))
833 cache_process_children_changed (&e);
835 else if (!strncmp (e.type, "object:property-change", 22))
837 cache_process_property_change (&e);
839 else if (!strncmp (e.type, "object:state-changed", 20))
841 cache_process_state_changed (&e);
844 g_free (converted_type);
847 g_object_unref (e.source);
848 g_value_unset (&e.any_data);
849 return DBUS_HANDLER_RESULT_HANDLED;
852 G_DEFINE_BOXED_TYPE (AtspiEvent, atspi_event, atspi_event_copy, atspi_event_free)