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"
36 /* TODO - This should possibly be a common define */
37 #define SPI_OBJECT_PREFIX "/org/at_spi"
38 #define SPI_CACHE_OBJECT_SUFFIX "/cache"
39 #define SPI_CACHE_OBJECT_PATH SPI_OBJECT_PREFIX SPI_CACHE_OBJECT_SUFFIX
41 #define SPI_OBJECT_REFERENCE_SIGNATURE "(" \
42 DBUS_TYPE_STRING_AS_STRING \
43 DBUS_TYPE_OBJECT_PATH_AS_STRING \
46 #define SPI_CACHE_ITEM_SIGNATURE "(" \
47 DBUS_TYPE_OBJECT_PATH_AS_STRING \
48 SPI_OBJECT_REFERENCE_SIGNATURE \
49 SPI_OBJECT_REFERENCE_SIGNATURE \
50 DBUS_TYPE_ARRAY_AS_STRING \
51 SPI_OBJECT_REFERENCE_SIGNATURE \
52 DBUS_TYPE_ARRAY_AS_STRING \
53 DBUS_TYPE_STRING_AS_STRING \
54 DBUS_TYPE_STRING_AS_STRING \
55 DBUS_TYPE_UINT32_AS_STRING \
56 DBUS_TYPE_STRING_AS_STRING \
57 DBUS_TYPE_ARRAY_AS_STRING \
58 DBUS_TYPE_UINT32_AS_STRING \
61 /*---------------------------------------------------------------------------*/
64 * Marshals the given AtkObject into the provided D-Bus iterator.
66 * The object is marshalled including all its client side cache data.
67 * The format of the structure is (o(so)a(so)assusau).
70 append_cache_item (AtkObject * obj, gpointer data)
72 DBusMessageIter iter_struct, iter_sub_array;
73 dbus_uint32_t states[2];
76 DBusMessageIter *iter_array = (DBusMessageIter *) data;
78 const char *name, *desc;
81 set = atk_object_ref_state_set (obj);
83 AtkObject *application, *parent;
85 dbus_message_iter_open_container (iter_array, DBUS_TYPE_STRUCT, NULL,
88 /* Marshall object path */
89 spi_object_append_reference (&iter_struct, obj);
91 role = spi_accessible_role_from_atk_role (atk_object_get_role (obj));
93 /* Marshall application */
94 application = spi_global_app_data->root;
95 spi_object_append_reference (&iter_struct, application);
98 parent = atk_object_get_parent (obj);
101 /* TODO: Support getting parent of an AtkPlug */
102 #ifdef __ATK_PLUG_H__
103 if (role != Accessibility_ROLE_APPLICATION && !ATK_IS_PLUG (obj))
105 if (role != Accessibility_ROLE_APPLICATION)
107 spi_object_append_null_reference (&iter_struct);
109 spi_object_append_desktop_reference (&iter_struct);
113 spi_object_append_reference (&iter_struct, parent);
116 /* Marshall children */
117 dbus_message_iter_open_container (&iter_struct, DBUS_TYPE_ARRAY, "(so)",
119 if (!atk_state_set_contains_state (set, ATK_STATE_MANAGES_DESCENDANTS))
123 childcount = atk_object_get_n_accessible_children (obj);
124 for (i = 0; i < childcount; i++)
129 child = atk_object_ref_accessible_child (obj, i);
130 spi_object_append_reference (&iter_sub_array, child);
131 g_object_unref (G_OBJECT (child));
134 #ifdef __ATK_PLUG_H__
135 if (ATK_IS_SOCKET (obj) && atk_socket_is_occupied (ATK_SOCKET (obj)))
137 AtkSocket *socket = ATK_SOCKET (obj);
138 gchar *child_name, *child_path;
139 child_name = g_strdup (socket->embedded_plug_id);
140 child_path = g_utf8_strchr (child_name + 1, -1, ':');
143 DBusMessageIter iter_socket;
144 *(child_path++) = '\0';
145 dbus_message_iter_open_container (&iter_sub_array, DBUS_TYPE_STRUCT, NULL,
147 dbus_message_iter_append_basic (&iter_socket, DBUS_TYPE_STRING, &name);
148 dbus_message_iter_append_basic (&iter_socket, DBUS_TYPE_OBJECT_PATH, &path);
149 dbus_message_iter_close_container (&iter_sub_array, &iter_socket);
155 dbus_message_iter_close_container (&iter_struct, &iter_sub_array);
157 /* Marshall interfaces */
158 dbus_message_iter_open_container (&iter_struct, DBUS_TYPE_ARRAY, "s",
160 spi_object_append_interfaces (&iter_sub_array, obj);
161 dbus_message_iter_close_container (&iter_struct, &iter_sub_array);
164 name = atk_object_get_name (obj);
167 dbus_message_iter_append_basic (&iter_struct, DBUS_TYPE_STRING, &name);
170 dbus_message_iter_append_basic (&iter_struct, DBUS_TYPE_UINT32, &role);
172 /* Marshall description */
173 desc = atk_object_get_description (obj);
176 dbus_message_iter_append_basic (&iter_struct, DBUS_TYPE_STRING, &desc);
178 /* Marshall state set */
179 spi_atk_state_set_to_dbus_array (set, states);
180 dbus_message_iter_open_container (&iter_struct, DBUS_TYPE_ARRAY, "u",
182 for (count = 0; count < 2; count++)
184 dbus_message_iter_append_basic (&iter_sub_array, DBUS_TYPE_UINT32,
187 dbus_message_iter_close_container (&iter_struct, &iter_sub_array);
189 dbus_message_iter_close_container (iter_array, &iter_struct);
190 g_object_unref (set);
193 /*---------------------------------------------------------------------------*/
195 /* For use as a GHFunc */
197 append_accessible_hf (gpointer key, gpointer obj_data, gpointer data)
199 /* Make sure it isn't a hyperlink */
200 if (ATK_IS_OBJECT (obj_data))
201 append_cache_item (ATK_OBJECT (obj_data), data);
204 /*---------------------------------------------------------------------------*/
207 emit_cache_remove (SpiCache *cache, GObject * obj)
209 DBusMessage *message;
211 if ((message = dbus_message_new_signal (SPI_CACHE_OBJECT_PATH,
212 SPI_DBUS_INTERFACE_CACHE,
213 "RemoveAccessible")))
215 DBusMessageIter iter;
218 dbus_message_iter_init_append (message, &iter);
220 spi_object_append_reference (&iter, ATK_OBJECT (obj));
222 dbus_connection_send (spi_global_app_data->bus, message, NULL);
224 dbus_message_unref (message);
229 emit_cache_add (SpiCache *cache, GObject * obj)
231 AtkObject *accessible = ATK_OBJECT (obj);
232 DBusMessage *message;
234 if ((message = dbus_message_new_signal (SPI_CACHE_OBJECT_PATH,
235 SPI_DBUS_INTERFACE_CACHE,
238 DBusMessageIter iter;
240 dbus_message_iter_init_append (message, &iter);
241 append_cache_item (accessible, &iter);
243 dbus_connection_send (spi_global_app_data->bus, message, NULL);
245 dbus_message_unref (message);
250 /*---------------------------------------------------------------------------*/
253 impl_GetRoot (DBusConnection * bus, DBusMessage * message, void *user_data)
255 return spi_object_return_reference (message,
256 g_object_ref (G_OBJECT (spi_global_app_data->root)));
259 /*---------------------------------------------------------------------------*/
262 impl_GetItems (DBusConnection * bus, DBusMessage * message, void *user_data)
265 DBusMessageIter iter, iter_array;
267 reply = dbus_message_new_method_return (message);
269 dbus_message_iter_init_append (reply, &iter);
270 dbus_message_iter_open_container (&iter, DBUS_TYPE_ARRAY,
271 SPI_CACHE_ITEM_SIGNATURE, &iter_array);
272 spi_cache_foreach (spi_global_cache, append_accessible_hf, &iter_array);
273 dbus_message_iter_close_container (&iter, &iter_array);
277 /*---------------------------------------------------------------------------*/
279 static DRouteMethod methods[] = {
280 {impl_GetRoot, "GetRoot"},
281 {impl_GetItems, "GetItems"},
286 spi_initialize_cache (DRoutePath * path)
288 droute_path_add_interface (path, SPI_DBUS_INTERFACE_CACHE, methods, NULL);
290 g_signal_connect (spi_global_cache,
292 (GCallback) emit_cache_add,
295 g_signal_connect (spi_global_cache,
297 (GCallback) emit_cache_remove,
301 /*END------------------------------------------------------------------------*/