summaryrefslogtreecommitdiffstats
path: root/dbus
diff options
context:
space:
mode:
authorKristian Høgsberg <krh@redhat.com>2004-06-02 13:13:14 +0000
committerKristian Høgsberg <krh@redhat.com>2004-06-02 13:13:14 +0000
commit54dcec2a8312634116c5a1acbbd0070953525c8a (patch)
tree2186d4c56fd66a3a101768944c5375599e84032c /dbus
parent0ea8ec33e01dfaf2194e1263546b943f970c6444 (diff)
2004-06-02 Kristian Høgsberg <krh@redhat.com>
* glib/dbus-gproxy.c, glib/dbus-gmain.c, dbus/dbus-string.c, dbus/dbus-object-tree.c, dbus/dbus-message.c: add comments to quiet doxygen. * Doxyfile.in: remove deprecated options. * dbus/dbus-message-handler.c, dbus/dbus-message-handler.h, glib/test-thread.h, glib/test-thread-client.c, glib/test-thread-server.c, glib/test-profile.c, glib/test-dbus-glib.c: remove these unused files.
Diffstat (limited to 'dbus')
-rw-r--r--dbus/dbus-message-handler.c366
-rw-r--r--dbus/dbus-message-handler.h59
-rw-r--r--dbus/dbus-message.c2
-rw-r--r--dbus/dbus-object-tree.c2
-rw-r--r--dbus/dbus-string.c8
5 files changed, 11 insertions, 426 deletions
diff --git a/dbus/dbus-message-handler.c b/dbus/dbus-message-handler.c
deleted file mode 100644
index cd548076..00000000
--- a/dbus/dbus-message-handler.c
+++ /dev/null
@@ -1,366 +0,0 @@
-/* -*- mode: C; c-file-style: "gnu" -*- */
-/* dbus-message-handler.c Sender/receiver of messages.
- *
- * Copyright (C) 2002, 2003 Red Hat Inc.
- *
- * Licensed under the Academic Free License version 2.0
- *
- * 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., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
- *
- */
-
-#include "dbus-internals.h"
-#include "dbus-message-handler.h"
-#include "dbus-list.h"
-#include "dbus-threads.h"
-#include "dbus-test.h"
-#include "dbus-connection-internal.h"
-
-/**
- * @defgroup DBusMessageHandlerInternals DBusMessageHandler implementation details
- * @ingroup DBusInternals
- * @brief DBusMessageHandler private implementation details.
- *
- * The guts of DBusMessageHandler and its methods.
- *
- * @{
- */
-
-_DBUS_DEFINE_GLOBAL_LOCK (message_handler);
-
-/**
- * @brief Internals of DBusMessageHandler
- *
- * Object that can send and receive messages.
- */
-struct DBusMessageHandler
-{
- DBusAtomic refcount; /**< reference count */
-
- DBusHandleMessageFunction function; /**< handler function */
- void *user_data; /**< user data for function */
- DBusFreeFunction free_user_data; /**< free the user data */
-
- DBusList *connections; /**< connections we're registered with */
-};
-
-/**
- * Add this connection to the list used by this message handler.
- * When the message handler goes away, the connection
- * will be notified.
- *
- * @param handler the message handler
- * @param connection the connection
- * @returns #FALSE if not enough memory
- */
-dbus_bool_t
-_dbus_message_handler_add_connection (DBusMessageHandler *handler,
- DBusConnection *connection)
-{
- dbus_bool_t res;
-
- _DBUS_LOCK (message_handler);
- /* This is a bit wasteful - we just put the connection in the list
- * once per time it's added. :-/
- */
- if (!_dbus_list_prepend (&handler->connections, connection))
- res = FALSE;
- else
- res = TRUE;
-
- _DBUS_UNLOCK (message_handler);
-
- return res;
-}
-
-/**
- * Reverses the effect of _dbus_message_handler_add_connection().
- * @param handler the message handler
- * @param connection the connection
- */
-void
-_dbus_message_handler_remove_connection (DBusMessageHandler *handler,
- DBusConnection *connection)
-{
- _DBUS_LOCK (message_handler);
- if (!_dbus_list_remove (&handler->connections, connection))
- _dbus_warn ("Function _dbus_message_handler_remove_connection() called when the connection hadn't been added\n");
- _DBUS_UNLOCK (message_handler);
-}
-
-
-/**
- * Handles the given message, by dispatching the handler function
- * for this DBusMessageHandler, if any.
- *
- * @param handler the handler
- * @param connection the connection that received the message
- * @param message the message
- *
- * @returns what to do with the message
- */
-DBusHandlerResult
-_dbus_message_handler_handle_message (DBusMessageHandler *handler,
- DBusConnection *connection,
- DBusMessage *message)
-{
- DBusHandleMessageFunction function;
- void *user_data;
-
- _DBUS_LOCK (message_handler);
- function = handler->function;
- user_data = handler->user_data;
- _DBUS_UNLOCK (message_handler);
-
- /* This function doesn't ref handler/connection/message
- * since that's done in dbus_connection_dispatch().
- */
- if (function != NULL)
- return (* function) (handler, connection, message, user_data);
- else
- return DBUS_HANDLER_RESULT_ALLOW_MORE_HANDLERS;
-}
-
-/** @} */
-
-/**
- * @defgroup DBusMessageHandler DBusMessageHandler
- * @ingroup DBus
- * @brief Message processor
- *
- * A DBusMessageHandler is an object that can send and receive
- * messages. Typically the handler is registered with one or
- * more DBusConnection objects and processes some types of
- * messages received from the connection.
- *
- * @{
- */
-
-/**
- * @typedef DBusMessageHandler
- *
- * Opaque data type representing a message handler.
- */
-
-/**
- * Creates a new message handler. The handler function
- * may be #NULL for a no-op handler or a handler to
- * be assigned a function later.
- *
- * @param function function to call to handle a message
- * @param user_data data to pass to the function
- * @param free_user_data function to call to free the user data
- * @returns a new DBusMessageHandler or #NULL if no memory.
- */
-DBusMessageHandler*
-dbus_message_handler_new (DBusHandleMessageFunction function,
- void *user_data,
- DBusFreeFunction free_user_data)
-{
- DBusMessageHandler *handler;
-
- handler = dbus_new (DBusMessageHandler, 1);
-
- if (handler == NULL)
- return NULL;
-
- handler->refcount.value = 1;
- handler->function = function;
- handler->user_data = user_data;
- handler->free_user_data = free_user_data;
- handler->connections = NULL;
-
- return handler;
-}
-
-/**
- * Increments the reference count on a message handler.
- *
- * @param handler the handler
- * @returns the handler
- */
-DBusMessageHandler *
-dbus_message_handler_ref (DBusMessageHandler *handler)
-{
- _dbus_return_if_fail (handler != NULL);
-
- _dbus_atomic_inc (&handler->refcount);
-
- return handler;
-}
-
-/**
- * Decrements the reference count on a message handler,
- * freeing the handler if the count reaches 0.
- *
- * @param handler the handler
- */
-void
-dbus_message_handler_unref (DBusMessageHandler *handler)
-{
- dbus_bool_t last_unref;
-
- _dbus_return_if_fail (handler != NULL);
-
- last_unref = (_dbus_atomic_dec (&handler->refcount) == 1);
-
- if (last_unref)
- {
- DBusList *link;
-
- if (handler->free_user_data)
- (* handler->free_user_data) (handler->user_data);
-
- link = _dbus_list_get_first_link (&handler->connections);
- while (link != NULL)
- {
- DBusConnection *connection = link->data;
-
- _dbus_connection_handler_destroyed_locked (connection, handler);
-
- link = _dbus_list_get_next_link (&handler->connections, link);
- }
-
- _dbus_list_clear (&handler->connections);
-
- dbus_free (handler);
- }
-}
-
-/**
- * Gets the user data for the handler (the same user data
- * passed to the handler function.)
- *
- * @param handler the handler
- * @returns the user data
- */
-void*
-dbus_message_handler_get_data (DBusMessageHandler *handler)
-{
- void* user_data;
-
- _dbus_return_val_if_fail (handler != NULL, NULL);
-
- _DBUS_LOCK (message_handler);
- user_data = handler->user_data;
- _DBUS_UNLOCK (message_handler);
- return user_data;
-}
-
-/**
- * Sets the user data for the handler (the same user data
- * to be passed to the handler function). Frees any previously-existing
- * user data with the previous free_user_data function.
- *
- * @param handler the handler
- * @param user_data the user data
- * @param free_user_data free function for the data
- */
-void
-dbus_message_handler_set_data (DBusMessageHandler *handler,
- void *user_data,
- DBusFreeFunction free_user_data)
-{
- DBusFreeFunction old_free_func;
- void *old_user_data;
-
- _dbus_return_if_fail (handler != NULL);
-
- _DBUS_LOCK (message_handler);
- old_free_func = handler->free_user_data;
- old_user_data = handler->user_data;
-
- handler->user_data = user_data;
- handler->free_user_data = free_user_data;
- _DBUS_UNLOCK (message_handler);
-
- if (old_free_func)
- (* old_free_func) (old_user_data);
-
-}
-
-/**
- * Sets the handler function. Call dbus_message_handler_set_data()
- * to set the user data for the function.
- *
- * @param handler the handler
- * @param function the function
- */
-void
-dbus_message_handler_set_function (DBusMessageHandler *handler,
- DBusHandleMessageFunction function)
-{
- _dbus_return_if_fail (handler != NULL);
-
- _DBUS_LOCK (message_handler);
- handler->function = function;
- _DBUS_UNLOCK (message_handler);
-}
-
-/** @} */
-
-#ifdef DBUS_BUILD_TESTS
-static DBusHandlerResult
-test_handler (DBusMessageHandler *handler,
- DBusConnection *connection,
- DBusMessage *message,
- void *user_data)
-{
- return DBUS_HANDLER_RESULT_ALLOW_MORE_HANDLERS;
-}
-
-static void
-free_test_data (void *data)
-{
- /* does nothing */
-}
-
-/**
- * @ingroup DBusMessageInternals
- * Unit test for DBusMessageHandler.
- *
- * @returns #TRUE on success.
- */
-dbus_bool_t
-_dbus_message_handler_test (const char *test_data_dir)
-{
- DBusMessageHandler *handler;
-
-#define TEST_DATA ((void*) 0xcafebabe)
-
- handler = dbus_message_handler_new (test_handler,
- TEST_DATA,
- free_test_data);
-
- _dbus_assert (handler != NULL);
- _dbus_assert (handler->function == test_handler);
-
- if (dbus_message_handler_get_data (handler) != TEST_DATA)
- _dbus_assert_not_reached ("got wrong data");
-
- dbus_message_handler_set_data (handler, NULL, NULL);
- if (dbus_message_handler_get_data (handler) != NULL)
- _dbus_assert_not_reached ("got wrong data after set");
-
- dbus_message_handler_set_function (handler, NULL);
- _dbus_assert (handler->function == NULL);
-
- dbus_message_handler_ref (handler);
- dbus_message_handler_unref (handler);
- dbus_message_handler_unref (handler);
-
- return TRUE;
-}
-#endif /* DBUS_BUILD_TESTS */
diff --git a/dbus/dbus-message-handler.h b/dbus/dbus-message-handler.h
deleted file mode 100644
index 9af8be33..00000000
--- a/dbus/dbus-message-handler.h
+++ /dev/null
@@ -1,59 +0,0 @@
-/* -*- mode: C; c-file-style: "gnu" -*- */
-/* dbus-message-handler.h Sender/receiver of messages.
- *
- * Copyright (C) 2002 Red Hat Inc.
- *
- * Licensed under the Academic Free License version 2.0
- *
- * 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., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
- *
- */
-#if !defined (DBUS_INSIDE_DBUS_H) && !defined (DBUS_COMPILATION)
-#error "Only <dbus/dbus.h> can be included directly, this file may disappear or change contents."
-#endif
-
-#ifndef DBUS_MESSAGE_HANDLER_H
-#define DBUS_MESSAGE_HANDLER_H
-
-#include <dbus/dbus-macros.h>
-#include <dbus/dbus-types.h>
-#include <dbus/dbus-connection.h>
-
-DBUS_BEGIN_DECLS;
-
-typedef DBusHandlerResult (* DBusHandleMessageFunction) (DBusMessageHandler *handler,
- DBusConnection *connection,
- DBusMessage *message,
- void *user_data);
-
-DBusMessageHandler* dbus_message_handler_new (DBusHandleMessageFunction function,
- void *user_data,
- DBusFreeFunction free_user_data);
-
-
-DBusMessageHandler* dbus_message_handler_ref (DBusMessageHandler *handler);
-void dbus_message_handler_unref (DBusMessageHandler *handler);
-
-
-void* dbus_message_handler_get_data (DBusMessageHandler *handler);
-void dbus_message_handler_set_data (DBusMessageHandler *handler,
- void *data,
- DBusFreeFunction free_user_data);
-void dbus_message_handler_set_function (DBusMessageHandler *handler,
- DBusHandleMessageFunction function);
-
-DBUS_END_DECLS;
-
-#endif /* DBUS_MESSAGE_HANDLER_H */
diff --git a/dbus/dbus-message.c b/dbus/dbus-message.c
index 850af21c..94884bb7 100644
--- a/dbus/dbus-message.c
+++ b/dbus/dbus-message.c
@@ -394,7 +394,9 @@ append_uint_field (DBusMessage *message,
return FALSE;
}
+/** The maximum number of bytes of overhead to append to a string */
#define MAX_BYTES_OVERHEAD_TO_APPEND_A_STRING (1 + 1 + 3 + 1 + 8)
+
static dbus_bool_t
append_string_field (DBusMessage *message,
int field,
diff --git a/dbus/dbus-object-tree.c b/dbus/dbus-object-tree.c
index 2c4335dc..3ec97320 100644
--- a/dbus/dbus-object-tree.c
+++ b/dbus/dbus-object-tree.c
@@ -915,7 +915,7 @@ _dbus_object_subtree_unref (DBusObjectSubtree *subtree)
* the given parent_path. The returned array should be freed with
* dbus_free_string_array().
*
- * @param connection the connection
+ * @param tree the object tree
* @param parent_path the path to list the child handlers of
* @param child_entries returns #NULL-terminated array of children
* @returns #FALSE if no memory to allocate the child entries
diff --git a/dbus/dbus-string.c b/dbus/dbus-string.c
index a1bab820..31ea6fcb 100644
--- a/dbus/dbus-string.c
+++ b/dbus/dbus-string.c
@@ -2551,11 +2551,19 @@ _dbus_string_validate_path (const DBusString *str,
return TRUE;
}
+/**
+ * Determine wether the given charater is valid as the first charater
+ * in a name.
+ */
#define VALID_INITIAL_NAME_CHARACTER(c) \
( ((c) >= 'A' && (c) <= 'Z') || \
((c) >= 'a' && (c) <= 'z') || \
((c) == '_') )
+/**
+ * Determine wether the given charater is valid as a second or later
+ * character in a nam
+ */
#define VALID_NAME_CHARACTER(c) \
( ((c) >= '0' && (c) <= '9') || \
((c) >= 'A' && (c) <= 'Z') || \