2 * AT-SPI - Assistive Technology Service Provider Interface
3 * (Gnome Accessibility Project; http://developer.gnome.org/projects/gap)
5 * Copyright 2008 Novell, Inc.
7 * This library is free software; you can redistribute it and/or
8 * modify it under the terms of the GNU Library General Public
9 * License as published by the Free Software Foundation; either
10 * version 2 of the License, or (at your option) any later version.
12 * This library is distributed in the hope that it will be useful,
13 * but WITHOUT ANY WARRANTY; without even the implied warranty of
14 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
15 * Library General Public License for more details.
17 * You should have received a copy of the GNU Library General Public
18 * License along with this library; if not, write to the
19 * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
20 * Boston, MA 02111-1307, USA.
27 #include <glib-object.h>
28 #include <dbus/dbus.h>
30 #include <atspi/atspi.h>
33 spi_dbus_general_error (DBusMessage * message)
35 return dbus_message_new_error (message,
36 "org.a11y.atspi.GeneralError",
41 spi_dbus_return_rect (DBusMessage * message, gint ix, gint iy, gint iwidth,
45 dbus_uint32_t x, y, width, height;
51 reply = dbus_message_new_method_return (message);
54 DBusMessageIter iter, sub;
55 dbus_message_iter_init_append (reply, &iter);
56 if (!dbus_message_iter_open_container
57 (&iter, DBUS_TYPE_STRUCT, NULL, &sub))
59 dbus_message_iter_append_basic (&sub, DBUS_TYPE_INT32, &x);
60 dbus_message_iter_append_basic (&sub, DBUS_TYPE_INT32, &y);
61 dbus_message_iter_append_basic (&sub, DBUS_TYPE_INT32, &width);
62 dbus_message_iter_append_basic (&sub, DBUS_TYPE_INT32, &height);
63 if (!dbus_message_iter_close_container (&iter, &sub))
68 /* todo: return an error */
72 void spi_dbus_emit_valist(DBusConnection *bus, const char *path, const char *interface, const char *name, int first_arg_type, va_list args)
76 sig = dbus_message_new_signal(path, interface, name);
77 if (first_arg_type != DBUS_TYPE_INVALID)
79 dbus_message_append_args_valist(sig, first_arg_type, args);
81 dbus_connection_send(bus, sig, NULL);
82 dbus_message_unref(sig);
85 dbus_bool_t spi_dbus_message_iter_get_struct(DBusMessageIter *iter, ...)
88 DBusMessageIter iter_struct;
92 dbus_message_iter_recurse(iter, &iter_struct);
96 type = va_arg(args, int);
97 if (type == DBUS_TYPE_INVALID) break;
98 if (type != dbus_message_iter_get_arg_type(&iter_struct))
103 ptr = va_arg(args, void *);
104 dbus_message_iter_get_basic(&iter_struct, ptr);
105 dbus_message_iter_next(&iter_struct);
107 dbus_message_iter_next(iter);
112 dbus_bool_t spi_dbus_message_iter_append_struct(DBusMessageIter *iter, ...)
115 DBusMessageIter iter_struct;
119 if (!dbus_message_iter_open_container(iter, DBUS_TYPE_STRUCT, NULL, &iter_struct)) return FALSE;
120 va_start(args, iter);
123 type = va_arg(args, int);
124 if (type == DBUS_TYPE_INVALID) break;
125 ptr = va_arg(args, void *);
126 dbus_message_iter_append_basic(&iter_struct, type, ptr);
129 if (!dbus_message_iter_close_container(iter, &iter_struct)) return FALSE;
133 dbus_bool_t spi_dbus_marshal_deviceEvent(DBusMessage *message, const AtspiDeviceEvent *e)
135 DBusMessageIter iter;
137 if (!message) return FALSE;
138 dbus_message_iter_init_append(message, &iter);
139 return spi_dbus_message_iter_append_struct(&iter, DBUS_TYPE_UINT32, &e->type, DBUS_TYPE_INT32, &e->id, DBUS_TYPE_INT16, &e->hw_code, DBUS_TYPE_INT16, &e->modifiers, DBUS_TYPE_INT32, &e->timestamp, DBUS_TYPE_STRING, &e->event_string, DBUS_TYPE_BOOLEAN, &e->is_text, DBUS_TYPE_INVALID);
142 dbus_bool_t spi_dbus_demarshal_deviceEvent(DBusMessage *message, AtspiDeviceEvent *e)
144 DBusMessageIter iter;
146 dbus_message_iter_init(message, &iter);
147 return spi_dbus_message_iter_get_struct(&iter, DBUS_TYPE_UINT32, &e->type, DBUS_TYPE_INT32, &e->id, DBUS_TYPE_INT16, &e->hw_code, DBUS_TYPE_INT16, &e->modifiers, DBUS_TYPE_INT32, &e->timestamp, DBUS_TYPE_STRING, &e->event_string, DBUS_TYPE_BOOLEAN, &e->is_text, DBUS_TYPE_INVALID);
151 * This is a rather annoying function needed to replace
152 * NULL values of strings with the empty string. Null string
153 * values can be created by the atk_object_get_name or text selection
156 provide_defaults(const gint type,
161 case DBUS_TYPE_STRING:
162 case DBUS_TYPE_OBJECT_PATH:
173 * Appends all the standard parameters to an AT-SPI event.
176 spi_dbus_signal_new (const char *path,
180 dbus_int32_t detail1,
181 dbus_int32_t detail2)
184 DBusMessageIter iter, sub;
187 if (!klass) klass = "";
188 if (!major) major = "";
189 if (!minor) minor = "";
192 * This is very annoying, but as '-' isn't a legal signal
193 * name in D-Bus (Why not??!?) The names need converting
194 * on this side, and again on the client side.
196 cname = g_strdup(major);
197 while ((t = strchr(cname, '-')) != NULL) *t = '_';
199 sig = dbus_message_new_signal(path, klass, cname);
202 dbus_message_iter_init_append(sig, &iter);
204 dbus_message_iter_append_basic(&iter, DBUS_TYPE_STRING, &minor);
205 dbus_message_iter_append_basic(&iter, DBUS_TYPE_INT32, &detail1);
206 dbus_message_iter_append_basic(&iter, DBUS_TYPE_INT32, &detail2);
210 spi_dbus_emit_signal(DBusConnection *bus, const char *path,
214 dbus_int32_t detail1,
215 dbus_int32_t detail2,
221 DBusMessageIter iter, sub;
222 if (!klass) klass = "";
223 if (!major) major = "";
224 if (!minor) minor = "";
225 if (!type) type = "u";
228 * This is very annoying, but as '-' isn't a legal signal
229 * name in D-Bus (Why not??!?) The names need converting
230 * on this side, and again on the client side.
232 cname = g_strdup(major);
233 while ((t = strchr(cname, '-')) != NULL) *t = '_';
235 sig = dbus_message_new_signal(path, klass, cname);
238 dbus_message_iter_init_append(sig, &iter);
240 dbus_message_iter_append_basic(&iter, DBUS_TYPE_STRING, &minor);
241 dbus_message_iter_append_basic(&iter, DBUS_TYPE_INT32, &detail1);
242 dbus_message_iter_append_basic(&iter, DBUS_TYPE_INT32, &detail2);
244 dbus_message_iter_open_container(&iter, DBUS_TYPE_VARIANT, type, &sub);
246 * I need to convert the string signature to an integer type signature.
247 * DBUS_TYPE_INT32 is defined as 'i' whereas the string is "i".
248 * I should just be able to cast the first character of the string to an
251 val = provide_defaults((int) *type, val);
252 dbus_message_iter_append_basic(&sub, (int) *type, &val);
253 dbus_message_iter_close_container(&iter, &sub);
255 dbus_connection_send(bus, sig, NULL);
256 dbus_message_unref(sig);
261 dbus_bool_t spi_dbus_get_simple_property (DBusConnection *bus, const char *dest, const char *path, const char *interface, const char *prop, int *type, void *ptr, DBusError *error)
263 DBusMessage *message, *reply;
264 DBusMessageIter iter, iter_variant;
267 dbus_error_init (error);
268 message = dbus_message_new_method_call (dest, path, "org.freedesktop.DBus.Properties", "get");
269 if (!message) return FALSE;
270 if (!dbus_message_append_args (message, DBUS_TYPE_STRING, &interface, DBUS_TYPE_STRING, &prop, DBUS_TYPE_INVALID))
274 reply = dbus_connection_send_with_reply_and_block (bus, message, 1000, error);
275 dbus_message_unref (message);
276 if (!reply) return FALSE;
277 dbus_message_iter_init (reply, &iter);
278 dbus_message_iter_recurse (&iter, &iter_variant);
279 typ = dbus_message_iter_get_arg_type (&iter_variant);
280 if (type) *type = typ;
281 if (typ == DBUS_TYPE_INVALID || typ == DBUS_TYPE_STRUCT || typ == DBUS_TYPE_ARRAY)
285 dbus_message_iter_get_basic (&iter_variant, ptr);
286 dbus_message_unref (reply);