1 /* -*- mode: C; c-file-style: "gnu" -*- */
2 /* dbus-object-tree.c DBusObjectTree (internals of DBusConnection)
4 * Copyright (C) 2003 Red Hat Inc.
6 * Licensed under the Academic Free License version 2.1
8 * This program is free software; you can redistribute it and/or modify
9 * it under the terms of the GNU General Public License as published by
10 * the Free Software Foundation; either version 2 of the License, or
11 * (at your option) any later version.
13 * This program is distributed in the hope that it will be useful,
14 * but WITHOUT ANY WARRANTY; without even the implied warranty of
15 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16 * GNU General Public License for more details.
18 * You should have received a copy of the GNU General Public License
19 * along with this program; if not, write to the Free Software
20 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
23 #include "dbus-object-tree.h"
24 #include "dbus-connection-internal.h"
25 #include "dbus-internals.h"
26 #include "dbus-hash.h"
27 #include "dbus-protocol.h"
28 #include "dbus-string.h"
33 * @defgroup DBusObjectTree A hierarchy of objects with container-contained relationship
34 * @ingroup DBusInternals
35 * @brief DBusObjectTree is used by DBusConnection to track the object tree
37 * Types and functions related to DBusObjectTree. These
38 * are all library-internal.
43 /** Subnode of the object hierarchy */
44 typedef struct DBusObjectSubtree DBusObjectSubtree;
46 static DBusObjectSubtree* _dbus_object_subtree_new (const char *name,
47 const DBusObjectPathVTable *vtable,
49 static DBusObjectSubtree* _dbus_object_subtree_ref (DBusObjectSubtree *subtree);
50 static void _dbus_object_subtree_unref (DBusObjectSubtree *subtree);
53 * Internals of DBusObjectTree
57 int refcount; /**< Reference count */
58 DBusConnection *connection; /**< Connection this tree belongs to */
60 DBusObjectSubtree *root; /**< Root of the tree ("/" node) */
64 * Struct representing a single registered subtree handler, or node
65 * that's a parent of a registered subtree handler. If
66 * message_function != NULL there's actually a handler at this node.
68 struct DBusObjectSubtree
70 DBusAtomic refcount; /**< Reference count */
71 DBusObjectSubtree *parent; /**< Parent node */
72 DBusObjectPathUnregisterFunction unregister_function; /**< Function to call on unregister */
73 DBusObjectPathMessageFunction message_function; /**< Function to handle messages */
74 void *user_data; /**< Data for functions */
75 DBusObjectSubtree **subtrees; /**< Child nodes */
76 int n_subtrees; /**< Number of child nodes */
77 unsigned int subtrees_sorted : 1; /**< Whether children are sorted */
78 unsigned int invoke_as_fallback : 1; /**< Whether to invoke message_function when child nodes don't handle the message */
79 char name[1]; /**< Allocated as large as necessary */
83 * Creates a new object tree, representing a mapping from paths
86 * @param connection the connection this tree belongs to
87 * @returns the new tree or #NULL if no memory
90 _dbus_object_tree_new (DBusConnection *connection)
94 /* the connection passed in here isn't fully constructed,
95 * so don't do anything more than store a pointer to
99 tree = dbus_new0 (DBusObjectTree, 1);
104 tree->connection = connection;
105 tree->root = _dbus_object_subtree_new ("/", NULL, NULL);
106 if (tree->root == NULL)
108 tree->root->invoke_as_fallback = TRUE;
122 * Increment the reference count
123 * @param tree the object tree
124 * @returns the object tree
127 _dbus_object_tree_ref (DBusObjectTree *tree)
129 _dbus_assert (tree->refcount > 0);
137 * Decrement the reference count
138 * @param tree the object tree
141 _dbus_object_tree_unref (DBusObjectTree *tree)
143 _dbus_assert (tree->refcount > 0);
147 if (tree->refcount == 0)
149 _dbus_object_tree_free_all_unlocked (tree);
156 subtree_cmp (DBusObjectSubtree *subtree_a,
157 DBusObjectSubtree *subtree_b)
159 return strcmp (subtree_a->name, subtree_b->name);
163 subtree_qsort_cmp (const void *a,
166 DBusObjectSubtree **subtree_a_p = (void*) a;
167 DBusObjectSubtree **subtree_b_p = (void*) b;
169 return subtree_cmp (*subtree_a_p, *subtree_b_p);
173 ensure_sorted (DBusObjectSubtree *subtree)
175 if (subtree->subtrees && !subtree->subtrees_sorted)
177 qsort (subtree->subtrees,
179 sizeof (DBusObjectSubtree*),
181 subtree->subtrees_sorted = TRUE;
185 /** Set to 1 to get a bunch of debug spew about finding the
188 #define VERBOSE_FIND 0
190 static DBusObjectSubtree*
191 find_subtree_recurse (DBusObjectSubtree *subtree,
193 dbus_bool_t create_if_not_found,
194 int *index_in_parent,
195 dbus_bool_t *exact_match)
198 dbus_bool_t return_deepest_match;
200 return_deepest_match = exact_match != NULL;
202 _dbus_assert (!(return_deepest_match && create_if_not_found));
207 _dbus_verbose (" path exhausted, returning %s\n",
210 if (exact_match != NULL)
216 _dbus_verbose (" searching children of %s for %s\n",
217 subtree->name, path[0]);
220 ensure_sorted (subtree);
222 /* FIXME we should do a binary search here instead
227 while (i < subtree->n_subtrees)
231 v = strcmp (path[0], subtree->subtrees[i]->name);
234 _dbus_verbose (" %s cmp %s = %d\n",
235 path[0], subtree->subtrees[i]->name,
244 _dbus_verbose (" storing parent index %d\n", i);
246 *index_in_parent = i;
249 if (return_deepest_match)
251 DBusObjectSubtree *next;
253 next = find_subtree_recurse (subtree->subtrees[i],
254 &path[1], create_if_not_found,
255 index_in_parent, exact_match);
257 subtree->invoke_as_fallback)
260 _dbus_verbose (" no deeper match found, returning %s\n",
263 if (exact_match != NULL)
264 *exact_match = FALSE;
271 return find_subtree_recurse (subtree->subtrees[i],
272 &path[1], create_if_not_found,
273 index_in_parent, exact_match);
285 _dbus_verbose (" no match found, current tree %s, create_if_not_found = %d\n",
286 subtree->name, create_if_not_found);
289 if (create_if_not_found)
291 DBusObjectSubtree* child;
292 DBusObjectSubtree **new_subtrees;
296 _dbus_verbose (" creating subtree %s\n",
300 child = _dbus_object_subtree_new (path[0],
305 /* FIXME we should do the "double alloc each time" standard thing */
306 new_n_subtrees = subtree->n_subtrees + 1;
307 new_subtrees = dbus_realloc (subtree->subtrees,
308 new_n_subtrees * sizeof (DBusObjectSubtree*));
309 if (new_subtrees == NULL)
311 child->unregister_function = NULL;
312 child->message_function = NULL;
313 _dbus_object_subtree_unref (child);
317 new_subtrees[subtree->n_subtrees] = child;
319 *index_in_parent = subtree->n_subtrees;
320 subtree->subtrees_sorted = FALSE;
321 subtree->n_subtrees = new_n_subtrees;
322 subtree->subtrees = new_subtrees;
324 child->parent = subtree;
326 return find_subtree_recurse (child,
327 &path[1], create_if_not_found,
328 index_in_parent, exact_match);
332 if (exact_match != NULL)
333 *exact_match = FALSE;
334 return (return_deepest_match && subtree->invoke_as_fallback) ? subtree : NULL;
338 static DBusObjectSubtree*
339 find_subtree (DBusObjectTree *tree,
341 int *index_in_parent)
343 DBusObjectSubtree *subtree;
346 _dbus_verbose ("Looking for exact registered subtree\n");
349 subtree = find_subtree_recurse (tree->root, path, FALSE, index_in_parent, NULL);
351 if (subtree && subtree->message_function == NULL)
357 static DBusObjectSubtree*
358 lookup_subtree (DBusObjectTree *tree,
362 _dbus_verbose ("Looking for subtree\n");
364 return find_subtree_recurse (tree->root, path, FALSE, NULL, NULL);
367 static DBusObjectSubtree*
368 find_handler (DBusObjectTree *tree,
370 dbus_bool_t *exact_match)
373 _dbus_verbose ("Looking for deepest handler\n");
375 _dbus_assert (exact_match != NULL);
376 return find_subtree_recurse (tree->root, path, FALSE, NULL, exact_match);
379 static DBusObjectSubtree*
380 ensure_subtree (DBusObjectTree *tree,
384 _dbus_verbose ("Ensuring subtree\n");
386 return find_subtree_recurse (tree->root, path, TRUE, NULL, NULL);
390 * Registers a new subtree in the global object tree.
392 * @param tree the global object tree
393 * @param fallback #TRUE to handle messages to children of this path
394 * @param path NULL-terminated array of path elements giving path to subtree
395 * @param vtable the vtable used to traverse this subtree
396 * @param user_data user data to pass to methods in the vtable
397 * @returns #FALSE if not enough memory
400 _dbus_object_tree_register (DBusObjectTree *tree,
401 dbus_bool_t fallback,
403 const DBusObjectPathVTable *vtable,
406 DBusObjectSubtree *subtree;
408 _dbus_assert (tree != NULL);
409 _dbus_assert (vtable->message_function != NULL);
410 _dbus_assert (path != NULL);
412 subtree = ensure_subtree (tree, path);
416 #ifndef DBUS_DISABLE_CHECKS
417 if (subtree->message_function != NULL)
419 _dbus_warn ("A handler is already registered for the path starting with path[0] = \"%s\"\n",
420 path[0] ? path[0] : "null");
424 _dbus_assert (subtree->message_function == NULL);
427 subtree->message_function = vtable->message_function;
428 subtree->unregister_function = vtable->unregister_function;
429 subtree->user_data = user_data;
430 subtree->invoke_as_fallback = fallback != FALSE;
436 * Unregisters an object subtree that was registered with the
439 * @param tree the global object tree
440 * @param path path to the subtree (same as the one passed to _dbus_object_tree_register())
443 _dbus_object_tree_unregister_and_unlock (DBusObjectTree *tree,
447 DBusObjectSubtree *subtree;
448 DBusObjectPathUnregisterFunction unregister_function;
450 DBusConnection *connection;
452 _dbus_assert (path != NULL);
454 subtree = find_subtree (tree, path, &i);
456 #ifndef DBUS_DISABLE_CHECKS
459 _dbus_warn ("Attempted to unregister path (path[0] = %s path[1] = %s) which isn't registered\n",
460 path[0] ? path[0] : "null",
461 path[1] ? path[1] : "null");
465 _dbus_assert (subtree != NULL);
468 _dbus_assert (subtree->parent == NULL ||
469 (i >= 0 && subtree->parent->subtrees[i] == subtree));
471 subtree->message_function = NULL;
473 unregister_function = subtree->unregister_function;
474 user_data = subtree->user_data;
476 subtree->unregister_function = NULL;
477 subtree->user_data = NULL;
479 /* If we have no subtrees of our own, remove from
480 * our parent (FIXME could also be more aggressive
481 * and remove our parent if it becomes empty)
483 if (subtree->parent && subtree->n_subtrees == 0)
485 /* assumes a 0-byte memmove is OK */
486 memmove (&subtree->parent->subtrees[i],
487 &subtree->parent->subtrees[i+1],
488 (subtree->parent->n_subtrees - i - 1) *
489 sizeof (subtree->parent->subtrees[0]));
490 subtree->parent->n_subtrees -= 1;
492 subtree->parent = NULL;
494 _dbus_object_subtree_unref (subtree);
498 connection = tree->connection;
500 /* Unlock and call application code */
501 #ifdef DBUS_BUILD_TESTS
505 _dbus_connection_ref_unlocked (connection);
506 _dbus_connection_unlock (connection);
509 if (unregister_function)
510 (* unregister_function) (connection, user_data);
512 #ifdef DBUS_BUILD_TESTS
515 dbus_connection_unref (connection);
519 free_subtree_recurse (DBusConnection *connection,
520 DBusObjectSubtree *subtree)
522 /* Delete them from the end, for slightly
523 * more robustness against odd reentrancy.
525 while (subtree->n_subtrees > 0)
527 DBusObjectSubtree *child;
529 child = subtree->subtrees[subtree->n_subtrees - 1];
530 subtree->subtrees[subtree->n_subtrees - 1] = NULL;
531 subtree->n_subtrees -= 1;
532 child->parent = NULL;
534 free_subtree_recurse (connection, child);
537 /* Call application code */
538 if (subtree->unregister_function)
539 (* subtree->unregister_function) (connection,
542 subtree->message_function = NULL;
543 subtree->unregister_function = NULL;
544 subtree->user_data = NULL;
546 /* Now free ourselves */
547 _dbus_object_subtree_unref (subtree);
551 * Free all the handlers in the tree. Lock on tree's connection
554 * @param tree the object tree
557 _dbus_object_tree_free_all_unlocked (DBusObjectTree *tree)
560 free_subtree_recurse (tree->connection,
566 _dbus_object_tree_list_registered_unlocked (DBusObjectTree *tree,
567 const char **parent_path,
568 char ***child_entries)
570 DBusObjectSubtree *subtree;
573 _dbus_assert (parent_path != NULL);
574 _dbus_assert (child_entries != NULL);
576 *child_entries = NULL;
578 subtree = lookup_subtree (tree, parent_path);
581 retval = dbus_new0 (char *, 1);
586 retval = dbus_new0 (char*, subtree->n_subtrees + 1);
590 while (i < subtree->n_subtrees)
592 retval[i] = _dbus_strdup (subtree->subtrees[i]->name);
593 if (retval[i] == NULL)
595 dbus_free_string_array (retval);
605 *child_entries = retval;
606 return retval != NULL;
609 static DBusHandlerResult
610 handle_default_introspect_unlocked (DBusObjectTree *tree,
611 DBusMessage *message,
615 DBusHandlerResult result;
619 if (!dbus_message_is_method_call (message,
620 DBUS_INTERFACE_ORG_FREEDESKTOP_INTROSPECTABLE,
622 return DBUS_HANDLER_RESULT_NOT_YET_HANDLED;
624 if (!_dbus_string_init (&xml))
625 return DBUS_HANDLER_RESULT_NEED_MEMORY;
627 result = DBUS_HANDLER_RESULT_NEED_MEMORY;
630 if (!_dbus_object_tree_list_registered_unlocked (tree, path, &children))
633 if (!_dbus_string_append (&xml, "<node>\n"))
637 while (children[i] != NULL)
639 if (!_dbus_string_append_printf (&xml, " <node name=\"%s\"/>\n",
646 if (!_dbus_string_append (&xml, "</node>\n"))
649 result = DBUS_HANDLER_RESULT_HANDLED;
652 _dbus_string_free (&xml);
653 dbus_free_string_array (children);
659 * Tries to dispatch a message by directing it to handler for the
660 * object path listed in the message header, if any. Messages are
661 * dispatched first to the registered handler that matches the largest
662 * number of path elements; that is, message to /foo/bar/baz would go
663 * to the handler for /foo/bar before the one for /foo.
665 * @todo thread problems
667 * @param tree the global object tree
668 * @param message the message to dispatch
669 * @returns whether message was handled successfully
672 _dbus_object_tree_dispatch_and_unlock (DBusObjectTree *tree,
673 DBusMessage *message)
676 dbus_bool_t exact_match;
679 DBusHandlerResult result;
680 DBusObjectSubtree *subtree;
683 _dbus_verbose ("Dispatch of message by object path\n");
687 if (!dbus_message_get_path_decomposed (message, &path))
689 #ifdef DBUS_BUILD_TESTS
690 if (tree->connection)
692 _dbus_connection_unlock (tree->connection);
694 _dbus_verbose ("No memory to get decomposed path\n");
696 return DBUS_HANDLER_RESULT_NEED_MEMORY;
701 #ifdef DBUS_BUILD_TESTS
702 if (tree->connection)
704 _dbus_connection_unlock (tree->connection);
706 _dbus_verbose ("No path field in message\n");
707 return DBUS_HANDLER_RESULT_NOT_YET_HANDLED;
710 /* Find the deepest path that covers the path in the message */
711 subtree = find_handler (tree, (const char**) path, &exact_match);
713 /* Build a list of all paths that cover the path in the message */
717 while (subtree != NULL)
719 if (subtree->message_function != NULL && (exact_match || subtree->invoke_as_fallback))
721 _dbus_object_subtree_ref (subtree);
723 /* run deepest paths first */
724 if (!_dbus_list_append (&list, subtree))
726 result = DBUS_HANDLER_RESULT_NEED_MEMORY;
727 _dbus_object_subtree_unref (subtree);
728 goto free_and_return;
733 subtree = subtree->parent;
736 _dbus_verbose ("%d handlers in the path tree for this message\n",
737 _dbus_list_get_length (&list));
739 /* Invoke each handler in the list */
741 result = DBUS_HANDLER_RESULT_NOT_YET_HANDLED;
743 link = _dbus_list_get_first_link (&list);
746 DBusList *next = _dbus_list_get_next_link (&list, link);
747 subtree = link->data;
749 /* message_function is NULL if we're unregistered
752 if (subtree->message_function)
754 DBusObjectPathMessageFunction message_function;
757 message_function = subtree->message_function;
758 user_data = subtree->user_data;
761 _dbus_verbose (" (invoking a handler)\n");
764 #ifdef DBUS_BUILD_TESTS
765 if (tree->connection)
767 _dbus_connection_unlock (tree->connection);
769 /* FIXME you could unregister the subtree in another thread
770 * before we invoke the callback, and I can't figure out a
771 * good way to solve this.
774 result = (* message_function) (tree->connection,
778 #ifdef DBUS_BUILD_TESTS
779 if (tree->connection)
781 _dbus_connection_lock (tree->connection);
783 if (result != DBUS_HANDLER_RESULT_NOT_YET_HANDLED)
784 goto free_and_return;
792 if (result == DBUS_HANDLER_RESULT_NOT_YET_HANDLED)
794 /* This hardcoded default handler does a minimal Introspect()
796 result = handle_default_introspect_unlocked (tree, message,
797 (const char**) path);
800 #ifdef DBUS_BUILD_TESTS
801 if (tree->connection)
803 _dbus_connection_unlock (tree->connection);
807 link = _dbus_list_get_first_link (&list);
808 _dbus_object_subtree_unref (link->data);
809 _dbus_list_remove_link (&list, link);
812 dbus_free_string_array (path);
818 * Allocates a subtree object.
820 * @param name name to duplicate.
821 * @returns newly-allocated subtree
823 static DBusObjectSubtree*
824 allocate_subtree_object (const char *name)
827 DBusObjectSubtree *subtree;
828 const size_t front_padding = _DBUS_STRUCT_OFFSET (DBusObjectSubtree, name);
830 _dbus_assert (name != NULL);
834 subtree = dbus_malloc (front_padding + (len + 1));
839 memcpy (subtree->name, name, len + 1);
844 static DBusObjectSubtree*
845 _dbus_object_subtree_new (const char *name,
846 const DBusObjectPathVTable *vtable,
849 DBusObjectSubtree *subtree;
851 subtree = allocate_subtree_object (name);
855 _dbus_assert (name != NULL);
857 subtree->parent = NULL;
861 subtree->message_function = vtable->message_function;
862 subtree->unregister_function = vtable->unregister_function;
866 subtree->message_function = NULL;
867 subtree->unregister_function = NULL;
870 subtree->user_data = user_data;
871 subtree->refcount.value = 1;
872 subtree->subtrees = NULL;
873 subtree->n_subtrees = 0;
874 subtree->subtrees_sorted = TRUE;
875 subtree->invoke_as_fallback = FALSE;
888 static DBusObjectSubtree *
889 _dbus_object_subtree_ref (DBusObjectSubtree *subtree)
891 _dbus_assert (subtree->refcount.value > 0);
892 _dbus_atomic_inc (&subtree->refcount);
898 _dbus_object_subtree_unref (DBusObjectSubtree *subtree)
900 _dbus_assert (subtree->refcount.value > 0);
902 if (_dbus_atomic_dec (&subtree->refcount) == 1)
904 _dbus_assert (subtree->unregister_function == NULL);
905 _dbus_assert (subtree->message_function == NULL);
907 dbus_free (subtree->subtrees);
913 * Lists the registered fallback handlers and object path handlers at
914 * the given parent_path. The returned array should be freed with
915 * dbus_free_string_array().
917 * @param tree the object tree
918 * @param parent_path the path to list the child handlers of
919 * @param child_entries returns #NULL-terminated array of children
920 * @returns #FALSE if no memory to allocate the child entries
923 _dbus_object_tree_list_registered_and_unlock (DBusObjectTree *tree,
924 const char **parent_path,
925 char ***child_entries)
929 result = _dbus_object_tree_list_registered_unlocked (tree,
933 #ifdef DBUS_BUILD_TESTS
934 if (tree->connection)
936 _dbus_connection_unlock (tree->connection);
943 #ifdef DBUS_BUILD_TESTS
944 #include "dbus-test.h"
948 flatten_path (const char **path)
954 if (!_dbus_string_init (&str))
960 if (!_dbus_string_append_byte (&str, '/'))
963 if (!_dbus_string_append (&str, path[i]))
969 if (!_dbus_string_steal_data (&str, &s))
972 _dbus_string_free (&str);
977 _dbus_string_free (&str);
989 /* Returns TRUE if container is a parent of child
992 path_contains (const char **container,
998 while (child[i] != NULL)
1002 if (container[i] == NULL)
1003 return STR_PREFIX; /* container ran out, child continues;
1004 * thus the container is a parent of the
1008 _dbus_assert (container[i] != NULL);
1009 _dbus_assert (child[i] != NULL);
1011 v = strcmp (container[i], child[i]);
1014 return STR_DIFFERENT; /* they overlap until here and then are different,
1021 /* Child ran out; if container also did, they are equal;
1022 * otherwise, the child is a parent of the container.
1024 if (container[i] == NULL)
1027 return STR_DIFFERENT;
1032 spew_subtree_recurse (DBusObjectSubtree *subtree,
1040 _dbus_verbose (" ");
1044 _dbus_verbose ("%s (%d children)\n",
1045 subtree->name, subtree->n_subtrees);
1048 while (i < subtree->n_subtrees)
1050 spew_subtree_recurse (subtree->subtrees[i], indent + 2);
1057 spew_tree (DBusObjectTree *tree)
1059 spew_subtree_recurse (tree->root, 0);
1064 * Callback data used in tests
1068 const char **path; /**< Path */
1069 dbus_bool_t handler_fallback; /**< true if the handler may be called as fallback */
1070 dbus_bool_t message_handled; /**< Gets set to true if message handler called */
1071 dbus_bool_t handler_unregistered; /**< gets set to true if handler is unregistered */
1076 test_unregister_function (DBusConnection *connection,
1079 TreeTestData *ttd = user_data;
1081 ttd->handler_unregistered = TRUE;
1084 static DBusHandlerResult
1085 test_message_function (DBusConnection *connection,
1086 DBusMessage *message,
1089 TreeTestData *ttd = user_data;
1091 ttd->message_handled = TRUE;
1093 return DBUS_HANDLER_RESULT_NOT_YET_HANDLED;
1097 do_register (DBusObjectTree *tree,
1099 dbus_bool_t fallback,
1101 TreeTestData *tree_test_data)
1103 DBusObjectPathVTable vtable = { test_unregister_function,
1104 test_message_function, NULL };
1106 tree_test_data[i].message_handled = FALSE;
1107 tree_test_data[i].handler_unregistered = FALSE;
1108 tree_test_data[i].handler_fallback = fallback;
1109 tree_test_data[i].path = path;
1111 if (!_dbus_object_tree_register (tree, fallback, path,
1113 &tree_test_data[i]))
1120 do_test_dispatch (DBusObjectTree *tree,
1123 TreeTestData *tree_test_data,
1126 DBusMessage *message;
1128 DBusHandlerResult result;
1133 flat = flatten_path (path);
1137 message = dbus_message_new_method_call (NULL,
1139 "org.freedesktop.TestInterface",
1142 if (message == NULL)
1146 while (j < n_test_data)
1148 tree_test_data[j].message_handled = FALSE;
1152 result = _dbus_object_tree_dispatch_and_unlock (tree, message);
1153 if (result == DBUS_HANDLER_RESULT_NEED_MEMORY)
1156 _dbus_assert (tree_test_data[i].message_handled);
1159 while (j < n_test_data)
1161 if (tree_test_data[j].message_handled)
1163 if (tree_test_data[j].handler_fallback)
1164 _dbus_assert (path_contains (tree_test_data[j].path,
1165 path) != STR_DIFFERENT);
1167 _dbus_assert (path_contains (tree_test_data[j].path, path) == STR_EQUAL);
1171 if (tree_test_data[j].handler_fallback)
1172 _dbus_assert (path_contains (tree_test_data[j].path,
1173 path) == STR_DIFFERENT);
1175 _dbus_assert (path_contains (tree_test_data[j].path, path) != STR_EQUAL);
1181 dbus_message_unref (message);
1187 dbus_message_unref (message);
1192 string_array_length (char **array)
1195 for (i = 0; array[i]; i++) ;
1201 object_tree_test_iteration (void *data)
1203 const char *path1[] = { "foo", NULL };
1204 const char *path2[] = { "foo", "bar", NULL };
1205 const char *path3[] = { "foo", "bar", "baz", NULL };
1206 const char *path4[] = { "foo", "bar", "boo", NULL };
1207 const char *path5[] = { "blah", NULL };
1208 const char *path6[] = { "blah", "boof", NULL };
1209 const char *path7[] = { "blah", "boof", "this", "is", "really", "long", NULL };
1210 const char *path8[] = { "childless", NULL };
1211 DBusObjectTree *tree;
1212 TreeTestData tree_test_data[8];
1214 dbus_bool_t exact_match;
1218 tree = _dbus_object_tree_new (NULL);
1222 if (!do_register (tree, path1, TRUE, 0, tree_test_data))
1225 _dbus_assert (find_subtree (tree, path1, NULL));
1226 _dbus_assert (!find_subtree (tree, path2, NULL));
1227 _dbus_assert (!find_subtree (tree, path3, NULL));
1228 _dbus_assert (!find_subtree (tree, path4, NULL));
1229 _dbus_assert (!find_subtree (tree, path5, NULL));
1230 _dbus_assert (!find_subtree (tree, path6, NULL));
1231 _dbus_assert (!find_subtree (tree, path7, NULL));
1232 _dbus_assert (!find_subtree (tree, path8, NULL));
1234 _dbus_assert (find_handler (tree, path1, &exact_match) && exact_match);
1235 _dbus_assert (find_handler (tree, path2, &exact_match) && !exact_match);
1236 _dbus_assert (find_handler (tree, path3, &exact_match) && !exact_match);
1237 _dbus_assert (find_handler (tree, path4, &exact_match) && !exact_match);
1238 _dbus_assert (find_handler (tree, path5, &exact_match) == tree->root && !exact_match);
1239 _dbus_assert (find_handler (tree, path6, &exact_match) == tree->root && !exact_match);
1240 _dbus_assert (find_handler (tree, path7, &exact_match) == tree->root && !exact_match);
1241 _dbus_assert (find_handler (tree, path8, &exact_match) == tree->root && !exact_match);
1243 if (!do_register (tree, path2, TRUE, 1, tree_test_data))
1246 _dbus_assert (find_subtree (tree, path1, NULL));
1247 _dbus_assert (find_subtree (tree, path2, NULL));
1248 _dbus_assert (!find_subtree (tree, path3, NULL));
1249 _dbus_assert (!find_subtree (tree, path4, NULL));
1250 _dbus_assert (!find_subtree (tree, path5, NULL));
1251 _dbus_assert (!find_subtree (tree, path6, NULL));
1252 _dbus_assert (!find_subtree (tree, path7, NULL));
1253 _dbus_assert (!find_subtree (tree, path8, NULL));
1255 if (!do_register (tree, path3, TRUE, 2, tree_test_data))
1258 _dbus_assert (find_subtree (tree, path1, NULL));
1259 _dbus_assert (find_subtree (tree, path2, NULL));
1260 _dbus_assert (find_subtree (tree, path3, NULL));
1261 _dbus_assert (!find_subtree (tree, path4, NULL));
1262 _dbus_assert (!find_subtree (tree, path5, NULL));
1263 _dbus_assert (!find_subtree (tree, path6, NULL));
1264 _dbus_assert (!find_subtree (tree, path7, NULL));
1265 _dbus_assert (!find_subtree (tree, path8, NULL));
1267 if (!do_register (tree, path4, TRUE, 3, tree_test_data))
1270 _dbus_assert (find_subtree (tree, path1, NULL));
1271 _dbus_assert (find_subtree (tree, path2, NULL));
1272 _dbus_assert (find_subtree (tree, path3, NULL));
1273 _dbus_assert (find_subtree (tree, path4, NULL));
1274 _dbus_assert (!find_subtree (tree, path5, NULL));
1275 _dbus_assert (!find_subtree (tree, path6, NULL));
1276 _dbus_assert (!find_subtree (tree, path7, NULL));
1277 _dbus_assert (!find_subtree (tree, path8, NULL));
1279 if (!do_register (tree, path5, TRUE, 4, tree_test_data))
1282 _dbus_assert (find_subtree (tree, path1, NULL));
1283 _dbus_assert (find_subtree (tree, path2, NULL));
1284 _dbus_assert (find_subtree (tree, path3, NULL));
1285 _dbus_assert (find_subtree (tree, path4, NULL));
1286 _dbus_assert (find_subtree (tree, path5, NULL));
1287 _dbus_assert (!find_subtree (tree, path6, NULL));
1288 _dbus_assert (!find_subtree (tree, path7, NULL));
1289 _dbus_assert (!find_subtree (tree, path8, NULL));
1291 _dbus_assert (find_handler (tree, path1, &exact_match) != tree->root && exact_match);
1292 _dbus_assert (find_handler (tree, path2, &exact_match) != tree->root && exact_match);
1293 _dbus_assert (find_handler (tree, path3, &exact_match) != tree->root && exact_match);
1294 _dbus_assert (find_handler (tree, path4, &exact_match) != tree->root && exact_match);
1295 _dbus_assert (find_handler (tree, path5, &exact_match) != tree->root && exact_match);
1296 _dbus_assert (find_handler (tree, path6, &exact_match) != tree->root && !exact_match);
1297 _dbus_assert (find_handler (tree, path7, &exact_match) != tree->root && !exact_match);
1298 _dbus_assert (find_handler (tree, path8, &exact_match) == tree->root && !exact_match);
1300 if (!do_register (tree, path6, TRUE, 5, tree_test_data))
1303 _dbus_assert (find_subtree (tree, path1, NULL));
1304 _dbus_assert (find_subtree (tree, path2, NULL));
1305 _dbus_assert (find_subtree (tree, path3, NULL));
1306 _dbus_assert (find_subtree (tree, path4, NULL));
1307 _dbus_assert (find_subtree (tree, path5, NULL));
1308 _dbus_assert (find_subtree (tree, path6, NULL));
1309 _dbus_assert (!find_subtree (tree, path7, NULL));
1310 _dbus_assert (!find_subtree (tree, path8, NULL));
1312 if (!do_register (tree, path7, TRUE, 6, tree_test_data))
1315 _dbus_assert (find_subtree (tree, path1, NULL));
1316 _dbus_assert (find_subtree (tree, path2, NULL));
1317 _dbus_assert (find_subtree (tree, path3, NULL));
1318 _dbus_assert (find_subtree (tree, path4, NULL));
1319 _dbus_assert (find_subtree (tree, path5, NULL));
1320 _dbus_assert (find_subtree (tree, path6, NULL));
1321 _dbus_assert (find_subtree (tree, path7, NULL));
1322 _dbus_assert (!find_subtree (tree, path8, NULL));
1324 if (!do_register (tree, path8, TRUE, 7, tree_test_data))
1327 _dbus_assert (find_subtree (tree, path1, NULL));
1328 _dbus_assert (find_subtree (tree, path2, NULL));
1329 _dbus_assert (find_subtree (tree, path3, NULL));
1330 _dbus_assert (find_subtree (tree, path4, NULL));
1331 _dbus_assert (find_subtree (tree, path5, NULL));
1332 _dbus_assert (find_subtree (tree, path6, NULL));
1333 _dbus_assert (find_subtree (tree, path7, NULL));
1334 _dbus_assert (find_subtree (tree, path8, NULL));
1336 _dbus_assert (find_handler (tree, path1, &exact_match) != tree->root && exact_match);
1337 _dbus_assert (find_handler (tree, path2, &exact_match) != tree->root && exact_match);
1338 _dbus_assert (find_handler (tree, path3, &exact_match) != tree->root && exact_match);
1339 _dbus_assert (find_handler (tree, path4, &exact_match) != tree->root && exact_match);
1340 _dbus_assert (find_handler (tree, path5, &exact_match) != tree->root && exact_match);
1341 _dbus_assert (find_handler (tree, path6, &exact_match) != tree->root && exact_match);
1342 _dbus_assert (find_handler (tree, path7, &exact_match) != tree->root && exact_match);
1343 _dbus_assert (find_handler (tree, path8, &exact_match) != tree->root && exact_match);
1345 /* test the list_registered function */
1348 const char *root[] = { NULL };
1349 char **child_entries;
1352 _dbus_object_tree_list_registered_unlocked (tree, path1, &child_entries);
1353 if (child_entries != NULL)
1355 nb = string_array_length (child_entries);
1356 _dbus_assert (nb == 1);
1357 dbus_free_string_array (child_entries);
1360 _dbus_object_tree_list_registered_unlocked (tree, path2, &child_entries);
1361 if (child_entries != NULL)
1363 nb = string_array_length (child_entries);
1364 _dbus_assert (nb == 2);
1365 dbus_free_string_array (child_entries);
1368 _dbus_object_tree_list_registered_unlocked (tree, path8, &child_entries);
1369 if (child_entries != NULL)
1371 nb = string_array_length (child_entries);
1372 _dbus_assert (nb == 0);
1373 dbus_free_string_array (child_entries);
1376 _dbus_object_tree_list_registered_unlocked (tree, root, &child_entries);
1377 if (child_entries != NULL)
1379 nb = string_array_length (child_entries);
1380 _dbus_assert (nb == 3);
1381 dbus_free_string_array (child_entries);
1385 /* Check that destroying tree calls unregister funcs */
1386 _dbus_object_tree_unref (tree);
1389 while (i < (int) _DBUS_N_ELEMENTS (tree_test_data))
1391 _dbus_assert (tree_test_data[i].handler_unregistered);
1392 _dbus_assert (!tree_test_data[i].message_handled);
1396 /* Now start again and try the individual unregister function */
1397 tree = _dbus_object_tree_new (NULL);
1401 if (!do_register (tree, path1, TRUE, 0, tree_test_data))
1403 if (!do_register (tree, path2, TRUE, 1, tree_test_data))
1405 if (!do_register (tree, path3, TRUE, 2, tree_test_data))
1407 if (!do_register (tree, path4, TRUE, 3, tree_test_data))
1409 if (!do_register (tree, path5, TRUE, 4, tree_test_data))
1411 if (!do_register (tree, path6, TRUE, 5, tree_test_data))
1413 if (!do_register (tree, path7, TRUE, 6, tree_test_data))
1415 if (!do_register (tree, path8, TRUE, 7, tree_test_data))
1418 _dbus_object_tree_unregister_and_unlock (tree, path1);
1420 _dbus_assert (!find_subtree (tree, path1, NULL));
1421 _dbus_assert (find_subtree (tree, path2, NULL));
1422 _dbus_assert (find_subtree (tree, path3, NULL));
1423 _dbus_assert (find_subtree (tree, path4, NULL));
1424 _dbus_assert (find_subtree (tree, path5, NULL));
1425 _dbus_assert (find_subtree (tree, path6, NULL));
1426 _dbus_assert (find_subtree (tree, path7, NULL));
1427 _dbus_assert (find_subtree (tree, path8, NULL));
1429 _dbus_object_tree_unregister_and_unlock (tree, path2);
1431 _dbus_assert (!find_subtree (tree, path1, NULL));
1432 _dbus_assert (!find_subtree (tree, path2, NULL));
1433 _dbus_assert (find_subtree (tree, path3, NULL));
1434 _dbus_assert (find_subtree (tree, path4, NULL));
1435 _dbus_assert (find_subtree (tree, path5, NULL));
1436 _dbus_assert (find_subtree (tree, path6, NULL));
1437 _dbus_assert (find_subtree (tree, path7, NULL));
1438 _dbus_assert (find_subtree (tree, path8, NULL));
1440 _dbus_object_tree_unregister_and_unlock (tree, path3);
1442 _dbus_assert (!find_subtree (tree, path1, NULL));
1443 _dbus_assert (!find_subtree (tree, path2, NULL));
1444 _dbus_assert (!find_subtree (tree, path3, NULL));
1445 _dbus_assert (find_subtree (tree, path4, NULL));
1446 _dbus_assert (find_subtree (tree, path5, NULL));
1447 _dbus_assert (find_subtree (tree, path6, NULL));
1448 _dbus_assert (find_subtree (tree, path7, NULL));
1449 _dbus_assert (find_subtree (tree, path8, NULL));
1451 _dbus_object_tree_unregister_and_unlock (tree, path4);
1453 _dbus_assert (!find_subtree (tree, path1, NULL));
1454 _dbus_assert (!find_subtree (tree, path2, NULL));
1455 _dbus_assert (!find_subtree (tree, path3, NULL));
1456 _dbus_assert (!find_subtree (tree, path4, NULL));
1457 _dbus_assert (find_subtree (tree, path5, NULL));
1458 _dbus_assert (find_subtree (tree, path6, NULL));
1459 _dbus_assert (find_subtree (tree, path7, NULL));
1460 _dbus_assert (find_subtree (tree, path8, NULL));
1462 _dbus_object_tree_unregister_and_unlock (tree, path5);
1464 _dbus_assert (!find_subtree (tree, path1, NULL));
1465 _dbus_assert (!find_subtree (tree, path2, NULL));
1466 _dbus_assert (!find_subtree (tree, path3, NULL));
1467 _dbus_assert (!find_subtree (tree, path4, NULL));
1468 _dbus_assert (!find_subtree (tree, path5, NULL));
1469 _dbus_assert (find_subtree (tree, path6, NULL));
1470 _dbus_assert (find_subtree (tree, path7, NULL));
1471 _dbus_assert (find_subtree (tree, path8, NULL));
1473 _dbus_object_tree_unregister_and_unlock (tree, path6);
1475 _dbus_assert (!find_subtree (tree, path1, NULL));
1476 _dbus_assert (!find_subtree (tree, path2, NULL));
1477 _dbus_assert (!find_subtree (tree, path3, NULL));
1478 _dbus_assert (!find_subtree (tree, path4, NULL));
1479 _dbus_assert (!find_subtree (tree, path5, NULL));
1480 _dbus_assert (!find_subtree (tree, path6, NULL));
1481 _dbus_assert (find_subtree (tree, path7, NULL));
1482 _dbus_assert (find_subtree (tree, path8, NULL));
1484 _dbus_object_tree_unregister_and_unlock (tree, path7);
1486 _dbus_assert (!find_subtree (tree, path1, NULL));
1487 _dbus_assert (!find_subtree (tree, path2, NULL));
1488 _dbus_assert (!find_subtree (tree, path3, NULL));
1489 _dbus_assert (!find_subtree (tree, path4, NULL));
1490 _dbus_assert (!find_subtree (tree, path5, NULL));
1491 _dbus_assert (!find_subtree (tree, path6, NULL));
1492 _dbus_assert (!find_subtree (tree, path7, NULL));
1493 _dbus_assert (find_subtree (tree, path8, NULL));
1495 _dbus_object_tree_unregister_and_unlock (tree, path8);
1497 _dbus_assert (!find_subtree (tree, path1, NULL));
1498 _dbus_assert (!find_subtree (tree, path2, NULL));
1499 _dbus_assert (!find_subtree (tree, path3, NULL));
1500 _dbus_assert (!find_subtree (tree, path4, NULL));
1501 _dbus_assert (!find_subtree (tree, path5, NULL));
1502 _dbus_assert (!find_subtree (tree, path6, NULL));
1503 _dbus_assert (!find_subtree (tree, path7, NULL));
1504 _dbus_assert (!find_subtree (tree, path8, NULL));
1507 while (i < (int) _DBUS_N_ELEMENTS (tree_test_data))
1509 _dbus_assert (tree_test_data[i].handler_unregistered);
1510 _dbus_assert (!tree_test_data[i].message_handled);
1514 /* Register it all again, and test dispatch */
1516 if (!do_register (tree, path1, FALSE, 0, tree_test_data))
1518 if (!do_register (tree, path2, TRUE, 1, tree_test_data))
1520 if (!do_register (tree, path3, TRUE, 2, tree_test_data))
1522 if (!do_register (tree, path4, TRUE, 3, tree_test_data))
1524 if (!do_register (tree, path5, TRUE, 4, tree_test_data))
1526 if (!do_register (tree, path6, FALSE, 5, tree_test_data))
1528 if (!do_register (tree, path7, TRUE, 6, tree_test_data))
1530 if (!do_register (tree, path8, TRUE, 7, tree_test_data))
1537 if (!do_test_dispatch (tree, path1, 0, tree_test_data, _DBUS_N_ELEMENTS (tree_test_data)))
1539 if (!do_test_dispatch (tree, path2, 1, tree_test_data, _DBUS_N_ELEMENTS (tree_test_data)))
1541 if (!do_test_dispatch (tree, path3, 2, tree_test_data, _DBUS_N_ELEMENTS (tree_test_data)))
1543 if (!do_test_dispatch (tree, path4, 3, tree_test_data, _DBUS_N_ELEMENTS (tree_test_data)))
1545 if (!do_test_dispatch (tree, path5, 4, tree_test_data, _DBUS_N_ELEMENTS (tree_test_data)))
1547 if (!do_test_dispatch (tree, path6, 5, tree_test_data, _DBUS_N_ELEMENTS (tree_test_data)))
1549 if (!do_test_dispatch (tree, path7, 6, tree_test_data, _DBUS_N_ELEMENTS (tree_test_data)))
1551 if (!do_test_dispatch (tree, path8, 7, tree_test_data, _DBUS_N_ELEMENTS (tree_test_data)))
1558 _dbus_object_tree_ref (tree);
1559 _dbus_object_tree_unref (tree);
1560 _dbus_object_tree_unref (tree);
1567 * @ingroup DBusObjectTree
1568 * Unit test for DBusObjectTree
1569 * @returns #TRUE on success.
1572 _dbus_object_tree_test (void)
1574 _dbus_test_oom_handling ("object tree",
1575 object_tree_test_iteration,
1581 #endif /* DBUS_BUILD_TESTS */