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.
22 #include "gtkrbtree.h"
25 static void _gtk_rbnode_validate_allocator (GAllocator *allocator);
26 static GtkRBNode * _gtk_rbnode_new (GtkRBTree *tree,
28 static void _gtk_rbnode_free (GtkRBNode *node);
29 static void _gtk_rbnode_rotate_left (GtkRBTree *tree,
31 static void _gtk_rbnode_rotate_right (GtkRBTree *tree,
33 static void _gtk_rbtree_insert_fixup (GtkRBTree *tree,
35 static void _gtk_rbtree_remove_node_fixup (GtkRBTree *tree,
37 static gint _count_nodes (GtkRBTree *tree,
39 static inline void _fixup_validation (GtkRBTree *tree,
41 static inline void _fixup_parity (GtkRBTree *tree,
48 struct _GAllocator /* from gmem.c */
56 GtkRBNode *free_nodes; /* implementation specific */
60 G_LOCK_DEFINE_STATIC (current_allocator);
61 static GAllocator *current_allocator = NULL;
64 /* HOLDS: current_allocator_lock */
66 _gtk_rbnode_validate_allocator (GAllocator *allocator)
68 g_return_if_fail (allocator != NULL);
69 g_return_if_fail (allocator->is_unused == TRUE);
71 if (allocator->type != G_ALLOCATOR_NODE)
73 allocator->type = G_ALLOCATOR_NODE;
74 if (allocator->mem_chunk)
76 g_mem_chunk_destroy (allocator->mem_chunk);
77 allocator->mem_chunk = NULL;
81 if (!allocator->mem_chunk)
83 allocator->mem_chunk = g_mem_chunk_new (allocator->name,
85 sizeof (GtkRBNode) * allocator->n_preallocs,
87 allocator->free_nodes = NULL;
90 allocator->is_unused = FALSE;
94 _gtk_rbnode_new (GtkRBTree *tree,
99 G_LOCK (current_allocator);
100 if (!current_allocator)
102 GAllocator *allocator = g_allocator_new ("GTK+ default GtkRBNode allocator",
104 _gtk_rbnode_validate_allocator (allocator);
105 allocator->last = NULL;
106 current_allocator = allocator;
108 if (!current_allocator->free_nodes)
109 node = g_chunk_new (GtkRBNode, current_allocator->mem_chunk);
112 node = current_allocator->free_nodes;
113 current_allocator->free_nodes = node->left;
115 G_UNLOCK (current_allocator);
117 node->left = tree->nil;
118 node->right = tree->nil;
119 node->parent = tree->nil;
120 node->flags = GTK_RBNODE_RED;
123 node->children = NULL;
124 node->offset = height;
129 _gtk_rbnode_free (GtkRBNode *node)
131 G_LOCK (current_allocator);
132 node->left = current_allocator->free_nodes;
133 current_allocator->free_nodes = node;
134 if (gtk_debug_flags & GTK_DEBUG_TREE)
136 /* unfortunately node->left has to continue to point to
139 node->right = (gpointer) 0xdeadbeef;
140 node->parent = (gpointer) 0xdeadbeef;
141 node->offset = 56789;
145 G_UNLOCK (current_allocator);
149 _gtk_rbnode_rotate_left (GtkRBTree *tree,
152 gint node_height, right_height;
153 GtkRBNode *right = node->right;
155 g_return_if_fail (node != tree->nil);
157 node_height = node->offset -
158 (node->left?node->left->offset:0) -
159 (node->right?node->right->offset:0) -
160 (node->children?node->children->root->offset:0);
161 right_height = right->offset -
162 (right->left?right->left->offset:0) -
163 (right->right?right->right->offset:0) -
164 (right->children?right->children->root->offset:0);
165 node->right = right->left;
166 if (right->left != tree->nil)
167 right->left->parent = node;
169 if (right != tree->nil)
170 right->parent = node->parent;
171 if (node->parent != tree->nil)
173 if (node == node->parent->left)
174 node->parent->left = right;
176 node->parent->right = right;
182 if (node != tree->nil)
183 node->parent = right;
185 node->count = 1 + (node->left?node->left->count:0) +
186 (node->right?node->right->count:0);
187 right->count = 1 + (right->left?right->left->count:0) +
188 (right->right?right->right->count:0);
190 node->offset = node_height +
191 (node->left?node->left->offset:0) +
192 (node->right?node->right->offset:0) +
193 (node->children?node->children->root->offset:0);
194 right->offset = right_height +
195 (right->left?right->left->offset:0) +
196 (right->right?right->right->offset:0) +
197 (right->children?right->children->root->offset:0);
199 _fixup_validation (tree, node);
200 _fixup_validation (tree, right);
201 _fixup_parity (tree, node);
202 _fixup_parity (tree, right);
206 _gtk_rbnode_rotate_right (GtkRBTree *tree,
209 gint node_height, left_height;
210 GtkRBNode *left = node->left;
212 g_return_if_fail (node != tree->nil);
214 node_height = node->offset -
215 (node->left?node->left->offset:0) -
216 (node->right?node->right->offset:0) -
217 (node->children?node->children->root->offset:0);
218 left_height = left->offset -
219 (left->left?left->left->offset:0) -
220 (left->right?left->right->offset:0) -
221 (left->children?left->children->root->offset:0);
223 node->left = left->right;
224 if (left->right != tree->nil)
225 left->right->parent = node;
227 if (left != tree->nil)
228 left->parent = node->parent;
229 if (node->parent != tree->nil)
231 if (node == node->parent->right)
232 node->parent->right = left;
234 node->parent->left = left;
241 /* link node and left */
243 if (node != tree->nil)
246 node->count = 1 + (node->left?node->left->count:0) +
247 (node->right?node->right->count:0);
248 left->count = 1 + (left->left?left->left->count:0) +
249 (left->right?left->right->count:0);
251 node->offset = node_height +
252 (node->left?node->left->offset:0) +
253 (node->right?node->right->offset:0) +
254 (node->children?node->children->root->offset:0);
255 left->offset = left_height +
256 (left->left?left->left->offset:0) +
257 (left->right?left->right->offset:0) +
258 (left->children?left->children->root->offset:0);
260 _fixup_validation (tree, node);
261 _fixup_validation (tree, left);
262 _fixup_parity (tree, node);
263 _fixup_parity (tree, left);
267 _gtk_rbtree_insert_fixup (GtkRBTree *tree,
271 /* check Red-Black properties */
272 while (node != tree->root && GTK_RBNODE_GET_COLOR (node->parent) == GTK_RBNODE_RED)
274 /* we have a violation */
275 if (node->parent == node->parent->parent->left)
277 GtkRBNode *y = node->parent->parent->right;
278 if (GTK_RBNODE_GET_COLOR (y) == GTK_RBNODE_RED)
280 /* uncle is GTK_RBNODE_RED */
281 GTK_RBNODE_SET_COLOR (node->parent, GTK_RBNODE_BLACK);
282 GTK_RBNODE_SET_COLOR (y, GTK_RBNODE_BLACK);
283 GTK_RBNODE_SET_COLOR (node->parent->parent, GTK_RBNODE_RED);
284 node = node->parent->parent;
288 /* uncle is GTK_RBNODE_BLACK */
289 if (node == node->parent->right)
291 /* make node a left child */
293 _gtk_rbnode_rotate_left (tree, node);
296 /* recolor and rotate */
297 GTK_RBNODE_SET_COLOR (node->parent, GTK_RBNODE_BLACK);
298 GTK_RBNODE_SET_COLOR (node->parent->parent, GTK_RBNODE_RED);
299 _gtk_rbnode_rotate_right(tree, node->parent->parent);
304 /* mirror image of above code */
305 GtkRBNode *y = node->parent->parent->left;
306 if (GTK_RBNODE_GET_COLOR (y) == GTK_RBNODE_RED)
308 /* uncle is GTK_RBNODE_RED */
309 GTK_RBNODE_SET_COLOR (node->parent, GTK_RBNODE_BLACK);
310 GTK_RBNODE_SET_COLOR (y, GTK_RBNODE_BLACK);
311 GTK_RBNODE_SET_COLOR (node->parent->parent, GTK_RBNODE_RED);
312 node = node->parent->parent;
316 /* uncle is GTK_RBNODE_BLACK */
317 if (node == node->parent->left)
320 _gtk_rbnode_rotate_right (tree, node);
322 GTK_RBNODE_SET_COLOR (node->parent, GTK_RBNODE_BLACK);
323 GTK_RBNODE_SET_COLOR (node->parent->parent, GTK_RBNODE_RED);
324 _gtk_rbnode_rotate_left (tree, node->parent->parent);
328 GTK_RBNODE_SET_COLOR (tree->root, GTK_RBNODE_BLACK);
332 _gtk_rbtree_remove_node_fixup (GtkRBTree *tree,
335 while (node != tree->root && GTK_RBNODE_GET_COLOR (node) == GTK_RBNODE_BLACK)
337 if (node == node->parent->left)
339 GtkRBNode *w = node->parent->right;
340 if (GTK_RBNODE_GET_COLOR (w) == GTK_RBNODE_RED)
342 GTK_RBNODE_SET_COLOR (w, GTK_RBNODE_BLACK);
343 GTK_RBNODE_SET_COLOR (node->parent, GTK_RBNODE_RED);
344 _gtk_rbnode_rotate_left (tree, node->parent);
345 w = node->parent->right;
347 if (GTK_RBNODE_GET_COLOR (w->left) == GTK_RBNODE_BLACK && GTK_RBNODE_GET_COLOR (w->right) == GTK_RBNODE_BLACK)
349 GTK_RBNODE_SET_COLOR (w, GTK_RBNODE_RED);
354 if (GTK_RBNODE_GET_COLOR (w->right) == GTK_RBNODE_BLACK)
356 GTK_RBNODE_SET_COLOR (w->left, GTK_RBNODE_BLACK);
357 GTK_RBNODE_SET_COLOR (w, GTK_RBNODE_RED);
358 _gtk_rbnode_rotate_right (tree, w);
359 w = node->parent->right;
361 GTK_RBNODE_SET_COLOR (w, GTK_RBNODE_GET_COLOR (node->parent));
362 GTK_RBNODE_SET_COLOR (node->parent, GTK_RBNODE_BLACK);
363 GTK_RBNODE_SET_COLOR (w->right, GTK_RBNODE_BLACK);
364 _gtk_rbnode_rotate_left (tree, node->parent);
370 GtkRBNode *w = node->parent->left;
371 if (GTK_RBNODE_GET_COLOR (w) == GTK_RBNODE_RED)
373 GTK_RBNODE_SET_COLOR (w, GTK_RBNODE_BLACK);
374 GTK_RBNODE_SET_COLOR (node->parent, GTK_RBNODE_RED);
375 _gtk_rbnode_rotate_right (tree, node->parent);
376 w = node->parent->left;
378 if (GTK_RBNODE_GET_COLOR (w->right) == GTK_RBNODE_BLACK && GTK_RBNODE_GET_COLOR (w->left) == GTK_RBNODE_BLACK)
380 GTK_RBNODE_SET_COLOR (w, GTK_RBNODE_RED);
385 if (GTK_RBNODE_GET_COLOR (w->left) == GTK_RBNODE_BLACK)
387 GTK_RBNODE_SET_COLOR (w->right, GTK_RBNODE_BLACK);
388 GTK_RBNODE_SET_COLOR (w, GTK_RBNODE_RED);
389 _gtk_rbnode_rotate_left (tree, w);
390 w = node->parent->left;
392 GTK_RBNODE_SET_COLOR (w, GTK_RBNODE_GET_COLOR (node->parent));
393 GTK_RBNODE_SET_COLOR (node->parent, GTK_RBNODE_BLACK);
394 GTK_RBNODE_SET_COLOR (w->left, GTK_RBNODE_BLACK);
395 _gtk_rbnode_rotate_right (tree, node->parent);
400 GTK_RBNODE_SET_COLOR (node, GTK_RBNODE_BLACK);
403 /* Public functions */
405 _gtk_rbnode_push_allocator (GAllocator *allocator)
407 G_LOCK (current_allocator);
408 _gtk_rbnode_validate_allocator ( allocator );
409 allocator->last = current_allocator;
410 current_allocator = allocator;
411 G_UNLOCK (current_allocator);
415 _gtk_rbnode_pop_allocator (void)
417 G_LOCK (current_allocator);
418 if (current_allocator)
420 GAllocator *allocator;
422 allocator = current_allocator;
423 current_allocator = allocator->last;
424 allocator->last = NULL;
425 allocator->is_unused = TRUE;
427 G_UNLOCK (current_allocator);
431 _gtk_rbtree_new (void)
435 retval = (GtkRBTree *) g_new (GtkRBTree, 1);
436 retval->parent_tree = NULL;
437 retval->parent_node = NULL;
439 retval->nil = g_new0 (GtkRBNode, 1);
440 retval->nil->left = NULL;
441 retval->nil->right = NULL;
442 retval->nil->parent = NULL;
443 retval->nil->flags = GTK_RBNODE_BLACK;
444 retval->nil->count = 0;
445 retval->nil->offset = 0;
446 retval->nil->parity = 0;
448 retval->root = retval->nil;
453 _gtk_rbtree_free_helper (GtkRBTree *tree,
458 _gtk_rbtree_free (node->children);
460 _gtk_rbnode_free (node);
464 _gtk_rbtree_free (GtkRBTree *tree)
466 _gtk_rbtree_traverse (tree,
469 _gtk_rbtree_free_helper,
472 if (tree->parent_node &&
473 tree->parent_node->children == tree)
474 tree->parent_node->children = NULL;
475 _gtk_rbnode_free (tree->nil);
480 _gtk_rbtree_remove (GtkRBTree *tree)
485 gint height = tree->root->offset;
487 #ifdef G_ENABLE_DEBUG
488 if (gtk_debug_flags & GTK_DEBUG_TREE)
489 _gtk_rbtree_test (G_STRLOC, tree);
492 tmp_tree = tree->parent_tree;
493 tmp_node = tree->parent_node;
495 /* ugly hack to make _fixup_validation work in the first iteration of the
497 GTK_RBNODE_UNSET_FLAG (tree->root, GTK_RBNODE_DESCENDANTS_INVALID);
499 while (tmp_tree && tmp_node && tmp_node != tmp_tree->nil)
501 _fixup_validation (tmp_tree, tmp_node);
502 tmp_node->offset -= height;
504 /* If the removed tree was odd, flip all parents */
505 if (tree->root->parity)
506 tmp_node->parity = !tmp_node->parity;
508 tmp_node = tmp_node->parent;
509 if (tmp_node == tmp_tree->nil)
511 tmp_node = tmp_tree->parent_node;
512 tmp_tree = tmp_tree->parent_tree;
516 tmp_tree = tree->parent_tree;
517 tmp_node = tree->parent_node;
518 _gtk_rbtree_free (tree);
520 #ifdef G_ENABLE_DEBUG
521 if (gtk_debug_flags & GTK_DEBUG_TREE)
522 _gtk_rbtree_test (G_STRLOC, tmp_tree);
528 _gtk_rbtree_insert_after (GtkRBTree *tree,
534 gboolean right = TRUE;
538 #ifdef G_ENABLE_DEBUG
539 if (gtk_debug_flags & GTK_DEBUG_TREE)
541 g_print ("\n\n_gtk_rbtree_insert_after: %p\n", current);
542 _gtk_rbtree_debug_spew (tree);
543 _gtk_rbtree_test (G_STRLOC, tree);
545 #endif /* G_ENABLE_DEBUG */
547 if (current != NULL && current->right != tree->nil)
549 current = current->right;
550 while (current->left != tree->nil)
551 current = current->left;
555 node = _gtk_rbnode_new (tree, height);
556 node->parent = (current?current:tree->nil);
558 /* insert node in tree */
562 current->right = node;
564 current->left = node;
565 tmp_node = node->parent;
571 tmp_node = tree->parent_node;
572 tmp_tree = tree->parent_tree;
575 while (tmp_tree && tmp_node && tmp_node != tmp_tree->nil)
577 /* We only want to propagate the count if we are in the tree we
579 if (tmp_tree == tree)
582 tmp_node->parity += 1;
583 tmp_node->offset += height;
584 tmp_node = tmp_node->parent;
585 if (tmp_node == tmp_tree->nil)
587 tmp_node = tmp_tree->parent_node;
588 tmp_tree = tmp_tree->parent_tree;
593 _gtk_rbtree_node_mark_valid (tree, node);
595 _gtk_rbtree_node_mark_invalid (tree, node);
597 _gtk_rbtree_insert_fixup (tree, node);
599 #ifdef G_ENABLE_DEBUG
600 if (gtk_debug_flags & GTK_DEBUG_TREE)
602 g_print ("_gtk_rbtree_insert_after finished...\n");
603 _gtk_rbtree_debug_spew (tree);
605 _gtk_rbtree_test (G_STRLOC, tree);
607 #endif /* G_ENABLE_DEBUG */
613 _gtk_rbtree_insert_before (GtkRBTree *tree,
619 gboolean left = TRUE;
623 #ifdef G_ENABLE_DEBUG
624 if (gtk_debug_flags & GTK_DEBUG_TREE)
626 g_print ("\n\n_gtk_rbtree_insert_before: %p\n", current);
627 _gtk_rbtree_debug_spew (tree);
628 _gtk_rbtree_test (G_STRLOC, tree);
630 #endif /* G_ENABLE_DEBUG */
632 if (current != NULL && current->left != tree->nil)
634 current = current->left;
635 while (current->right != tree->nil)
636 current = current->right;
641 node = _gtk_rbnode_new (tree, height);
642 node->parent = (current?current:tree->nil);
644 /* insert node in tree */
648 current->left = node;
650 current->right = node;
651 tmp_node = node->parent;
657 tmp_node = tree->parent_node;
658 tmp_tree = tree->parent_tree;
661 while (tmp_tree && tmp_node && tmp_node != tmp_tree->nil)
663 /* We only want to propagate the count if we are in the tree we
665 if (tmp_tree == tree)
668 tmp_node->parity += 1;
669 tmp_node->offset += height;
670 tmp_node = tmp_node->parent;
671 if (tmp_node == tmp_tree->nil)
673 tmp_node = tmp_tree->parent_node;
674 tmp_tree = tmp_tree->parent_tree;
679 _gtk_rbtree_node_mark_valid (tree, node);
681 _gtk_rbtree_node_mark_invalid (tree, node);
683 _gtk_rbtree_insert_fixup (tree, node);
685 #ifdef G_ENABLE_DEBUG
686 if (gtk_debug_flags & GTK_DEBUG_TREE)
688 g_print ("_gtk_rbtree_insert_before finished...\n");
689 _gtk_rbtree_debug_spew (tree);
691 _gtk_rbtree_test (G_STRLOC, tree);
693 #endif /* G_ENABLE_DEBUG */
699 _gtk_rbtree_find_count (GtkRBTree *tree,
705 while (node != tree->nil && (node->left->count + 1 != count))
707 if (node->left->count >= count)
711 count -= (node->left->count + 1);
715 if (node == tree->nil)
721 _gtk_rbtree_node_set_height (GtkRBTree *tree,
725 gint diff = height - GTK_RBNODE_GET_HEIGHT (node);
726 GtkRBNode *tmp_node = node;
727 GtkRBTree *tmp_tree = tree;
732 while (tmp_tree && tmp_node && tmp_node != tmp_tree->nil)
734 tmp_node->offset += diff;
735 tmp_node = tmp_node->parent;
736 if (tmp_node == tmp_tree->nil)
738 tmp_node = tmp_tree->parent_node;
739 tmp_tree = tmp_tree->parent_tree;
742 #ifdef G_ENABLE_DEBUG
743 if (gtk_debug_flags & GTK_DEBUG_TREE)
744 _gtk_rbtree_test (G_STRLOC, tree);
749 _gtk_rbtree_node_mark_invalid (GtkRBTree *tree,
752 if (GTK_RBNODE_FLAG_SET (node, GTK_RBNODE_INVALID))
755 GTK_RBNODE_SET_FLAG (node, GTK_RBNODE_INVALID);
758 if (GTK_RBNODE_FLAG_SET (node, GTK_RBNODE_DESCENDANTS_INVALID))
760 GTK_RBNODE_SET_FLAG (node, GTK_RBNODE_DESCENDANTS_INVALID);
762 if (node == tree->nil)
764 node = tree->parent_node;
765 tree = tree->parent_tree;
772 /* Draconian version. */
774 _gtk_rbtree_node_mark_invalid (GtkRBTree *tree,
777 GTK_RBNODE_SET_FLAG (node, GTK_RBNODE_INVALID);
780 _fixup_validation (tree, node);
782 if (node == tree->nil)
784 node = tree->parent_node;
785 tree = tree->parent_tree;
793 _gtk_rbtree_node_mark_valid (GtkRBTree *tree,
796 if ((!GTK_RBNODE_FLAG_SET (node, GTK_RBNODE_INVALID)) &&
797 (!GTK_RBNODE_FLAG_SET (node, GTK_RBNODE_COLUMN_INVALID)))
800 GTK_RBNODE_UNSET_FLAG (node, GTK_RBNODE_INVALID);
801 GTK_RBNODE_UNSET_FLAG (node, GTK_RBNODE_COLUMN_INVALID);
805 if ((GTK_RBNODE_FLAG_SET (node, GTK_RBNODE_INVALID)) ||
806 (GTK_RBNODE_FLAG_SET (node, GTK_RBNODE_COLUMN_INVALID)) ||
807 (node->children && GTK_RBNODE_FLAG_SET (node->children->root, GTK_RBNODE_DESCENDANTS_INVALID)) ||
808 (node->left != tree->nil && GTK_RBNODE_FLAG_SET (node->left, GTK_RBNODE_DESCENDANTS_INVALID)) ||
809 (node->right != tree->nil && GTK_RBNODE_FLAG_SET (node->right, GTK_RBNODE_DESCENDANTS_INVALID)))
812 GTK_RBNODE_UNSET_FLAG (node, GTK_RBNODE_DESCENDANTS_INVALID);
814 if (node == tree->nil)
816 node = tree->parent_node;
817 tree = tree->parent_tree;
824 /* Draconian version */
826 _gtk_rbtree_node_mark_valid (GtkRBTree *tree,
829 GTK_RBNODE_UNSET_FLAG (node, GTK_RBNODE_INVALID);
830 GTK_RBNODE_UNSET_FLAG (node, GTK_RBNODE_COLUMN_INVALID);
834 _fixup_validation (tree, node);
836 if (node == tree->nil)
838 node = tree->parent_node;
839 tree = tree->parent_tree;
845 /* Assume tree is the root node as it doesn't set DESCENDANTS_INVALID above.
848 _gtk_rbtree_column_invalid (GtkRBTree *tree)
857 while (node->left != tree->nil)
862 if (! (GTK_RBNODE_FLAG_SET (node, GTK_RBNODE_INVALID)))
863 GTK_RBNODE_SET_FLAG (node, GTK_RBNODE_COLUMN_INVALID);
864 GTK_RBNODE_SET_FLAG (node, GTK_RBNODE_DESCENDANTS_INVALID);
867 _gtk_rbtree_column_invalid (node->children);
869 while ((node = _gtk_rbtree_next (tree, node)) != NULL);
873 _gtk_rbtree_mark_invalid (GtkRBTree *tree)
882 while (node->left != tree->nil)
887 GTK_RBNODE_SET_FLAG (node, GTK_RBNODE_INVALID);
888 GTK_RBNODE_SET_FLAG (node, GTK_RBNODE_DESCENDANTS_INVALID);
891 _gtk_rbtree_mark_invalid (node->children);
893 while ((node = _gtk_rbtree_next (tree, node)) != NULL);
897 _gtk_rbtree_set_fixed_height (GtkRBTree *tree,
908 while (node->left != tree->nil)
913 if (GTK_RBNODE_FLAG_SET (node, GTK_RBNODE_INVALID))
914 _gtk_rbtree_node_set_height (tree, node, height);
917 _gtk_rbtree_set_fixed_height (node->children, height);
919 while ((node = _gtk_rbtree_next (tree, node)) != NULL);
922 typedef struct _GtkRBReorder
933 gtk_rbtree_reorder_sort_func (gconstpointer a,
936 return ((GtkRBReorder *) a)->order - ((GtkRBReorder *) b)->order;
940 gtk_rbtree_reorder_invert_func (gconstpointer a,
943 return ((GtkRBReorder *) a)->invert_order - ((GtkRBReorder *) b)->invert_order;
947 gtk_rbtree_reorder_fixup (GtkRBTree *tree,
950 if (node == tree->nil)
955 if (node->left != tree->nil)
957 gtk_rbtree_reorder_fixup (tree, node->left);
958 node->offset += node->left->offset;
959 node->parity += node->left->parity;
961 if (node->right != tree->nil)
963 gtk_rbtree_reorder_fixup (tree, node->right);
964 node->offset += node->right->offset;
965 node->parity += node->right->parity;
970 node->offset += node->children->root->offset;
971 node->parity += node->children->root->parity;
974 if (GTK_RBNODE_FLAG_SET (node, GTK_RBNODE_INVALID) ||
975 (node->right != tree->nil && GTK_RBNODE_FLAG_SET (node->right, GTK_RBNODE_DESCENDANTS_INVALID)) ||
976 (node->left != tree->nil && GTK_RBNODE_FLAG_SET (node->left, GTK_RBNODE_DESCENDANTS_INVALID)) ||
977 (node->children && GTK_RBNODE_FLAG_SET (node->children->root, GTK_RBNODE_DESCENDANTS_INVALID)))
978 GTK_RBNODE_SET_FLAG (node, GTK_RBNODE_DESCENDANTS_INVALID);
980 GTK_RBNODE_UNSET_FLAG (node, GTK_RBNODE_DESCENDANTS_INVALID);
983 /* It basically pulls everything out of the tree, rearranges it, and puts it
984 * back together. Our strategy is to keep the old RBTree intact, and just
985 * rearrange the contents. When that is done, we go through and update the
986 * heights. There is probably a more elegant way to write this function. If
987 * anyone wants to spend the time writing it, patches will be accepted.
990 _gtk_rbtree_reorder (GtkRBTree *tree,
994 GtkRBReorder reorder = {0, };
999 g_return_if_fail (tree != NULL);
1000 g_return_if_fail (length > 0);
1001 g_return_if_fail (tree->root->count == length);
1003 /* Sort the trees values in the new tree. */
1004 array = g_array_sized_new (FALSE, FALSE, sizeof (GtkRBReorder), length);
1005 for (i = 0; i < length; i++)
1007 reorder.order = new_order[i];
1008 reorder.invert_order = i;
1009 g_array_append_val (array, reorder);
1012 g_array_sort(array, gtk_rbtree_reorder_sort_func);
1016 while (node && node->left != tree->nil)
1019 for (i = 0; i < length; i++)
1021 g_assert (node != tree->nil);
1022 g_array_index (array, GtkRBReorder, i).children = node->children;
1023 g_array_index (array, GtkRBReorder, i).flags = GTK_RBNODE_NON_COLORS & node->flags;
1024 g_array_index (array, GtkRBReorder, i).height = GTK_RBNODE_GET_HEIGHT (node);
1026 node = _gtk_rbtree_next (tree, node);
1029 g_array_sort (array, gtk_rbtree_reorder_invert_func);
1033 while (node && node->left != tree->nil)
1036 /* Go through the tree and change the values to the new ones. */
1037 for (i = 0; i < length; i++)
1039 reorder = g_array_index (array, GtkRBReorder, i);
1040 node->children = reorder.children;
1042 node->children->parent_node = node;
1043 node->flags = GTK_RBNODE_GET_COLOR (node) | reorder.flags;
1044 /* We temporarily set the height to this. */
1045 node->offset = reorder.height;
1046 node = _gtk_rbtree_next (tree, node);
1048 gtk_rbtree_reorder_fixup (tree, tree->root);
1050 g_array_free (array, TRUE);
1055 _gtk_rbtree_node_find_offset (GtkRBTree *tree,
1062 g_assert (node->left);
1064 retval = node->left->offset;
1066 while (tree && node && node != tree->nil)
1069 node = node->parent;
1071 /* Add left branch, plus children, iff we came from the right */
1072 if (node->right == last)
1073 retval += node->offset - node->right->offset;
1075 if (node == tree->nil)
1077 node = tree->parent_node;
1078 tree = tree->parent_tree;
1080 /* Add the parent node, plus the left branch. */
1082 retval += node->left->offset + GTK_RBNODE_GET_HEIGHT (node);
1089 _gtk_rbtree_node_find_parity (GtkRBTree *tree,
1096 g_assert (node->left);
1098 retval = node->left->parity;
1100 while (tree && node && node != tree->nil)
1103 node = node->parent;
1105 /* Add left branch, plus children, iff we came from the right */
1106 if (node->right == last)
1107 retval += node->parity - node->right->parity;
1109 if (node == tree->nil)
1111 node = tree->parent_node;
1112 tree = tree->parent_tree;
1114 /* Add the parent node, plus the left branch. */
1116 retval += node->left->parity + 1; /* 1 == GTK_RBNODE_GET_PARITY() */
1124 _gtk_rbtree_real_find_offset (GtkRBTree *tree,
1126 GtkRBTree **new_tree,
1127 GtkRBNode **new_node)
1129 GtkRBNode *tmp_node;
1142 tmp_node = tree->root;
1143 while (tmp_node != tree->nil &&
1144 (tmp_node->left->offset > height ||
1145 (tmp_node->offset - tmp_node->right->offset) < height))
1147 if (tmp_node->left->offset > height)
1148 tmp_node = tmp_node->left;
1151 height -= (tmp_node->offset - tmp_node->right->offset);
1152 tmp_node = tmp_node->right;
1155 if (tmp_node == tree->nil)
1161 if (tmp_node->children)
1163 if ((tmp_node->offset -
1164 tmp_node->right->offset -
1165 tmp_node->children->root->offset) > height)
1168 *new_node = tmp_node;
1169 return (height - tmp_node->left->offset);
1171 return _gtk_rbtree_real_find_offset (tmp_node->children,
1172 height - tmp_node->left->offset -
1174 tmp_node->left->offset -
1175 tmp_node->right->offset -
1176 tmp_node->children->root->offset),
1181 *new_node = tmp_node;
1182 return (height - tmp_node->left->offset);
1186 _gtk_rbtree_find_offset (GtkRBTree *tree,
1188 GtkRBTree **new_tree,
1189 GtkRBNode **new_node)
1194 (height >= tree->root->offset))
1201 return _gtk_rbtree_real_find_offset (tree, height, new_tree, new_node);
1205 _gtk_rbtree_remove_node (GtkRBTree *tree,
1209 GtkRBTree *tmp_tree;
1210 GtkRBNode *tmp_node;
1214 g_return_if_fail (tree != NULL);
1215 g_return_if_fail (node != NULL);
1218 #ifdef G_ENABLE_DEBUG
1219 if (gtk_debug_flags & GTK_DEBUG_TREE)
1221 g_print ("\n\n_gtk_rbtree_remove_node: %p\n", node);
1222 _gtk_rbtree_debug_spew (tree);
1223 _gtk_rbtree_test (G_STRLOC, tree);
1225 #endif /* G_ENABLE_DEBUG */
1227 /* make sure we're deleting a node that's actually in the tree */
1228 for (x = node; x->parent != tree->nil; x = x->parent)
1230 g_return_if_fail (x == tree->root);
1232 #ifdef G_ENABLE_DEBUG
1233 if (gtk_debug_flags & GTK_DEBUG_TREE)
1234 _gtk_rbtree_test (G_STRLOC, tree);
1237 if (node->left == tree->nil || node->right == tree->nil)
1245 while (y->left != tree->nil)
1249 /* adjust count only beneath tree */
1250 for (x = y; x != tree->nil; x = x->parent)
1255 /* offsets and parity adjust all the way up through parent trees */
1256 y_height = GTK_RBNODE_GET_HEIGHT (y);
1257 node_height = GTK_RBNODE_GET_HEIGHT (node) + (node->children?node->children->root->offset:0);
1261 while (tmp_tree && tmp_node && tmp_node != tmp_tree->nil)
1263 tmp_node->offset -= (y_height + (y->children?y->children->root->offset:0));
1264 _fixup_validation (tmp_tree, tmp_node);
1265 _fixup_parity (tmp_tree, tmp_node);
1266 tmp_node = tmp_node->parent;
1267 if (tmp_node == tmp_tree->nil)
1269 tmp_node = tmp_tree->parent_node;
1270 tmp_tree = tmp_tree->parent_tree;
1274 /* x is y's only child, or nil */
1275 if (y->left != tree->nil)
1280 /* remove y from the parent chain */
1281 x->parent = y->parent;
1282 if (y->parent != tree->nil)
1284 if (y == y->parent->left)
1285 y->parent->left = x;
1287 y->parent->right = x;
1294 /* We need to clean up the validity of the tree.
1301 /* We skip the first time, iff x is nil */
1302 if (tmp_node != tmp_tree->nil)
1304 _fixup_validation (tmp_tree, tmp_node);
1305 _fixup_parity (tmp_tree, tmp_node);
1307 tmp_node = tmp_node->parent;
1308 if (tmp_node == tmp_tree->nil)
1310 tmp_node = tmp_tree->parent_node;
1311 tmp_tree = tmp_tree->parent_tree;
1314 while (tmp_tree != NULL);
1320 /* Copy the node over */
1321 if (GTK_RBNODE_GET_COLOR (node) == GTK_RBNODE_BLACK)
1322 node->flags = ((y->flags & (GTK_RBNODE_NON_COLORS)) | GTK_RBNODE_BLACK);
1324 node->flags = ((y->flags & (GTK_RBNODE_NON_COLORS)) | GTK_RBNODE_RED);
1325 node->children = y->children;
1328 node->children = y->children;
1329 node->children->parent_node = node;
1333 node->children = NULL;
1335 _fixup_validation (tree, node);
1336 _fixup_parity (tree, node);
1337 /* We want to see how different our height is from the previous node.
1338 * To do this, we compare our current height with our supposed height.
1340 diff = y_height - GTK_RBNODE_GET_HEIGHT (node);
1344 while (tmp_tree && tmp_node && tmp_node != tmp_tree->nil)
1346 tmp_node->offset += diff;
1347 _fixup_validation (tmp_tree, tmp_node);
1348 _fixup_parity (tmp_tree, tmp_node);
1349 tmp_node = tmp_node->parent;
1350 if (tmp_node == tmp_tree->nil)
1352 tmp_node = tmp_tree->parent_node;
1353 tmp_tree = tmp_tree->parent_tree;
1358 if (GTK_RBNODE_GET_COLOR (y) == GTK_RBNODE_BLACK)
1359 _gtk_rbtree_remove_node_fixup (tree, x);
1360 _gtk_rbnode_free (y);
1362 #ifdef G_ENABLE_DEBUG
1363 if (gtk_debug_flags & GTK_DEBUG_TREE)
1365 g_print ("_gtk_rbtree_remove_node finished...\n");
1366 _gtk_rbtree_debug_spew (tree);
1368 _gtk_rbtree_test (G_STRLOC, tree);
1370 #endif /* G_ENABLE_DEBUG */
1374 _gtk_rbtree_next (GtkRBTree *tree,
1377 g_return_val_if_fail (tree != NULL, NULL);
1378 g_return_val_if_fail (node != NULL, NULL);
1380 /* Case 1: the node's below us. */
1381 if (node->right != tree->nil)
1384 while (node->left != tree->nil)
1389 /* Case 2: it's an ancestor */
1390 while (node->parent != tree->nil)
1392 if (node->parent->right == node)
1393 node = node->parent;
1395 return (node->parent);
1398 /* Case 3: There is no next node */
1403 _gtk_rbtree_prev (GtkRBTree *tree,
1406 g_return_val_if_fail (tree != NULL, NULL);
1407 g_return_val_if_fail (node != NULL, NULL);
1409 /* Case 1: the node's below us. */
1410 if (node->left != tree->nil)
1413 while (node->right != tree->nil)
1418 /* Case 2: it's an ancestor */
1419 while (node->parent != tree->nil)
1421 if (node->parent->left == node)
1422 node = node->parent;
1424 return (node->parent);
1427 /* Case 3: There is no next node */
1432 _gtk_rbtree_next_full (GtkRBTree *tree,
1434 GtkRBTree **new_tree,
1435 GtkRBNode **new_node)
1437 g_return_if_fail (tree != NULL);
1438 g_return_if_fail (node != NULL);
1439 g_return_if_fail (new_tree != NULL);
1440 g_return_if_fail (new_node != NULL);
1444 *new_tree = node->children;
1445 *new_node = (*new_tree)->root;
1446 while ((*new_node)->left != (*new_tree)->nil)
1447 *new_node = (*new_node)->left;
1452 *new_node = _gtk_rbtree_next (tree, node);
1454 while ((*new_node == NULL) &&
1455 (*new_tree != NULL))
1457 *new_node = (*new_tree)->parent_node;
1458 *new_tree = (*new_tree)->parent_tree;
1460 *new_node = _gtk_rbtree_next (*new_tree, *new_node);
1465 _gtk_rbtree_prev_full (GtkRBTree *tree,
1467 GtkRBTree **new_tree,
1468 GtkRBNode **new_node)
1470 g_return_if_fail (tree != NULL);
1471 g_return_if_fail (node != NULL);
1472 g_return_if_fail (new_tree != NULL);
1473 g_return_if_fail (new_node != NULL);
1476 *new_node = _gtk_rbtree_prev (tree, node);
1478 if (*new_node == NULL)
1480 *new_node = (*new_tree)->parent_node;
1481 *new_tree = (*new_tree)->parent_tree;
1485 while ((*new_node)->children)
1487 *new_tree = (*new_node)->children;
1488 *new_node = (*new_tree)->root;
1489 while ((*new_node)->right != (*new_tree)->nil)
1490 *new_node = (*new_node)->right;
1496 _gtk_rbtree_get_depth (GtkRBTree *tree)
1498 GtkRBTree *tmp_tree;
1501 tmp_tree = tree->parent_tree;
1505 tmp_tree = tmp_tree->parent_tree;
1512 _gtk_rbtree_traverse_pre_order (GtkRBTree *tree,
1514 GtkRBTreeTraverseFunc func,
1517 if (node == tree->nil)
1520 (* func) (tree, node, data);
1521 _gtk_rbtree_traverse_pre_order (tree, node->left, func, data);
1522 _gtk_rbtree_traverse_pre_order (tree, node->right, func, data);
1526 _gtk_rbtree_traverse_post_order (GtkRBTree *tree,
1528 GtkRBTreeTraverseFunc func,
1531 if (node == tree->nil)
1534 _gtk_rbtree_traverse_post_order (tree, node->left, func, data);
1535 _gtk_rbtree_traverse_post_order (tree, node->right, func, data);
1536 (* func) (tree, node, data);
1540 _gtk_rbtree_traverse (GtkRBTree *tree,
1542 GTraverseType order,
1543 GtkRBTreeTraverseFunc func,
1546 g_return_if_fail (tree != NULL);
1547 g_return_if_fail (node != NULL);
1548 g_return_if_fail (func != NULL);
1549 g_return_if_fail (order <= G_LEVEL_ORDER);
1554 _gtk_rbtree_traverse_pre_order (tree, node, func, data);
1557 _gtk_rbtree_traverse_post_order (tree, node, func, data);
1562 g_warning ("unsupported traversal order.");
1568 _count_nodes (GtkRBTree *tree,
1572 if (node == tree->nil)
1575 g_assert (node->left);
1576 g_assert (node->right);
1578 res = (_count_nodes (tree, node->left) +
1579 _count_nodes (tree, node->right) + 1);
1581 if (res != node->count)
1582 g_print ("Tree failed\n");
1587 void _fixup_validation (GtkRBTree *tree,
1590 if (GTK_RBNODE_FLAG_SET (node, GTK_RBNODE_INVALID) ||
1591 GTK_RBNODE_FLAG_SET (node, GTK_RBNODE_COLUMN_INVALID) ||
1592 (node->left != tree->nil && GTK_RBNODE_FLAG_SET (node->left, GTK_RBNODE_DESCENDANTS_INVALID)) ||
1593 (node->right != tree->nil && GTK_RBNODE_FLAG_SET (node->right, GTK_RBNODE_DESCENDANTS_INVALID)) ||
1594 (node->children != NULL && GTK_RBNODE_FLAG_SET (node->children->root, GTK_RBNODE_DESCENDANTS_INVALID)))
1596 GTK_RBNODE_SET_FLAG (node, GTK_RBNODE_DESCENDANTS_INVALID);
1600 GTK_RBNODE_UNSET_FLAG (node, GTK_RBNODE_DESCENDANTS_INVALID);
1605 void _fixup_parity (GtkRBTree *tree,
1609 ((node->children != NULL && node->children->root != node->children->nil) ? node->children->root->parity : 0) +
1610 ((node->left != tree->nil) ? node->left->parity : 0) +
1611 ((node->right != tree->nil) ? node->right->parity : 0);
1614 #ifdef G_ENABLE_DEBUG
1616 get_parity (GtkRBNode *node)
1618 guint child_total = 0;
1621 /* The parity of a node is node->parity minus
1622 * the parity of left, right, and children.
1624 * This is equivalent to saying that if left, right, children
1625 * sum to 0 parity, then node->parity is the parity of node,
1626 * and if left, right, children are odd parity, then
1627 * node->parity is the reverse of the node's parity.
1630 child_total += (guint) node->left->parity;
1631 child_total += (guint) node->right->parity;
1634 child_total += (guint) node->children->root->parity;
1636 rem = child_total % 2;
1639 return node->parity;
1641 return !node->parity;
1645 count_parity (GtkRBTree *tree,
1650 if (node == tree->nil)
1654 count_parity (tree, node->left) +
1655 count_parity (tree, node->right) +
1657 (node->children ? count_parity (node->children, node->children->root) : 0);
1659 res = res % (guint)2;
1661 if (res != node->parity)
1662 g_print ("parity incorrect for node\n");
1664 if (get_parity (node) != 1)
1665 g_error ("Node has incorrect parity %d", get_parity (node));
1671 _gtk_rbtree_test_height (GtkRBTree *tree,
1674 gint computed_offset = 0;
1676 /* This whole test is sort of a useless truism. */
1678 if (node->left != tree->nil)
1679 computed_offset += node->left->offset;
1681 if (node->right != tree->nil)
1682 computed_offset += node->right->offset;
1684 if (node->children && node->children->root != node->children->nil)
1685 computed_offset += node->children->root->offset;
1687 if (GTK_RBNODE_GET_HEIGHT (node) + computed_offset != node->offset)
1688 g_error ("node has broken offset\n");
1690 if (node->left != tree->nil)
1691 _gtk_rbtree_test_height (tree, node->left);
1693 if (node->right != tree->nil)
1694 _gtk_rbtree_test_height (tree, node->right);
1696 if (node->children && node->children->root != node->children->nil)
1697 _gtk_rbtree_test_height (node->children, node->children->root);
1701 _gtk_rbtree_test_dirty (GtkRBTree *tree,
1703 gint expected_dirtyness)
1706 if (expected_dirtyness)
1708 g_assert (GTK_RBNODE_FLAG_SET (node, GTK_RBNODE_COLUMN_INVALID) ||
1709 GTK_RBNODE_FLAG_SET (node, GTK_RBNODE_INVALID) ||
1710 (node->left != tree->nil && GTK_RBNODE_FLAG_SET (node->left, GTK_RBNODE_DESCENDANTS_INVALID)) ||
1711 (node->right != tree->nil && GTK_RBNODE_FLAG_SET (node->right, GTK_RBNODE_DESCENDANTS_INVALID)) ||
1712 (node->children && GTK_RBNODE_FLAG_SET (node->children->root, GTK_RBNODE_DESCENDANTS_INVALID)));
1716 g_assert (! GTK_RBNODE_FLAG_SET (node, GTK_RBNODE_COLUMN_INVALID) &&
1717 ! GTK_RBNODE_FLAG_SET (node, GTK_RBNODE_INVALID));
1718 if (node->left != tree->nil)
1719 g_assert (! GTK_RBNODE_FLAG_SET (node->left, GTK_RBNODE_DESCENDANTS_INVALID));
1720 if (node->right != tree->nil)
1721 g_assert (! GTK_RBNODE_FLAG_SET (node->right, GTK_RBNODE_DESCENDANTS_INVALID));
1722 if (node->children != NULL)
1723 g_assert (! GTK_RBNODE_FLAG_SET (node->children->root, GTK_RBNODE_DESCENDANTS_INVALID));
1726 if (node->left != tree->nil)
1727 _gtk_rbtree_test_dirty (tree, node->left, GTK_RBNODE_FLAG_SET (node->left, GTK_RBNODE_DESCENDANTS_INVALID));
1728 if (node->right != tree->nil)
1729 _gtk_rbtree_test_dirty (tree, node->right, GTK_RBNODE_FLAG_SET (node->right, GTK_RBNODE_DESCENDANTS_INVALID));
1730 if (node->children != NULL && node->children->root != node->children->nil)
1731 _gtk_rbtree_test_dirty (node->children, node->children->root, GTK_RBNODE_FLAG_SET (node->children->root, GTK_RBNODE_DESCENDANTS_INVALID));
1734 static void _gtk_rbtree_test_structure (GtkRBTree *tree);
1737 _gtk_rbtree_test_structure_helper (GtkRBTree *tree,
1740 g_assert (node != tree->nil);
1742 g_assert (node->left != NULL);
1743 g_assert (node->right != NULL);
1744 g_assert (node->parent != NULL);
1746 if (node->left != tree->nil)
1748 g_assert (node->left->parent == node);
1749 _gtk_rbtree_test_structure_helper (tree, node->left);
1751 if (node->right != tree->nil)
1753 g_assert (node->right->parent == node);
1754 _gtk_rbtree_test_structure_helper (tree, node->right);
1757 if (node->children != NULL)
1759 g_assert (node->children->parent_tree == tree);
1760 g_assert (node->children->parent_node == node);
1762 _gtk_rbtree_test_structure (node->children);
1766 _gtk_rbtree_test_structure (GtkRBTree *tree)
1768 g_assert (tree->root);
1769 if (tree->root == tree->nil)
1772 g_assert (tree->root->parent == tree->nil);
1773 _gtk_rbtree_test_structure_helper (tree, tree->root);
1777 _gtk_rbtree_test (const gchar *where,
1780 GtkRBTree *tmp_tree;
1785 /* Test the entire tree */
1787 while (tmp_tree->parent_tree)
1788 tmp_tree = tmp_tree->parent_tree;
1790 g_assert (tmp_tree->nil != NULL);
1792 if (tmp_tree->root == tmp_tree->nil)
1795 _gtk_rbtree_test_structure (tmp_tree);
1797 g_assert ((_count_nodes (tmp_tree, tmp_tree->root->left) +
1798 _count_nodes (tmp_tree, tmp_tree->root->right) + 1) == tmp_tree->root->count);
1801 _gtk_rbtree_test_height (tmp_tree, tmp_tree->root);
1802 _gtk_rbtree_test_dirty (tmp_tree, tmp_tree->root, GTK_RBNODE_FLAG_SET (tmp_tree->root, GTK_RBNODE_DESCENDANTS_INVALID));
1803 g_assert (count_parity (tmp_tree, tmp_tree->root) == tmp_tree->root->parity);
1807 _gtk_rbtree_debug_spew_helper (GtkRBTree *tree,
1812 for (i = 0; i < depth; i++)
1815 g_print ("(%p - %s) (Offset %d) (Parity %d) (Validity %d%d%d)\n",
1817 (GTK_RBNODE_GET_COLOR (node) == GTK_RBNODE_BLACK)?"BLACK":" RED ",
1820 (GTK_RBNODE_FLAG_SET (node, GTK_RBNODE_DESCENDANTS_INVALID))?1:0,
1821 (GTK_RBNODE_FLAG_SET (node, GTK_RBNODE_INVALID))?1:0,
1822 (GTK_RBNODE_FLAG_SET (node, GTK_RBNODE_COLUMN_INVALID))?1:0);
1823 if (node->children != NULL)
1825 g_print ("Looking at child.\n");
1826 _gtk_rbtree_debug_spew (node->children);
1827 g_print ("Done looking at child.\n");
1829 if (node->left != tree->nil)
1831 _gtk_rbtree_debug_spew_helper (tree, node->left, depth+1);
1833 if (node->right != tree->nil)
1835 _gtk_rbtree_debug_spew_helper (tree, node->right, depth+1);
1840 _gtk_rbtree_debug_spew (GtkRBTree *tree)
1842 g_return_if_fail (tree != NULL);
1844 if (tree->root == tree->nil)
1845 g_print ("Empty tree...\n");
1847 _gtk_rbtree_debug_spew_helper (tree, tree->root, 0);
1849 #endif /* G_ENABLE_DEBUG */