2 * Copyright (C) 2000 Red Hat, Inc., Jonathan Blandford <jrb@redhat.com>
4 * This library is free software; you can redistribute it and/or
5 * modify it under the terms of the GNU Library General Public
6 * License as published by the Free Software Foundation; either
7 * version 2 of the License, or (at your option) any later version.
9 * This library is distributed in the hope that it will be useful,
10 * but WITHOUT ANY WARRANTY; without even the implied warranty of
11 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
12 * Library General Public License for more details.
14 * You should have received a copy of the GNU Library General Public
15 * License along with this library; if not, write to the
16 * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
17 * Boston, MA 02111-1307, USA.
21 #include "gtkrbtree.h"
24 static GtkRBNode * _gtk_rbnode_new (GtkRBTree *tree,
26 static void _gtk_rbnode_free (GtkRBNode *node);
27 static void _gtk_rbnode_rotate_left (GtkRBTree *tree,
29 static void _gtk_rbnode_rotate_right (GtkRBTree *tree,
31 static void _gtk_rbtree_insert_fixup (GtkRBTree *tree,
33 static void _gtk_rbtree_remove_node_fixup (GtkRBTree *tree,
35 static inline void _fixup_validation (GtkRBTree *tree,
37 static inline void _fixup_parity (GtkRBTree *tree,
43 _gtk_rbnode_new (GtkRBTree *tree,
46 GtkRBNode *node = g_slice_new (GtkRBNode);
48 node->left = tree->nil;
49 node->right = tree->nil;
50 node->parent = tree->nil;
51 node->flags = GTK_RBNODE_RED;
54 node->children = NULL;
55 node->offset = height;
60 _gtk_rbnode_free (GtkRBNode *node)
62 if (gtk_get_debug_flags () & GTK_DEBUG_TREE)
64 node->left = (gpointer) 0xdeadbeef;
65 node->right = (gpointer) 0xdeadbeef;
66 node->parent = (gpointer) 0xdeadbeef;
71 g_slice_free (GtkRBNode, node);
75 _gtk_rbnode_rotate_left (GtkRBTree *tree,
78 gint node_height, right_height;
79 GtkRBNode *right = node->right;
81 g_return_if_fail (node != tree->nil);
83 node_height = node->offset -
84 (node->left?node->left->offset:0) -
85 (node->right?node->right->offset:0) -
86 (node->children?node->children->root->offset:0);
87 right_height = right->offset -
88 (right->left?right->left->offset:0) -
89 (right->right?right->right->offset:0) -
90 (right->children?right->children->root->offset:0);
91 node->right = right->left;
92 if (right->left != tree->nil)
93 right->left->parent = node;
95 if (right != tree->nil)
96 right->parent = node->parent;
97 if (node->parent != tree->nil)
99 if (node == node->parent->left)
100 node->parent->left = right;
102 node->parent->right = right;
108 if (node != tree->nil)
109 node->parent = right;
111 node->count = 1 + (node->left?node->left->count:0) +
112 (node->right?node->right->count:0);
113 right->count = 1 + (right->left?right->left->count:0) +
114 (right->right?right->right->count:0);
116 node->offset = node_height +
117 (node->left?node->left->offset:0) +
118 (node->right?node->right->offset:0) +
119 (node->children?node->children->root->offset:0);
120 right->offset = right_height +
121 (right->left?right->left->offset:0) +
122 (right->right?right->right->offset:0) +
123 (right->children?right->children->root->offset:0);
125 _fixup_validation (tree, node);
126 _fixup_validation (tree, right);
127 _fixup_parity (tree, node);
128 _fixup_parity (tree, right);
132 _gtk_rbnode_rotate_right (GtkRBTree *tree,
135 gint node_height, left_height;
136 GtkRBNode *left = node->left;
138 g_return_if_fail (node != tree->nil);
140 node_height = node->offset -
141 (node->left?node->left->offset:0) -
142 (node->right?node->right->offset:0) -
143 (node->children?node->children->root->offset:0);
144 left_height = left->offset -
145 (left->left?left->left->offset:0) -
146 (left->right?left->right->offset:0) -
147 (left->children?left->children->root->offset:0);
149 node->left = left->right;
150 if (left->right != tree->nil)
151 left->right->parent = node;
153 if (left != tree->nil)
154 left->parent = node->parent;
155 if (node->parent != tree->nil)
157 if (node == node->parent->right)
158 node->parent->right = left;
160 node->parent->left = left;
167 /* link node and left */
169 if (node != tree->nil)
172 node->count = 1 + (node->left?node->left->count:0) +
173 (node->right?node->right->count:0);
174 left->count = 1 + (left->left?left->left->count:0) +
175 (left->right?left->right->count:0);
177 node->offset = node_height +
178 (node->left?node->left->offset:0) +
179 (node->right?node->right->offset:0) +
180 (node->children?node->children->root->offset:0);
181 left->offset = left_height +
182 (left->left?left->left->offset:0) +
183 (left->right?left->right->offset:0) +
184 (left->children?left->children->root->offset:0);
186 _fixup_validation (tree, node);
187 _fixup_validation (tree, left);
188 _fixup_parity (tree, node);
189 _fixup_parity (tree, left);
193 _gtk_rbtree_insert_fixup (GtkRBTree *tree,
197 /* check Red-Black properties */
198 while (node != tree->root && GTK_RBNODE_GET_COLOR (node->parent) == GTK_RBNODE_RED)
200 /* we have a violation */
201 if (node->parent == node->parent->parent->left)
203 GtkRBNode *y = node->parent->parent->right;
204 if (GTK_RBNODE_GET_COLOR (y) == GTK_RBNODE_RED)
206 /* uncle is GTK_RBNODE_RED */
207 GTK_RBNODE_SET_COLOR (node->parent, GTK_RBNODE_BLACK);
208 GTK_RBNODE_SET_COLOR (y, GTK_RBNODE_BLACK);
209 GTK_RBNODE_SET_COLOR (node->parent->parent, GTK_RBNODE_RED);
210 node = node->parent->parent;
214 /* uncle is GTK_RBNODE_BLACK */
215 if (node == node->parent->right)
217 /* make node a left child */
219 _gtk_rbnode_rotate_left (tree, node);
222 /* recolor and rotate */
223 GTK_RBNODE_SET_COLOR (node->parent, GTK_RBNODE_BLACK);
224 GTK_RBNODE_SET_COLOR (node->parent->parent, GTK_RBNODE_RED);
225 _gtk_rbnode_rotate_right(tree, node->parent->parent);
230 /* mirror image of above code */
231 GtkRBNode *y = node->parent->parent->left;
232 if (GTK_RBNODE_GET_COLOR (y) == GTK_RBNODE_RED)
234 /* uncle is GTK_RBNODE_RED */
235 GTK_RBNODE_SET_COLOR (node->parent, GTK_RBNODE_BLACK);
236 GTK_RBNODE_SET_COLOR (y, GTK_RBNODE_BLACK);
237 GTK_RBNODE_SET_COLOR (node->parent->parent, GTK_RBNODE_RED);
238 node = node->parent->parent;
242 /* uncle is GTK_RBNODE_BLACK */
243 if (node == node->parent->left)
246 _gtk_rbnode_rotate_right (tree, node);
248 GTK_RBNODE_SET_COLOR (node->parent, GTK_RBNODE_BLACK);
249 GTK_RBNODE_SET_COLOR (node->parent->parent, GTK_RBNODE_RED);
250 _gtk_rbnode_rotate_left (tree, node->parent->parent);
254 GTK_RBNODE_SET_COLOR (tree->root, GTK_RBNODE_BLACK);
258 _gtk_rbtree_remove_node_fixup (GtkRBTree *tree,
261 while (node != tree->root && GTK_RBNODE_GET_COLOR (node) == GTK_RBNODE_BLACK)
263 if (node == node->parent->left)
265 GtkRBNode *w = node->parent->right;
266 if (GTK_RBNODE_GET_COLOR (w) == GTK_RBNODE_RED)
268 GTK_RBNODE_SET_COLOR (w, GTK_RBNODE_BLACK);
269 GTK_RBNODE_SET_COLOR (node->parent, GTK_RBNODE_RED);
270 _gtk_rbnode_rotate_left (tree, node->parent);
271 w = node->parent->right;
273 if (GTK_RBNODE_GET_COLOR (w->left) == GTK_RBNODE_BLACK && GTK_RBNODE_GET_COLOR (w->right) == GTK_RBNODE_BLACK)
275 GTK_RBNODE_SET_COLOR (w, GTK_RBNODE_RED);
280 if (GTK_RBNODE_GET_COLOR (w->right) == GTK_RBNODE_BLACK)
282 GTK_RBNODE_SET_COLOR (w->left, GTK_RBNODE_BLACK);
283 GTK_RBNODE_SET_COLOR (w, GTK_RBNODE_RED);
284 _gtk_rbnode_rotate_right (tree, w);
285 w = node->parent->right;
287 GTK_RBNODE_SET_COLOR (w, GTK_RBNODE_GET_COLOR (node->parent));
288 GTK_RBNODE_SET_COLOR (node->parent, GTK_RBNODE_BLACK);
289 GTK_RBNODE_SET_COLOR (w->right, GTK_RBNODE_BLACK);
290 _gtk_rbnode_rotate_left (tree, node->parent);
296 GtkRBNode *w = node->parent->left;
297 if (GTK_RBNODE_GET_COLOR (w) == GTK_RBNODE_RED)
299 GTK_RBNODE_SET_COLOR (w, GTK_RBNODE_BLACK);
300 GTK_RBNODE_SET_COLOR (node->parent, GTK_RBNODE_RED);
301 _gtk_rbnode_rotate_right (tree, node->parent);
302 w = node->parent->left;
304 if (GTK_RBNODE_GET_COLOR (w->right) == GTK_RBNODE_BLACK && GTK_RBNODE_GET_COLOR (w->left) == GTK_RBNODE_BLACK)
306 GTK_RBNODE_SET_COLOR (w, GTK_RBNODE_RED);
311 if (GTK_RBNODE_GET_COLOR (w->left) == GTK_RBNODE_BLACK)
313 GTK_RBNODE_SET_COLOR (w->right, GTK_RBNODE_BLACK);
314 GTK_RBNODE_SET_COLOR (w, GTK_RBNODE_RED);
315 _gtk_rbnode_rotate_left (tree, w);
316 w = node->parent->left;
318 GTK_RBNODE_SET_COLOR (w, GTK_RBNODE_GET_COLOR (node->parent));
319 GTK_RBNODE_SET_COLOR (node->parent, GTK_RBNODE_BLACK);
320 GTK_RBNODE_SET_COLOR (w->left, GTK_RBNODE_BLACK);
321 _gtk_rbnode_rotate_right (tree, node->parent);
326 GTK_RBNODE_SET_COLOR (node, GTK_RBNODE_BLACK);
330 _gtk_rbtree_new (void)
334 retval = g_new (GtkRBTree, 1);
335 retval->parent_tree = NULL;
336 retval->parent_node = NULL;
338 retval->nil = g_slice_new (GtkRBNode);
339 retval->nil->left = NULL;
340 retval->nil->right = NULL;
341 retval->nil->parent = NULL;
342 retval->nil->flags = GTK_RBNODE_BLACK;
343 retval->nil->count = 0;
344 retval->nil->offset = 0;
345 retval->nil->parity = 0;
347 retval->root = retval->nil;
352 _gtk_rbtree_free_helper (GtkRBTree *tree,
357 _gtk_rbtree_free (node->children);
359 _gtk_rbnode_free (node);
363 _gtk_rbtree_free (GtkRBTree *tree)
365 _gtk_rbtree_traverse (tree,
368 _gtk_rbtree_free_helper,
371 if (tree->parent_node &&
372 tree->parent_node->children == tree)
373 tree->parent_node->children = NULL;
374 _gtk_rbnode_free (tree->nil);
379 _gtk_rbtree_remove (GtkRBTree *tree)
384 gint height = tree->root->offset;
386 #ifdef G_ENABLE_DEBUG
387 if (gtk_get_debug_flags () & GTK_DEBUG_TREE)
388 _gtk_rbtree_test (G_STRLOC, tree);
391 tmp_tree = tree->parent_tree;
392 tmp_node = tree->parent_node;
394 /* ugly hack to make _fixup_validation work in the first iteration of the
396 GTK_RBNODE_UNSET_FLAG (tree->root, GTK_RBNODE_DESCENDANTS_INVALID);
398 while (tmp_tree && tmp_node && tmp_node != tmp_tree->nil)
400 _fixup_validation (tmp_tree, tmp_node);
401 tmp_node->offset -= height;
403 /* If the removed tree was odd, flip all parents */
404 if (tree->root->parity)
405 tmp_node->parity = !tmp_node->parity;
407 tmp_node = tmp_node->parent;
408 if (tmp_node == tmp_tree->nil)
410 tmp_node = tmp_tree->parent_node;
411 tmp_tree = tmp_tree->parent_tree;
415 tmp_tree = tree->parent_tree;
416 tmp_node = tree->parent_node;
417 _gtk_rbtree_free (tree);
419 #ifdef G_ENABLE_DEBUG
420 if (gtk_get_debug_flags () & GTK_DEBUG_TREE)
421 _gtk_rbtree_test (G_STRLOC, tmp_tree);
427 _gtk_rbtree_insert_after (GtkRBTree *tree,
433 gboolean right = TRUE;
437 #ifdef G_ENABLE_DEBUG
438 if (gtk_get_debug_flags () & GTK_DEBUG_TREE)
440 g_print ("\n\n_gtk_rbtree_insert_after: %p\n", current);
441 _gtk_rbtree_debug_spew (tree);
442 _gtk_rbtree_test (G_STRLOC, tree);
444 #endif /* G_ENABLE_DEBUG */
446 if (current != NULL && current->right != tree->nil)
448 current = current->right;
449 while (current->left != tree->nil)
450 current = current->left;
454 node = _gtk_rbnode_new (tree, height);
455 node->parent = (current?current:tree->nil);
457 /* insert node in tree */
461 current->right = node;
463 current->left = node;
464 tmp_node = node->parent;
470 tmp_node = tree->parent_node;
471 tmp_tree = tree->parent_tree;
474 while (tmp_tree && tmp_node && tmp_node != tmp_tree->nil)
476 /* We only want to propagate the count if we are in the tree we
478 if (tmp_tree == tree)
481 tmp_node->parity += 1;
482 tmp_node->offset += height;
483 tmp_node = tmp_node->parent;
484 if (tmp_node == tmp_tree->nil)
486 tmp_node = tmp_tree->parent_node;
487 tmp_tree = tmp_tree->parent_tree;
492 _gtk_rbtree_node_mark_valid (tree, node);
494 _gtk_rbtree_node_mark_invalid (tree, node);
496 _gtk_rbtree_insert_fixup (tree, node);
498 #ifdef G_ENABLE_DEBUG
499 if (gtk_get_debug_flags () & GTK_DEBUG_TREE)
501 g_print ("_gtk_rbtree_insert_after finished...\n");
502 _gtk_rbtree_debug_spew (tree);
504 _gtk_rbtree_test (G_STRLOC, tree);
506 #endif /* G_ENABLE_DEBUG */
512 _gtk_rbtree_insert_before (GtkRBTree *tree,
518 gboolean left = TRUE;
522 #ifdef G_ENABLE_DEBUG
523 if (gtk_get_debug_flags () & GTK_DEBUG_TREE)
525 g_print ("\n\n_gtk_rbtree_insert_before: %p\n", current);
526 _gtk_rbtree_debug_spew (tree);
527 _gtk_rbtree_test (G_STRLOC, tree);
529 #endif /* G_ENABLE_DEBUG */
531 if (current != NULL && current->left != tree->nil)
533 current = current->left;
534 while (current->right != tree->nil)
535 current = current->right;
540 node = _gtk_rbnode_new (tree, height);
541 node->parent = (current?current:tree->nil);
543 /* insert node in tree */
547 current->left = node;
549 current->right = node;
550 tmp_node = node->parent;
556 tmp_node = tree->parent_node;
557 tmp_tree = tree->parent_tree;
560 while (tmp_tree && tmp_node && tmp_node != tmp_tree->nil)
562 /* We only want to propagate the count if we are in the tree we
564 if (tmp_tree == tree)
567 tmp_node->parity += 1;
568 tmp_node->offset += height;
569 tmp_node = tmp_node->parent;
570 if (tmp_node == tmp_tree->nil)
572 tmp_node = tmp_tree->parent_node;
573 tmp_tree = tmp_tree->parent_tree;
578 _gtk_rbtree_node_mark_valid (tree, node);
580 _gtk_rbtree_node_mark_invalid (tree, node);
582 _gtk_rbtree_insert_fixup (tree, node);
584 #ifdef G_ENABLE_DEBUG
585 if (gtk_get_debug_flags () & GTK_DEBUG_TREE)
587 g_print ("_gtk_rbtree_insert_before finished...\n");
588 _gtk_rbtree_debug_spew (tree);
590 _gtk_rbtree_test (G_STRLOC, tree);
592 #endif /* G_ENABLE_DEBUG */
598 _gtk_rbtree_find_count (GtkRBTree *tree,
604 while (node != tree->nil && (node->left->count + 1 != count))
606 if (node->left->count >= count)
610 count -= (node->left->count + 1);
614 if (node == tree->nil)
620 _gtk_rbtree_node_set_height (GtkRBTree *tree,
624 gint diff = height - GTK_RBNODE_GET_HEIGHT (node);
625 GtkRBNode *tmp_node = node;
626 GtkRBTree *tmp_tree = tree;
631 while (tmp_tree && tmp_node && tmp_node != tmp_tree->nil)
633 tmp_node->offset += diff;
634 tmp_node = tmp_node->parent;
635 if (tmp_node == tmp_tree->nil)
637 tmp_node = tmp_tree->parent_node;
638 tmp_tree = tmp_tree->parent_tree;
641 #ifdef G_ENABLE_DEBUG
642 if (gtk_get_debug_flags () & GTK_DEBUG_TREE)
643 _gtk_rbtree_test (G_STRLOC, tree);
648 _gtk_rbtree_node_mark_invalid (GtkRBTree *tree,
651 if (GTK_RBNODE_FLAG_SET (node, GTK_RBNODE_INVALID))
654 GTK_RBNODE_SET_FLAG (node, GTK_RBNODE_INVALID);
657 if (GTK_RBNODE_FLAG_SET (node, GTK_RBNODE_DESCENDANTS_INVALID))
659 GTK_RBNODE_SET_FLAG (node, GTK_RBNODE_DESCENDANTS_INVALID);
661 if (node == tree->nil)
663 node = tree->parent_node;
664 tree = tree->parent_tree;
671 /* Draconian version. */
673 _gtk_rbtree_node_mark_invalid (GtkRBTree *tree,
676 GTK_RBNODE_SET_FLAG (node, GTK_RBNODE_INVALID);
679 _fixup_validation (tree, node);
681 if (node == tree->nil)
683 node = tree->parent_node;
684 tree = tree->parent_tree;
692 _gtk_rbtree_node_mark_valid (GtkRBTree *tree,
695 if ((!GTK_RBNODE_FLAG_SET (node, GTK_RBNODE_INVALID)) &&
696 (!GTK_RBNODE_FLAG_SET (node, GTK_RBNODE_COLUMN_INVALID)))
699 GTK_RBNODE_UNSET_FLAG (node, GTK_RBNODE_INVALID);
700 GTK_RBNODE_UNSET_FLAG (node, GTK_RBNODE_COLUMN_INVALID);
704 if ((GTK_RBNODE_FLAG_SET (node, GTK_RBNODE_INVALID)) ||
705 (GTK_RBNODE_FLAG_SET (node, GTK_RBNODE_COLUMN_INVALID)) ||
706 (node->children && GTK_RBNODE_FLAG_SET (node->children->root, GTK_RBNODE_DESCENDANTS_INVALID)) ||
707 (node->left != tree->nil && GTK_RBNODE_FLAG_SET (node->left, GTK_RBNODE_DESCENDANTS_INVALID)) ||
708 (node->right != tree->nil && GTK_RBNODE_FLAG_SET (node->right, GTK_RBNODE_DESCENDANTS_INVALID)))
711 GTK_RBNODE_UNSET_FLAG (node, GTK_RBNODE_DESCENDANTS_INVALID);
713 if (node == tree->nil)
715 node = tree->parent_node;
716 tree = tree->parent_tree;
723 /* Draconian version */
725 _gtk_rbtree_node_mark_valid (GtkRBTree *tree,
728 GTK_RBNODE_UNSET_FLAG (node, GTK_RBNODE_INVALID);
729 GTK_RBNODE_UNSET_FLAG (node, GTK_RBNODE_COLUMN_INVALID);
733 _fixup_validation (tree, node);
735 if (node == tree->nil)
737 node = tree->parent_node;
738 tree = tree->parent_tree;
744 /* Assume tree is the root node as it doesn't set DESCENDANTS_INVALID above.
747 _gtk_rbtree_column_invalid (GtkRBTree *tree)
756 while (node->left != tree->nil)
761 if (! (GTK_RBNODE_FLAG_SET (node, GTK_RBNODE_INVALID)))
762 GTK_RBNODE_SET_FLAG (node, GTK_RBNODE_COLUMN_INVALID);
763 GTK_RBNODE_SET_FLAG (node, GTK_RBNODE_DESCENDANTS_INVALID);
766 _gtk_rbtree_column_invalid (node->children);
768 while ((node = _gtk_rbtree_next (tree, node)) != NULL);
772 _gtk_rbtree_mark_invalid (GtkRBTree *tree)
781 while (node->left != tree->nil)
786 GTK_RBNODE_SET_FLAG (node, GTK_RBNODE_INVALID);
787 GTK_RBNODE_SET_FLAG (node, GTK_RBNODE_DESCENDANTS_INVALID);
790 _gtk_rbtree_mark_invalid (node->children);
792 while ((node = _gtk_rbtree_next (tree, node)) != NULL);
796 _gtk_rbtree_set_fixed_height (GtkRBTree *tree,
808 while (node->left != tree->nil)
813 if (GTK_RBNODE_FLAG_SET (node, GTK_RBNODE_INVALID))
815 _gtk_rbtree_node_set_height (tree, node, height);
817 _gtk_rbtree_node_mark_valid (tree, node);
821 _gtk_rbtree_set_fixed_height (node->children, height, mark_valid);
823 while ((node = _gtk_rbtree_next (tree, node)) != NULL);
826 typedef struct _GtkRBReorder
837 gtk_rbtree_reorder_sort_func (gconstpointer a,
840 return ((GtkRBReorder *) a)->order - ((GtkRBReorder *) b)->order;
844 gtk_rbtree_reorder_invert_func (gconstpointer a,
847 return ((GtkRBReorder *) a)->invert_order - ((GtkRBReorder *) b)->invert_order;
851 gtk_rbtree_reorder_fixup (GtkRBTree *tree,
854 if (node == tree->nil)
859 if (node->left != tree->nil)
861 gtk_rbtree_reorder_fixup (tree, node->left);
862 node->offset += node->left->offset;
863 node->parity += node->left->parity;
865 if (node->right != tree->nil)
867 gtk_rbtree_reorder_fixup (tree, node->right);
868 node->offset += node->right->offset;
869 node->parity += node->right->parity;
874 node->offset += node->children->root->offset;
875 node->parity += node->children->root->parity;
878 if (GTK_RBNODE_FLAG_SET (node, GTK_RBNODE_INVALID) ||
879 (node->right != tree->nil && GTK_RBNODE_FLAG_SET (node->right, GTK_RBNODE_DESCENDANTS_INVALID)) ||
880 (node->left != tree->nil && GTK_RBNODE_FLAG_SET (node->left, GTK_RBNODE_DESCENDANTS_INVALID)) ||
881 (node->children && GTK_RBNODE_FLAG_SET (node->children->root, GTK_RBNODE_DESCENDANTS_INVALID)))
882 GTK_RBNODE_SET_FLAG (node, GTK_RBNODE_DESCENDANTS_INVALID);
884 GTK_RBNODE_UNSET_FLAG (node, GTK_RBNODE_DESCENDANTS_INVALID);
887 /* It basically pulls everything out of the tree, rearranges it, and puts it
888 * back together. Our strategy is to keep the old RBTree intact, and just
889 * rearrange the contents. When that is done, we go through and update the
890 * heights. There is probably a more elegant way to write this function. If
891 * anyone wants to spend the time writing it, patches will be accepted.
894 _gtk_rbtree_reorder (GtkRBTree *tree,
898 GtkRBReorder reorder = { NULL };
903 g_return_if_fail (tree != NULL);
904 g_return_if_fail (length > 0);
905 g_return_if_fail (tree->root->count == length);
907 /* Sort the trees values in the new tree. */
908 array = g_array_sized_new (FALSE, FALSE, sizeof (GtkRBReorder), length);
909 for (i = 0; i < length; i++)
911 reorder.order = new_order[i];
912 reorder.invert_order = i;
913 g_array_append_val (array, reorder);
916 g_array_sort(array, gtk_rbtree_reorder_sort_func);
920 while (node && node->left != tree->nil)
923 for (i = 0; i < length; i++)
925 g_assert (node != tree->nil);
926 g_array_index (array, GtkRBReorder, i).children = node->children;
927 g_array_index (array, GtkRBReorder, i).flags = GTK_RBNODE_NON_COLORS & node->flags;
928 g_array_index (array, GtkRBReorder, i).height = GTK_RBNODE_GET_HEIGHT (node);
930 node = _gtk_rbtree_next (tree, node);
933 g_array_sort (array, gtk_rbtree_reorder_invert_func);
937 while (node && node->left != tree->nil)
940 /* Go through the tree and change the values to the new ones. */
941 for (i = 0; i < length; i++)
943 reorder = g_array_index (array, GtkRBReorder, i);
944 node->children = reorder.children;
946 node->children->parent_node = node;
947 node->flags = GTK_RBNODE_GET_COLOR (node) | reorder.flags;
948 /* We temporarily set the height to this. */
949 node->offset = reorder.height;
950 node = _gtk_rbtree_next (tree, node);
952 gtk_rbtree_reorder_fixup (tree, tree->root);
954 g_array_free (array, TRUE);
959 _gtk_rbtree_node_find_offset (GtkRBTree *tree,
966 g_assert (node->left);
968 retval = node->left->offset;
970 while (tree && node && node != tree->nil)
975 /* Add left branch, plus children, iff we came from the right */
976 if (node->right == last)
977 retval += node->offset - node->right->offset;
979 if (node == tree->nil)
981 node = tree->parent_node;
982 tree = tree->parent_tree;
984 /* Add the parent node, plus the left branch. */
986 retval += node->left->offset + GTK_RBNODE_GET_HEIGHT (node);
993 _gtk_rbtree_node_find_parity (GtkRBTree *tree,
1000 g_assert (node->left);
1002 retval = node->left->parity;
1004 while (tree && node && node != tree->nil)
1007 node = node->parent;
1009 /* Add left branch, plus children, iff we came from the right */
1010 if (node->right == last)
1011 retval += node->parity - node->right->parity;
1013 if (node == tree->nil)
1015 node = tree->parent_node;
1016 tree = tree->parent_tree;
1018 /* Add the parent node, plus the left branch. */
1020 retval += node->left->parity + 1; /* 1 == GTK_RBNODE_GET_PARITY() */
1028 _gtk_rbtree_real_find_offset (GtkRBTree *tree,
1030 GtkRBTree **new_tree,
1031 GtkRBNode **new_node)
1033 GtkRBNode *tmp_node;
1046 tmp_node = tree->root;
1047 while (tmp_node != tree->nil &&
1048 (tmp_node->left->offset > height ||
1049 (tmp_node->offset - tmp_node->right->offset) < height))
1051 if (tmp_node->left->offset > height)
1052 tmp_node = tmp_node->left;
1055 height -= (tmp_node->offset - tmp_node->right->offset);
1056 tmp_node = tmp_node->right;
1059 if (tmp_node == tree->nil)
1065 if (tmp_node->children)
1067 if ((tmp_node->offset -
1068 tmp_node->right->offset -
1069 tmp_node->children->root->offset) > height)
1072 *new_node = tmp_node;
1073 return (height - tmp_node->left->offset);
1075 return _gtk_rbtree_real_find_offset (tmp_node->children,
1076 height - tmp_node->left->offset -
1078 tmp_node->left->offset -
1079 tmp_node->right->offset -
1080 tmp_node->children->root->offset),
1085 *new_node = tmp_node;
1086 return (height - tmp_node->left->offset);
1090 _gtk_rbtree_find_offset (GtkRBTree *tree,
1092 GtkRBTree **new_tree,
1093 GtkRBNode **new_node)
1098 (height >= tree->root->offset))
1105 return _gtk_rbtree_real_find_offset (tree, height, new_tree, new_node);
1109 _gtk_rbtree_remove_node (GtkRBTree *tree,
1113 GtkRBTree *tmp_tree;
1114 GtkRBNode *tmp_node;
1117 g_return_if_fail (tree != NULL);
1118 g_return_if_fail (node != NULL);
1121 #ifdef G_ENABLE_DEBUG
1122 if (gtk_get_debug_flags () & GTK_DEBUG_TREE)
1124 g_print ("\n\n_gtk_rbtree_remove_node: %p\n", node);
1125 _gtk_rbtree_debug_spew (tree);
1126 _gtk_rbtree_test (G_STRLOC, tree);
1128 #endif /* G_ENABLE_DEBUG */
1130 /* make sure we're deleting a node that's actually in the tree */
1131 for (x = node; x->parent != tree->nil; x = x->parent)
1133 g_return_if_fail (x == tree->root);
1135 #ifdef G_ENABLE_DEBUG
1136 if (gtk_get_debug_flags () & GTK_DEBUG_TREE)
1137 _gtk_rbtree_test (G_STRLOC, tree);
1140 if (node->left == tree->nil || node->right == tree->nil)
1148 while (y->left != tree->nil)
1152 /* adjust count only beneath tree */
1153 for (x = y; x != tree->nil; x = x->parent)
1158 /* offsets and parity adjust all the way up through parent trees */
1159 y_height = GTK_RBNODE_GET_HEIGHT (y);
1163 while (tmp_tree && tmp_node && tmp_node != tmp_tree->nil)
1165 tmp_node->offset -= (y_height + (y->children?y->children->root->offset:0));
1166 _fixup_validation (tmp_tree, tmp_node);
1167 _fixup_parity (tmp_tree, tmp_node);
1168 tmp_node = tmp_node->parent;
1169 if (tmp_node == tmp_tree->nil)
1171 tmp_node = tmp_tree->parent_node;
1172 tmp_tree = tmp_tree->parent_tree;
1176 /* x is y's only child, or nil */
1177 if (y->left != tree->nil)
1182 /* remove y from the parent chain */
1183 x->parent = y->parent;
1184 if (y->parent != tree->nil)
1186 if (y == y->parent->left)
1187 y->parent->left = x;
1189 y->parent->right = x;
1196 /* We need to clean up the validity of the tree.
1203 /* We skip the first time, iff x is nil */
1204 if (tmp_node != tmp_tree->nil)
1206 _fixup_validation (tmp_tree, tmp_node);
1207 _fixup_parity (tmp_tree, tmp_node);
1209 tmp_node = tmp_node->parent;
1210 if (tmp_node == tmp_tree->nil)
1212 tmp_node = tmp_tree->parent_node;
1213 tmp_tree = tmp_tree->parent_tree;
1216 while (tmp_tree != NULL);
1222 /* Copy the node over */
1223 if (GTK_RBNODE_GET_COLOR (node) == GTK_RBNODE_BLACK)
1224 node->flags = ((y->flags & (GTK_RBNODE_NON_COLORS)) | GTK_RBNODE_BLACK);
1226 node->flags = ((y->flags & (GTK_RBNODE_NON_COLORS)) | GTK_RBNODE_RED);
1227 node->children = y->children;
1230 node->children = y->children;
1231 node->children->parent_node = node;
1235 node->children = NULL;
1237 _fixup_validation (tree, node);
1238 _fixup_parity (tree, node);
1239 /* We want to see how different our height is from the previous node.
1240 * To do this, we compare our current height with our supposed height.
1242 diff = y_height - GTK_RBNODE_GET_HEIGHT (node);
1246 while (tmp_tree && tmp_node && tmp_node != tmp_tree->nil)
1248 tmp_node->offset += diff;
1249 _fixup_validation (tmp_tree, tmp_node);
1250 _fixup_parity (tmp_tree, tmp_node);
1251 tmp_node = tmp_node->parent;
1252 if (tmp_node == tmp_tree->nil)
1254 tmp_node = tmp_tree->parent_node;
1255 tmp_tree = tmp_tree->parent_tree;
1260 if (GTK_RBNODE_GET_COLOR (y) == GTK_RBNODE_BLACK)
1261 _gtk_rbtree_remove_node_fixup (tree, x);
1262 _gtk_rbnode_free (y);
1264 #ifdef G_ENABLE_DEBUG
1265 if (gtk_get_debug_flags () & GTK_DEBUG_TREE)
1267 g_print ("_gtk_rbtree_remove_node finished...\n");
1268 _gtk_rbtree_debug_spew (tree);
1270 _gtk_rbtree_test (G_STRLOC, tree);
1272 #endif /* G_ENABLE_DEBUG */
1276 _gtk_rbtree_next (GtkRBTree *tree,
1279 g_return_val_if_fail (tree != NULL, NULL);
1280 g_return_val_if_fail (node != NULL, NULL);
1282 /* Case 1: the node's below us. */
1283 if (node->right != tree->nil)
1286 while (node->left != tree->nil)
1291 /* Case 2: it's an ancestor */
1292 while (node->parent != tree->nil)
1294 if (node->parent->right == node)
1295 node = node->parent;
1297 return (node->parent);
1300 /* Case 3: There is no next node */
1305 _gtk_rbtree_prev (GtkRBTree *tree,
1308 g_return_val_if_fail (tree != NULL, NULL);
1309 g_return_val_if_fail (node != NULL, NULL);
1311 /* Case 1: the node's below us. */
1312 if (node->left != tree->nil)
1315 while (node->right != tree->nil)
1320 /* Case 2: it's an ancestor */
1321 while (node->parent != tree->nil)
1323 if (node->parent->left == node)
1324 node = node->parent;
1326 return (node->parent);
1329 /* Case 3: There is no next node */
1334 _gtk_rbtree_next_full (GtkRBTree *tree,
1336 GtkRBTree **new_tree,
1337 GtkRBNode **new_node)
1339 g_return_if_fail (tree != NULL);
1340 g_return_if_fail (node != NULL);
1341 g_return_if_fail (new_tree != NULL);
1342 g_return_if_fail (new_node != NULL);
1346 *new_tree = node->children;
1347 *new_node = (*new_tree)->root;
1348 while ((*new_node)->left != (*new_tree)->nil)
1349 *new_node = (*new_node)->left;
1354 *new_node = _gtk_rbtree_next (tree, node);
1356 while ((*new_node == NULL) &&
1357 (*new_tree != NULL))
1359 *new_node = (*new_tree)->parent_node;
1360 *new_tree = (*new_tree)->parent_tree;
1362 *new_node = _gtk_rbtree_next (*new_tree, *new_node);
1367 _gtk_rbtree_prev_full (GtkRBTree *tree,
1369 GtkRBTree **new_tree,
1370 GtkRBNode **new_node)
1372 g_return_if_fail (tree != NULL);
1373 g_return_if_fail (node != NULL);
1374 g_return_if_fail (new_tree != NULL);
1375 g_return_if_fail (new_node != NULL);
1378 *new_node = _gtk_rbtree_prev (tree, node);
1380 if (*new_node == NULL)
1382 *new_node = (*new_tree)->parent_node;
1383 *new_tree = (*new_tree)->parent_tree;
1387 while ((*new_node)->children)
1389 *new_tree = (*new_node)->children;
1390 *new_node = (*new_tree)->root;
1391 while ((*new_node)->right != (*new_tree)->nil)
1392 *new_node = (*new_node)->right;
1398 _gtk_rbtree_get_depth (GtkRBTree *tree)
1400 GtkRBTree *tmp_tree;
1403 tmp_tree = tree->parent_tree;
1407 tmp_tree = tmp_tree->parent_tree;
1414 _gtk_rbtree_traverse_pre_order (GtkRBTree *tree,
1416 GtkRBTreeTraverseFunc func,
1419 if (node == tree->nil)
1422 (* func) (tree, node, data);
1423 _gtk_rbtree_traverse_pre_order (tree, node->left, func, data);
1424 _gtk_rbtree_traverse_pre_order (tree, node->right, func, data);
1428 _gtk_rbtree_traverse_post_order (GtkRBTree *tree,
1430 GtkRBTreeTraverseFunc func,
1433 if (node == tree->nil)
1436 _gtk_rbtree_traverse_post_order (tree, node->left, func, data);
1437 _gtk_rbtree_traverse_post_order (tree, node->right, func, data);
1438 (* func) (tree, node, data);
1442 _gtk_rbtree_traverse (GtkRBTree *tree,
1444 GTraverseType order,
1445 GtkRBTreeTraverseFunc func,
1448 g_return_if_fail (tree != NULL);
1449 g_return_if_fail (node != NULL);
1450 g_return_if_fail (func != NULL);
1451 g_return_if_fail (order <= G_LEVEL_ORDER);
1456 _gtk_rbtree_traverse_pre_order (tree, node, func, data);
1459 _gtk_rbtree_traverse_post_order (tree, node, func, data);
1464 g_warning ("unsupported traversal order.");
1470 void _fixup_validation (GtkRBTree *tree,
1473 if (GTK_RBNODE_FLAG_SET (node, GTK_RBNODE_INVALID) ||
1474 GTK_RBNODE_FLAG_SET (node, GTK_RBNODE_COLUMN_INVALID) ||
1475 (node->left != tree->nil && GTK_RBNODE_FLAG_SET (node->left, GTK_RBNODE_DESCENDANTS_INVALID)) ||
1476 (node->right != tree->nil && GTK_RBNODE_FLAG_SET (node->right, GTK_RBNODE_DESCENDANTS_INVALID)) ||
1477 (node->children != NULL && GTK_RBNODE_FLAG_SET (node->children->root, GTK_RBNODE_DESCENDANTS_INVALID)))
1479 GTK_RBNODE_SET_FLAG (node, GTK_RBNODE_DESCENDANTS_INVALID);
1483 GTK_RBNODE_UNSET_FLAG (node, GTK_RBNODE_DESCENDANTS_INVALID);
1488 void _fixup_parity (GtkRBTree *tree,
1492 (node->children != NULL ? node->children->root->parity : 0) +
1493 node->left->parity + node->right->parity;
1496 #ifdef G_ENABLE_DEBUG
1498 get_parity (GtkRBNode *node)
1500 guint child_total = 0;
1503 /* The parity of a node is node->parity minus
1504 * the parity of left, right, and children.
1506 * This is equivalent to saying that if left, right, children
1507 * sum to 0 parity, then node->parity is the parity of node,
1508 * and if left, right, children are odd parity, then
1509 * node->parity is the reverse of the node's parity.
1512 child_total += (guint) node->left->parity;
1513 child_total += (guint) node->right->parity;
1516 child_total += (guint) node->children->root->parity;
1518 rem = child_total % 2;
1521 return node->parity;
1523 return !node->parity;
1527 count_parity (GtkRBTree *tree,
1532 if (node == tree->nil)
1536 count_parity (tree, node->left) +
1537 count_parity (tree, node->right) +
1539 (node->children ? count_parity (node->children, node->children->root) : 0);
1541 res = res % (guint)2;
1543 if (res != node->parity)
1544 g_print ("parity incorrect for node\n");
1546 if (get_parity (node) != 1)
1547 g_error ("Node has incorrect parity %u", get_parity (node));
1553 _count_nodes (GtkRBTree *tree,
1557 if (node == tree->nil)
1560 g_assert (node->left);
1561 g_assert (node->right);
1563 res = (_count_nodes (tree, node->left) +
1564 _count_nodes (tree, node->right) + 1);
1566 if (res != node->count)
1567 g_print ("Tree failed\n");
1572 _gtk_rbtree_test_height (GtkRBTree *tree,
1575 gint computed_offset = 0;
1577 /* This whole test is sort of a useless truism. */
1579 if (node->left != tree->nil)
1580 computed_offset += node->left->offset;
1582 if (node->right != tree->nil)
1583 computed_offset += node->right->offset;
1585 if (node->children && node->children->root != node->children->nil)
1586 computed_offset += node->children->root->offset;
1588 if (GTK_RBNODE_GET_HEIGHT (node) + computed_offset != node->offset)
1589 g_error ("node has broken offset\n");
1591 if (node->left != tree->nil)
1592 _gtk_rbtree_test_height (tree, node->left);
1594 if (node->right != tree->nil)
1595 _gtk_rbtree_test_height (tree, node->right);
1597 if (node->children && node->children->root != node->children->nil)
1598 _gtk_rbtree_test_height (node->children, node->children->root);
1602 _gtk_rbtree_test_dirty (GtkRBTree *tree,
1604 gint expected_dirtyness)
1607 if (expected_dirtyness)
1609 g_assert (GTK_RBNODE_FLAG_SET (node, GTK_RBNODE_COLUMN_INVALID) ||
1610 GTK_RBNODE_FLAG_SET (node, GTK_RBNODE_INVALID) ||
1611 (node->left != tree->nil && GTK_RBNODE_FLAG_SET (node->left, GTK_RBNODE_DESCENDANTS_INVALID)) ||
1612 (node->right != tree->nil && GTK_RBNODE_FLAG_SET (node->right, GTK_RBNODE_DESCENDANTS_INVALID)) ||
1613 (node->children && GTK_RBNODE_FLAG_SET (node->children->root, GTK_RBNODE_DESCENDANTS_INVALID)));
1617 g_assert (! GTK_RBNODE_FLAG_SET (node, GTK_RBNODE_COLUMN_INVALID) &&
1618 ! GTK_RBNODE_FLAG_SET (node, GTK_RBNODE_INVALID));
1619 if (node->left != tree->nil)
1620 g_assert (! GTK_RBNODE_FLAG_SET (node->left, GTK_RBNODE_DESCENDANTS_INVALID));
1621 if (node->right != tree->nil)
1622 g_assert (! GTK_RBNODE_FLAG_SET (node->right, GTK_RBNODE_DESCENDANTS_INVALID));
1623 if (node->children != NULL)
1624 g_assert (! GTK_RBNODE_FLAG_SET (node->children->root, GTK_RBNODE_DESCENDANTS_INVALID));
1627 if (node->left != tree->nil)
1628 _gtk_rbtree_test_dirty (tree, node->left, GTK_RBNODE_FLAG_SET (node->left, GTK_RBNODE_DESCENDANTS_INVALID));
1629 if (node->right != tree->nil)
1630 _gtk_rbtree_test_dirty (tree, node->right, GTK_RBNODE_FLAG_SET (node->right, GTK_RBNODE_DESCENDANTS_INVALID));
1631 if (node->children != NULL && node->children->root != node->children->nil)
1632 _gtk_rbtree_test_dirty (node->children, node->children->root, GTK_RBNODE_FLAG_SET (node->children->root, GTK_RBNODE_DESCENDANTS_INVALID));
1635 static void _gtk_rbtree_test_structure (GtkRBTree *tree);
1638 _gtk_rbtree_test_structure_helper (GtkRBTree *tree,
1641 g_assert (node != tree->nil);
1643 g_assert (node->left != NULL);
1644 g_assert (node->right != NULL);
1645 g_assert (node->parent != NULL);
1647 if (node->left != tree->nil)
1649 g_assert (node->left->parent == node);
1650 _gtk_rbtree_test_structure_helper (tree, node->left);
1652 if (node->right != tree->nil)
1654 g_assert (node->right->parent == node);
1655 _gtk_rbtree_test_structure_helper (tree, node->right);
1658 if (node->children != NULL)
1660 g_assert (node->children->parent_tree == tree);
1661 g_assert (node->children->parent_node == node);
1663 _gtk_rbtree_test_structure (node->children);
1667 _gtk_rbtree_test_structure (GtkRBTree *tree)
1669 g_assert (tree->root);
1670 if (tree->root == tree->nil)
1673 g_assert (tree->root->parent == tree->nil);
1674 _gtk_rbtree_test_structure_helper (tree, tree->root);
1678 _gtk_rbtree_test (const gchar *where,
1681 GtkRBTree *tmp_tree;
1686 /* Test the entire tree */
1688 while (tmp_tree->parent_tree)
1689 tmp_tree = tmp_tree->parent_tree;
1691 g_assert (tmp_tree->nil != NULL);
1693 if (tmp_tree->root == tmp_tree->nil)
1696 _gtk_rbtree_test_structure (tmp_tree);
1698 g_assert ((_count_nodes (tmp_tree, tmp_tree->root->left) +
1699 _count_nodes (tmp_tree, tmp_tree->root->right) + 1) == tmp_tree->root->count);
1702 _gtk_rbtree_test_height (tmp_tree, tmp_tree->root);
1703 _gtk_rbtree_test_dirty (tmp_tree, tmp_tree->root, GTK_RBNODE_FLAG_SET (tmp_tree->root, GTK_RBNODE_DESCENDANTS_INVALID));
1704 g_assert (count_parity (tmp_tree, tmp_tree->root) == tmp_tree->root->parity);
1708 _gtk_rbtree_debug_spew_helper (GtkRBTree *tree,
1713 for (i = 0; i < depth; i++)
1716 g_print ("(%p - %s) (Offset %d) (Parity %d) (Validity %d%d%d)\n",
1718 (GTK_RBNODE_GET_COLOR (node) == GTK_RBNODE_BLACK)?"BLACK":" RED ",
1721 (GTK_RBNODE_FLAG_SET (node, GTK_RBNODE_DESCENDANTS_INVALID))?1:0,
1722 (GTK_RBNODE_FLAG_SET (node, GTK_RBNODE_INVALID))?1:0,
1723 (GTK_RBNODE_FLAG_SET (node, GTK_RBNODE_COLUMN_INVALID))?1:0);
1724 if (node->children != NULL)
1726 g_print ("Looking at child.\n");
1727 _gtk_rbtree_debug_spew (node->children);
1728 g_print ("Done looking at child.\n");
1730 if (node->left != tree->nil)
1732 _gtk_rbtree_debug_spew_helper (tree, node->left, depth+1);
1734 if (node->right != tree->nil)
1736 _gtk_rbtree_debug_spew_helper (tree, node->right, depth+1);
1741 _gtk_rbtree_debug_spew (GtkRBTree *tree)
1743 g_return_if_fail (tree != NULL);
1745 if (tree->root == tree->nil)
1746 g_print ("Empty tree...\n");
1748 _gtk_rbtree_debug_spew_helper (tree, tree->root, 0);
1750 #endif /* G_ENABLE_DEBUG */