* Copyright 2010, 2011 Novell, Inc.
*
* This library is free software; you can redistribute it and/or
- * modify it under the terms of the GNU Library General Public
+ * modify it under the terms of the GNU Lesser General Public
* License as published by the Free Software Foundation; either
- * version 2 of the License, or (at your option) any later version.
+ * version 2.1 of the License, or (at your option) any later version.
*
* This library is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
- * Library General Public License for more details.
+ * Lesser General Public License for more details.
*
- * You should have received a copy of the GNU Library General Public
+ * You should have received a copy of the GNU Lesser General Public
* License along with this library; if not, write to the
- * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
- * Boston, MA 02111-1307, USA.
+ * Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
+ * Boston, MA 02110-1301, USA.
*/
#include "atspi-private.h"
+#include "atspi-accessible-private.h"
#include <string.h>
+#include <strings.h>
#include <ctype.h>
typedef struct
AtspiEventListenerCB callback;
void *user_data;
GDestroyNotify callback_destroyed;
+ char *event_type;
char *category;
char *name;
char *detail;
+ GArray *properties;
} EventListenerEntry;
G_DEFINE_TYPE (AtspiEventListener, atspi_event_listener, G_TYPE_OBJECT)
}
static void
-remove_datum (const AtspiEvent *event, void *user_data)
+remove_datum (AtspiEvent *event, void *user_data)
{
AtspiEventListenerSimpleCB cb = user_data;
cb (event);
info = g_hash_table_lookup (callbacks, callback);
if (!info)
{
- g_warning ("Atspi: Dereferencing invalid callback %p\n", callback);
+ g_warning ("AT-SPI: Dereferencing invalid callback %p\n", callback);
return;
}
info->ref_count--;
/**
* atspi_event_listener_new:
- * @callback: (scope notified): An #AtspiEventListenerSimpleCB to be called
+ * @callback: (scope notified): An #AtspiEventListenerCB to be called
* when an event is fired.
* @user_data: (closure): data to pass to the callback.
* @callback_destroyed: A #GDestroyNotify called when the listener is freed
}
/**
- * atspi_event_listener_new_simple:
+ * atspi_event_listener_new_simple: (skip)
* @callback: (scope notified): An #AtspiEventListenerSimpleCB to be called
* when an event is fired.
* @callback_destroyed: A #GDestroyNotify called when the listener is freed
static GList *event_listeners = NULL;
static gchar *
-convert_name_from_dbus (const char *name)
+convert_name_from_dbus (const char *name, gboolean path_hack)
{
- gchar *ret = g_malloc (g_utf8_strlen (name, -1) * 2 + 1);
+ gchar *ret;
const char *p = name;
- gchar *q = ret;
+ gchar *q;
- if (!ret)
- return NULL;
+ if (!name)
+ return g_strdup ("");
+
+ ret = g_malloc (g_utf8_strlen (name, -1) * 2 + 1);
+ q = ret;
while (*p)
{
*q++ = '-';
*q++ = tolower (*p++);
}
+ else if (path_hack && *p == '/')
+ {
+ *q++ = ':';
+ p++;
+ }
else
*q++ = *p++;
}
return;
child = g_value_get_object (&event->any_data);
+ if (child == NULL)
+ return;
if (!strncmp (event->type, "object:children-changed:add", 27))
{
- if (g_list_find (event->source->children, child))
+ g_ptr_array_remove (event->source->children, child); /* just to be safe */
+ if (event->detail1 < 0 || event->detail1 > event->source->children->len)
+ {
+ event->source->cached_properties &= ~ATSPI_CACHE_CHILDREN;
return;
- GList *new_list = g_list_insert (event->source->children, g_object_ref (child), event->detail1);
- if (new_list)
- event->source->children = new_list;
+ }
+ /* Unfortunately, there's no g_ptr_array_insert or similar */
+ g_ptr_array_add (event->source->children, NULL);
+ memmove (event->source->children->pdata + event->detail1 + 1,
+ event->source->children->pdata + event->detail1,
+ (event->source->children->len - event->detail1 - 1) * sizeof (gpointer));
+ g_ptr_array_index (event->source->children, event->detail1) = g_object_ref (child);
}
- else if (g_list_find (event->source->children, child))
+ else
{
- event->source->children = g_list_remove (event->source->children, child);
+ g_ptr_array_remove (event->source->children, child);
if (child == child->parent.app->root)
g_object_run_dispose (G_OBJECT (child->parent.app));
- g_object_unref (child);
}
}
event->source->cached_properties &= ~ATSPI_CACHE_DESCRIPTION;
}
}
+ else if (!strcmp (event->type, "object:property-change:accessible-role"))
+ {
+ if (G_VALUE_HOLDS_INT (&event->any_data))
+ {
+ event->source->role = g_value_get_int (&event->any_data);
+ _atspi_accessible_add_cache (event->source, ATSPI_CACHE_ROLE);
+ }
+ else
+ {
+ event->source->cached_properties &= ~ATSPI_CACHE_ROLE;
+ }
+ }
}
static void
}
static gboolean
-convert_event_type_to_dbus (const char *eventType, char **categoryp, char **namep, char **detailp, char **matchrule)
+convert_event_type_to_dbus (const char *eventType, char **categoryp, char **namep, char **detailp, GPtrArray **matchrule_array)
{
gchar *tmp = strdup_and_adjust_for_dbus (eventType);
char *category = NULL, *name = NULL, *detail = NULL;
if (tmp == NULL) return FALSE;
category = strtok_r (tmp, ":", &saveptr);
if (category) category = g_strdup (category);
- if (!category) goto oom;
name = strtok_r (NULL, ":", &saveptr);
if (name)
{
name = g_strdup (name);
- if (!name) goto oom;
detail = strtok_r (NULL, ":", &saveptr);
if (detail) detail = g_strdup (detail);
}
- if (matchrule)
+ if (matchrule_array)
{
- *matchrule = g_strdup_printf ("type='signal',interface='org.a11y.atspi.Event.%s'", category);
- if (!*matchrule) goto oom;
+ gchar *matchrule;
+ (*matchrule_array) = g_ptr_array_new ();
+ matchrule = g_strdup_printf ("type='signal',interface='org.a11y.atspi.Event.%s'", category);
if (name && name [0])
{
- gchar *new_str = g_strconcat (*matchrule, ",member='", name, "'", NULL);
- g_free (*matchrule);
- *matchrule = new_str;
+ gchar *new_str = g_strconcat (matchrule, ",member='", name, "'", NULL);
+ g_free (matchrule);
+ matchrule = new_str;
}
if (detail && detail [0])
{
- gchar *new_str = g_strconcat (*matchrule, ",arg0='", detail, "'", NULL);
- g_free (*matchrule);
- *matchrule = new_str;
+ gchar *new_str = g_strconcat (matchrule, ",arg0='", detail, "'", NULL);
+ g_ptr_array_add (*matchrule_array, new_str);
+ new_str = g_strconcat (matchrule, ",arg0path='", detail, "/'", NULL);
+ g_ptr_array_add (*matchrule_array, new_str);
+ g_free (matchrule);
}
+ else
+ g_ptr_array_add (*matchrule_array, matchrule);
}
if (categoryp) *categoryp = category;
else g_free (category);
else if (detail) g_free (detail);
g_free (tmp);
return TRUE;
-oom:
- if (tmp) g_free (tmp);
- if (category) g_free (category);
- if (name) g_free (name);
- if (detail) g_free (detail);
- return FALSE;
}
static void
listener_entry_free (EventListenerEntry *e)
{
gpointer callback = (e->callback == remove_datum ? (gpointer)e->user_data : (gpointer)e->callback);
+ g_free (e->event_type);
g_free (e->category);
g_free (e->name);
if (e->detail) g_free (e->detail);
* object:model-changed
* object:active-descendant-changed
*
+ * (screen reader events)
+* screen-reader:region-changed
+ *
* (window events)
*
* window:minimize
* In general, listening to
* toolkit-specific events is not recommended.
*
+ * Currently, object:text-reading-position needs to be specified explicitly
+ * (it is not implied by object:text), since it is generated by the screen
+ * reader and is thus a special case internally.
*
* Returns: #TRUE if successful, otherwise #FALSE.
**/
}
/**
+ * atspi_event_listener_register_full:
+ * @listener: The #AtspiEventListener to register against an event type.
+ * @event_type: a character string indicating the type of events for which
+ * notification is requested. See #atspi_event_listener_register
+ * for a description of the format and legal event types.
+* @properties: (element-type gchar*) (transfer none) (allow-none): a list of
+ * properties that should be sent along with the event. The
+ * properties are valued for the duration of the event callback.k
+ * TODO: Document.
+ *
+ * Adds an in-process callback function to an existing #AtspiEventListener.
+ *
+ * Returns: #TRUE if successful, otherwise #FALSE.
+ **/
+gboolean
+atspi_event_listener_register_full (AtspiEventListener *listener,
+ const gchar *event_type,
+ GArray *properties,
+ GError **error)
+{
+ /* TODO: Keep track of which events have been registered, so that we
+ * deregister all of them when the event listener is destroyed */
+
+ return atspi_event_listener_register_from_callback_full (listener->callback,
+ listener->user_data,
+ listener->cb_destroyed,
+ event_type,
+ properties,
+ error);
+}
+
+static gboolean
+notify_event_registered (EventListenerEntry *e)
+{
+
+ if (e->properties)
+ dbind_method_call_reentrant (_atspi_bus (), atspi_bus_registry,
+ atspi_path_registry,
+ atspi_interface_registry,
+ "RegisterEvent",
+ NULL, "sas", e->event_type,
+ e->properties);
+ else
+ dbind_method_call_reentrant (_atspi_bus (), atspi_bus_registry,
+ atspi_path_registry,
+ atspi_interface_registry,
+ "RegisterEvent",
+ NULL, "s", e->event_type);
+
+ return TRUE;
+}
+
+/**
* atspi_event_listener_register_from_callback:
* @callback: (scope notified): the #AtspiEventListenerCB to be registered
* against an event type.
const gchar *event_type,
GError **error)
{
+ return atspi_event_listener_register_from_callback_full (callback,
+ user_data,
+ callback_destroyed,
+ event_type, NULL,
+ error);
+}
+
+static GArray *
+copy_event_properties (GArray *src)
+{
+ gint i;
+
+ GArray *dst = g_array_new (FALSE, FALSE, sizeof (char *));
+
+ if (!src)
+ return dst;
+ for (i = 0; i < src->len; i++)
+ {
+ gchar *dup = g_strdup (g_array_index (src, char *, i));
+ g_array_append_val (dst, dup);
+ }
+ return dst;
+}
+
+/**
+ * atspi_event_listener_register_from_callback_full:
+ * @callback: (scope async): an #AtspiEventListenerCB function pointer.
+ * @user_data: (closure callback)
+ * @callback_destroyed: (destroy callback)
+ * @event_type:
+ * @properties: (element-type utf8)
+ * @error:
+ *
+ * Returns: #TRUE if successful, otherwise #FALSE.
+ *
+ **/
+gboolean
+atspi_event_listener_register_from_callback_full (AtspiEventListenerCB callback,
+ void *user_data,
+ GDestroyNotify callback_destroyed,
+ const gchar *event_type,
+ GArray *properties,
+ GError **error)
+{
EventListenerEntry *e;
- char *matchrule;
DBusError d_error;
- GList *new_list;
- DBusMessage *message, *reply;
+ GPtrArray *matchrule_array;
+ gint i;
if (!callback)
{
}
e = g_new (EventListenerEntry, 1);
+ e->event_type = g_strdup (event_type);
e->callback = callback;
e->user_data = user_data;
e->callback_destroyed = callback_destroyed;
callback_ref (callback == remove_datum ? (gpointer)user_data : (gpointer)callback,
callback_destroyed);
- if (!convert_event_type_to_dbus (event_type, &e->category, &e->name, &e->detail, &matchrule))
+ if (!convert_event_type_to_dbus (event_type, &e->category, &e->name, &e->detail, &matchrule_array))
{
g_free (e);
return FALSE;
}
- new_list = g_list_prepend (event_listeners, e);
- if (!new_list)
+ e->properties = copy_event_properties (properties);
+ event_listeners = g_list_prepend (event_listeners, e);
+ for (i = 0; i < matchrule_array->len; i++)
{
- listener_entry_free (e);
- return FALSE;
- }
- event_listeners = new_list;
- dbus_error_init (&d_error);
- dbus_bus_add_match (_atspi_bus(), matchrule, &d_error);
- if (d_error.message)
- {
- g_warning ("Atspi: Adding match: %s", d_error.message);
- /* TODO: Set error */
- }
+ char *matchrule = g_ptr_array_index (matchrule_array, i);
+ dbus_error_init (&d_error);
+ dbus_bus_add_match (_atspi_bus(), matchrule, &d_error);
+ if (dbus_error_is_set (&d_error))
+ {
+ g_warning ("AT-SPI: Adding match: %s", d_error.message);
+ dbus_error_free (&d_error);
+ /* TODO: Set error */
+ }
- dbus_error_init (&d_error);
- message = dbus_message_new_method_call (atspi_bus_registry,
- atspi_path_registry,
- atspi_interface_registry,
- "RegisterEvent");
- if (!message)
- return FALSE;
- dbus_message_append_args (message, DBUS_TYPE_STRING, &event_type, DBUS_TYPE_INVALID);
- reply = _atspi_dbus_send_with_reply_and_block (message, error);
- if (reply)
- dbus_message_unref (reply);
+ g_free (matchrule);
+ }
+ g_ptr_array_free (matchrule_array, TRUE);
+ notify_event_registered (e);
return TRUE;
}
+void
+_atspi_reregister_event_listeners ()
+{
+ GList *l;
+ EventListenerEntry *e;
+
+ for (l = event_listeners; l; l = l->next)
+ {
+ e = l->data;
+ notify_event_registered (e);
+ }
+}
+
/**
- * atspi_event_listener_register_no_data:
+ * atspi_event_listener_register_no_data: (skip)
* @callback: (scope notified): the #AtspiEventListenerSimpleCB to be
* registered against an event type.
* @callback_destroyed: A #GDestroyNotify called when the callback is destroyed.
const gchar *event_type,
GError **error)
{
- char *category, *name, *detail, *matchrule;
+ char *category, *name, *detail;
+ GPtrArray *matchrule_array;
+ gint i;
GList *l;
+ gboolean result = TRUE;
- if (!convert_event_type_to_dbus (event_type, &category, &name, &detail, &matchrule))
+ if (!callback)
+ {
+ return FALSE;
+ }
+ if (!convert_event_type_to_dbus (event_type, &category, &name, &detail, &matchrule_array))
{
return FALSE;
}
- if (!callback)
- {
- return FALSE;
- }
for (l = event_listeners; l;)
{
is_superset (detail, e->detail))
{
gboolean need_replace;
- DBusError d_error;
DBusMessage *message, *reply;
need_replace = (l == event_listeners);
l = g_list_remove (l, e);
if (need_replace)
event_listeners = l;
- dbus_error_init (&d_error);
- dbus_bus_remove_match (_atspi_bus(), matchrule, &d_error);
- dbus_error_init (&d_error);
+ for (i = 0; i < matchrule_array->len; i++)
+ {
+ char *matchrule = g_ptr_array_index (matchrule_array, i);
+ dbus_bus_remove_match (_atspi_bus(), matchrule, NULL);
+ }
message = dbus_message_new_method_call (atspi_bus_registry,
atspi_path_registry,
atspi_interface_registry,
- "RegisterEvent");
- if (!message)
- return FALSE;
+ "DeregisterEvent");
+ if (!message) {
+ result = FALSE;
+ break;
+ }
dbus_message_append_args (message, DBUS_TYPE_STRING, &event_type, DBUS_TYPE_INVALID);
reply = _atspi_dbus_send_with_reply_and_block (message, error);
if (reply)
g_free (category);
g_free (name);
if (detail) g_free (detail);
- g_free (matchrule);
- return TRUE;
+ for (i = 0; i < matchrule_array->len; i++)
+ g_free (g_ptr_array_index (matchrule_array, i));
+ g_ptr_array_free (matchrule_array, TRUE);
+ return result;
}
/**
- * atspi_event_listener_deregister_no_data:
+ * atspi_event_listener_deregister_no_data: (skip)
* @callback: (scope call): the #AtspiEventListenerSimpleCB registered against
* an event type.
* @event_type: a string specifying the event type for which this
dst->detail2 = src->detail2;
g_value_init (&dst->any_data, G_VALUE_TYPE (&src->any_data));
g_value_copy (&src->any_data, &dst->any_data);
+ dst->sender = g_object_ref (src->sender);
return dst;
}
g_object_unref (event->source);
g_free (event->type);
g_value_unset (&event->any_data);
+ g_object_unref (event->sender);
g_free (event);
}
+static gboolean
+detail_matches_listener (const char *event_detail, const char *listener_detail)
+{
+ if (!listener_detail)
+ return TRUE;
+
+ if (!event_detail)
+ return FALSE;
+
+ return !(listener_detail [strcspn (listener_detail, ":")] == '\0'
+ ? strncmp (listener_detail, event_detail,
+ strcspn (event_detail, ":"))
+ : strcmp (listener_detail, event_detail));
+}
+
void
_atspi_send_event (AtspiEvent *e)
{
char *category, *name, *detail;
GList *l;
+ GList *called_listeners = NULL;
/* Ensure that the value is set to avoid a Python exception */
/* TODO: Figure out how to do this without using a private field */
if (!convert_event_type_to_dbus (e->type, &category, &name, &detail, NULL))
{
- g_warning ("Atspi: Couldn't parse event: %s\n", e->type);
+ g_warning ("AT-SPI: Couldn't parse event: %s\n", e->type);
return;
}
for (l = event_listeners; l; l = g_list_next (l))
EventListenerEntry *entry = l->data;
if (!strcmp (category, entry->category) &&
(entry->name == NULL || !strcmp (name, entry->name)) &&
- (entry->detail == NULL || !strcmp (detail, entry->detail)))
+ detail_matches_listener (detail, entry->detail))
{
+ GList *l2;
+ for (l2 = called_listeners; l2; l2 = l2->next)
+ {
+ EventListenerEntry *e2 = l2->data;
+ if (entry->callback == e2->callback && entry->user_data == e2->user_data)
+ break;
+ }
+ if (!l2)
+ {
entry->callback (atspi_event_copy (e), entry->user_data);
+ called_listeners = g_list_prepend (called_listeners, entry);
+ }
}
}
if (detail) g_free (detail);
g_free (name);
g_free (category);
+ g_list_free (called_listeners);
}
DBusHandlerResult
{
char *detail = NULL;
const char *category = dbus_message_get_interface (message);
+ const char *sender = dbus_message_get_sender (message);
const char *member = dbus_message_get_member (message);
const char *signature = dbus_message_get_signature (message);
gchar *name;
AtspiEvent e;
dbus_int32_t detail1, detail2;
char *p;
+ GHashTable *cache = NULL;
- if (strcmp (signature, "siiv(so)") != 0)
+ if (strcmp (signature, "siiv(so)") != 0 &&
+ strcmp (signature, "siiva{sv}") != 0)
{
- g_warning ("Got invalid signature %s for signal %s from interface %s\n", signature, member, category);
+ g_warning ("Got invalid signature %s for signal %s from interface %s\n", signature, member, category);
return DBUS_HANDLER_RESULT_HANDLED;
}
memset (&e, 0, sizeof (e));
- if (category)
+ if (!category)
{
- category = g_utf8_strrchr (category, -1, '.');
- if (category == NULL)
- {
- // TODO: Error
- return DBUS_HANDLER_RESULT_NOT_YET_HANDLED;
- }
- category++;
+ // TODO: Error
+ return DBUS_HANDLER_RESULT_NOT_YET_HANDLED;
}
+
+ category = g_utf8_strrchr (category, -1, '.');
+ if (category == NULL)
+ {
+ // TODO: Error
+ return DBUS_HANDLER_RESULT_NOT_YET_HANDLED;
+ }
+ category++;
+
dbus_message_iter_get_basic (&iter, &detail);
dbus_message_iter_next (&iter);
dbus_message_iter_get_basic (&iter, &detail1);
e.detail2 = detail2;
dbus_message_iter_next (&iter);
- converted_type = convert_name_from_dbus (category);
- name = convert_name_from_dbus (member);
- detail = convert_name_from_dbus (detail);
+ converted_type = convert_name_from_dbus (category, FALSE);
+ name = convert_name_from_dbus (member, FALSE);
+ detail = convert_name_from_dbus (detail, TRUE);
if (strcasecmp (category, name) != 0)
{
converted_type = p;
}
e.type = converted_type;
- e.source = _atspi_ref_accessible (dbus_message_get_sender(message), dbus_message_get_path(message));
+ if (strcmp (category, "ScreenReader") != 0)
+ {
+ e.source = _atspi_ref_accessible (sender, dbus_message_get_path (message));
+ if (e.source == NULL)
+ {
+ g_warning ("Got no valid source accessible for signal %s from interface %s\n", member, category);
+ g_free (converted_type);
+ g_free (name);
+ g_free (detail);
+ return DBUS_HANDLER_RESULT_HANDLED;
+ }
+ }
dbus_message_iter_recurse (&iter, &iter_variant);
switch (dbus_message_iter_get_arg_type (&iter_variant))
AtspiRect rect;
if (demarshal_rect (&iter_variant, &rect))
{
- g_value_init (&e.any_data, ATSPI_TYPE_RECT);
- g_value_set_boxed (&e.any_data, &rect);
+ g_value_init (&e.any_data, ATSPI_TYPE_RECT);
+ g_value_set_boxed (&e.any_data, &rect);
}
else
{
AtspiAccessible *accessible;
- accessible = _atspi_dbus_return_accessible_from_iter (&iter_variant);
- g_value_init (&e.any_data, ATSPI_TYPE_ACCESSIBLE);
- g_value_set_instance (&e.any_data, accessible);
- g_object_unref (accessible); /* value now owns it */
+ accessible = _atspi_dbus_return_accessible_from_iter (&iter_variant);
+ if (!strcmp (category, "ScreenReader"))
+ {
+ e.source = accessible;
+ if (e.source == NULL)
+ {
+ g_warning ("Got no valid source accessible for signal %s from interface %s\n", member, category);
+ g_free (converted_type);
+ g_free (name);
+ g_free (detail);
+ return DBUS_HANDLER_RESULT_HANDLED;
+ }
+ }
+ else
+ {
+ g_value_init (&e.any_data, ATSPI_TYPE_ACCESSIBLE);
+ g_value_set_instance (&e.any_data, accessible);
+ if (accessible)
+ g_object_unref (accessible); /* value now owns it */
+ }
}
break;
}
break;
}
+ dbus_message_iter_next (&iter);
+ if (dbus_message_iter_get_arg_type (&iter) == DBUS_TYPE_ARRAY)
+ {
+ /* new form -- parse properties sent with event */
+ cache = _atspi_dbus_update_cache_from_dict (e.source, &iter);
+ }
+
+ e.sender = _atspi_ref_accessible (sender, ATSPI_DBUS_PATH_ROOT);
+
if (!strncmp (e.type, "object:children-changed", 23))
{
cache_process_children_changed (&e);
{
cache_process_state_changed (&e);
}
+ else if (!strncmp (e.type, "focus", 5))
+ {
+ /* BGO#663992 - TODO: figure out the real problem */
+ e.source->cached_properties &= ~(ATSPI_CACHE_STATES);
+ }
_atspi_send_event (&e);
+ if (cache)
+ _atspi_accessible_unref_cache (e.source);
+
g_free (converted_type);
g_free (name);
g_free (detail);
projects / platform / upstream / at-spi2-core.git / blobdiff