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 "accessible-cache.h"
35 #include "introspection.h"
37 /* TODO - This should possibly be a common define */
38 #define SPI_OBJECT_PREFIX "/org/a11y/atspi"
39 #define SPI_CACHE_OBJECT_SUFFIX "/cache"
40 #define SPI_CACHE_OBJECT_PATH SPI_OBJECT_PREFIX SPI_CACHE_OBJECT_SUFFIX
42 #define SPI_OBJECT_REFERENCE_SIGNATURE "(" \
43 DBUS_TYPE_STRING_AS_STRING \
44 DBUS_TYPE_OBJECT_PATH_AS_STRING \
47 #define SPI_CACHE_ITEM_SIGNATURE "(" \
48 SPI_OBJECT_REFERENCE_SIGNATURE \
49 SPI_OBJECT_REFERENCE_SIGNATURE \
50 SPI_OBJECT_REFERENCE_SIGNATURE \
51 DBUS_TYPE_ARRAY_AS_STRING \
52 SPI_OBJECT_REFERENCE_SIGNATURE \
53 DBUS_TYPE_ARRAY_AS_STRING \
54 DBUS_TYPE_STRING_AS_STRING \
55 DBUS_TYPE_STRING_AS_STRING \
56 DBUS_TYPE_UINT32_AS_STRING \
57 DBUS_TYPE_STRING_AS_STRING \
58 DBUS_TYPE_ARRAY_AS_STRING \
59 DBUS_TYPE_UINT32_AS_STRING \
62 /*---------------------------------------------------------------------------*/
65 * Marshals the given AtkObject into the provided D-Bus iterator.
67 * The object is marshalled including all its client side cache data.
68 * The format of the structure is (o(so)a(so)assusau).
71 append_cache_item (AtkObject * obj, gpointer data)
73 DBusMessageIter iter_struct, iter_sub_array;
74 dbus_uint32_t states[2];
77 DBusMessageIter *iter_array = (DBusMessageIter *) data;
79 const char *name, *desc;
82 g_object_ref (G_OBJECT (obj));
84 set = atk_object_ref_state_set (obj);
86 AtkObject *application, *parent;
88 dbus_message_iter_open_container (iter_array, DBUS_TYPE_STRUCT, NULL,
91 /* Marshall object path */
92 spi_object_append_reference (&iter_struct, obj);
94 role = spi_accessible_role_from_atk_role (atk_object_get_role (obj));
96 /* Marshall application */
97 application = spi_global_app_data->root;
98 spi_object_append_reference (&iter_struct, application);
100 /* Marshall parent */
101 parent = atk_object_get_parent (obj);
104 /* TODO, move in to a 'Plug' wrapper. */
105 if (ATK_IS_PLUG (obj))
107 char *id = g_object_get_data (G_OBJECT (obj), "dbus-plug-parent");
113 bus_parent = g_strdup (id);
114 if (bus_parent && (path_parent = g_utf8_strchr (bus_parent + 1, -1, ':')))
116 DBusMessageIter iter_parent;
117 *(path_parent++) = '\0';
118 dbus_message_iter_open_container (&iter_struct, DBUS_TYPE_STRUCT, NULL,
120 dbus_message_iter_append_basic (&iter_parent, DBUS_TYPE_STRING, &bus_parent);
121 dbus_message_iter_append_basic (&iter_parent, DBUS_TYPE_OBJECT_PATH, &path_parent);
122 dbus_message_iter_close_container (&iter_struct, &iter_parent);
126 spi_object_append_null_reference (&iter_struct);
131 spi_object_append_null_reference (&iter_struct);
134 else if (role != Accessibility_ROLE_APPLICATION)
135 spi_object_append_null_reference (&iter_struct);
137 spi_object_append_desktop_reference (&iter_struct);
141 spi_object_append_reference (&iter_struct, parent);
144 /* Marshall children */
145 dbus_message_iter_open_container (&iter_struct, DBUS_TYPE_ARRAY, "(so)",
147 if (!atk_state_set_contains_state (set, ATK_STATE_MANAGES_DESCENDANTS))
151 childcount = atk_object_get_n_accessible_children (obj);
152 for (i = 0; i < childcount; i++)
157 child = atk_object_ref_accessible_child (obj, i);
158 spi_object_append_reference (&iter_sub_array, child);
159 g_object_unref (G_OBJECT (child));
162 if (ATK_IS_SOCKET (obj) && atk_socket_is_occupied (ATK_SOCKET (obj)))
164 AtkSocket *socket = ATK_SOCKET (obj);
165 gchar *child_name, *child_path;
166 child_name = g_strdup (socket->embedded_plug_id);
167 child_path = g_utf8_strchr (child_name + 1, -1, ':');
170 DBusMessageIter iter_socket;
171 *(child_path++) = '\0';
172 dbus_message_iter_open_container (&iter_sub_array, DBUS_TYPE_STRUCT, NULL,
174 dbus_message_iter_append_basic (&iter_socket, DBUS_TYPE_STRING, &child_name);
175 dbus_message_iter_append_basic (&iter_socket, DBUS_TYPE_OBJECT_PATH, &child_path);
176 dbus_message_iter_close_container (&iter_sub_array, &iter_socket);
181 dbus_message_iter_close_container (&iter_struct, &iter_sub_array);
183 /* Marshall interfaces */
184 dbus_message_iter_open_container (&iter_struct, DBUS_TYPE_ARRAY, "s",
186 spi_object_append_interfaces (&iter_sub_array, obj);
187 dbus_message_iter_close_container (&iter_struct, &iter_sub_array);
190 name = atk_object_get_name (obj);
193 dbus_message_iter_append_basic (&iter_struct, DBUS_TYPE_STRING, &name);
196 dbus_message_iter_append_basic (&iter_struct, DBUS_TYPE_UINT32, &role);
198 /* Marshall description */
199 desc = atk_object_get_description (obj);
202 dbus_message_iter_append_basic (&iter_struct, DBUS_TYPE_STRING, &desc);
204 /* Marshall state set */
205 spi_atk_state_set_to_dbus_array (set, states);
206 dbus_message_iter_open_container (&iter_struct, DBUS_TYPE_ARRAY, "u",
208 for (count = 0; count < 2; count++)
210 dbus_message_iter_append_basic (&iter_sub_array, DBUS_TYPE_UINT32,
213 dbus_message_iter_close_container (&iter_struct, &iter_sub_array);
215 dbus_message_iter_close_container (iter_array, &iter_struct);
216 g_object_unref (set);
217 g_object_unref (obj);
220 /*---------------------------------------------------------------------------*/
222 /* For use as a GHFunc */
224 append_accessible_hf (gpointer key, gpointer obj_data, gpointer data)
226 /* Make sure it isn't a hyperlink */
227 if (ATK_IS_OBJECT (key))
228 append_cache_item (ATK_OBJECT (key), data);
231 /*---------------------------------------------------------------------------*/
234 emit_cache_remove (SpiCache *cache, GObject * obj)
236 DBusMessage *message;
238 if ((message = dbus_message_new_signal (SPI_CACHE_OBJECT_PATH,
239 SPI_DBUS_INTERFACE_CACHE,
240 "RemoveAccessible")))
242 DBusMessageIter iter;
245 dbus_message_iter_init_append (message, &iter);
247 spi_object_append_reference (&iter, ATK_OBJECT (obj));
249 dbus_connection_send (spi_global_app_data->bus, message, NULL);
251 dbus_message_unref (message);
256 emit_cache_add (SpiCache *cache, GObject * obj)
258 AtkObject *accessible = ATK_OBJECT (obj);
259 DBusMessage *message;
261 if ((message = dbus_message_new_signal (SPI_CACHE_OBJECT_PATH,
262 SPI_DBUS_INTERFACE_CACHE,
265 DBusMessageIter iter;
267 dbus_message_iter_init_append (message, &iter);
268 append_cache_item (accessible, &iter);
270 dbus_connection_send (spi_global_app_data->bus, message, NULL);
272 dbus_message_unref (message);
277 /*---------------------------------------------------------------------------*/
280 impl_GetRoot (DBusConnection * bus, DBusMessage * message, void *user_data)
282 return spi_object_return_reference (message, spi_global_app_data->root);
285 /*---------------------------------------------------------------------------*/
288 impl_GetItems (DBusConnection * bus, DBusMessage * message, void *user_data)
291 DBusMessageIter iter, iter_array;
293 reply = dbus_message_new_method_return (message);
295 dbus_message_iter_init_append (reply, &iter);
296 dbus_message_iter_open_container (&iter, DBUS_TYPE_ARRAY,
297 SPI_CACHE_ITEM_SIGNATURE, &iter_array);
298 spi_cache_foreach (spi_global_cache, append_accessible_hf, &iter_array);
299 dbus_message_iter_close_container (&iter, &iter_array);
303 /*---------------------------------------------------------------------------*/
305 static DRouteMethod methods[] = {
306 {impl_GetRoot, "GetRoot"},
307 {impl_GetItems, "GetItems"},
312 spi_initialize_cache (DRoutePath * path)
314 droute_path_add_interface (path, SPI_DBUS_INTERFACE_CACHE, spi_org_a11y_atspi_Cache, methods, NULL);
316 g_signal_connect (spi_global_cache,
318 (GCallback) emit_cache_add,
321 g_signal_connect (spi_global_cache,
323 (GCallback) emit_cache_remove,
327 /*END------------------------------------------------------------------------*/