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 GList *new_list = g_list_insert (event->source->children, g_object_ref (child), event->detail1);
181 event->source->children = new_list;
183 else if (g_list_find (event->source->children, child))
185 event->source->children = g_list_remove (event->source->children, child);
190 cache_process_property_change (AtspiEvent *event)
192 if (!strcmp (event->type, "object:property-change:accessible-parent"))
194 if (event->source->accessible_parent)
195 g_object_unref (event->source->accessible_parent);
196 if (G_VALUE_HOLDS (&event->any_data, ATSPI_TYPE_ACCESSIBLE))
198 event->source->accessible_parent = g_value_dup_object (&event->any_data);
199 event->source->cached_properties |= ATSPI_CACHE_PARENT;
203 event->source->accessible_parent = NULL;
204 event->source->cached_properties &= ~ATSPI_CACHE_PARENT;
207 else if (!strcmp (event->type, "object:property-change:accessible-name"))
209 if (event->source->name)
210 g_free (event->source->name);
211 if (G_VALUE_HOLDS_STRING (&event->any_data))
213 event->source->name = g_value_dup_string (&event->any_data);
214 event->source->cached_properties |= ATSPI_CACHE_NAME;
218 event->source->name = NULL;
219 event->source->cached_properties &= ~ATSPI_CACHE_NAME;
222 else if (!strcmp (event->type, "object:property-change:accessible-description"))
224 if (event->source->description)
225 g_free (event->source->description);
226 if (G_VALUE_HOLDS_STRING (&event->any_data))
228 event->source->description = g_value_dup_string (&event->any_data);
229 event->source->cached_properties |= ATSPI_CACHE_DESCRIPTION;
233 event->source->description = NULL;
234 event->source->cached_properties &= ~ATSPI_CACHE_DESCRIPTION;
240 cache_process_state_changed (AtspiEvent *event)
242 atspi_state_set_set_by_name (event->source->states, event->type + 21, event->detail1);
246 demarshal_rect (DBusMessageIter *iter, AtspiRect *rect)
248 dbus_int32_t x, y, width, height;
249 DBusMessageIter iter_struct;
251 dbus_message_iter_recurse (iter, &iter_struct);
252 if (dbus_message_iter_get_arg_type (&iter_struct) != DBUS_TYPE_INT32) return FALSE;
253 dbus_message_iter_get_basic (&iter_struct, &x);
254 dbus_message_iter_next (&iter_struct);
255 if (dbus_message_iter_get_arg_type (&iter_struct) != DBUS_TYPE_INT32) return FALSE;
256 dbus_message_iter_get_basic (&iter_struct, &y);
257 dbus_message_iter_next (&iter_struct);
258 if (dbus_message_iter_get_arg_type (&iter_struct) != DBUS_TYPE_INT32) return FALSE;
259 dbus_message_iter_get_basic (&iter_struct, &width);
260 dbus_message_iter_next (&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, &height);
266 rect->height = height;
271 strdup_and_adjust_for_dbus (const char *s)
273 gchar *d = g_strdup (s);
284 memmove (p, p + 1, g_utf8_strlen (p, -1));
292 p [1] = toupper (p [1]);
296 d [0] = toupper (d [0]);
301 convert_event_type_to_dbus (const char *eventType, char **categoryp, char **namep, char **detailp, char **matchrule)
303 gchar *tmp = strdup_and_adjust_for_dbus (eventType);
304 char *category = NULL, *name = NULL, *detail = NULL;
305 char *saveptr = NULL;
308 if (tmp == NULL) return FALSE;
309 category = strtok_r (tmp, ":", &saveptr);
310 if (category) category = g_strdup (category);
311 if (!category) goto oom;
312 name = strtok_r (NULL, ":", &saveptr);
315 name = g_strdup (name);
317 detail = strtok_r (NULL, ":", &saveptr);
318 if (detail) detail = g_strdup (detail);
322 *matchrule = g_strdup_printf ("type='signal',interface='org.a11y.atspi.Event.%s'", category);
323 if (!*matchrule) goto oom;
324 if (name && name [0])
326 gchar *new_str = g_strconcat (*matchrule, ",member='", name, "'", NULL);
330 *matchrule = new_str;
333 if (detail && detail [0])
335 gchar *new_str = g_strconcat (*matchrule, ",arg0='", detail, "'", NULL);
339 *matchrule = new_str;
343 if (categoryp) *categoryp = category;
344 else g_free (category);
345 if (namep) *namep = name;
346 else if (name) g_free (name);
347 if (detailp) *detailp = detail;
348 else if (detail) g_free (detail);
352 if (tmp) g_free (tmp);
353 if (category) g_free (category);
354 if (name) g_free (name);
355 if (detail) g_free (detail);
360 listener_entry_free (EventListenerEntry *e)
362 gpointer callback = (e->callback = remove_datum ? e->user_data : e->callback);
363 g_free (e->category);
365 if (e->detail) g_free (e->detail);
366 callback_unref (callback);
371 * atspi_event_listener_register:
372 * @listener: The #AtspiEventListener to register against an event type.
373 * @user_data: (closure): User data to be passed to the callback.
374 * @callback_destroyed: A #GDestroyNotify called when the callback is destroyed.
375 * @event_type: a character string indicating the type of events for which
376 * notification is requested. Format is
377 * EventClass:major_type:minor_type:detail
378 * where all subfields other than EventClass are optional.
379 * EventClasses include "object", "window", "mouse",
380 * and toolkit events (e.g. "Gtk", "AWT").
381 * Examples: "focus:", "Gtk:GtkWidget:button_press_event".
383 * Legal object event types:
385 * (property change events)
387 * object:property-change
388 * object:property-change:accessible-name
389 * object:property-change:accessible-description
390 * object:property-change:accessible-parent
391 * object:property-change:accessible-value
392 * object:property-change:accessible-role
393 * object:property-change:accessible-table-caption
394 * object:property-change:accessible-table-column-description
395 * object:property-change:accessible-table-column-header
396 * object:property-change:accessible-table-row-description
397 * object:property-change:accessible-table-row-header
398 * object:property-change:accessible-table-summary
400 * (other object events)
402 * object:state-changed
403 * object:children-changed
404 * object:visible-data-changed
405 * object:selection-changed
406 * object:text-selection-changed
407 * object:text-changed
408 * object:text-caret-moved
409 * object:row-inserted
410 * object:row-reordered
412 * object:column-inserted
413 * object:column-reordered
414 * object:column-deleted
415 * object:model-changed
416 * object:active-descendant-changed
426 * window:desktop-create
427 * window:desktop-destroy
450 * NOTE: this string may be UTF-8, but should not contain byte value 56
451 * (ascii ':'), except as a delimiter, since non-UTF-8 string
452 * delimiting functions are used internally.
453 * In general, listening to
454 * toolkit-specific events is not recommended.
456 * Add an in-process callback function to an existing AtspiEventListener.
458 * Returns: #TRUE if successful, otherwise #FALSE.
461 atspi_event_listener_register (AtspiEventListener *listener,
462 const gchar *event_type)
464 /* TODO: Keep track of which events have been registered, so that we
465 * deregister all of them when the event listener is destroyed */
467 return atspi_event_listener_register_from_callback (listener->callback,
469 listener->cb_destroyed,
474 * atspi_event_listener_register_from_callback:
475 * @callback: (scope notified): the #AtspiEventListenerCB to be registered against
477 * @user_data: (closure): User data to be passed to the callback.
478 * @callback_destroyed: A #GDestroyNotify called when the callback is destroyed.
479 * @event_type: a character string indicating the type of events for which
480 * notification is requested. See #atspi_event_listener_register
481 * for a description of the format.
484 atspi_event_listener_register_from_callback (AtspiEventListenerCB callback,
486 GDestroyNotify callback_destroyed,
487 const gchar *event_type)
489 EventListenerEntry *e;
493 DBusMessage *message, *reply;
500 e = g_new (EventListenerEntry, 1);
501 if (!e) return FALSE;
502 e->callback = callback;
503 e->user_data = user_data;
504 e->callback_destroyed = callback_destroyed;
505 callback_ref (callback == remove_datum ? user_data : callback,
507 if (!convert_event_type_to_dbus (event_type, &e->category, &e->name, &e->detail, &matchrule))
512 new_list = g_list_prepend (event_listeners, e);
515 listener_entry_free (e);
518 event_listeners = new_list;
519 dbus_error_init (&error);
520 dbus_bus_add_match (_atspi_bus(), matchrule, &error);
523 g_warning ("Atspi: Adding match: %s", error.message);
526 dbus_error_init (&error);
527 message = dbus_message_new_method_call (atspi_bus_registry,
529 atspi_interface_registry,
533 dbus_message_append_args (message, DBUS_TYPE_STRING, &event_type, DBUS_TYPE_INVALID);
534 reply = _atspi_dbus_send_with_reply_and_block (message);
535 dbus_message_unref (reply);
541 * atspi_event_listener_register_no_data:
542 * @callback: (scope notified): the #AtspiEventListenerSimpleCB to be
543 * registered against an event type.
544 * @callback_destroyed: A #GDestroyNotify called when the callback is destroyed.
545 * @event_type: a character string indicating the type of events for which
546 * notification is requested. Format is
547 * EventClass:major_type:minor_type:detail
548 * where all subfields other than EventClass are optional.
549 * EventClasses include "object", "window", "mouse",
550 * and toolkit events (e.g. "Gtk", "AWT").
551 * Examples: "focus:", "Gtk:GtkWidget:button_press_event".
553 * Like atspi_event_listener_register, but callback takes no user_data.
556 atspi_event_listener_register_no_data (AtspiEventListenerSimpleCB callback,
557 GDestroyNotify callback_destroyed,
558 const gchar *event_type)
560 return atspi_event_listener_register_from_callback (remove_datum, callback, callback_destroyed, event_type);
564 is_superset (const gchar *super, const gchar *sub)
566 if (!super || !super [0])
568 return (strcmp (super, sub) == 0);
572 * atspi_event_listener_deregister:
573 * @listener: The #AtspiEventListener to deregister.
574 * @event_type: a string specifying the event type for which this
575 * listener is to be deregistered.
577 * deregisters an #AtspiEventListener from the registry, for a specific
580 * Returns: #TRUE if successful, otherwise #FALSE.
583 atspi_event_listener_deregister (AtspiEventListener *listener,
584 const gchar *event_type)
586 atspi_event_listener_deregister_from_callback (listener->callback, listener->user_data, event_type);
590 * atspi_event_listener_deregister_from_callback:
591 * @callback: (scope call): the #AtspiEventListenerCB registered against an
593 * @user_data: (closure): User data that was passed in for this callback.
594 * @event_type: a string specifying the event type for which this
595 * listener is to be deregistered.
597 * deregisters an #AtspiEventListenerCB from the registry, for a specific
600 * Returns: #TRUE if successful, otherwise #FALSE.
603 atspi_event_listener_deregister_from_callback (AtspiEventListenerCB callback,
605 const gchar *event_type)
607 char *category, *name, *detail, *matchrule;
610 if (!convert_event_type_to_dbus (event_type, &category, &name, &detail, &matchrule))
619 for (l = event_listeners; l;)
621 EventListenerEntry *e = l->data;
622 if (e->callback == callback &&
623 e->user_data == user_data &&
624 is_superset (category, e->category) &&
625 is_superset (name, e->name) &&
626 is_superset (detail, e->detail))
629 DBusMessage *message, *reply;
630 l = g_list_remove (l, e);
631 dbus_error_init (&error);
632 dbus_bus_remove_match (_atspi_bus(), matchrule, &error);
633 dbus_error_init (&error);
634 message = dbus_message_new_method_call (atspi_bus_registry,
636 atspi_interface_registry,
640 dbus_message_append_args (message, DBUS_TYPE_STRING, &event_type, DBUS_TYPE_INVALID);
641 reply = _atspi_dbus_send_with_reply_and_block (message);
642 dbus_message_unref (reply);
644 listener_entry_free (e);
646 else l = g_list_next (l);
650 if (detail) g_free (detail);
656 * atspi_event_listener_deregister_no_data:
657 * @callback: (scope call): the #AtspiEventListenerSimpleCB registered against
659 * @event_type: a string specifying the event type for which this
660 * listener is to be deregistered.
662 * deregisters an #AtspiEventListenerSimpleCB from the registry, for a specific
665 * Returns: #TRUE if successful, otherwise #FALSE.
668 atspi_event_listener_deregister_no_data (AtspiEventListenerSimpleCB callback,
669 const gchar *event_type)
671 return atspi_event_listener_deregister_from_callback (remove_datum, callback,
676 atspi_event_copy (AtspiEvent *src)
678 AtspiEvent *dst = g_new0 (AtspiEvent, 1);
679 dst->type = g_strdup (src->type);
680 dst->source = g_object_ref (src->source);
681 dst->detail1 = src->detail1;
682 dst->detail2 = src->detail2;
683 dst->any_data.g_type = src->any_data.g_type;
684 g_value_copy (&dst->any_data, &src->any_data);
689 atspi_event_free (AtspiEvent *event)
691 g_object_unref (event->source);
692 g_free (event->type);
693 g_value_unset (&event->any_data);
698 _atspi_send_event (AtspiEvent *e)
700 char *category, *name, *detail;
703 /* Ensure that the value is set to avoid a Python exception */
704 /* TODO: Figure out how to do this without using a private field */
705 if (e->any_data.g_type == 0)
707 g_value_init (&e->any_data, G_TYPE_INT);
708 g_value_set_int (&e->any_data, 0);
711 if (!convert_event_type_to_dbus (e->type, &category, &name, &detail, NULL))
713 g_warning ("Atspi: Couldn't parse event: %s\n", e->type);
716 for (l = event_listeners; l; l = g_list_next (l))
718 EventListenerEntry *entry = l->data;
719 if (!strcmp (category, entry->category) &&
720 (entry->name == NULL || !strcmp (name, entry->name)) &&
721 (entry->detail == NULL || !strcmp (detail, entry->detail)))
723 entry->callback (atspi_event_copy (e), entry->user_data);
726 if (detail) g_free (detail);
732 atspi_dbus_handle_event (DBusConnection *bus, DBusMessage *message, void *data)
735 const char *category = dbus_message_get_interface (message);
736 const char *member = dbus_message_get_member (message);
738 gchar *converted_type;
739 DBusMessageIter iter, iter_variant;
740 dbus_message_iter_init (message, &iter);
742 dbus_int32_t detail1, detail2;
745 memset (&e, 0, sizeof (e));
749 category = g_utf8_strrchr (category, -1, '.');
750 if (category == NULL)
753 return DBUS_HANDLER_RESULT_NOT_YET_HANDLED;
757 g_return_val_if_fail (dbus_message_iter_get_arg_type (&iter) == DBUS_TYPE_STRING, DBUS_HANDLER_RESULT_NOT_YET_HANDLED);
758 dbus_message_iter_get_basic (&iter, &detail);
759 dbus_message_iter_next (&iter);
760 /* TODO: Return error indicating invalid arguments in next line */
761 g_return_val_if_fail (dbus_message_iter_get_arg_type (&iter) == DBUS_TYPE_INT32, DBUS_HANDLER_RESULT_NOT_YET_HANDLED);
762 dbus_message_iter_get_basic (&iter, &detail1);
764 dbus_message_iter_next (&iter);
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, &detail2);
768 dbus_message_iter_next (&iter);
770 converted_type = convert_name_from_dbus (category);
771 name = convert_name_from_dbus (member);
772 detail = convert_name_from_dbus (detail);
774 if (strcasecmp (category, name) != 0)
776 p = g_strconcat (converted_type, ":", name, NULL);
779 g_free (converted_type);
783 if (detail[0] != '\0')
785 p = g_strconcat (converted_type, ":", detail, NULL);
788 g_free (converted_type);
792 e.type = converted_type;
793 e.source = _atspi_ref_accessible (dbus_message_get_sender(message), dbus_message_get_path(message));
795 dbus_message_iter_recurse (&iter, &iter_variant);
796 switch (dbus_message_iter_get_arg_type (&iter_variant))
798 case DBUS_TYPE_STRUCT:
801 if (demarshal_rect (&iter_variant, &rect))
803 g_value_init (&e.any_data, ATSPI_TYPE_RECT);
804 g_value_set_boxed (&e.any_data, &rect);
808 AtspiAccessible *accessible;
809 accessible = _atspi_dbus_return_accessible_from_iter (&iter_variant);
810 g_value_init (&e.any_data, ATSPI_TYPE_ACCESSIBLE);
811 g_value_set_instance (&e.any_data, accessible);
815 case DBUS_TYPE_STRING:
817 dbus_message_iter_get_basic (&iter_variant, &p);
818 g_value_init (&e.any_data, G_TYPE_STRING);
819 g_value_set_string (&e.any_data, p);
825 _atspi_send_event (&e);
827 if (!strcmp (e.type, "children-changed"))
829 cache_process_children_changed (&e);
831 else if (!strcmp (e.type, "property-change"))
833 cache_process_property_change (&e);
835 else if (!strcmp (e.type, "state-changed"))
837 cache_process_state_changed (&e);
840 g_free (converted_type);
843 g_object_unref (e.source);
844 g_value_unset (&e.any_data);
845 return DBUS_HANDLER_RESULT_HANDLED;
848 G_DEFINE_BOXED_TYPE (AtspiEvent, atspi_event, atspi_event_copy, atspi_event_free)