Pileus Git - ~andy/gtk/blob - gtk/gtkrbtree.c

   1 /* gtkrbtree.c
   2  * Copyright (C) 2000  Red Hat, Inc.,  Jonathan Blandford <jrb@redhat.com>
   3  *
   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.
   8  *
   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.
  13  *
  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.
  18  */
  19
  20 #include "gtkrbtree.h"
  21 #include "gtkdebug.h"
  22
  23 static void        _gtk_rbnode_validate_allocator (GAllocator *allocator);
  24 static GtkRBNode * _gtk_rbnode_new                (GtkRBTree  *tree,
  25                                                    gint        height);
  26 static void        _gtk_rbnode_free               (GtkRBNode  *node);
  27 static void        _gtk_rbnode_rotate_left        (GtkRBTree  *tree,
  28                                                    GtkRBNode  *node);
  29 static void        _gtk_rbnode_rotate_right       (GtkRBTree  *tree,
  30                                                    GtkRBNode  *node);
  31 static void        _gtk_rbtree_insert_fixup       (GtkRBTree  *tree,
  32                                                    GtkRBNode  *node);
  33 static void        _gtk_rbtree_remove_node_fixup  (GtkRBTree  *tree,
  34                                                    GtkRBNode  *node);
  35 static gint        _count_nodes                   (GtkRBTree  *tree,
  36                                                    GtkRBNode  *node);
  37 static inline void _fixup_validation              (GtkRBTree  *tree,
  38                                                    GtkRBNode  *node);
  39 static inline void _fixup_parity                  (GtkRBTree  *tree,
  40                                                    GtkRBNode  *node);
  41
  42
  43
  44 /* node allocation
  45  */
  46 struct _GAllocator /* from gmem.c */
  47 {
  48   gchar      *name;
  49   guint16     n_preallocs;
  50   guint       is_unused : 1;
  51   guint       type : 4;
  52   GAllocator *last;
  53   GMemChunk  *mem_chunk;
  54   GtkRBNode  *free_nodes; /* implementation specific */
  55 };
  56
  57
  58 G_LOCK_DEFINE_STATIC (current_allocator);
  59 static GAllocator *current_allocator = NULL;
  60
  61
  62 /* HOLDS: current_allocator_lock */
  63 static void
  64 _gtk_rbnode_validate_allocator (GAllocator *allocator)
  65 {
  66   g_return_if_fail (allocator != NULL);
  67   g_return_if_fail (allocator->is_unused == TRUE);
  68
  69   if (allocator->type != G_ALLOCATOR_NODE)
  70     {
  71       allocator->type = G_ALLOCATOR_NODE;
  72       if (allocator->mem_chunk)
  73         {
  74           g_mem_chunk_destroy (allocator->mem_chunk);
  75           allocator->mem_chunk = NULL;
  76         }
  77     }
  78
  79   if (!allocator->mem_chunk)
  80     {
  81       allocator->mem_chunk = g_mem_chunk_new (allocator->name,
  82                                               sizeof (GtkRBNode),
  83                                               sizeof (GtkRBNode) * allocator->n_preallocs,
  84                                               G_ALLOC_ONLY);
  85       allocator->free_nodes = NULL;
  86     }
  87
  88   allocator->is_unused = FALSE;
  89 }
  90
  91 static GtkRBNode *
  92 _gtk_rbnode_new (GtkRBTree *tree,
  93                  gint       height)
  94 {
  95   GtkRBNode *node;
  96
  97   G_LOCK (current_allocator);
  98   if (!current_allocator)
  99     {
 100       GAllocator *allocator = g_allocator_new ("GTK+ default GtkRBNode allocator",
 101                                                128);
 102       _gtk_rbnode_validate_allocator (allocator);
 103       allocator->last = NULL;
 104       current_allocator = allocator;
 105     }
 106   if (!current_allocator->free_nodes)
 107     node = g_chunk_new (GtkRBNode, current_allocator->mem_chunk);
 108   else
 109     {
 110       node = current_allocator->free_nodes;
 111       current_allocator->free_nodes = node->left;
 112     }
 113   G_UNLOCK (current_allocator);
 114
 115   node->left = tree->nil;
 116   node->right = tree->nil;
 117   node->parent = tree->nil;
 118   node->flags = GTK_RBNODE_RED;
 119   node->parity = 1;
 120   node->count = 1;
 121   node->children = NULL;
 122   node->offset = height;
 123   return node;
 124 }
 125
 126 static void
 127 _gtk_rbnode_free (GtkRBNode *node)
 128 {
 129   G_LOCK (current_allocator);
 130   node->left = current_allocator->free_nodes;
 131   current_allocator->free_nodes = node;
 132   if (gtk_debug_flags & GTK_DEBUG_TREE)
 133     {
 134       /* unfortunately node->left has to continue to point to
 135        * a node...
 136        */
 137       node->right = (gpointer) 0xdeadbeef;
 138       node->parent = (gpointer) 0xdeadbeef;
 139       node->offset = 56789;
 140       node->count = 56789;
 141       node->flags = 0;
 142     }
 143   G_UNLOCK (current_allocator);
 144 }
 145
 146 static void
 147 _gtk_rbnode_rotate_left (GtkRBTree *tree,
 148                          GtkRBNode *node)
 149 {
 150   gint node_height, right_height;
 151   GtkRBNode *right = node->right;
 152
 153   g_return_if_fail (node != tree->nil);
 154
 155   node_height = node->offset -
 156     (node->left?node->left->offset:0) -
 157     (node->right?node->right->offset:0) -
 158     (node->children?node->children->root->offset:0);
 159   right_height = right->offset -
 160     (right->left?right->left->offset:0) -
 161     (right->right?right->right->offset:0) -
 162     (right->children?right->children->root->offset:0);
 163   node->right = right->left;
 164   if (right->left != tree->nil)
 165     right->left->parent = node;
 166
 167   if (right != tree->nil)
 168     right->parent = node->parent;
 169   if (node->parent != tree->nil)
 170     {
 171       if (node == node->parent->left)
 172         node->parent->left = right;
 173       else
 174         node->parent->right = right;
 175     } else {
 176       tree->root = right;
 177     }
 178
 179   right->left = node;
 180   if (node != tree->nil)
 181     node->parent = right;
 182
 183   node->count = 1 + (node->left?node->left->count:0) +
 184     (node->right?node->right->count:0);
 185   right->count = 1 + (right->left?right->left->count:0) +
 186     (right->right?right->right->count:0);
 187
 188   node->offset = node_height +
 189     (node->left?node->left->offset:0) +
 190     (node->right?node->right->offset:0) +
 191     (node->children?node->children->root->offset:0);
 192   right->offset = right_height +
 193     (right->left?right->left->offset:0) +
 194     (right->right?right->right->offset:0) +
 195     (right->children?right->children->root->offset:0);
 196
 197   _fixup_validation (tree, node);
 198   _fixup_validation (tree, right);
 199   _fixup_parity (tree, node);
 200   _fixup_parity (tree, right);
 201 }
 202
 203 static void
 204 _gtk_rbnode_rotate_right (GtkRBTree *tree,
 205                           GtkRBNode *node)
 206 {
 207   gint node_height, left_height;
 208   GtkRBNode *left = node->left;
 209
 210   g_return_if_fail (node != tree->nil);
 211
 212   node_height = node->offset -
 213     (node->left?node->left->offset:0) -
 214     (node->right?node->right->offset:0) -
 215     (node->children?node->children->root->offset:0);
 216   left_height = left->offset -
 217     (left->left?left->left->offset:0) -
 218     (left->right?left->right->offset:0) -
 219     (left->children?left->children->root->offset:0);
 220
 221   node->left = left->right;
 222   if (left->right != tree->nil)
 223     left->right->parent = node;
 224
 225   if (left != tree->nil)
 226     left->parent = node->parent;
 227   if (node->parent != tree->nil)
 228     {
 229       if (node == node->parent->right)
 230         node->parent->right = left;
 231       else
 232         node->parent->left = left;
 233     }
 234   else
 235     {
 236       tree->root = left;
 237     }
 238
 239   /* link node and left */
 240   left->right = node;
 241   if (node != tree->nil)
 242     node->parent = left;
 243
 244   node->count = 1 + (node->left?node->left->count:0) +
 245     (node->right?node->right->count:0);
 246   left->count = 1 + (left->left?left->left->count:0) +
 247     (left->right?left->right->count:0);
 248
 249   node->offset = node_height +
 250     (node->left?node->left->offset:0) +
 251     (node->right?node->right->offset:0) +
 252     (node->children?node->children->root->offset:0);
 253   left->offset = left_height +
 254     (left->left?left->left->offset:0) +
 255     (left->right?left->right->offset:0) +
 256     (left->children?left->children->root->offset:0);
 257
 258   _fixup_validation (tree, node);
 259   _fixup_validation (tree, left);
 260   _fixup_parity (tree, node);
 261   _fixup_parity (tree, left);
 262 }
 263
 264 static void
 265 _gtk_rbtree_insert_fixup (GtkRBTree *tree,
 266                           GtkRBNode *node)
 267 {
 268
 269   /* check Red-Black properties */
 270   while (node != tree->root && GTK_RBNODE_GET_COLOR (node->parent) == GTK_RBNODE_RED)
 271     {
 272       /* we have a violation */
 273       if (node->parent == node->parent->parent->left)
 274         {
 275           GtkRBNode *y = node->parent->parent->right;
 276           if (GTK_RBNODE_GET_COLOR (y) == GTK_RBNODE_RED)
 277             {
 278                                 /* uncle is GTK_RBNODE_RED */
 279               GTK_RBNODE_SET_COLOR (node->parent, GTK_RBNODE_BLACK);
 280               GTK_RBNODE_SET_COLOR (y, GTK_RBNODE_BLACK);
 281               GTK_RBNODE_SET_COLOR (node->parent->parent, GTK_RBNODE_RED);
 282               node = node->parent->parent;
 283             }
 284           else
 285             {
 286                                 /* uncle is GTK_RBNODE_BLACK */
 287               if (node == node->parent->right)
 288                 {
 289                   /* make node a left child */
 290                   node = node->parent;
 291                   _gtk_rbnode_rotate_left (tree, node);
 292                 }
 293
 294                                 /* recolor and rotate */
 295               GTK_RBNODE_SET_COLOR (node->parent, GTK_RBNODE_BLACK);
 296               GTK_RBNODE_SET_COLOR (node->parent->parent, GTK_RBNODE_RED);
 297               _gtk_rbnode_rotate_right(tree, node->parent->parent);
 298             }
 299         }
 300       else
 301         {
 302           /* mirror image of above code */
 303           GtkRBNode *y = node->parent->parent->left;
 304           if (GTK_RBNODE_GET_COLOR (y) == GTK_RBNODE_RED)
 305             {
 306                                 /* uncle is GTK_RBNODE_RED */
 307               GTK_RBNODE_SET_COLOR (node->parent, GTK_RBNODE_BLACK);
 308               GTK_RBNODE_SET_COLOR (y, GTK_RBNODE_BLACK);
 309               GTK_RBNODE_SET_COLOR (node->parent->parent, GTK_RBNODE_RED);
 310               node = node->parent->parent;
 311             }
 312           else
 313             {
 314                                 /* uncle is GTK_RBNODE_BLACK */
 315               if (node == node->parent->left)
 316                 {
 317                   node = node->parent;
 318                   _gtk_rbnode_rotate_right (tree, node);
 319                 }
 320               GTK_RBNODE_SET_COLOR (node->parent, GTK_RBNODE_BLACK);
 321               GTK_RBNODE_SET_COLOR (node->parent->parent, GTK_RBNODE_RED);
 322               _gtk_rbnode_rotate_left (tree, node->parent->parent);
 323             }
 324         }
 325     }
 326   GTK_RBNODE_SET_COLOR (tree->root, GTK_RBNODE_BLACK);
 327 }
 328
 329 static void
 330 _gtk_rbtree_remove_node_fixup (GtkRBTree *tree,
 331                                GtkRBNode *node)
 332 {
 333   while (node != tree->root && GTK_RBNODE_GET_COLOR (node) == GTK_RBNODE_BLACK)
 334     {
 335       if (node == node->parent->left)
 336         {
 337           GtkRBNode *w = node->parent->right;
 338           if (GTK_RBNODE_GET_COLOR (w) == GTK_RBNODE_RED)
 339             {
 340               GTK_RBNODE_SET_COLOR (w, GTK_RBNODE_BLACK);
 341               GTK_RBNODE_SET_COLOR (node->parent, GTK_RBNODE_RED);
 342               _gtk_rbnode_rotate_left (tree, node->parent);
 343               w = node->parent->right;
 344             }
 345           if (GTK_RBNODE_GET_COLOR (w->left) == GTK_RBNODE_BLACK && GTK_RBNODE_GET_COLOR (w->right) == GTK_RBNODE_BLACK)
 346             {
 347               GTK_RBNODE_SET_COLOR (w, GTK_RBNODE_RED);
 348               node = node->parent;
 349             }
 350           else
 351             {
 352               if (GTK_RBNODE_GET_COLOR (w->right) == GTK_RBNODE_BLACK)
 353                 {
 354                   GTK_RBNODE_SET_COLOR (w->left, GTK_RBNODE_BLACK);
 355                   GTK_RBNODE_SET_COLOR (w, GTK_RBNODE_RED);
 356                   _gtk_rbnode_rotate_right (tree, w);
 357                   w = node->parent->right;
 358                 }
 359               GTK_RBNODE_SET_COLOR (w, GTK_RBNODE_GET_COLOR (node->parent));
 360               GTK_RBNODE_SET_COLOR (node->parent, GTK_RBNODE_BLACK);
 361               GTK_RBNODE_SET_COLOR (w->right, GTK_RBNODE_BLACK);
 362               _gtk_rbnode_rotate_left (tree, node->parent);
 363               node = tree->root;
 364             }
 365         }
 366       else
 367         {
 368           GtkRBNode *w = node->parent->left;
 369           if (GTK_RBNODE_GET_COLOR (w) == GTK_RBNODE_RED)
 370             {
 371               GTK_RBNODE_SET_COLOR (w, GTK_RBNODE_BLACK);
 372               GTK_RBNODE_SET_COLOR (node->parent, GTK_RBNODE_RED);
 373               _gtk_rbnode_rotate_right (tree, node->parent);
 374               w = node->parent->left;
 375             }
 376           if (GTK_RBNODE_GET_COLOR (w->right) == GTK_RBNODE_BLACK && GTK_RBNODE_GET_COLOR (w->left) == GTK_RBNODE_BLACK)
 377             {
 378               GTK_RBNODE_SET_COLOR (w, GTK_RBNODE_RED);
 379               node = node->parent;
 380             }
 381           else
 382             {
 383               if (GTK_RBNODE_GET_COLOR (w->left) == GTK_RBNODE_BLACK)
 384                 {
 385                   GTK_RBNODE_SET_COLOR (w->right, GTK_RBNODE_BLACK);
 386                   GTK_RBNODE_SET_COLOR (w, GTK_RBNODE_RED);
 387                   _gtk_rbnode_rotate_left (tree, w);
 388                   w = node->parent->left;
 389                 }
 390               GTK_RBNODE_SET_COLOR (w, GTK_RBNODE_GET_COLOR (node->parent));
 391               GTK_RBNODE_SET_COLOR (node->parent, GTK_RBNODE_BLACK);
 392               GTK_RBNODE_SET_COLOR (w->left, GTK_RBNODE_BLACK);
 393               _gtk_rbnode_rotate_right (tree, node->parent);
 394               node = tree->root;
 395             }
 396         }
 397     }
 398   GTK_RBNODE_SET_COLOR (node, GTK_RBNODE_BLACK);
 399 }
 400
 401 /* Public functions */
 402 void
 403 _gtk_rbnode_push_allocator (GAllocator *allocator)
 404 {
 405   G_LOCK (current_allocator);
 406   _gtk_rbnode_validate_allocator ( allocator );
 407   allocator->last = current_allocator;
 408   current_allocator = allocator;
 409   G_UNLOCK (current_allocator);
 410 }
 411
 412 void
 413 _gtk_rbnode_pop_allocator (void)
 414 {
 415   G_LOCK (current_allocator);
 416   if (current_allocator)
 417     {
 418       GAllocator *allocator;
 419
 420       allocator = current_allocator;
 421       current_allocator = allocator->last;
 422       allocator->last = NULL;
 423       allocator->is_unused = TRUE;
 424     }
 425   G_UNLOCK (current_allocator);
 426 }
 427
 428 GtkRBTree *
 429 _gtk_rbtree_new (void)
 430 {
 431   GtkRBTree *retval;
 432
 433   retval = (GtkRBTree *) g_new (GtkRBTree, 1);
 434   retval->parent_tree = NULL;
 435   retval->parent_node = NULL;
 436
 437   retval->nil = g_new0 (GtkRBNode, 1);
 438   retval->nil->left = NULL;
 439   retval->nil->right = NULL;
 440   retval->nil->parent = NULL;
 441   retval->nil->flags = GTK_RBNODE_BLACK;
 442   retval->nil->count = 0;
 443   retval->nil->offset = 0;
 444   retval->nil->parity = 0;
 445
 446   retval->root = retval->nil;
 447   return retval;
 448 }
 449
 450 static void
 451 _gtk_rbtree_free_helper (GtkRBTree  *tree,
 452                          GtkRBNode  *node,
 453                          gpointer    data)
 454 {
 455   if (node->children)
 456     _gtk_rbtree_free (node->children);
 457
 458   _gtk_rbnode_free (node);
 459 }
 460
 461 void
 462 _gtk_rbtree_free (GtkRBTree *tree)
 463 {
 464   _gtk_rbtree_traverse (tree,
 465                         tree->root,
 466                         G_POST_ORDER,
 467                         _gtk_rbtree_free_helper,
 468                         NULL);
 469
 470   if (tree->parent_node &&
 471       tree->parent_node->children == tree)
 472     tree->parent_node->children = NULL;
 473   _gtk_rbnode_free (tree->nil);
 474   g_free (tree);
 475 }
 476
 477 void
 478 _gtk_rbtree_remove (GtkRBTree *tree)
 479 {
 480   GtkRBTree *tmp_tree;
 481   GtkRBNode *tmp_node;
 482
 483   gint height = tree->root->offset;
 484
 485   if (gtk_debug_flags & GTK_DEBUG_TREE)
 486     _gtk_rbtree_test (G_STRLOC, tree);
 487
 488   tmp_tree = tree->parent_tree;
 489   tmp_node = tree->parent_node;
 490
 491   /* ugly hack to make _fixup_validation work in the first iteration of the
 492    * loop below */
 493   GTK_RBNODE_UNSET_FLAG (tree->root, GTK_RBNODE_DESCENDANTS_INVALID);
 494
 495   while (tmp_tree && tmp_node && tmp_node != tmp_tree->nil)
 496     {
 497       _fixup_validation (tmp_tree, tmp_node);
 498       tmp_node->offset -= height;
 499
 500       /* If the removed tree was odd, flip all parents */
 501       if (tree->root->parity)
 502         tmp_node->parity = !tmp_node->parity;
 503
 504       tmp_node = tmp_node->parent;
 505       if (tmp_node == tmp_tree->nil)
 506         {
 507           tmp_node = tmp_tree->parent_node;
 508           tmp_tree = tmp_tree->parent_tree;
 509         }
 510     }
 511
 512   tmp_tree = tree->parent_tree;
 513   tmp_node = tree->parent_node;
 514   _gtk_rbtree_free (tree);
 515
 516   if (gtk_debug_flags & GTK_DEBUG_TREE)
 517     _gtk_rbtree_test (G_STRLOC, tmp_tree);
 518 }
 519
 520
 521 GtkRBNode *
 522 _gtk_rbtree_insert_after (GtkRBTree *tree,
 523                           GtkRBNode *current,
 524                           gint       height,
 525                           gboolean   valid)
 526 {
 527   GtkRBNode *node;
 528   gboolean right = TRUE;
 529   GtkRBNode *tmp_node;
 530   GtkRBTree *tmp_tree;
 531
 532   if (gtk_debug_flags & GTK_DEBUG_TREE)
 533     {
 534       g_print ("\n\n_gtk_rbtree_insert_after: 0x%x\n", (gint) current);
 535       _gtk_rbtree_debug_spew (tree);
 536       _gtk_rbtree_test (G_STRLOC, tree);
 537     }
 538
 539   if (current != NULL && current->right != tree->nil)
 540     {
 541       current = current->right;
 542       while (current->left != tree->nil)
 543         current = current->left;
 544       right = FALSE;
 545     }
 546   /* setup new node */
 547   node = _gtk_rbnode_new (tree, height);
 548   node->parent = (current?current:tree->nil);
 549
 550   /* insert node in tree */
 551   if (current)
 552     {
 553       if (right)
 554         current->right = node;
 555       else
 556         current->left = node;
 557       tmp_node = node->parent;
 558       tmp_tree = tree;
 559     }
 560   else
 561     {
 562       tree->root = node;
 563       tmp_node = tree->parent_node;
 564       tmp_tree = tree->parent_tree;
 565     }
 566
 567   while (tmp_tree && tmp_node && tmp_node != tmp_tree->nil)
 568     {
 569       /* We only want to propagate the count if we are in the tree we
 570        * started in. */
 571       if (tmp_tree == tree)
 572         tmp_node->count++;
 573
 574       tmp_node->parity += 1;
 575       tmp_node->offset += height;
 576       tmp_node = tmp_node->parent;
 577       if (tmp_node == tmp_tree->nil)
 578         {
 579           tmp_node = tmp_tree->parent_node;
 580           tmp_tree = tmp_tree->parent_tree;
 581         }
 582     }
 583
 584   if (valid)
 585     _gtk_rbtree_node_mark_valid (tree, node);
 586   else
 587     _gtk_rbtree_node_mark_invalid (tree, node);
 588
 589   _gtk_rbtree_insert_fixup (tree, node);
 590
 591   if (gtk_debug_flags & GTK_DEBUG_TREE)
 592     {
 593       g_print ("_gtk_rbtree_insert_after finished...\n");
 594       _gtk_rbtree_debug_spew (tree);
 595       g_print ("\n\n");
 596       _gtk_rbtree_test (G_STRLOC, tree);
 597     }
 598
 599   return node;
 600 }
 601
 602 GtkRBNode *
 603 _gtk_rbtree_insert_before (GtkRBTree *tree,
 604                            GtkRBNode *current,
 605                            gint       height,
 606                            gboolean   valid)
 607 {
 608   GtkRBNode *node;
 609   gboolean left = TRUE;
 610   GtkRBNode *tmp_node;
 611   GtkRBTree *tmp_tree;
 612
 613   if (gtk_debug_flags & GTK_DEBUG_TREE)
 614     {
 615       g_print ("\n\n_gtk_rbtree_insert_before: 0x%x\n", (gint) current);
 616       _gtk_rbtree_debug_spew (tree);
 617       _gtk_rbtree_test (G_STRLOC, tree);
 618     }
 619
 620   if (current != NULL && current->left != tree->nil)
 621     {
 622       current = current->left;
 623       while (current->right != tree->nil)
 624         current = current->right;
 625       left = FALSE;
 626     }
 627
 628   /* setup new node */
 629   node = _gtk_rbnode_new (tree, height);
 630   node->parent = (current?current:tree->nil);
 631
 632   /* insert node in tree */
 633   if (current)
 634     {
 635       if (left)
 636         current->left = node;
 637       else
 638         current->right = node;
 639       tmp_node = node->parent;
 640       tmp_tree = tree;
 641     }
 642   else
 643     {
 644       tree->root = node;
 645       tmp_node = tree->parent_node;
 646       tmp_tree = tree->parent_tree;
 647     }
 648
 649   while (tmp_tree && tmp_node && tmp_node != tmp_tree->nil)
 650     {
 651       /* We only want to propagate the count if we are in the tree we
 652        * started in. */
 653       if (tmp_tree == tree)
 654         tmp_node->count++;
 655
 656       tmp_node->parity += 1;
 657       tmp_node->offset += height;
 658       tmp_node = tmp_node->parent;
 659       if (tmp_node == tmp_tree->nil)
 660         {
 661           tmp_node = tmp_tree->parent_node;
 662           tmp_tree = tmp_tree->parent_tree;
 663         }
 664     }
 665
 666   if (valid)
 667     _gtk_rbtree_node_mark_valid (tree, node);
 668   else
 669     _gtk_rbtree_node_mark_invalid (tree, node);
 670
 671   _gtk_rbtree_insert_fixup (tree, node);
 672
 673   if (gtk_debug_flags & GTK_DEBUG_TREE)
 674     {
 675       g_print ("_gtk_rbtree_insert_before finished...\n");
 676       _gtk_rbtree_debug_spew (tree);
 677       g_print ("\n\n");
 678       _gtk_rbtree_test (G_STRLOC, tree);
 679     }
 680
 681   return node;
 682 }
 683
 684 GtkRBNode *
 685 _gtk_rbtree_find_count (GtkRBTree *tree,
 686                         gint       count)
 687 {
 688   GtkRBNode *node;
 689
 690   node = tree->root;
 691   while (node != tree->nil && (node->left->count + 1 != count))
 692     {
 693       if (node->left->count >= count)
 694         node = node->left;
 695       else
 696         {
 697           count -= (node->left->count + 1);
 698           node = node->right;
 699         }
 700     }
 701   if (node == tree->nil)
 702     return NULL;
 703   return node;
 704 }
 705
 706 void
 707 _gtk_rbtree_node_set_height (GtkRBTree *tree,
 708                              GtkRBNode *node,
 709                              gint       height)
 710 {
 711   gint diff = height - GTK_RBNODE_GET_HEIGHT (node);
 712   GtkRBNode *tmp_node = node;
 713   GtkRBTree *tmp_tree = tree;
 714
 715   if (diff == 0)
 716     return;
 717
 718   while (tmp_tree && tmp_node && tmp_node != tmp_tree->nil)
 719     {
 720       tmp_node->offset += diff;
 721       tmp_node = tmp_node->parent;
 722       if (tmp_node == tmp_tree->nil)
 723         {
 724           tmp_node = tmp_tree->parent_node;
 725           tmp_tree = tmp_tree->parent_tree;
 726         }
 727     }
 728   if (gtk_debug_flags & GTK_DEBUG_TREE)
 729     _gtk_rbtree_test (G_STRLOC, tree);
 730 }
 731
 732 void
 733 _gtk_rbtree_node_mark_invalid (GtkRBTree *tree,
 734                                GtkRBNode *node)
 735 {
 736   if (GTK_RBNODE_FLAG_SET (node, GTK_RBNODE_INVALID))
 737     return;
 738
 739   GTK_RBNODE_SET_FLAG (node, GTK_RBNODE_INVALID);
 740   do
 741     {
 742       if (GTK_RBNODE_FLAG_SET (node, GTK_RBNODE_DESCENDANTS_INVALID))
 743         return;
 744       GTK_RBNODE_SET_FLAG (node, GTK_RBNODE_DESCENDANTS_INVALID);
 745       node = node->parent;
 746       if (node == tree->nil)
 747         {
 748           node = tree->parent_node;
 749           tree = tree->parent_tree;
 750         }
 751     }
 752   while (node);
 753 }
 754
 755 #if 0
 756 /* Draconian version. */
 757 void
 758 _gtk_rbtree_node_mark_invalid (GtkRBTree *tree,
 759                                GtkRBNode *node)
 760 {
 761   GTK_RBNODE_SET_FLAG (node, GTK_RBNODE_INVALID);
 762   do
 763     {
 764       _fixup_validation (tree, node);
 765       node = node->parent;
 766       if (node == tree->nil)
 767         {
 768           node = tree->parent_node;
 769           tree = tree->parent_tree;
 770         }
 771     }
 772   while (node);
 773 }
 774 #endif
 775
 776 void
 777 _gtk_rbtree_node_mark_valid (GtkRBTree *tree,
 778                              GtkRBNode *node)
 779 {
 780   if ((!GTK_RBNODE_FLAG_SET (node, GTK_RBNODE_INVALID)) &&
 781       (!GTK_RBNODE_FLAG_SET (node, GTK_RBNODE_COLUMN_INVALID)))
 782     return;
 783
 784   GTK_RBNODE_UNSET_FLAG (node, GTK_RBNODE_INVALID);
 785   GTK_RBNODE_UNSET_FLAG (node, GTK_RBNODE_COLUMN_INVALID);
 786
 787   do
 788     {
 789       if ((GTK_RBNODE_FLAG_SET (node, GTK_RBNODE_INVALID)) ||
 790           (GTK_RBNODE_FLAG_SET (node, GTK_RBNODE_COLUMN_INVALID)) ||
 791           (node->children && GTK_RBNODE_FLAG_SET (node->children->root, GTK_RBNODE_DESCENDANTS_INVALID)) ||
 792           (node->left != tree->nil && GTK_RBNODE_FLAG_SET (node->left, GTK_RBNODE_DESCENDANTS_INVALID)) ||
 793           (node->right != tree->nil && GTK_RBNODE_FLAG_SET (node->right, GTK_RBNODE_DESCENDANTS_INVALID)))
 794         return;
 795
 796       GTK_RBNODE_UNSET_FLAG (node, GTK_RBNODE_DESCENDANTS_INVALID);
 797       node = node->parent;
 798       if (node == tree->nil)
 799         {
 800           node = tree->parent_node;
 801           tree = tree->parent_tree;
 802         }
 803     }
 804   while (node);
 805 }
 806
 807 #if 0
 808 /* Draconian version */
 809 void
 810 _gtk_rbtree_node_mark_valid (GtkRBTree *tree,
 811                              GtkRBNode *node)
 812 {
 813   GTK_RBNODE_UNSET_FLAG (node, GTK_RBNODE_INVALID);
 814   GTK_RBNODE_UNSET_FLAG (node, GTK_RBNODE_COLUMN_INVALID);
 815
 816   do
 817     {
 818       _fixup_validation (tree, node);
 819       node = node->parent;
 820       if (node == tree->nil)
 821         {
 822           node = tree->parent_node;
 823           tree = tree->parent_tree;
 824         }
 825     }
 826   while (node);
 827 }
 828 #endif
 829 /* Assume tree is the root node as it doesn't set DESCENDANTS_INVALID above.
 830  */
 831 void
 832 _gtk_rbtree_column_invalid (GtkRBTree *tree)
 833 {
 834   GtkRBNode *node;
 835
 836   if (tree == NULL)
 837     return;
 838   node = tree->root;
 839   g_assert (node);
 840
 841   while (node->left != tree->nil)
 842     node = node->left;
 843
 844   do
 845     {
 846       if (! (GTK_RBNODE_FLAG_SET (node, GTK_RBNODE_INVALID)))
 847         GTK_RBNODE_SET_FLAG (node, GTK_RBNODE_COLUMN_INVALID);
 848       GTK_RBNODE_SET_FLAG (node, GTK_RBNODE_DESCENDANTS_INVALID);
 849
 850       if (node->children)
 851         _gtk_rbtree_column_invalid (node->children);
 852     }
 853   while ((node = _gtk_rbtree_next (tree, node)) != NULL);
 854 }
 855
 856 void
 857 _gtk_rbtree_mark_invalid (GtkRBTree *tree)
 858 {
 859   GtkRBNode *node;
 860
 861   if (tree == NULL)
 862     return;
 863   node = tree->root;
 864   g_assert (node);
 865
 866   while (node->left != tree->nil)
 867     node = node->left;
 868
 869   do
 870     {
 871       GTK_RBNODE_SET_FLAG (node, GTK_RBNODE_INVALID);
 872       GTK_RBNODE_SET_FLAG (node, GTK_RBNODE_DESCENDANTS_INVALID);
 873
 874       if (node->children)
 875         _gtk_rbtree_mark_invalid (node->children);
 876     }
 877   while ((node = _gtk_rbtree_next (tree, node)) != NULL);
 878 }
 879
 880 typedef struct _GtkRBReorder
 881 {
 882   GtkRBTree *children;
 883   gint height;
 884   gint flags;
 885   gint order;
 886   gint invert_order;
 887   gint parity;
 888 } GtkRBReorder;
 889
 890 static int
 891 gtk_rbtree_reorder_sort_func (gconstpointer a,
 892                               gconstpointer b)
 893 {
 894   return ((GtkRBReorder *) a)->order > ((GtkRBReorder *) b)->order;
 895 }
 896
 897 static int
 898 gtk_rbtree_reorder_invert_func (gconstpointer a,
 899                                 gconstpointer b)
 900 {
 901   return ((GtkRBReorder *) a)->invert_order > ((GtkRBReorder *) b)->invert_order;
 902 }
 903
 904 static void
 905 gtk_rbtree_reorder_fixup (GtkRBTree *tree,
 906                           GtkRBNode *node)
 907 {
 908   if (node == tree->nil)
 909     return;
 910
 911   node->parity = 1;
 912
 913   if (node->left != tree->nil)
 914     {
 915       gtk_rbtree_reorder_fixup (tree, node->left);
 916       node->offset += node->left->offset;
 917       node->parity += node->left->parity;
 918     }
 919   if (node->right != tree->nil)
 920     {
 921       gtk_rbtree_reorder_fixup (tree, node->right);
 922       node->offset += node->right->offset;
 923       node->parity += node->right->parity;
 924     }
 925
 926   if (node->children)
 927     {
 928       node->offset += node->children->root->offset;
 929       node->parity += node->children->root->parity;
 930     }
 931
 932   if (GTK_RBNODE_FLAG_SET (node, GTK_RBNODE_INVALID) ||
 933       (node->right != tree->nil && GTK_RBNODE_FLAG_SET (node->right, GTK_RBNODE_DESCENDANTS_INVALID)) ||
 934       (node->left != tree->nil && GTK_RBNODE_FLAG_SET (node->left, GTK_RBNODE_DESCENDANTS_INVALID)) ||
 935       (node->children && GTK_RBNODE_FLAG_SET (node->children->root, GTK_RBNODE_DESCENDANTS_INVALID)))
 936     GTK_RBNODE_SET_FLAG (node, GTK_RBNODE_DESCENDANTS_INVALID);
 937   else
 938     GTK_RBNODE_UNSET_FLAG (node, GTK_RBNODE_DESCENDANTS_INVALID);
 939 }
 940
 941 /* It basically pulls everything out of the tree, rearranges it, and puts it
 942  * back together.  Our strategy is to keep the old RBTree intact, and just
 943  * rearrange the contents.  When that is done, we go through and update the
 944  * heights.  There is probably a more elegant way to write this function.  If
 945  * anyone wants to spend the time writing it, patches will be accepted.
 946  */
 947 void
 948 _gtk_rbtree_reorder (GtkRBTree *tree,
 949                      gint      *new_order,
 950                      gint       length)
 951 {
 952   GtkRBReorder reorder;
 953   GArray *array;
 954   GtkRBNode *node;
 955   gint i;
 956
 957   g_return_if_fail (tree != NULL);
 958   g_return_if_fail (length > 0);
 959   g_return_if_fail (tree->root->count == length);
 960
 961   /* Sort the trees values in the new tree. */
 962   array = g_array_sized_new (FALSE, FALSE, sizeof (GtkRBReorder), length);
 963   for (i = 0; i < length; i++)
 964     {
 965       reorder.order = new_order[i];
 966       reorder.invert_order = i;
 967       g_array_append_val (array, reorder);
 968     }
 969
 970   g_array_sort(array, gtk_rbtree_reorder_sort_func);
 971
 972   /* rewind node*/
 973   node = tree->root;
 974   while (node && node->left != tree->nil)
 975     node = node->left;
 976
 977   for (i = 0; i < length; i++)
 978     {
 979       g_assert (node != tree->nil);
 980       g_array_index (array, GtkRBReorder, i).children = node->children;
 981       g_array_index (array, GtkRBReorder, i).flags = GTK_RBNODE_NON_COLORS & node->flags;
 982       g_array_index (array, GtkRBReorder, i).height = GTK_RBNODE_GET_HEIGHT (node);
 983
 984       node = _gtk_rbtree_next (tree, node);
 985     }
 986
 987   g_array_sort (array, gtk_rbtree_reorder_invert_func);
 988
 989   /* rewind node*/
 990   node = tree->root;
 991   while (node && node->left != tree->nil)
 992     node = node->left;
 993
 994   /* Go through the tree and change the values to the new ones. */
 995   for (i = 0; i < length; i++)
 996     {
 997       reorder = g_array_index (array, GtkRBReorder, i);
 998       node->children = reorder.children;
 999       if (node->children)
1000         node->children->parent_node = node;
1001       node->flags = GTK_RBNODE_GET_COLOR (node) | reorder.flags;
1002       /* We temporarily set the height to this. */
1003       node->offset = reorder.height;
1004       node = _gtk_rbtree_next (tree, node);
1005     }
1006   gtk_rbtree_reorder_fixup (tree, tree->root);
1007 }
1008
1009
1010 gint
1011 _gtk_rbtree_node_find_offset (GtkRBTree *tree,
1012                               GtkRBNode *node)
1013 {
1014   GtkRBNode *last;
1015   gint retval;
1016
1017   g_assert (node);
1018   g_assert (node->left);
1019
1020   retval = node->left->offset;
1021
1022   while (tree && node && node != tree->nil)
1023     {
1024       last = node;
1025       node = node->parent;
1026
1027       /* Add left branch, plus children, iff we came from the right */
1028       if (node->right == last)
1029         retval += node->offset - node->right->offset;
1030
1031       if (node == tree->nil)
1032         {
1033           node = tree->parent_node;
1034           tree = tree->parent_tree;
1035
1036           /* Add the parent node, plus the left branch. */
1037           if (node)
1038             retval += node->left->offset + GTK_RBNODE_GET_HEIGHT (node);
1039         }
1040     }
1041   return retval;
1042 }
1043
1044 gint
1045 _gtk_rbtree_node_find_parity (GtkRBTree *tree,
1046                               GtkRBNode *node)
1047 {
1048   GtkRBNode *last;
1049   gint retval;
1050
1051   g_assert (node);
1052   g_assert (node->left);
1053
1054   retval = node->left->parity;
1055
1056   while (tree && node && node != tree->nil)
1057     {
1058       last = node;
1059       node = node->parent;
1060
1061       /* Add left branch, plus children, iff we came from the right */
1062       if (node->right == last)
1063         retval += node->parity - node->right->parity;
1064
1065       if (node == tree->nil)
1066         {
1067           node = tree->parent_node;
1068           tree = tree->parent_tree;
1069
1070           /* Add the parent node, plus the left branch. */
1071           if (node)
1072             retval += node->left->parity + 1; /* 1 == GTK_RBNODE_GET_PARITY() */
1073         }
1074     }
1075
1076   return retval % 2;
1077 }
1078
1079 gint
1080 _gtk_rbtree_real_find_offset (GtkRBTree  *tree,
1081                               gint        height,
1082                               GtkRBTree **new_tree,
1083                               GtkRBNode **new_node)
1084 {
1085   GtkRBNode *tmp_node;
1086
1087   g_assert (tree);
1088
1089   if (height < 0)
1090     {
1091       *new_tree = NULL;
1092       *new_node = NULL;
1093
1094       return 0;
1095     }
1096
1097
1098   tmp_node = tree->root;
1099   while (tmp_node != tree->nil &&
1100          (tmp_node->left->offset > height ||
1101           (tmp_node->offset - tmp_node->right->offset) < height))
1102     {
1103       if (tmp_node->left->offset > height)
1104         tmp_node = tmp_node->left;
1105       else
1106         {
1107           height -= (tmp_node->offset - tmp_node->right->offset);
1108           tmp_node = tmp_node->right;
1109         }
1110     }
1111   if (tmp_node == tree->nil)
1112     {
1113       *new_tree = NULL;
1114       *new_node = NULL;
1115       return 0;
1116     }
1117   if (tmp_node->children)
1118     {
1119       if ((tmp_node->offset -
1120            tmp_node->right->offset -
1121            tmp_node->children->root->offset) > height)
1122         {
1123           *new_tree = tree;
1124           *new_node = tmp_node;
1125           return (height - tmp_node->left->offset);
1126         }
1127       return _gtk_rbtree_real_find_offset (tmp_node->children,
1128                                            height - tmp_node->left->offset -
1129                                            (tmp_node->offset -
1130                                             tmp_node->left->offset -
1131                                             tmp_node->right->offset -
1132                                             tmp_node->children->root->offset),
1133                                            new_tree,
1134                                            new_node);
1135     }
1136   *new_tree = tree;
1137   *new_node = tmp_node;
1138   return (height - tmp_node->left->offset);
1139 }
1140
1141 gint
1142 _gtk_rbtree_find_offset (GtkRBTree  *tree,
1143                               gint        height,
1144                               GtkRBTree **new_tree,
1145                               GtkRBNode **new_node)
1146 {
1147   g_assert (tree);
1148
1149   if ((height < 0) ||
1150       (height >= tree->root->offset))
1151     {
1152       *new_tree = NULL;
1153       *new_node = NULL;
1154
1155       return 0;
1156     }
1157   return _gtk_rbtree_real_find_offset (tree, height, new_tree, new_node);
1158 }
1159
1160 void
1161 _gtk_rbtree_remove_node (GtkRBTree *tree,
1162                          GtkRBNode *node)
1163 {
1164   GtkRBNode *x, *y;
1165   GtkRBTree *tmp_tree;
1166   GtkRBNode *tmp_node;
1167   gint node_height;
1168   gint y_height;
1169
1170   g_return_if_fail (tree != NULL);
1171   g_return_if_fail (node != NULL);
1172
1173   if (gtk_debug_flags & GTK_DEBUG_TREE)
1174     {
1175       g_print ("\n\n_gtk_rbtree_remove_node: 0x%x\n", (gint) node);
1176       _gtk_rbtree_debug_spew (tree);
1177       _gtk_rbtree_test (G_STRLOC, tree);
1178     }
1179   /* make sure we're deleting a node that's actually in the tree */
1180   for (x = node; x->parent != tree->nil; x = x->parent)
1181     ;
1182   g_return_if_fail (x == tree->root);
1183
1184   if (gtk_debug_flags & GTK_DEBUG_TREE)
1185     _gtk_rbtree_test (G_STRLOC, tree);
1186
1187   if (node->left == tree->nil || node->right == tree->nil)
1188     {
1189       y = node;
1190     }
1191   else
1192     {
1193       y = node->right;
1194
1195       while (y->left != tree->nil)
1196         y = y->left;
1197     }
1198
1199   /* adjust count only beneath tree */
1200   for (x = y; x != tree->nil; x = x->parent)
1201     {
1202       x->count--;
1203     }
1204
1205   /* offsets and parity adjust all the way up through parent trees */
1206   y_height = GTK_RBNODE_GET_HEIGHT (y);
1207   node_height = GTK_RBNODE_GET_HEIGHT (node) + (node->children?node->children->root->offset:0);
1208
1209   tmp_tree = tree;
1210   tmp_node = y;
1211   while (tmp_tree && tmp_node && tmp_node != tmp_tree->nil)
1212     {
1213       tmp_node->offset -= (y_height + (y->children?y->children->root->offset:0));
1214       _fixup_validation (tmp_tree, tmp_node);
1215       _fixup_parity (tmp_tree, tmp_node);
1216       tmp_node = tmp_node->parent;
1217       if (tmp_node == tmp_tree->nil)
1218         {
1219           tmp_node = tmp_tree->parent_node;
1220           tmp_tree = tmp_tree->parent_tree;
1221         }
1222     }
1223
1224   /* x is y's only child, or nil */
1225   if (y->left != tree->nil)
1226     x = y->left;
1227   else
1228     x = y->right;
1229
1230   /* remove y from the parent chain */
1231   x->parent = y->parent;
1232   if (y->parent != tree->nil)
1233     {
1234       if (y == y->parent->left)
1235         y->parent->left = x;
1236       else
1237         y->parent->right = x;
1238     }
1239   else
1240     {
1241       tree->root = x;
1242     }
1243
1244   /* We need to clean up the validity of the tree.
1245    */
1246
1247   tmp_tree = tree;
1248   tmp_node = x;
1249   do
1250     {
1251       /* We skip the first time, iff x is nil */
1252       if (tmp_node != tmp_tree->nil)
1253         {
1254           _fixup_validation (tmp_tree, tmp_node);
1255           _fixup_parity (tmp_tree, tmp_node);
1256         }
1257       tmp_node = tmp_node->parent;
1258       if (tmp_node == tmp_tree->nil)
1259         {
1260           tmp_node = tmp_tree->parent_node;
1261           tmp_tree = tmp_tree->parent_tree;
1262         }
1263     }
1264   while (tmp_tree != NULL);
1265
1266   if (y != node)
1267     {
1268       gint diff;
1269
1270       /* Copy the node over */
1271       if (GTK_RBNODE_GET_COLOR (node) == GTK_RBNODE_BLACK)
1272         node->flags = ((y->flags & (GTK_RBNODE_NON_COLORS)) | GTK_RBNODE_BLACK);
1273       else
1274         node->flags = ((y->flags & (GTK_RBNODE_NON_COLORS)) | GTK_RBNODE_RED);
1275       node->children = y->children;
1276       if (y->children)
1277         {
1278           node->children = y->children;
1279           node->children->parent_node = node;
1280         }
1281       else
1282         {
1283           node->children = NULL;
1284         }
1285       _fixup_validation (tree, node);
1286       _fixup_parity (tree, node);
1287       /* We want to see how different our height is from the previous node.
1288        * To do this, we compare our current height with our supposed height.
1289        */
1290       diff = y_height - GTK_RBNODE_GET_HEIGHT (node);
1291       tmp_tree = tree;
1292       tmp_node = node;
1293
1294       while (tmp_tree && tmp_node && tmp_node != tmp_tree->nil)
1295         {
1296           tmp_node->offset += diff;
1297           _fixup_validation (tmp_tree, tmp_node);
1298           _fixup_parity (tmp_tree, tmp_node);
1299           tmp_node = tmp_node->parent;
1300           if (tmp_node == tmp_tree->nil)
1301             {
1302               tmp_node = tmp_tree->parent_node;
1303               tmp_tree = tmp_tree->parent_tree;
1304             }
1305         }
1306     }
1307
1308   if (GTK_RBNODE_GET_COLOR (y) == GTK_RBNODE_BLACK)
1309     _gtk_rbtree_remove_node_fixup (tree, x);
1310   _gtk_rbnode_free (y);
1311
1312   if (gtk_debug_flags & GTK_DEBUG_TREE)
1313     {
1314       g_print ("_gtk_rbtree_remove_node finished...\n");
1315       _gtk_rbtree_debug_spew (tree);
1316       g_print ("\n\n");
1317       _gtk_rbtree_test (G_STRLOC, tree);
1318     }
1319 }
1320
1321 GtkRBNode *
1322 _gtk_rbtree_next (GtkRBTree *tree,
1323                   GtkRBNode *node)
1324 {
1325   g_return_val_if_fail (tree != NULL, NULL);
1326   g_return_val_if_fail (node != NULL, NULL);
1327
1328   /* Case 1: the node's below us. */
1329   if (node->right != tree->nil)
1330     {
1331       node = node->right;
1332       while (node->left != tree->nil)
1333         node = node->left;
1334       return node;
1335     }
1336
1337   /* Case 2: it's an ancestor */
1338   while (node->parent != tree->nil)
1339     {
1340       if (node->parent->right == node)
1341         node = node->parent;
1342       else
1343         return (node->parent);
1344     }
1345
1346   /* Case 3: There is no next node */
1347   return NULL;
1348 }
1349
1350 GtkRBNode *
1351 _gtk_rbtree_prev (GtkRBTree *tree,
1352                   GtkRBNode *node)
1353 {
1354   g_return_val_if_fail (tree != NULL, NULL);
1355   g_return_val_if_fail (node != NULL, NULL);
1356
1357   /* Case 1: the node's below us. */
1358   if (node->left != tree->nil)
1359     {
1360       node = node->left;
1361       while (node->right != tree->nil)
1362         node = node->right;
1363       return node;
1364     }
1365
1366   /* Case 2: it's an ancestor */
1367   while (node->parent != tree->nil)
1368     {
1369       if (node->parent->left == node)
1370         node = node->parent;
1371       else
1372         return (node->parent);
1373     }
1374
1375   /* Case 3: There is no next node */
1376   return NULL;
1377 }
1378
1379 void
1380 _gtk_rbtree_next_full (GtkRBTree  *tree,
1381                        GtkRBNode  *node,
1382                        GtkRBTree **new_tree,
1383                        GtkRBNode **new_node)
1384 {
1385   g_return_if_fail (tree != NULL);
1386   g_return_if_fail (node != NULL);
1387   g_return_if_fail (new_tree != NULL);
1388   g_return_if_fail (new_node != NULL);
1389
1390   if (node->children)
1391     {
1392       *new_tree = node->children;
1393       *new_node = (*new_tree)->root;
1394       while ((*new_node)->left != (*new_tree)->nil)
1395         *new_node = (*new_node)->left;
1396       return;
1397     }
1398
1399   *new_tree = tree;
1400   *new_node = _gtk_rbtree_next (tree, node);
1401
1402   while ((*new_node == NULL) &&
1403          (*new_tree != NULL))
1404     {
1405       *new_node = (*new_tree)->parent_node;
1406       *new_tree = (*new_tree)->parent_tree;
1407       if (*new_tree)
1408         *new_node = _gtk_rbtree_next (*new_tree, *new_node);
1409     }
1410 }
1411
1412 void
1413 _gtk_rbtree_prev_full (GtkRBTree  *tree,
1414                        GtkRBNode  *node,
1415                        GtkRBTree **new_tree,
1416                        GtkRBNode **new_node)
1417 {
1418   g_return_if_fail (tree != NULL);
1419   g_return_if_fail (node != NULL);
1420   g_return_if_fail (new_tree != NULL);
1421   g_return_if_fail (new_node != NULL);
1422
1423   *new_tree = tree;
1424   *new_node = _gtk_rbtree_prev (tree, node);
1425
1426   if (*new_node == NULL)
1427     {
1428       *new_node = (*new_tree)->parent_node;
1429       *new_tree = (*new_tree)->parent_tree;
1430     }
1431   else
1432     {
1433       while ((*new_node)->children)
1434         {
1435           *new_tree = (*new_node)->children;
1436           *new_node = (*new_tree)->root;
1437           while ((*new_node)->right != (*new_tree)->nil)
1438             *new_node = (*new_node)->right;
1439         }
1440     }
1441 }
1442
1443 gint
1444 _gtk_rbtree_get_depth (GtkRBTree *tree)
1445 {
1446   GtkRBTree *tmp_tree;
1447   gint depth = 0;
1448
1449   tmp_tree = tree->parent_tree;
1450   while (tmp_tree)
1451     {
1452       ++depth;
1453       tmp_tree = tmp_tree->parent_tree;
1454     }
1455
1456   return depth;
1457 }
1458
1459 static void
1460 _gtk_rbtree_traverse_pre_order (GtkRBTree             *tree,
1461                                 GtkRBNode             *node,
1462                                 GtkRBTreeTraverseFunc  func,
1463                                 gpointer               data)
1464 {
1465   if (node == tree->nil)
1466     return;
1467
1468   (* func) (tree, node, data);
1469   _gtk_rbtree_traverse_pre_order (tree, node->left, func, data);
1470   _gtk_rbtree_traverse_pre_order (tree, node->right, func, data);
1471 }
1472
1473 static void
1474 _gtk_rbtree_traverse_post_order (GtkRBTree             *tree,
1475                                  GtkRBNode             *node,
1476                                  GtkRBTreeTraverseFunc  func,
1477                                  gpointer               data)
1478 {
1479   if (node == tree->nil)
1480     return;
1481
1482   _gtk_rbtree_traverse_post_order (tree, node->left, func, data);
1483   _gtk_rbtree_traverse_post_order (tree, node->right, func, data);
1484   (* func) (tree, node, data);
1485 }
1486
1487 void
1488 _gtk_rbtree_traverse (GtkRBTree             *tree,
1489                       GtkRBNode             *node,
1490                       GTraverseType          order,
1491                       GtkRBTreeTraverseFunc  func,
1492                       gpointer               data)
1493 {
1494   g_return_if_fail (tree != NULL);
1495   g_return_if_fail (node != NULL);
1496   g_return_if_fail (func != NULL);
1497   g_return_if_fail (order <= G_LEVEL_ORDER);
1498
1499   switch (order)
1500     {
1501     case G_PRE_ORDER:
1502       _gtk_rbtree_traverse_pre_order (tree, node, func, data);
1503       break;
1504     case G_POST_ORDER:
1505       _gtk_rbtree_traverse_post_order (tree, node, func, data);
1506       break;
1507     case G_IN_ORDER:
1508     case G_LEVEL_ORDER:
1509     default:
1510       g_warning ("unsupported traversal order.");
1511       break;
1512     }
1513 }
1514
1515 static gint
1516 _count_nodes (GtkRBTree *tree,
1517               GtkRBNode *node)
1518 {
1519   gint res;
1520   if (node == tree->nil)
1521     return 0;
1522
1523   g_assert (node->left);
1524   g_assert (node->right);
1525
1526   res = (_count_nodes (tree, node->left) +
1527          _count_nodes (tree, node->right) + 1);
1528
1529   if (res != node->count)
1530     g_print ("Tree failed\n");
1531   return res;
1532 }
1533
1534 static inline
1535 void _fixup_validation (GtkRBTree *tree,
1536                         GtkRBNode *node)
1537 {
1538   if (GTK_RBNODE_FLAG_SET (node, GTK_RBNODE_INVALID) ||
1539       GTK_RBNODE_FLAG_SET (node, GTK_RBNODE_COLUMN_INVALID) ||
1540       (node->left != tree->nil && GTK_RBNODE_FLAG_SET (node->left, GTK_RBNODE_DESCENDANTS_INVALID)) ||
1541       (node->right != tree->nil && GTK_RBNODE_FLAG_SET (node->right, GTK_RBNODE_DESCENDANTS_INVALID)) ||
1542       (node->children != NULL && GTK_RBNODE_FLAG_SET (node->children->root, GTK_RBNODE_DESCENDANTS_INVALID)))
1543     {
1544       GTK_RBNODE_SET_FLAG (node, GTK_RBNODE_DESCENDANTS_INVALID);
1545     }
1546   else
1547     {
1548       GTK_RBNODE_UNSET_FLAG (node, GTK_RBNODE_DESCENDANTS_INVALID);
1549     }
1550 }
1551
1552 static inline
1553 void _fixup_parity (GtkRBTree *tree,
1554                     GtkRBNode *node)
1555 {
1556   node->parity = 1 +
1557     ((node->children != NULL && node->children->root != node->children->nil) ? node->children->root->parity : 0) +
1558     ((node->left != tree->nil) ? node->left->parity : 0) +
1559     ((node->right != tree->nil) ? node->right->parity : 0);
1560 }
1561
1562 static guint
1563 get_parity (GtkRBNode *node)
1564 {
1565   guint child_total = 0;
1566   guint rem;
1567
1568   /* The parity of a node is node->parity minus
1569    * the parity of left, right, and children.
1570    *
1571    * This is equivalent to saying that if left, right, children
1572    * sum to 0 parity, then node->parity is the parity of node,
1573    * and if left, right, children are odd parity, then
1574    * node->parity is the reverse of the node's parity.
1575    */
1576
1577   child_total += (guint) node->left->parity;
1578   child_total += (guint) node->right->parity;
1579
1580   if (node->children)
1581     child_total += (guint) node->children->root->parity;
1582
1583   rem = child_total % 2;
1584
1585   if (rem == 0)
1586     return node->parity;
1587   else
1588     return !node->parity;
1589 }
1590
1591 static guint
1592 count_parity (GtkRBTree *tree,
1593               GtkRBNode *node)
1594 {
1595   guint res;
1596
1597   if (node == tree->nil)
1598     return 0;
1599
1600   res =
1601     count_parity (tree, node->left) +
1602     count_parity (tree, node->right) +
1603     (guint)1 +
1604     (node->children ? count_parity (node->children, node->children->root) : 0);
1605
1606   res = res % (guint)2;
1607
1608   if (res != node->parity)
1609     g_print ("parity incorrect for node\n");
1610
1611   if (get_parity (node) != 1)
1612     g_error ("Node has incorrect parity %d", get_parity (node));
1613
1614   return res;
1615 }
1616
1617 static void
1618 _gtk_rbtree_test_height (GtkRBTree *tree,
1619                          GtkRBNode *node)
1620 {
1621   gint computed_offset = 0;
1622
1623   /* This whole test is sort of a useless truism. */
1624
1625   if (node->left != tree->nil)
1626     computed_offset += node->left->offset;
1627
1628   if (node->right != tree->nil)
1629     computed_offset += node->right->offset;
1630
1631   if (node->children && node->children->root != node->children->nil)
1632     computed_offset += node->children->root->offset;
1633
1634   if (GTK_RBNODE_GET_HEIGHT (node) + computed_offset != node->offset)
1635     g_error ("node has broken offset\n");
1636
1637   if (node->left != tree->nil)
1638     _gtk_rbtree_test_height (tree, node->left);
1639
1640   if (node->right != tree->nil)
1641     _gtk_rbtree_test_height (tree, node->right);
1642
1643   if (node->children && node->children->root != node->children->nil)
1644     _gtk_rbtree_test_height (node->children, node->children->root);
1645 }
1646
1647 static void
1648 _gtk_rbtree_test_dirty (GtkRBTree *tree,
1649                         GtkRBNode *node,
1650                          gint      expected_dirtyness)
1651 {
1652
1653   if (expected_dirtyness)
1654     {
1655       g_assert (GTK_RBNODE_FLAG_SET (node, GTK_RBNODE_COLUMN_INVALID) ||
1656                 GTK_RBNODE_FLAG_SET (node, GTK_RBNODE_INVALID) ||
1657                 (node->left != tree->nil && GTK_RBNODE_FLAG_SET (node->left, GTK_RBNODE_DESCENDANTS_INVALID)) ||
1658                 (node->right != tree->nil && GTK_RBNODE_FLAG_SET (node->right, GTK_RBNODE_DESCENDANTS_INVALID)) ||
1659                 (node->children && GTK_RBNODE_FLAG_SET (node->children->root, GTK_RBNODE_DESCENDANTS_INVALID)));
1660     }
1661   else
1662     {
1663       g_assert (! GTK_RBNODE_FLAG_SET (node, GTK_RBNODE_COLUMN_INVALID) &&
1664                 ! GTK_RBNODE_FLAG_SET (node, GTK_RBNODE_INVALID));
1665       if (node->left != tree->nil)
1666         g_assert (! GTK_RBNODE_FLAG_SET (node->left, GTK_RBNODE_DESCENDANTS_INVALID));
1667       if (node->right != tree->nil)
1668         g_assert (! GTK_RBNODE_FLAG_SET (node->right, GTK_RBNODE_DESCENDANTS_INVALID));
1669       if (node->children != NULL)
1670         g_assert (! GTK_RBNODE_FLAG_SET (node->children->root, GTK_RBNODE_DESCENDANTS_INVALID));
1671     }
1672
1673   if (node->left != tree->nil)
1674     _gtk_rbtree_test_dirty (tree, node->left, GTK_RBNODE_FLAG_SET (node->left, GTK_RBNODE_DESCENDANTS_INVALID));
1675   if (node->right != tree->nil)
1676     _gtk_rbtree_test_dirty (tree, node->right, GTK_RBNODE_FLAG_SET (node->right, GTK_RBNODE_DESCENDANTS_INVALID));
1677   if (node->children != NULL && node->children->root != node->children->nil)
1678     _gtk_rbtree_test_dirty (node->children, node->children->root, GTK_RBNODE_FLAG_SET (node->children->root, GTK_RBNODE_DESCENDANTS_INVALID));
1679 }
1680
1681 static void _gtk_rbtree_test_structure (GtkRBTree *tree);
1682
1683 static void
1684 _gtk_rbtree_test_structure_helper (GtkRBTree *tree,
1685                                    GtkRBNode *node)
1686 {
1687   g_assert (node != tree->nil);
1688
1689   g_assert (node->left != NULL);
1690   g_assert (node->right != NULL);
1691   g_assert (node->parent != NULL);
1692
1693   if (node->left != tree->nil)
1694     {
1695       g_assert (node->left->parent == node);
1696       _gtk_rbtree_test_structure_helper (tree, node->left);
1697     }
1698   if (node->right != tree->nil)
1699     {
1700       g_assert (node->right->parent == node);
1701       _gtk_rbtree_test_structure_helper (tree, node->right);
1702     }
1703
1704   if (node->children != NULL)
1705     {
1706       g_assert (node->children->parent_tree == tree);
1707       g_assert (node->children->parent_node == node);
1708
1709       _gtk_rbtree_test_structure (node->children);
1710     }
1711 }
1712 static void
1713 _gtk_rbtree_test_structure (GtkRBTree *tree)
1714 {
1715   g_assert (tree->root);
1716   if (tree->root == tree->nil)
1717     return;
1718
1719   g_assert (tree->root->parent == tree->nil);
1720   _gtk_rbtree_test_structure_helper (tree, tree->root);
1721 }
1722
1723 void
1724 _gtk_rbtree_test (const gchar *where,
1725                   GtkRBTree   *tree)
1726 {
1727   GtkRBTree *tmp_tree;
1728
1729   if (tree == NULL)
1730     return;
1731
1732   /* Test the entire tree */
1733   tmp_tree = tree;
1734   while (tmp_tree->parent_tree)
1735     tmp_tree = tmp_tree->parent_tree;
1736
1737   g_assert (tmp_tree->nil != NULL);
1738
1739   if (tmp_tree->root == tmp_tree->nil)
1740     return;
1741
1742   _gtk_rbtree_test_structure (tmp_tree);
1743
1744   g_assert ((_count_nodes (tmp_tree, tmp_tree->root->left) +
1745              _count_nodes (tmp_tree, tmp_tree->root->right) + 1) == tmp_tree->root->count);
1746
1747
1748   _gtk_rbtree_test_height (tmp_tree, tmp_tree->root);
1749   _gtk_rbtree_test_dirty (tmp_tree, tmp_tree->root, GTK_RBNODE_FLAG_SET (tmp_tree->root, GTK_RBNODE_DESCENDANTS_INVALID));
1750   g_assert (count_parity (tmp_tree, tmp_tree->root) == tmp_tree->root->parity);
1751 }
1752
1753 static void
1754 _gtk_rbtree_debug_spew_helper (GtkRBTree *tree,
1755                                GtkRBNode *node,
1756                                gint       depth)
1757 {
1758   gint i;
1759   for (i = 0; i < depth; i++)
1760     g_print ("\t");
1761
1762   g_print ("(0x%x - %s) (Offset %d) (Parity %d) (Validity %d%d%d)\n",
1763            (gint) node,
1764            (GTK_RBNODE_GET_COLOR (node) == GTK_RBNODE_BLACK)?"BLACK":" RED ",
1765            node->offset,
1766            node->parity?1:0,
1767            (GTK_RBNODE_FLAG_SET (node, GTK_RBNODE_DESCENDANTS_INVALID))?1:0,
1768            (GTK_RBNODE_FLAG_SET (node, GTK_RBNODE_INVALID))?1:0,
1769            (GTK_RBNODE_FLAG_SET (node, GTK_RBNODE_COLUMN_INVALID))?1:0);
1770   if (node->children != NULL)
1771     {
1772       g_print ("Looking at child.\n");
1773       _gtk_rbtree_debug_spew (node->children);
1774       g_print ("Done looking at child.\n");
1775     }
1776   if (node->left != tree->nil)
1777     {
1778       _gtk_rbtree_debug_spew_helper (tree, node->left, depth+1);
1779     }
1780   if (node->right != tree->nil)
1781     {
1782       _gtk_rbtree_debug_spew_helper (tree, node->right, depth+1);
1783     }
1784 }
1785
1786 void
1787 _gtk_rbtree_debug_spew (GtkRBTree *tree)
1788 {
1789   g_return_if_fail (tree != NULL);
1790
1791   if (tree->root == tree->nil)
1792     g_print ("Empty tree...\n");
1793   else
1794     _gtk_rbtree_debug_spew_helper (tree, tree->root, 0);
1795 }