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"
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,
909 while (node->left != tree->nil)
914 if (GTK_RBNODE_FLAG_SET (node, GTK_RBNODE_INVALID))
916 _gtk_rbtree_node_set_height (tree, node, height);
918 _gtk_rbtree_node_mark_valid (tree, node);
922 _gtk_rbtree_set_fixed_height (node->children, height, mark_valid);
924 while ((node = _gtk_rbtree_next (tree, node)) != NULL);
927 typedef struct _GtkRBReorder
938 gtk_rbtree_reorder_sort_func (gconstpointer a,
941 return ((GtkRBReorder *) a)->order - ((GtkRBReorder *) b)->order;
945 gtk_rbtree_reorder_invert_func (gconstpointer a,
948 return ((GtkRBReorder *) a)->invert_order - ((GtkRBReorder *) b)->invert_order;
952 gtk_rbtree_reorder_fixup (GtkRBTree *tree,
955 if (node == tree->nil)
960 if (node->left != tree->nil)
962 gtk_rbtree_reorder_fixup (tree, node->left);
963 node->offset += node->left->offset;
964 node->parity += node->left->parity;
966 if (node->right != tree->nil)
968 gtk_rbtree_reorder_fixup (tree, node->right);
969 node->offset += node->right->offset;
970 node->parity += node->right->parity;
975 node->offset += node->children->root->offset;
976 node->parity += node->children->root->parity;
979 if (GTK_RBNODE_FLAG_SET (node, GTK_RBNODE_INVALID) ||
980 (node->right != tree->nil && GTK_RBNODE_FLAG_SET (node->right, GTK_RBNODE_DESCENDANTS_INVALID)) ||
981 (node->left != tree->nil && GTK_RBNODE_FLAG_SET (node->left, GTK_RBNODE_DESCENDANTS_INVALID)) ||
982 (node->children && GTK_RBNODE_FLAG_SET (node->children->root, GTK_RBNODE_DESCENDANTS_INVALID)))
983 GTK_RBNODE_SET_FLAG (node, GTK_RBNODE_DESCENDANTS_INVALID);
985 GTK_RBNODE_UNSET_FLAG (node, GTK_RBNODE_DESCENDANTS_INVALID);
988 /* It basically pulls everything out of the tree, rearranges it, and puts it
989 * back together. Our strategy is to keep the old RBTree intact, and just
990 * rearrange the contents. When that is done, we go through and update the
991 * heights. There is probably a more elegant way to write this function. If
992 * anyone wants to spend the time writing it, patches will be accepted.
995 _gtk_rbtree_reorder (GtkRBTree *tree,
999 GtkRBReorder reorder = { NULL };
1004 g_return_if_fail (tree != NULL);
1005 g_return_if_fail (length > 0);
1006 g_return_if_fail (tree->root->count == length);
1008 /* Sort the trees values in the new tree. */
1009 array = g_array_sized_new (FALSE, FALSE, sizeof (GtkRBReorder), length);
1010 for (i = 0; i < length; i++)
1012 reorder.order = new_order[i];
1013 reorder.invert_order = i;
1014 g_array_append_val (array, reorder);
1017 g_array_sort(array, gtk_rbtree_reorder_sort_func);
1021 while (node && node->left != tree->nil)
1024 for (i = 0; i < length; i++)
1026 g_assert (node != tree->nil);
1027 g_array_index (array, GtkRBReorder, i).children = node->children;
1028 g_array_index (array, GtkRBReorder, i).flags = GTK_RBNODE_NON_COLORS & node->flags;
1029 g_array_index (array, GtkRBReorder, i).height = GTK_RBNODE_GET_HEIGHT (node);
1031 node = _gtk_rbtree_next (tree, node);
1034 g_array_sort (array, gtk_rbtree_reorder_invert_func);
1038 while (node && node->left != tree->nil)
1041 /* Go through the tree and change the values to the new ones. */
1042 for (i = 0; i < length; i++)
1044 reorder = g_array_index (array, GtkRBReorder, i);
1045 node->children = reorder.children;
1047 node->children->parent_node = node;
1048 node->flags = GTK_RBNODE_GET_COLOR (node) | reorder.flags;
1049 /* We temporarily set the height to this. */
1050 node->offset = reorder.height;
1051 node = _gtk_rbtree_next (tree, node);
1053 gtk_rbtree_reorder_fixup (tree, tree->root);
1055 g_array_free (array, TRUE);
1060 _gtk_rbtree_node_find_offset (GtkRBTree *tree,
1067 g_assert (node->left);
1069 retval = node->left->offset;
1071 while (tree && node && node != tree->nil)
1074 node = node->parent;
1076 /* Add left branch, plus children, iff we came from the right */
1077 if (node->right == last)
1078 retval += node->offset - node->right->offset;
1080 if (node == tree->nil)
1082 node = tree->parent_node;
1083 tree = tree->parent_tree;
1085 /* Add the parent node, plus the left branch. */
1087 retval += node->left->offset + GTK_RBNODE_GET_HEIGHT (node);
1094 _gtk_rbtree_node_find_parity (GtkRBTree *tree,
1101 g_assert (node->left);
1103 retval = node->left->parity;
1105 while (tree && node && node != tree->nil)
1108 node = node->parent;
1110 /* Add left branch, plus children, iff we came from the right */
1111 if (node->right == last)
1112 retval += node->parity - node->right->parity;
1114 if (node == tree->nil)
1116 node = tree->parent_node;
1117 tree = tree->parent_tree;
1119 /* Add the parent node, plus the left branch. */
1121 retval += node->left->parity + 1; /* 1 == GTK_RBNODE_GET_PARITY() */
1129 _gtk_rbtree_real_find_offset (GtkRBTree *tree,
1131 GtkRBTree **new_tree,
1132 GtkRBNode **new_node)
1134 GtkRBNode *tmp_node;
1147 tmp_node = tree->root;
1148 while (tmp_node != tree->nil &&
1149 (tmp_node->left->offset > height ||
1150 (tmp_node->offset - tmp_node->right->offset) < height))
1152 if (tmp_node->left->offset > height)
1153 tmp_node = tmp_node->left;
1156 height -= (tmp_node->offset - tmp_node->right->offset);
1157 tmp_node = tmp_node->right;
1160 if (tmp_node == tree->nil)
1166 if (tmp_node->children)
1168 if ((tmp_node->offset -
1169 tmp_node->right->offset -
1170 tmp_node->children->root->offset) > height)
1173 *new_node = tmp_node;
1174 return (height - tmp_node->left->offset);
1176 return _gtk_rbtree_real_find_offset (tmp_node->children,
1177 height - tmp_node->left->offset -
1179 tmp_node->left->offset -
1180 tmp_node->right->offset -
1181 tmp_node->children->root->offset),
1186 *new_node = tmp_node;
1187 return (height - tmp_node->left->offset);
1191 _gtk_rbtree_find_offset (GtkRBTree *tree,
1193 GtkRBTree **new_tree,
1194 GtkRBNode **new_node)
1199 (height >= tree->root->offset))
1206 return _gtk_rbtree_real_find_offset (tree, height, new_tree, new_node);
1210 _gtk_rbtree_remove_node (GtkRBTree *tree,
1214 GtkRBTree *tmp_tree;
1215 GtkRBNode *tmp_node;
1219 g_return_if_fail (tree != NULL);
1220 g_return_if_fail (node != NULL);
1223 #ifdef G_ENABLE_DEBUG
1224 if (gtk_debug_flags & GTK_DEBUG_TREE)
1226 g_print ("\n\n_gtk_rbtree_remove_node: %p\n", node);
1227 _gtk_rbtree_debug_spew (tree);
1228 _gtk_rbtree_test (G_STRLOC, tree);
1230 #endif /* G_ENABLE_DEBUG */
1232 /* make sure we're deleting a node that's actually in the tree */
1233 for (x = node; x->parent != tree->nil; x = x->parent)
1235 g_return_if_fail (x == tree->root);
1237 #ifdef G_ENABLE_DEBUG
1238 if (gtk_debug_flags & GTK_DEBUG_TREE)
1239 _gtk_rbtree_test (G_STRLOC, tree);
1242 if (node->left == tree->nil || node->right == tree->nil)
1250 while (y->left != tree->nil)
1254 /* adjust count only beneath tree */
1255 for (x = y; x != tree->nil; x = x->parent)
1260 /* offsets and parity adjust all the way up through parent trees */
1261 y_height = GTK_RBNODE_GET_HEIGHT (y);
1262 node_height = GTK_RBNODE_GET_HEIGHT (node) + (node->children?node->children->root->offset:0);
1266 while (tmp_tree && tmp_node && tmp_node != tmp_tree->nil)
1268 tmp_node->offset -= (y_height + (y->children?y->children->root->offset:0));
1269 _fixup_validation (tmp_tree, tmp_node);
1270 _fixup_parity (tmp_tree, tmp_node);
1271 tmp_node = tmp_node->parent;
1272 if (tmp_node == tmp_tree->nil)
1274 tmp_node = tmp_tree->parent_node;
1275 tmp_tree = tmp_tree->parent_tree;
1279 /* x is y's only child, or nil */
1280 if (y->left != tree->nil)
1285 /* remove y from the parent chain */
1286 x->parent = y->parent;
1287 if (y->parent != tree->nil)
1289 if (y == y->parent->left)
1290 y->parent->left = x;
1292 y->parent->right = x;
1299 /* We need to clean up the validity of the tree.
1306 /* We skip the first time, iff x is nil */
1307 if (tmp_node != tmp_tree->nil)
1309 _fixup_validation (tmp_tree, tmp_node);
1310 _fixup_parity (tmp_tree, tmp_node);
1312 tmp_node = tmp_node->parent;
1313 if (tmp_node == tmp_tree->nil)
1315 tmp_node = tmp_tree->parent_node;
1316 tmp_tree = tmp_tree->parent_tree;
1319 while (tmp_tree != NULL);
1325 /* Copy the node over */
1326 if (GTK_RBNODE_GET_COLOR (node) == GTK_RBNODE_BLACK)
1327 node->flags = ((y->flags & (GTK_RBNODE_NON_COLORS)) | GTK_RBNODE_BLACK);
1329 node->flags = ((y->flags & (GTK_RBNODE_NON_COLORS)) | GTK_RBNODE_RED);
1330 node->children = y->children;
1333 node->children = y->children;
1334 node->children->parent_node = node;
1338 node->children = NULL;
1340 _fixup_validation (tree, node);
1341 _fixup_parity (tree, node);
1342 /* We want to see how different our height is from the previous node.
1343 * To do this, we compare our current height with our supposed height.
1345 diff = y_height - GTK_RBNODE_GET_HEIGHT (node);
1349 while (tmp_tree && tmp_node && tmp_node != tmp_tree->nil)
1351 tmp_node->offset += diff;
1352 _fixup_validation (tmp_tree, tmp_node);
1353 _fixup_parity (tmp_tree, tmp_node);
1354 tmp_node = tmp_node->parent;
1355 if (tmp_node == tmp_tree->nil)
1357 tmp_node = tmp_tree->parent_node;
1358 tmp_tree = tmp_tree->parent_tree;
1363 if (GTK_RBNODE_GET_COLOR (y) == GTK_RBNODE_BLACK)
1364 _gtk_rbtree_remove_node_fixup (tree, x);
1365 _gtk_rbnode_free (y);
1367 #ifdef G_ENABLE_DEBUG
1368 if (gtk_debug_flags & GTK_DEBUG_TREE)
1370 g_print ("_gtk_rbtree_remove_node finished...\n");
1371 _gtk_rbtree_debug_spew (tree);
1373 _gtk_rbtree_test (G_STRLOC, tree);
1375 #endif /* G_ENABLE_DEBUG */
1379 _gtk_rbtree_next (GtkRBTree *tree,
1382 g_return_val_if_fail (tree != NULL, NULL);
1383 g_return_val_if_fail (node != NULL, NULL);
1385 /* Case 1: the node's below us. */
1386 if (node->right != tree->nil)
1389 while (node->left != tree->nil)
1394 /* Case 2: it's an ancestor */
1395 while (node->parent != tree->nil)
1397 if (node->parent->right == node)
1398 node = node->parent;
1400 return (node->parent);
1403 /* Case 3: There is no next node */
1408 _gtk_rbtree_prev (GtkRBTree *tree,
1411 g_return_val_if_fail (tree != NULL, NULL);
1412 g_return_val_if_fail (node != NULL, NULL);
1414 /* Case 1: the node's below us. */
1415 if (node->left != tree->nil)
1418 while (node->right != tree->nil)
1423 /* Case 2: it's an ancestor */
1424 while (node->parent != tree->nil)
1426 if (node->parent->left == node)
1427 node = node->parent;
1429 return (node->parent);
1432 /* Case 3: There is no next node */
1437 _gtk_rbtree_next_full (GtkRBTree *tree,
1439 GtkRBTree **new_tree,
1440 GtkRBNode **new_node)
1442 g_return_if_fail (tree != NULL);
1443 g_return_if_fail (node != NULL);
1444 g_return_if_fail (new_tree != NULL);
1445 g_return_if_fail (new_node != NULL);
1449 *new_tree = node->children;
1450 *new_node = (*new_tree)->root;
1451 while ((*new_node)->left != (*new_tree)->nil)
1452 *new_node = (*new_node)->left;
1457 *new_node = _gtk_rbtree_next (tree, node);
1459 while ((*new_node == NULL) &&
1460 (*new_tree != NULL))
1462 *new_node = (*new_tree)->parent_node;
1463 *new_tree = (*new_tree)->parent_tree;
1465 *new_node = _gtk_rbtree_next (*new_tree, *new_node);
1470 _gtk_rbtree_prev_full (GtkRBTree *tree,
1472 GtkRBTree **new_tree,
1473 GtkRBNode **new_node)
1475 g_return_if_fail (tree != NULL);
1476 g_return_if_fail (node != NULL);
1477 g_return_if_fail (new_tree != NULL);
1478 g_return_if_fail (new_node != NULL);
1481 *new_node = _gtk_rbtree_prev (tree, node);
1483 if (*new_node == NULL)
1485 *new_node = (*new_tree)->parent_node;
1486 *new_tree = (*new_tree)->parent_tree;
1490 while ((*new_node)->children)
1492 *new_tree = (*new_node)->children;
1493 *new_node = (*new_tree)->root;
1494 while ((*new_node)->right != (*new_tree)->nil)
1495 *new_node = (*new_node)->right;
1501 _gtk_rbtree_get_depth (GtkRBTree *tree)
1503 GtkRBTree *tmp_tree;
1506 tmp_tree = tree->parent_tree;
1510 tmp_tree = tmp_tree->parent_tree;
1517 _gtk_rbtree_traverse_pre_order (GtkRBTree *tree,
1519 GtkRBTreeTraverseFunc func,
1522 if (node == tree->nil)
1525 (* func) (tree, node, data);
1526 _gtk_rbtree_traverse_pre_order (tree, node->left, func, data);
1527 _gtk_rbtree_traverse_pre_order (tree, node->right, func, data);
1531 _gtk_rbtree_traverse_post_order (GtkRBTree *tree,
1533 GtkRBTreeTraverseFunc func,
1536 if (node == tree->nil)
1539 _gtk_rbtree_traverse_post_order (tree, node->left, func, data);
1540 _gtk_rbtree_traverse_post_order (tree, node->right, func, data);
1541 (* func) (tree, node, data);
1545 _gtk_rbtree_traverse (GtkRBTree *tree,
1547 GTraverseType order,
1548 GtkRBTreeTraverseFunc func,
1551 g_return_if_fail (tree != NULL);
1552 g_return_if_fail (node != NULL);
1553 g_return_if_fail (func != NULL);
1554 g_return_if_fail (order <= G_LEVEL_ORDER);
1559 _gtk_rbtree_traverse_pre_order (tree, node, func, data);
1562 _gtk_rbtree_traverse_post_order (tree, node, func, data);
1567 g_warning ("unsupported traversal order.");
1573 _count_nodes (GtkRBTree *tree,
1577 if (node == tree->nil)
1580 g_assert (node->left);
1581 g_assert (node->right);
1583 res = (_count_nodes (tree, node->left) +
1584 _count_nodes (tree, node->right) + 1);
1586 if (res != node->count)
1587 g_print ("Tree failed\n");
1592 void _fixup_validation (GtkRBTree *tree,
1595 if (GTK_RBNODE_FLAG_SET (node, GTK_RBNODE_INVALID) ||
1596 GTK_RBNODE_FLAG_SET (node, GTK_RBNODE_COLUMN_INVALID) ||
1597 (node->left != tree->nil && GTK_RBNODE_FLAG_SET (node->left, GTK_RBNODE_DESCENDANTS_INVALID)) ||
1598 (node->right != tree->nil && GTK_RBNODE_FLAG_SET (node->right, GTK_RBNODE_DESCENDANTS_INVALID)) ||
1599 (node->children != NULL && GTK_RBNODE_FLAG_SET (node->children->root, GTK_RBNODE_DESCENDANTS_INVALID)))
1601 GTK_RBNODE_SET_FLAG (node, GTK_RBNODE_DESCENDANTS_INVALID);
1605 GTK_RBNODE_UNSET_FLAG (node, GTK_RBNODE_DESCENDANTS_INVALID);
1610 void _fixup_parity (GtkRBTree *tree,
1614 ((node->children != NULL && node->children->root != node->children->nil) ? node->children->root->parity : 0) +
1615 ((node->left != tree->nil) ? node->left->parity : 0) +
1616 ((node->right != tree->nil) ? node->right->parity : 0);
1619 #ifdef G_ENABLE_DEBUG
1621 get_parity (GtkRBNode *node)
1623 guint child_total = 0;
1626 /* The parity of a node is node->parity minus
1627 * the parity of left, right, and children.
1629 * This is equivalent to saying that if left, right, children
1630 * sum to 0 parity, then node->parity is the parity of node,
1631 * and if left, right, children are odd parity, then
1632 * node->parity is the reverse of the node's parity.
1635 child_total += (guint) node->left->parity;
1636 child_total += (guint) node->right->parity;
1639 child_total += (guint) node->children->root->parity;
1641 rem = child_total % 2;
1644 return node->parity;
1646 return !node->parity;
1650 count_parity (GtkRBTree *tree,
1655 if (node == tree->nil)
1659 count_parity (tree, node->left) +
1660 count_parity (tree, node->right) +
1662 (node->children ? count_parity (node->children, node->children->root) : 0);
1664 res = res % (guint)2;
1666 if (res != node->parity)
1667 g_print ("parity incorrect for node\n");
1669 if (get_parity (node) != 1)
1670 g_error ("Node has incorrect parity %d", get_parity (node));
1676 _gtk_rbtree_test_height (GtkRBTree *tree,
1679 gint computed_offset = 0;
1681 /* This whole test is sort of a useless truism. */
1683 if (node->left != tree->nil)
1684 computed_offset += node->left->offset;
1686 if (node->right != tree->nil)
1687 computed_offset += node->right->offset;
1689 if (node->children && node->children->root != node->children->nil)
1690 computed_offset += node->children->root->offset;
1692 if (GTK_RBNODE_GET_HEIGHT (node) + computed_offset != node->offset)
1693 g_error ("node has broken offset\n");
1695 if (node->left != tree->nil)
1696 _gtk_rbtree_test_height (tree, node->left);
1698 if (node->right != tree->nil)
1699 _gtk_rbtree_test_height (tree, node->right);
1701 if (node->children && node->children->root != node->children->nil)
1702 _gtk_rbtree_test_height (node->children, node->children->root);
1706 _gtk_rbtree_test_dirty (GtkRBTree *tree,
1708 gint expected_dirtyness)
1711 if (expected_dirtyness)
1713 g_assert (GTK_RBNODE_FLAG_SET (node, GTK_RBNODE_COLUMN_INVALID) ||
1714 GTK_RBNODE_FLAG_SET (node, GTK_RBNODE_INVALID) ||
1715 (node->left != tree->nil && GTK_RBNODE_FLAG_SET (node->left, GTK_RBNODE_DESCENDANTS_INVALID)) ||
1716 (node->right != tree->nil && GTK_RBNODE_FLAG_SET (node->right, GTK_RBNODE_DESCENDANTS_INVALID)) ||
1717 (node->children && GTK_RBNODE_FLAG_SET (node->children->root, GTK_RBNODE_DESCENDANTS_INVALID)));
1721 g_assert (! GTK_RBNODE_FLAG_SET (node, GTK_RBNODE_COLUMN_INVALID) &&
1722 ! GTK_RBNODE_FLAG_SET (node, GTK_RBNODE_INVALID));
1723 if (node->left != tree->nil)
1724 g_assert (! GTK_RBNODE_FLAG_SET (node->left, GTK_RBNODE_DESCENDANTS_INVALID));
1725 if (node->right != tree->nil)
1726 g_assert (! GTK_RBNODE_FLAG_SET (node->right, GTK_RBNODE_DESCENDANTS_INVALID));
1727 if (node->children != NULL)
1728 g_assert (! GTK_RBNODE_FLAG_SET (node->children->root, GTK_RBNODE_DESCENDANTS_INVALID));
1731 if (node->left != tree->nil)
1732 _gtk_rbtree_test_dirty (tree, node->left, GTK_RBNODE_FLAG_SET (node->left, GTK_RBNODE_DESCENDANTS_INVALID));
1733 if (node->right != tree->nil)
1734 _gtk_rbtree_test_dirty (tree, node->right, GTK_RBNODE_FLAG_SET (node->right, GTK_RBNODE_DESCENDANTS_INVALID));
1735 if (node->children != NULL && node->children->root != node->children->nil)
1736 _gtk_rbtree_test_dirty (node->children, node->children->root, GTK_RBNODE_FLAG_SET (node->children->root, GTK_RBNODE_DESCENDANTS_INVALID));
1739 static void _gtk_rbtree_test_structure (GtkRBTree *tree);
1742 _gtk_rbtree_test_structure_helper (GtkRBTree *tree,
1745 g_assert (node != tree->nil);
1747 g_assert (node->left != NULL);
1748 g_assert (node->right != NULL);
1749 g_assert (node->parent != NULL);
1751 if (node->left != tree->nil)
1753 g_assert (node->left->parent == node);
1754 _gtk_rbtree_test_structure_helper (tree, node->left);
1756 if (node->right != tree->nil)
1758 g_assert (node->right->parent == node);
1759 _gtk_rbtree_test_structure_helper (tree, node->right);
1762 if (node->children != NULL)
1764 g_assert (node->children->parent_tree == tree);
1765 g_assert (node->children->parent_node == node);
1767 _gtk_rbtree_test_structure (node->children);
1771 _gtk_rbtree_test_structure (GtkRBTree *tree)
1773 g_assert (tree->root);
1774 if (tree->root == tree->nil)
1777 g_assert (tree->root->parent == tree->nil);
1778 _gtk_rbtree_test_structure_helper (tree, tree->root);
1782 _gtk_rbtree_test (const gchar *where,
1785 GtkRBTree *tmp_tree;
1790 /* Test the entire tree */
1792 while (tmp_tree->parent_tree)
1793 tmp_tree = tmp_tree->parent_tree;
1795 g_assert (tmp_tree->nil != NULL);
1797 if (tmp_tree->root == tmp_tree->nil)
1800 _gtk_rbtree_test_structure (tmp_tree);
1802 g_assert ((_count_nodes (tmp_tree, tmp_tree->root->left) +
1803 _count_nodes (tmp_tree, tmp_tree->root->right) + 1) == tmp_tree->root->count);
1806 _gtk_rbtree_test_height (tmp_tree, tmp_tree->root);
1807 _gtk_rbtree_test_dirty (tmp_tree, tmp_tree->root, GTK_RBNODE_FLAG_SET (tmp_tree->root, GTK_RBNODE_DESCENDANTS_INVALID));
1808 g_assert (count_parity (tmp_tree, tmp_tree->root) == tmp_tree->root->parity);
1812 _gtk_rbtree_debug_spew_helper (GtkRBTree *tree,
1817 for (i = 0; i < depth; i++)
1820 g_print ("(%p - %s) (Offset %d) (Parity %d) (Validity %d%d%d)\n",
1822 (GTK_RBNODE_GET_COLOR (node) == GTK_RBNODE_BLACK)?"BLACK":" RED ",
1825 (GTK_RBNODE_FLAG_SET (node, GTK_RBNODE_DESCENDANTS_INVALID))?1:0,
1826 (GTK_RBNODE_FLAG_SET (node, GTK_RBNODE_INVALID))?1:0,
1827 (GTK_RBNODE_FLAG_SET (node, GTK_RBNODE_COLUMN_INVALID))?1:0);
1828 if (node->children != NULL)
1830 g_print ("Looking at child.\n");
1831 _gtk_rbtree_debug_spew (node->children);
1832 g_print ("Done looking at child.\n");
1834 if (node->left != tree->nil)
1836 _gtk_rbtree_debug_spew_helper (tree, node->left, depth+1);
1838 if (node->right != tree->nil)
1840 _gtk_rbtree_debug_spew_helper (tree, node->right, depth+1);
1845 _gtk_rbtree_debug_spew (GtkRBTree *tree)
1847 g_return_if_fail (tree != NULL);
1849 if (tree->root == tree->nil)
1850 g_print ("Empty tree...\n");
1852 _gtk_rbtree_debug_spew_helper (tree, tree->root, 0);
1854 #endif /* G_ENABLE_DEBUG */