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;
42 * Standard event dispatcher
45 static guint listener_id = 0;
46 static GList *event_listeners = NULL;
49 convert_name_from_dbus (const char *name)
51 gchar *ret = g_malloc (g_utf8_strlen (name, -1) * 2 + 1);
64 *q++ = tolower (*p++);
74 cache_process_children_changed (AtspiEvent *event)
76 AtspiAccessible *child;
78 if (!G_VALUE_HOLDS (&event->any_data, ATSPI_TYPE_ACCESSIBLE) ||
79 !event->source->children ||
80 atspi_state_set_contains (event->source->states, ATSPI_STATE_MANAGES_DESCENDANTS))
83 child = g_value_get_object (&event->any_data);
85 if (!strncmp (event->type, "object:children-changed:add", 27))
87 GList *new_list = g_list_insert (event->source->children, g_object_ref (child), event->detail1);
89 event->source->children = new_list;
91 else if (g_list_find (event->source->children, child))
93 event->source->children = g_list_remove (event->source->children, child);
98 cache_process_property_change (AtspiEvent *event)
100 if (!strcmp (event->type, "object:property-change:accessible-parent"))
102 if (event->source->accessible_parent)
103 g_object_unref (event->source->accessible_parent);
104 if (G_VALUE_HOLDS (&event->any_data, ATSPI_TYPE_ACCESSIBLE))
106 event->source->accessible_parent = g_value_dup_object (&event->any_data);
107 event->source->cached_properties |= ATSPI_CACHE_PARENT;
111 event->source->accessible_parent = NULL;
112 event->source->cached_properties &= ~ATSPI_CACHE_PARENT;
115 else if (!strcmp (event->type, "object:property-change:accessible-name"))
117 if (event->source->name)
118 g_free (event->source->name);
119 if (G_VALUE_HOLDS_STRING (&event->any_data))
121 event->source->name = g_value_dup_string (&event->any_data);
122 event->source->cached_properties |= ATSPI_CACHE_NAME;
126 event->source->name = NULL;
127 event->source->cached_properties &= ~ATSPI_CACHE_NAME;
130 else if (!strcmp (event->type, "object:property-change:accessible-description"))
132 if (event->source->description)
133 g_free (event->source->description);
134 if (G_VALUE_HOLDS_STRING (&event->any_data))
136 event->source->description = g_value_dup_string (&event->any_data);
137 event->source->cached_properties |= ATSPI_CACHE_DESCRIPTION;
141 event->source->description = NULL;
142 event->source->cached_properties &= ~ATSPI_CACHE_DESCRIPTION;
148 cache_process_state_changed (AtspiEvent *event)
150 atspi_state_set_set_by_name (event->source->states, event->type + 21, event->detail1);
154 demarshal_rect (DBusMessageIter *iter, AtspiRect *rect)
156 dbus_int32_t x, y, width, height;
157 DBusMessageIter iter_struct;
159 dbus_message_iter_recurse (iter, &iter_struct);
160 if (dbus_message_iter_get_arg_type (&iter_struct) != DBUS_TYPE_INT32) return FALSE;
161 dbus_message_iter_get_basic (&iter_struct, &x);
162 dbus_message_iter_next (&iter_struct);
163 if (dbus_message_iter_get_arg_type (&iter_struct) != DBUS_TYPE_INT32) return FALSE;
164 dbus_message_iter_get_basic (&iter_struct, &y);
165 dbus_message_iter_next (&iter_struct);
166 if (dbus_message_iter_get_arg_type (&iter_struct) != DBUS_TYPE_INT32) return FALSE;
167 dbus_message_iter_get_basic (&iter_struct, &width);
168 dbus_message_iter_next (&iter_struct);
169 if (dbus_message_iter_get_arg_type (&iter_struct) != DBUS_TYPE_INT32) return FALSE;
170 dbus_message_iter_get_basic (&iter_struct, &height);
174 rect->height = height;
179 strdup_and_adjust_for_dbus (const char *s)
181 gchar *d = g_strdup (s);
191 memmove (p, p + 1, g_utf8_strlen (p, -1));
196 p [1] = toupper (p [1]);
200 d [0] = toupper (d [0]);
205 convert_event_type_to_dbus (const char *eventType, char **categoryp, char **namep, char **detailp, char **matchrule)
207 gchar *tmp = strdup_and_adjust_for_dbus (eventType);
208 char *category = NULL, *name = NULL, *detail = NULL;
209 char *saveptr = NULL;
212 if (tmp == NULL) return FALSE;
213 category = strtok_r (tmp, ":", &saveptr);
214 if (category) category = g_strdup (category);
215 if (!category) goto oom;
216 name = strtok_r (NULL, ":", &saveptr);
219 name = g_strdup (name);
221 detail = strtok_r (NULL, ":", &saveptr);
222 if (detail) detail = g_strdup (detail);
226 *matchrule = g_strdup_printf ("type='signal',interface='org.a11y.atspi.Event.%s'", category);
227 if (!*matchrule) goto oom;
228 if (name && name [0])
230 gchar *new_str = g_strconcat (*matchrule, ",member='", name, "'", NULL);
234 *matchrule = new_str;
237 if (detail && detail [0])
239 gchar *new_str = g_strconcat (*matchrule, ",arg0='", detail, "'", NULL);
243 *matchrule = new_str;
247 if (categoryp) *categoryp = category;
248 else g_free (category);
249 if (namep) *namep = name;
250 else if (name) g_free (name);
251 if (detailp) *detailp = detail;
252 else if (detail) g_free (detail);
256 if (tmp) g_free (tmp);
257 if (category) g_free (category);
258 if (name) g_free (name);
259 if (detail) g_free (detail);
264 listener_entry_free (EventListenerEntry *e)
266 g_free (e->category);
268 if (e->detail) g_free (e->detail);
269 if (e->callback_destroyed)
270 (*e->callback_destroyed) (e->callback);
275 * atspi_event_listener_register:
276 * @callback: (scope notified): the #AtspiEventListenerCB to be registered against
278 * @user_data: (closure): User data to be passed to the callback.
279 * @callback_destroyed: A #GDestroyNotify called when the callback is destroyed.
280 * @event_type: a character string indicating the type of events for which
281 * notification is requested. Format is
282 * EventClass:major_type:minor_type:detail
283 * where all subfields other than EventClass are optional.
284 * EventClasses include "object", "window", "mouse",
285 * and toolkit events (e.g. "Gtk", "AWT").
286 * Examples: "focus:", "Gtk:GtkWidget:button_press_event".
288 * Legal object event types:
290 * (property change events)
292 * object:property-change
293 * object:property-change:accessible-name
294 * object:property-change:accessible-description
295 * object:property-change:accessible-parent
296 * object:property-change:accessible-value
297 * object:property-change:accessible-role
298 * object:property-change:accessible-table-caption
299 * object:property-change:accessible-table-column-description
300 * object:property-change:accessible-table-column-header
301 * object:property-change:accessible-table-row-description
302 * object:property-change:accessible-table-row-header
303 * object:property-change:accessible-table-summary
305 * (other object events)
307 * object:state-changed
308 * object:children-changed
309 * object:visible-data-changed
310 * object:selection-changed
311 * object:text-selection-changed
312 * object:text-changed
313 * object:text-caret-moved
314 * object:row-inserted
315 * object:row-reordered
317 * object:column-inserted
318 * object:column-reordered
319 * object:column-deleted
320 * object:model-changed
321 * object:active-descendant-changed
331 * window:desktop-create
332 * window:desktop-destroy
355 * NOTE: this string may be UTF-8, but should not contain byte value 56
356 * (ascii ':'), except as a delimiter, since non-UTF-8 string
357 * delimiting functions are used internally.
358 * In general, listening to
359 * toolkit-specific events is not recommended.
361 * Add an in-process callback function to an existing AtspiEventListener.
363 * Returns: #TRUE if successful, otherwise #FALSE.
366 atspi_event_listener_register (AtspiEventListenerCB callback,
368 GDestroyNotify callback_destroyed,
369 const gchar *event_type)
371 EventListenerEntry *e;
375 DBusMessage *message, *reply;
382 e = g_new (EventListenerEntry, 1);
383 if (!e) return FALSE;
384 e->callback = callback;
385 e->user_data = user_data;
386 e->callback_destroyed = callback_destroyed;
387 if (!convert_event_type_to_dbus (event_type, &e->category, &e->name, &e->detail, &matchrule))
392 new_list = g_list_prepend (event_listeners, e);
395 listener_entry_free (e);
398 event_listeners = new_list;
399 dbus_error_init (&error);
400 dbus_bus_add_match (_atspi_bus(), matchrule, &error);
403 g_warning ("Atspi: Adding match: %s", error.message);
406 dbus_error_init (&error);
407 message = dbus_message_new_method_call (atspi_bus_registry,
409 atspi_interface_registry,
413 dbus_message_append_args (message, DBUS_TYPE_STRING, &event_type, DBUS_TYPE_INVALID);
414 reply = _atspi_dbus_send_with_reply_and_block (message);
415 dbus_message_unref (reply);
421 remove_datum (const AtspiEvent *event, void *user_data)
423 AtspiEventListenerSimpleCB cb = user_data;
428 * atspi_event_listener_register_no_data:
429 * @callback: (scope notified): the #AtspiEventListenerSimpleCB to be
430 * registered against an event type.
431 * @callback_destroyed: A #GDestroyNotify called when the callback is destroyed.
432 * @event_type: a character string indicating the type of events for which
433 * notification is requested. Format is
434 * EventClass:major_type:minor_type:detail
435 * where all subfields other than EventClass are optional.
436 * EventClasses include "object", "window", "mouse",
437 * and toolkit events (e.g. "Gtk", "AWT").
438 * Examples: "focus:", "Gtk:GtkWidget:button_press_event".
440 * Like atspi_event_listener_register, but callback takes no user_data.
443 atspi_event_listener_register_no_data (AtspiEventListenerSimpleCB callback,
444 GDestroyNotify callback_destroyed,
445 const gchar *event_type)
447 return atspi_event_listener_register (remove_datum, callback, callback_destroyed, event_type);
451 is_superset (const gchar *super, const gchar *sub)
453 if (!super || !super [0])
455 return (strcmp (super, sub) == 0);
459 * atspi_event_listener_deregister:
460 * @callback: (scope call): the #AtspiEventListenerCB registered against an
462 * @user_data: (closure): User data that was passed in for this callback.
463 * @event_type: a string specifying the event type for which this
464 * listener is to be deregistered.
466 * deregisters an #AtspiEventListenerCB from the registry, for a specific
469 * Returns: #TRUE if successful, otherwise #FALSE.
472 atspi_event_listener_deregister (AtspiEventListenerCB callback,
474 const gchar *event_type)
476 char *category, *name, *detail, *matchrule;
479 if (!convert_event_type_to_dbus (event_type, &category, &name, &detail, &matchrule))
488 for (l = event_listeners; l;)
490 EventListenerEntry *e = l->data;
491 if (e->callback == callback &&
492 e->user_data == user_data &&
493 is_superset (category, e->category) &&
494 is_superset (name, e->name) &&
495 is_superset (detail, e->detail))
498 DBusMessage *message, *reply;
499 l = g_list_remove (l, e);
500 dbus_error_init (&error);
501 dbus_bus_remove_match (_atspi_bus(), matchrule, &error);
502 dbus_error_init (&error);
503 message = dbus_message_new_method_call (atspi_bus_registry,
505 atspi_interface_registry,
509 dbus_message_append_args (message, DBUS_TYPE_STRING, &event_type, DBUS_TYPE_INVALID);
510 reply = _atspi_dbus_send_with_reply_and_block (message);
511 dbus_message_unref (reply);
513 listener_entry_free (e);
515 else l = g_list_next (l);
519 if (detail) g_free (detail);
525 * atspi_event_listener_deregister_no_data:
526 * @callback: (scope call): the #AtspiEventListenerSimpleCB registered against
528 * @event_type: a string specifying the event type for which this
529 * listener is to be deregistered.
531 * deregisters an #AtspiEventListenerSimpleCB from the registry, for a specific
534 * Returns: #TRUE if successful, otherwise #FALSE.
537 atspi_event_listener_deregister_no_data (AtspiEventListenerSimpleCB callback,
538 const gchar *event_type)
540 return atspi_event_listener_deregister (remove_datum, callback, event_type);
544 _atspi_send_event (AtspiEvent *e)
546 char *category, *name, *detail;
549 /* Ensure that the value is set to avoid a Python exception */
550 /* TODO: Figure out how to do this without using a private field */
551 if (e->any_data.g_type == 0)
552 g_value_set_int (&e->any_data, 0);
554 if (!convert_event_type_to_dbus (e->type, &category, &name, &detail, NULL))
556 g_warning ("Atspi: Couldn't parse event: %s\n", e->type);
559 for (l = event_listeners; l; l = g_list_next (l))
561 EventListenerEntry *entry = l->data;
562 if (!strcmp (category, entry->category) &&
563 (entry->name == NULL || !strcmp (name, entry->name)) &&
564 (entry->detail == NULL || !strcmp (detail, entry->detail)))
566 entry->callback (e, entry->user_data);
569 if (detail) g_free (detail);
575 atspi_dbus_handle_event (DBusConnection *bus, DBusMessage *message, void *data)
578 const char *category = dbus_message_get_interface (message);
579 const char *member = dbus_message_get_member (message);
581 gchar *converted_type;
582 DBusMessageIter iter, iter_variant;
583 dbus_message_iter_init (message, &iter);
585 dbus_int32_t detail1, detail2;
588 memset (&e, 0, sizeof (e));
592 category = g_utf8_strrchr (category, -1, '.');
593 if (category == NULL)
596 return DBUS_HANDLER_RESULT_NOT_YET_HANDLED;
600 g_return_val_if_fail (dbus_message_iter_get_arg_type (&iter) == DBUS_TYPE_STRING, DBUS_HANDLER_RESULT_NOT_YET_HANDLED);
601 dbus_message_iter_get_basic (&iter, &detail);
602 dbus_message_iter_next (&iter);
603 /* TODO: Return error indicating invalid arguments in next line */
604 g_return_val_if_fail (dbus_message_iter_get_arg_type (&iter) == DBUS_TYPE_INT32, DBUS_HANDLER_RESULT_NOT_YET_HANDLED);
605 dbus_message_iter_get_basic (&iter, &detail1);
607 dbus_message_iter_next (&iter);
608 g_return_val_if_fail (dbus_message_iter_get_arg_type (&iter) == DBUS_TYPE_INT32, DBUS_HANDLER_RESULT_NOT_YET_HANDLED);
609 dbus_message_iter_get_basic (&iter, &detail2);
611 dbus_message_iter_next (&iter);
613 converted_type = convert_name_from_dbus (category);
614 name = convert_name_from_dbus (member);
615 detail = convert_name_from_dbus (detail);
617 if (strcasecmp (category, name) != 0)
619 p = g_strconcat (converted_type, ":", name, NULL);
622 g_free (converted_type);
626 if (detail[0] != '\0')
628 p = g_strconcat (converted_type, ":", detail, NULL);
631 g_free (converted_type);
635 e.type = converted_type;
636 e.source = _atspi_ref_accessible (dbus_message_get_sender(message), dbus_message_get_path(message));
638 dbus_message_iter_recurse (&iter, &iter_variant);
639 switch (dbus_message_iter_get_arg_type (&iter_variant))
641 case DBUS_TYPE_STRUCT:
644 if (demarshal_rect (&iter_variant, &rect))
646 g_value_init (&e.any_data, ATSPI_TYPE_RECT);
647 g_value_set_boxed (&e.any_data, &rect);
651 AtspiAccessible *accessible;
652 accessible = _atspi_dbus_return_accessible_from_iter (&iter_variant);
653 g_value_init (&e.any_data, ATSPI_TYPE_ACCESSIBLE);
654 g_value_set_instance (&e.any_data, accessible);
658 case DBUS_TYPE_STRING:
660 dbus_message_iter_get_basic (&iter_variant, &p);
661 g_value_set_string (&e.any_data, p);
667 _atspi_send_event (&e);
669 if (!strcmp (e.type, "children-changed"))
671 cache_process_children_changed (&e);
673 else if (!strcmp (e.type, "property-change"))
675 cache_process_property_change (&e);
677 else if (!strcmp (e.type, "state-changed"))
679 cache_process_state_changed (&e);
682 g_free (converted_type);
685 g_object_unref (e.source);
686 g_value_unset (&e.any_data);
687 return DBUS_HANDLER_RESULT_HANDLED;
691 atspi_event_copy (AtspiEvent *src)
693 AtspiEvent *dst = g_new0 (AtspiEvent, 1);
694 dst->type = g_strdup (src->type);
695 dst->detail1 = src->detail1;
696 dst->detail2 = src->detail2;
697 g_value_copy (&dst->any_data, &src->any_data);
701 atspi_event_free (AtspiEvent *event)
703 g_object_unref (event->source);
704 g_free (event->type);
705 g_value_unset (&event->any_data);
709 G_DEFINE_BOXED_TYPE (AtspiEvent, atspi_event, atspi_event_copy, atspi_event_free)