2 * AT-SPI - Assistive Technology Service Provider Interface
3 * (Gnome Accessibility Project; http://developer.gnome.org/projects/gap)
5 * Copyright 2008 Novell, Inc.
6 * Copyright 2001, 2002 Sun Microsystems Inc.,
7 * Copyright 2001, 2002 Ximian, Inc.
8 * Copyright 2008, 2009 Codethink Ltd.
10 * This library is free software; you can redistribute it and/or
11 * modify it under the terms of the GNU Library General Public
12 * License as published by the Free Software Foundation; either
13 * version 2 of the License, or (at your option) any later version.
15 * This library is distributed in the hope that it will be useful,
16 * but WITHOUT ANY WARRANTY; without even the implied warranty of
17 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
18 * Library General Public License for more details.
20 * You should have received a copy of the GNU Library General Public
21 * License along with this library; if not, write to the
22 * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
23 * Boston, MA 02111-1307, USA.
29 #include <droute/droute.h>
31 #include "common/spi-dbus.h"
32 #include "common/spi-stateset.h"
33 #include "accessible-cache.h"
36 #include "introspection.h"
38 /* TODO - This should possibly be a common define */
39 #define SPI_OBJECT_PREFIX "/org/a11y/atspi"
40 #define SPI_CACHE_OBJECT_SUFFIX "/cache"
41 #define SPI_CACHE_OBJECT_PATH SPI_OBJECT_PREFIX SPI_CACHE_OBJECT_SUFFIX
43 #define SPI_OBJECT_REFERENCE_SIGNATURE "(" \
44 DBUS_TYPE_STRING_AS_STRING \
45 DBUS_TYPE_OBJECT_PATH_AS_STRING \
48 #define SPI_CACHE_ITEM_SIGNATURE "(" \
49 SPI_OBJECT_REFERENCE_SIGNATURE \
50 SPI_OBJECT_REFERENCE_SIGNATURE \
51 SPI_OBJECT_REFERENCE_SIGNATURE \
52 DBUS_TYPE_ARRAY_AS_STRING \
53 SPI_OBJECT_REFERENCE_SIGNATURE \
54 DBUS_TYPE_ARRAY_AS_STRING \
55 DBUS_TYPE_STRING_AS_STRING \
56 DBUS_TYPE_STRING_AS_STRING \
57 DBUS_TYPE_UINT32_AS_STRING \
58 DBUS_TYPE_STRING_AS_STRING \
59 DBUS_TYPE_ARRAY_AS_STRING \
60 DBUS_TYPE_UINT32_AS_STRING \
63 /*---------------------------------------------------------------------------*/
66 * Marshals the given AtkObject into the provided D-Bus iterator.
68 * The object is marshalled including all its client side cache data.
69 * The format of the structure is (o(so)a(so)assusau).
72 append_cache_item (AtkObject * obj, gpointer data)
74 DBusMessageIter iter_struct, iter_sub_array;
75 dbus_uint32_t states[2];
78 DBusMessageIter *iter_array = (DBusMessageIter *) data;
80 const char *name, *desc;
83 g_object_ref (G_OBJECT (obj));
85 set = atk_object_ref_state_set (obj);
87 AtkObject *application, *parent;
89 dbus_message_iter_open_container (iter_array, DBUS_TYPE_STRUCT, NULL,
92 /* Marshall object path */
93 spi_object_append_reference (&iter_struct, obj);
95 role = spi_accessible_role_from_atk_role (atk_object_get_role (obj));
97 /* Marshall application */
98 application = spi_global_app_data->root;
99 spi_object_append_reference (&iter_struct, application);
101 /* Marshall parent */
102 parent = atk_object_get_parent (obj);
105 /* TODO, move in to a 'Plug' wrapper. */
106 if (ATK_IS_PLUG (obj))
108 char *id = g_object_get_data (G_OBJECT (obj), "dbus-plug-parent");
114 bus_parent = g_strdup (id);
115 if (bus_parent && (path_parent = g_utf8_strchr (bus_parent + 1, -1, ':')))
117 DBusMessageIter iter_parent;
118 *(path_parent++) = '\0';
119 dbus_message_iter_open_container (&iter_struct, DBUS_TYPE_STRUCT, NULL,
121 dbus_message_iter_append_basic (&iter_parent, DBUS_TYPE_STRING, &bus_parent);
122 dbus_message_iter_append_basic (&iter_parent, DBUS_TYPE_OBJECT_PATH, &path_parent);
123 dbus_message_iter_close_container (&iter_struct, &iter_parent);
127 spi_object_append_null_reference (&iter_struct);
132 spi_object_append_null_reference (&iter_struct);
135 else if (role != Accessibility_ROLE_APPLICATION)
136 spi_object_append_null_reference (&iter_struct);
138 spi_object_append_desktop_reference (&iter_struct);
142 spi_object_append_reference (&iter_struct, parent);
145 /* Marshall children */
146 dbus_message_iter_open_container (&iter_struct, DBUS_TYPE_ARRAY, "(so)",
148 if (!atk_state_set_contains_state (set, ATK_STATE_MANAGES_DESCENDANTS))
152 childcount = atk_object_get_n_accessible_children (obj);
153 for (i = 0; i < childcount; i++)
158 child = atk_object_ref_accessible_child (obj, i);
159 spi_object_append_reference (&iter_sub_array, child);
160 g_object_unref (G_OBJECT (child));
163 if (ATK_IS_SOCKET (obj) && atk_socket_is_occupied (ATK_SOCKET (obj)))
165 AtkSocket *socket = ATK_SOCKET (obj);
166 gchar *child_name, *child_path;
167 child_name = g_strdup (socket->embedded_plug_id);
168 child_path = g_utf8_strchr (child_name + 1, -1, ':');
171 DBusMessageIter iter_socket;
172 *(child_path++) = '\0';
173 dbus_message_iter_open_container (&iter_sub_array, DBUS_TYPE_STRUCT, NULL,
175 dbus_message_iter_append_basic (&iter_socket, DBUS_TYPE_STRING, &child_name);
176 dbus_message_iter_append_basic (&iter_socket, DBUS_TYPE_OBJECT_PATH, &child_path);
177 dbus_message_iter_close_container (&iter_sub_array, &iter_socket);
182 dbus_message_iter_close_container (&iter_struct, &iter_sub_array);
184 /* Marshall interfaces */
185 dbus_message_iter_open_container (&iter_struct, DBUS_TYPE_ARRAY, "s",
187 spi_object_append_interfaces (&iter_sub_array, obj);
188 dbus_message_iter_close_container (&iter_struct, &iter_sub_array);
191 name = atk_object_get_name (obj);
194 dbus_message_iter_append_basic (&iter_struct, DBUS_TYPE_STRING, &name);
197 dbus_message_iter_append_basic (&iter_struct, DBUS_TYPE_UINT32, &role);
199 /* Marshall description */
200 desc = atk_object_get_description (obj);
203 dbus_message_iter_append_basic (&iter_struct, DBUS_TYPE_STRING, &desc);
205 /* Marshall state set */
206 spi_atk_state_set_to_dbus_array (set, states);
207 dbus_message_iter_open_container (&iter_struct, DBUS_TYPE_ARRAY, "u",
209 for (count = 0; count < 2; count++)
211 dbus_message_iter_append_basic (&iter_sub_array, DBUS_TYPE_UINT32,
214 dbus_message_iter_close_container (&iter_struct, &iter_sub_array);
216 dbus_message_iter_close_container (iter_array, &iter_struct);
217 g_object_unref (set);
218 g_object_unref (obj);
221 /*---------------------------------------------------------------------------*/
223 /* For use as a GHFunc */
225 append_accessible_hf (gpointer key, gpointer obj_data, gpointer data)
227 /* Make sure it isn't a hyperlink */
228 if (ATK_IS_OBJECT (key))
229 append_cache_item (ATK_OBJECT (key), data);
232 /*---------------------------------------------------------------------------*/
235 emit_cache_remove (SpiCache *cache, GObject * obj)
237 DBusMessage *message;
239 if ((message = dbus_message_new_signal (SPI_CACHE_OBJECT_PATH,
240 SPI_DBUS_INTERFACE_CACHE,
241 "RemoveAccessible")))
243 DBusMessageIter iter;
246 dbus_message_iter_init_append (message, &iter);
248 spi_object_append_reference (&iter, ATK_OBJECT (obj));
250 dbus_connection_send (spi_global_app_data->bus, message, NULL);
252 dbus_message_unref (message);
257 emit_cache_add (SpiCache *cache, GObject * obj)
259 AtkObject *accessible = ATK_OBJECT (obj);
260 DBusMessage *message;
262 if ((message = dbus_message_new_signal (SPI_CACHE_OBJECT_PATH,
263 SPI_DBUS_INTERFACE_CACHE,
266 DBusMessageIter iter;
268 dbus_message_iter_init_append (message, &iter);
269 append_cache_item (accessible, &iter);
271 dbus_connection_send (spi_global_app_data->bus, message, NULL);
273 dbus_message_unref (message);
278 /*---------------------------------------------------------------------------*/
281 impl_GetRoot (DBusConnection * bus, DBusMessage * message, void *user_data)
283 return spi_object_return_reference (message, spi_global_app_data->root);
286 /*---------------------------------------------------------------------------*/
289 impl_GetItems (DBusConnection * bus, DBusMessage * message, void *user_data)
292 DBusMessageIter iter, iter_array;
294 reply = dbus_message_new_method_return (message);
296 dbus_message_iter_init_append (reply, &iter);
297 dbus_message_iter_open_container (&iter, DBUS_TYPE_ARRAY,
298 SPI_CACHE_ITEM_SIGNATURE, &iter_array);
299 spi_cache_foreach (spi_global_cache, append_accessible_hf, &iter_array);
300 dbus_message_iter_close_container (&iter, &iter_array);
304 /*---------------------------------------------------------------------------*/
306 static DRouteMethod methods[] = {
307 {impl_GetRoot, "GetRoot"},
308 {impl_GetItems, "GetItems"},
313 spi_initialize_cache (DRoutePath * path)
315 droute_path_add_interface (path, SPI_DBUS_INTERFACE_CACHE, spi_org_a11y_atspi_Cache, methods, NULL);
317 g_signal_connect (spi_global_cache,
319 (GCallback) emit_cache_add,
322 g_signal_connect (spi_global_cache,
324 (GCallback) emit_cache_remove,
328 /*END------------------------------------------------------------------------*/