diff options
author | Marcel Holtmann <marcel@holtmann.org> | 2008-05-08 22:19:14 +0000 |
---|---|---|
committer | Marcel Holtmann <marcel@holtmann.org> | 2008-05-08 22:19:14 +0000 |
commit | 15ea15b3a752f0487bc50d0ea04925f1b9d33dcb (patch) | |
tree | 1ec75fe77a089c0678bdbc24d7ad2bd85a6fa1c9 /common | |
parent | e7d668ac9e813bc9922ee7d771848bd8822d5d1f (diff) |
Move D-Bus object and interface helpers into libgdbus
Diffstat (limited to 'common')
-rw-r--r-- | common/Makefile.am | 3 | ||||
-rw-r--r-- | common/dbus-helper.c | 659 | ||||
-rw-r--r-- | common/dbus-helper.h | 107 | ||||
-rw-r--r-- | common/error.c | 3 |
4 files changed, 3 insertions, 769 deletions
diff --git a/common/Makefile.am b/common/Makefile.am index 5352d34f..6ae5ed7a 100644 --- a/common/Makefile.am +++ b/common/Makefile.am @@ -3,14 +3,13 @@ noinst_LIBRARIES = libhelper.a libhelper_a_SOURCES = oui.h oui.c textfile.h textfile.c \ logging.h logging.c error.h error.c \ - dbus-helper.h dbus-helper.c \ glib-helper.h glib-helper.c sdp-xml.h sdp-xml.c sdp-glib.c noinst_PROGRAMS = test_textfile test_textfile_LDADD = libhelper.a -AM_CFLAGS = @DBUS_CFLAGS@ @GLIB_CFLAGS@ +AM_CFLAGS = @DBUS_CFLAGS@ @GLIB_CFLAGS@ @GDBUS_CFLAGS@ EXTRA_DIST = ppoll.h uinput.h diff --git a/common/dbus-helper.c b/common/dbus-helper.c deleted file mode 100644 index a7604f65..00000000 --- a/common/dbus-helper.c +++ /dev/null @@ -1,659 +0,0 @@ -/* - * - * BlueZ - Bluetooth protocol stack for Linux - * - * Copyright (C) 2004-2008 Marcel Holtmann <marcel@holtmann.org> - * - * - * This program is free software; you can redistribute it and/or modify - * it under the terms of the GNU General Public License as published by - * the Free Software Foundation; either version 2 of the License, or - * (at your option) any later version. - * - * This program 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 General Public License for more details. - * - * You should have received a copy of the GNU General Public License - * along with this program; if not, write to the Free Software - * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA - * - */ - -#ifdef HAVE_CONFIG_H -#include <config.h> -#endif - -#include <stdlib.h> -#include <string.h> - -#include <glib.h> - -#include <dbus/dbus.h> - -#include "logging.h" - -#include "dbus-helper.h" - -struct generic_data { - void *user_data; - DBusObjectPathUnregisterFunction unregister_function; - GSList *interfaces; - char *introspect; -}; - -struct interface_data { - char *name; - DBusMethodVTable *methods; - DBusSignalVTable *signals; - DBusPropertyVTable *properties; -}; - -DBusHandlerResult dbus_connection_send_and_unref(DBusConnection *connection, - DBusMessage *message) -{ - if (message) { - dbus_connection_send(connection, message, NULL); - dbus_message_unref(message); - } - - return DBUS_HANDLER_RESULT_HANDLED; -} - -static void print_arguments(GString *gstr, const char *sig, const char *direction) -{ - int i; - - for (i = 0; sig[i]; i++) { - char type[32]; - int len, struct_level, dict_level; - gboolean complete; - - complete = FALSE; - struct_level = dict_level = 0; - memset(type, 0, sizeof(type)); - - /* Gather enough data to have a single complete type */ - for (len = 0; len < (sizeof(type) - 1) && sig[i]; len++, i++) { - switch (sig[i]){ - case '(': - struct_level++; - break; - case ')': - struct_level--; - if (struct_level <= 0 && dict_level <= 0) - complete = TRUE; - break; - case '{': - dict_level++; - break; - case '}': - dict_level--; - if (struct_level <= 0 && dict_level <= 0) - complete = TRUE; - break; - case 'a': - break; - default: - if (struct_level <= 0 && dict_level <= 0) - complete = TRUE; - break; - } - - type[len] = sig[i]; - - if (complete) - break; - } - - - if (direction) - g_string_append_printf(gstr, - "\t\t\t<arg type=\"%s\" direction=\"%s\"/>\n", - type, direction); - else - g_string_append_printf(gstr, - "\t\t\t<arg type=\"%s\"/>\n", - type); - } -} - -static void generate_introspection_xml(DBusConnection *conn, - struct generic_data *data, - const char *path) -{ - GSList *list; - GString *gstr; - char **children; - int i; - - g_free(data->introspect); - - gstr = g_string_new(DBUS_INTROSPECT_1_0_XML_DOCTYPE_DECL_NODE); - - g_string_append_printf(gstr, "<node name=\"%s\">\n", path); - - for (list = data->interfaces; list; list = list->next) { - struct interface_data *iface = list->data; - DBusMethodVTable *method; - DBusSignalVTable *signal; - DBusPropertyVTable *property; - - g_string_append_printf(gstr, "\t<interface name=\"%s\">\n", iface->name); - - for (method = iface->methods; method && method->name; method++) { - /* debug("%s: adding method %s.%s", - path, iface->name, method->name); */ - if (!strlen(method->signature) && !strlen(method->reply)) - g_string_append_printf(gstr, "\t\t<method name=\"%s\"/>\n", - method->name); - else { - g_string_append_printf(gstr, "\t\t<method name=\"%s\">\n", - method->name); - print_arguments(gstr, method->signature, "in"); - print_arguments(gstr, method->reply, "out"); - g_string_append_printf(gstr, "\t\t</method>\n"); - } - } - - for (signal = iface->signals; signal && signal->name; signal++) { - /* debug("%s: adding signal %s.%s", - path, iface->name, signal->name); */ - if (!strlen(signal->signature)) - g_string_append_printf(gstr, "\t\t<signal name=\"%s\"/>\n", - signal->name); - else { - g_string_append_printf(gstr, "\t\t<signal name=\"%s\">\n", - signal->name); - print_arguments(gstr, signal->signature, NULL); - g_string_append_printf(gstr, "\t\t</signal>\n"); - } - } - - for (property = iface->properties; property && property->name; property++) { - debug("%s: adding property %s.%s", - path, iface->name, property->name); - } - - g_string_append_printf(gstr, "\t</interface>\n"); - } - - if (!dbus_connection_list_registered(conn, path, &children)) - goto done; - - for (i = 0; children[i]; i++) - g_string_append_printf(gstr, "\t<node name=\"%s\"/>\n", children[i]); - - dbus_free_string_array(children); - -done: - g_string_append_printf(gstr, "</node>\n"); - - data->introspect = g_string_free(gstr, FALSE); -} - -static DBusHandlerResult introspect(DBusConnection *connection, - DBusMessage *message, struct generic_data *data) -{ - DBusMessage *reply; - - if (!dbus_message_has_signature(message, DBUS_TYPE_INVALID_AS_STRING)) { - error("Unexpected signature to introspect call"); - return DBUS_HANDLER_RESULT_NOT_YET_HANDLED; - } - - if (!data->introspect) - generate_introspection_xml(connection, data, - dbus_message_get_path(message)); - - reply = dbus_message_new_method_return(message); - if (!reply) - return DBUS_HANDLER_RESULT_NEED_MEMORY; - - dbus_message_append_args(reply, DBUS_TYPE_STRING, &data->introspect, - DBUS_TYPE_INVALID); - - return dbus_connection_send_and_unref(connection, reply); -} - -static void generic_unregister(DBusConnection *connection, void *user_data) -{ - struct generic_data *data = user_data; - - if (data->unregister_function) - data->unregister_function(connection, data->user_data); - - g_free(data->introspect); - g_free(data); -} - -static struct interface_data *find_interface(GSList *interfaces, - const char *name) -{ - GSList *list; - - for (list = interfaces; list; list = list->next) { - struct interface_data *iface = list->data; - if (!strcmp(name, iface->name)) - return iface; - } - - return NULL; -} - -static DBusHandlerResult generic_message(DBusConnection *connection, - DBusMessage *message, void *user_data) -{ - struct generic_data *data = user_data; - struct interface_data *iface; - DBusMethodVTable *current; - const char *interface; - - if (dbus_message_is_method_call(message, - DBUS_INTERFACE_INTROSPECTABLE, - "Introspect")) - return introspect(connection, message, data); - - interface = dbus_message_get_interface(message); - - iface = find_interface(data->interfaces, interface); - if (!iface) - return DBUS_HANDLER_RESULT_NOT_YET_HANDLED; - - for (current = iface->methods; - current->name && current->message_function; current++) { - if (!dbus_message_is_method_call(message, iface->name, - current->name)) - continue; - - if (dbus_message_has_signature(message, current->signature)) { - debug("%s: %s.%s()", dbus_message_get_path(message), - iface->name, current->name); - return current->message_function(connection, - message, data->user_data); - } - } - - return DBUS_HANDLER_RESULT_NOT_YET_HANDLED; -} - -static DBusObjectPathVTable generic_table = { - .unregister_function = generic_unregister, - .message_function = generic_message, -}; - -static void invalidate_parent_data(DBusConnection *conn, const char *child_path) -{ - struct generic_data *data = NULL; - char *parent_path, *slash; - - parent_path = g_strdup(child_path); - slash = strrchr(parent_path, '/'); - if (!slash) - goto done; - - *slash = '\0'; - if (!strlen(parent_path)) - goto done; - - if (!dbus_connection_get_object_path_data(conn, parent_path, - (void *) &data)) - goto done; - - if (!data) - goto done; - - g_free(data->introspect); - data->introspect = NULL; - -done: - g_free(parent_path); -} - -dbus_bool_t dbus_connection_create_object_path(DBusConnection *connection, - const char *path, void *user_data, - DBusObjectPathUnregisterFunction function) -{ - struct generic_data *data; - - data = g_new0(struct generic_data, 1); - - data->user_data = user_data; - data->unregister_function = function; - - data->introspect = g_strdup(DBUS_INTROSPECT_1_0_XML_DOCTYPE_DECL_NODE "<node></node>"); - - if (!dbus_connection_register_object_path(connection, path, - &generic_table, data)) { - g_free(data->introspect); - g_free(data); - return FALSE; - } - - invalidate_parent_data(connection, path); - - return TRUE; -} - -dbus_bool_t dbus_connection_destroy_object_path(DBusConnection *connection, - const char *path) -{ - invalidate_parent_data(connection, path); - - return dbus_connection_unregister_object_path(connection, path); -} - -dbus_bool_t dbus_connection_get_object_user_data(DBusConnection *connection, - const char *path, - void **data_p) -{ - struct generic_data *data = NULL; - - if (!dbus_connection_get_object_path_data(connection, path, - (void *) &data) || !data) - return FALSE; - - *data_p = data->user_data; - - return TRUE; -} - -dbus_bool_t dbus_connection_register_interface(DBusConnection *connection, - const char *path, const char *name, - DBusMethodVTable *methods, - DBusSignalVTable *signals, - DBusPropertyVTable *properties) -{ - struct generic_data *data = NULL; - struct interface_data *iface; - - if (!dbus_connection_get_object_path_data(connection, path, - (void *) &data) || !data) - return FALSE; - - if (find_interface(data->interfaces, name)) - return FALSE; - - iface = g_new0(struct interface_data, 1); - - iface->name = g_strdup(name); - iface->methods = methods; - iface->signals = signals; - iface->properties = properties; - - data->interfaces = g_slist_append(data->interfaces, iface); - - g_free(data->introspect); - data->introspect = NULL; - - return TRUE; -} - -dbus_bool_t dbus_connection_unregister_interface(DBusConnection *connection, - const char *path, const char *name) -{ - struct generic_data *data = NULL; - struct interface_data *iface; - - if (!dbus_connection_get_object_path_data(connection, path, - (void *) &data) || !data) - return FALSE; - - iface = find_interface(data->interfaces, name); - if (!iface) - return FALSE; - - data->interfaces = g_slist_remove(data->interfaces, iface); - - g_free(iface->name); - g_free(iface); - - g_free(data->introspect); - data->introspect = NULL; - - return TRUE; -} - -void dbus_message_iter_append_variant(DBusMessageIter *iter, int type, void *val) -{ - DBusMessageIter value; - DBusMessageIter array; - char *sig; - - switch (type) { - case DBUS_TYPE_STRING: - sig = DBUS_TYPE_STRING_AS_STRING; - break; - case DBUS_TYPE_BYTE: - sig = DBUS_TYPE_BYTE_AS_STRING; - break; - case DBUS_TYPE_INT16: - sig = DBUS_TYPE_INT16_AS_STRING; - break; - case DBUS_TYPE_UINT16: - sig = DBUS_TYPE_UINT16_AS_STRING; - break; - case DBUS_TYPE_INT32: - sig = DBUS_TYPE_INT32_AS_STRING; - break; - case DBUS_TYPE_UINT32: - sig = DBUS_TYPE_UINT32_AS_STRING; - break; - case DBUS_TYPE_BOOLEAN: - sig = DBUS_TYPE_BOOLEAN_AS_STRING; - break; - case DBUS_TYPE_ARRAY: - sig = DBUS_TYPE_ARRAY_AS_STRING DBUS_TYPE_STRING_AS_STRING; - break; - case DBUS_TYPE_OBJECT_PATH: - sig = DBUS_TYPE_OBJECT_PATH_AS_STRING; - break; - default: - error("Could not append variant with type %d", type); - return; - } - - dbus_message_iter_open_container(iter, DBUS_TYPE_VARIANT, sig, &value); - - if (type == DBUS_TYPE_ARRAY) { - int i; - const char ***str_array = val; - - dbus_message_iter_open_container(&value, DBUS_TYPE_ARRAY, - DBUS_TYPE_STRING_AS_STRING, &array); - - for (i = 0; (*str_array)[i]; i++) - dbus_message_iter_append_basic(&array, DBUS_TYPE_STRING, - &((*str_array)[i])); - - dbus_message_iter_close_container(&value, &array); - } else - dbus_message_iter_append_basic(&value, type, val); - - dbus_message_iter_close_container(iter, &value); -} - -void dbus_message_iter_append_dict_entry(DBusMessageIter *dict, - const char *key, int type, void *val) -{ - DBusMessageIter entry; - - dbus_message_iter_open_container(dict, DBUS_TYPE_DICT_ENTRY, NULL, &entry); - - dbus_message_iter_append_basic(&entry, DBUS_TYPE_STRING, &key); - - dbus_message_iter_append_variant(&entry, type, val); - - dbus_message_iter_close_container(dict, &entry); -} - -void dbus_message_iter_append_dict_valist(DBusMessageIter *iter, - const char *first_key, - va_list var_args) -{ - DBusMessageIter dict; - const char *key; - int type; - void *val; - - dbus_message_iter_open_container(iter, DBUS_TYPE_ARRAY, - DBUS_DICT_ENTRY_BEGIN_CHAR_AS_STRING - DBUS_TYPE_STRING_AS_STRING DBUS_TYPE_VARIANT_AS_STRING - DBUS_DICT_ENTRY_END_CHAR_AS_STRING, &dict); - - key = first_key; - while (key) { - type = va_arg(var_args, int); - val = va_arg(var_args, void *); - dbus_message_iter_append_dict_entry(&dict, key, type, val); - key = va_arg(var_args, char *); - } - - dbus_message_iter_close_container(iter, &dict); -} - -void dbus_message_iter_append_dict(DBusMessageIter *iter, - const char *first_key, ...) -{ - va_list var_args; - - va_start(var_args, first_key); - dbus_message_iter_append_dict_valist(iter, first_key, var_args); - va_end(var_args); -} - -static gboolean check_signal(DBusConnection *conn, const char *path, - const char *interface, const char *name, - const char **args) -{ - struct generic_data *data = NULL; - struct interface_data *iface; - DBusSignalVTable *sig_data; - - *args = NULL; - if (!dbus_connection_get_object_path_data(conn, path, - (void *) &data) || !data) { - error("dbus_connection_emit_signal: path %s isn't registered", - path); - return FALSE; - } - - iface = find_interface(data->interfaces, interface); - - if (!iface) { - error("dbus_connection_emit_signal: %s does not implement %s", - path, interface); - return FALSE; - } - - for (sig_data = iface->signals; sig_data && sig_data->name; sig_data++) { - if (!strcmp(sig_data->name, name)) { - *args = sig_data->signature; - break; - } - } - - if (!*args) { - error("No signal named %s on interface %s", name, interface); - return FALSE; - } - - return TRUE; -} - -dbus_bool_t dbus_connection_emit_signal_valist(DBusConnection *conn, - const char *path, - const char *interface, - const char *name, - int first, - va_list var_args) -{ - DBusMessage *signal; - dbus_bool_t ret; - const char *signature, *args; - - if (!check_signal(conn, path, interface, name, &args)) - return FALSE; - - signal = dbus_message_new_signal(path, interface, name); - if (!signal) { - error("Unable to allocate new %s.%s signal", interface, name); - return FALSE; - } - - ret = dbus_message_append_args_valist(signal, first, var_args); - if (!ret) - goto fail; - - signature = dbus_message_get_signature(signal); - if (strcmp(args, signature) != 0) { - error("%s.%s: expected signature'%s' but got '%s'", - interface, name, args, signature); - ret = FALSE; - goto fail; - } - - ret = dbus_connection_send(conn, signal, NULL); -fail: - dbus_message_unref(signal); - - return ret; -} - -dbus_bool_t dbus_connection_emit_signal(DBusConnection *conn, const char *path, - const char *interface, const char *name, - int first, ...) -{ - dbus_bool_t ret; - va_list var_args; - - va_start(var_args, first); - ret = dbus_connection_emit_signal_valist(conn, path, interface, name, - first, var_args); - va_end(var_args); - - return ret; -} - -dbus_bool_t dbus_connection_emit_property_changed(DBusConnection *conn, - const char *path, - const char *interface, - const char *name, - int type, void *value) -{ - DBusMessage *signal; - DBusMessageIter iter; - gboolean ret; - const char *signature, *args; - - if (!check_signal(conn, path, interface, "PropertyChanged", &args)) - return FALSE; - - signal = dbus_message_new_signal(path, interface, "PropertyChanged"); - - if (!signal) { - error("Unable to allocate new %s.PropertyChanged signal", - interface); - return FALSE; - } - - dbus_message_iter_init_append(signal, &iter); - - dbus_message_iter_append_basic(&iter, DBUS_TYPE_STRING, &name); - dbus_message_iter_append_variant(&iter, type, value); - - signature = dbus_message_get_signature(signal); - if (strcmp(args, signature) != 0) { - error("%s.%s: expected signature'%s' but got '%s'", - interface, name, args, signature); - ret = FALSE; - goto fail; - } - - ret = dbus_connection_send(conn, signal, NULL); - -fail: - dbus_message_unref(signal); - return ret; -} diff --git a/common/dbus-helper.h b/common/dbus-helper.h deleted file mode 100644 index 6c3c3a89..00000000 --- a/common/dbus-helper.h +++ /dev/null @@ -1,107 +0,0 @@ -/* - * - * BlueZ - Bluetooth protocol stack for Linux - * - * Copyright (C) 2004-2008 Marcel Holtmann <marcel@holtmann.org> - * - * - * This program is free software; you can redistribute it and/or modify - * it under the terms of the GNU General Public License as published by - * the Free Software Foundation; either version 2 of the License, or - * (at your option) any later version. - * - * This program 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 General Public License for more details. - * - * You should have received a copy of the GNU General Public License - * along with this program; if not, write to the Free Software - * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA - * - */ - -#include <stdarg.h> -#include <dbus/dbus.h> - -#define DBUS_TYPE_STRING_ARRAY_AS_STRING (DBUS_TYPE_ARRAY_AS_STRING DBUS_TYPE_STRING_AS_STRING) -#define DBUS_TYPE_BYTE_ARRAY_AS_STRING (DBUS_TYPE_ARRAY_AS_STRING DBUS_TYPE_BYTE_AS_STRING) - -DBusHandlerResult dbus_connection_send_and_unref(DBusConnection *connection, - DBusMessage *message); - -dbus_bool_t dbus_connection_create_object_path(DBusConnection *connection, - const char *path, void *user_data, - DBusObjectPathUnregisterFunction function); - -dbus_bool_t dbus_connection_destroy_object_path(DBusConnection *connection, - const char *path); - -dbus_bool_t dbus_connection_get_object_user_data(DBusConnection *connection, - const char *path, - void **data_p); - -typedef struct DBusMethodVTable DBusMethodVTable; - -struct DBusMethodVTable { - const char *name; - DBusObjectPathMessageFunction message_function; - const char *signature; - const char *reply; -}; - -typedef struct DBusSignalVTable DBusSignalVTable; - -struct DBusSignalVTable { - const char *name; - const char *signature; -}; - -typedef struct DBusPropertyVTable DBusPropertyVTable; - -struct DBusPropertyVTable { - const char *name; -}; - -dbus_bool_t dbus_connection_register_interface(DBusConnection *connection, - const char *path, const char *name, - DBusMethodVTable *methods, - DBusSignalVTable *signals, - DBusPropertyVTable *properties); - -dbus_bool_t dbus_connection_unregister_interface(DBusConnection *connection, - const char *path, const char *name); -void dbus_message_iter_append_variant(DBusMessageIter *iter, int type, void *val); -void dbus_message_iter_append_dict_entry(DBusMessageIter *dict, - const char *key, int type, void *val); -void dbus_message_iter_append_dict_valist(DBusMessageIter *iter, - const char *first_key, - va_list var_args); -void dbus_message_iter_append_dict(DBusMessageIter *iter, - const char *first_key, ...); -dbus_bool_t dbus_connection_emit_signal(DBusConnection *conn, const char *path, - const char *interface, const char *name, - int first, ...); - -dbus_bool_t dbus_connection_emit_signal_valist(DBusConnection *conn, - const char *path, - const char *interface, - const char *name, - int first, - va_list var_args); -dbus_bool_t dbus_connection_emit_property_changed(DBusConnection *conn, - const char *path, - const char *interface, - const char *name, - int type, void *value); - -static inline DBusHandlerResult send_message_and_unref(DBusConnection *conn, - DBusMessage *msg) -{ - if (msg) { - dbus_connection_send(conn, msg, NULL); - dbus_message_unref(msg); - } - - return DBUS_HANDLER_RESULT_HANDLED; -} diff --git a/common/error.c b/common/error.c index 58999393..656c7299 100644 --- a/common/error.c +++ b/common/error.c @@ -31,7 +31,8 @@ #include <string.h> #include <errno.h> -#include "dbus-helper.h" +#include <gdbus.h> + #include "error.h" /** |