glib/gtree.c

   1 /* GLIB - Library of useful routines for C programming
   2  * Copyright (C) 1995-1997  Peter Mattis, Spencer Kimball and Josh MacDonald
   3  *
   4  * This library is free software; you can redistribute it and/or
   5  * modify it under the terms of the GNU Lesser 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  * Lesser General Public License for more details.
  13  *
  14  * You should have received a copy of the GNU Lesser 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 /*
  21  * Modified by the GLib Team and others 1997-2000.  See the AUTHORS
  22  * file for a list of people on the GLib Team.  See the ChangeLog
  23  * files for a list of changes.  These files are distributed with
  24  * GLib at ftp://ftp.gtk.org/pub/gtk/.
  25  */
  26
  27 /*
  28  * MT safe
  29  */
  30
  31 #ifdef HAVE_CONFIG_H
  32 #include <config.h>
  33 #endif
  34
  35 #include "glib.h"
  36
  37
  38 typedef struct _GTreeNode  GTreeNode;
  39
  40 struct _GTree
  41 {
  42   GTreeNode *root;
  43   GCompareDataFunc key_compare;
  44   GDestroyNotify   key_destroy_func;
  45   GDestroyNotify   value_destroy_func;
  46   gpointer         key_compare_data;
  47 };
  48
  49 struct _GTreeNode
  50 {
  51   gint balance;      /* height (left) - height (right) */
  52   GTreeNode *left;   /* left subtree */
  53   GTreeNode *right;  /* right subtree */
  54   gpointer key;      /* key for this node */
  55   gpointer value;    /* value stored at this node */
  56 };
  57
  58
  59 static GTreeNode* g_tree_node_new                   (gpointer          key,
  60                                                      gpointer          value);
  61 static void       g_tree_node_destroy               (GTreeNode        *node,
  62                                                      GDestroyNotify    key_destroy_func,
  63                                                      GDestroyNotify    value_destroy_func);
  64 static GTreeNode* g_tree_node_insert                (GTree            *tree,
  65                                                      GTreeNode        *node,
  66                                                      gpointer          key,
  67                                                      gpointer          value,
  68                                                      gboolean          replace,
  69                                                      gboolean         *inserted);
  70 static GTreeNode* g_tree_node_remove                (GTree            *tree,
  71                                                      GTreeNode        *node,
  72                                                      gconstpointer     key,
  73                                                      gboolean          notify);
  74 static GTreeNode* g_tree_node_balance               (GTreeNode        *node);
  75 static GTreeNode* g_tree_node_remove_leftmost       (GTreeNode        *node,
  76                                                      GTreeNode       **leftmost);
  77 static GTreeNode* g_tree_node_restore_left_balance  (GTreeNode        *node,
  78                                                      gint              old_balance);
  79 static GTreeNode* g_tree_node_restore_right_balance (GTreeNode        *node,
  80                                                      gint              old_balance);
  81 static GTreeNode* g_tree_node_lookup                (GTreeNode        *node,
  82                                                      GCompareDataFunc  compare,
  83                                                      gpointer          comp_data,
  84                                                      gconstpointer     key);
  85 static gint       g_tree_node_count                 (GTreeNode        *node);
  86 static gint       g_tree_node_pre_order             (GTreeNode        *node,
  87                                                      GTraverseFunc     traverse_func,
  88                                                      gpointer          data);
  89 static gint       g_tree_node_in_order              (GTreeNode        *node,
  90                                                      GTraverseFunc     traverse_func,
  91                                                      gpointer          data);
  92 static gint       g_tree_node_post_order            (GTreeNode        *node,
  93                                                      GTraverseFunc     traverse_func,
  94                                                      gpointer          data);
  95 static gpointer   g_tree_node_search                (GTreeNode        *node,
  96                                                      GCompareFunc      search_func,
  97                                                      gconstpointer     data);
  98 static gint       g_tree_node_height                (GTreeNode        *node);
  99 static GTreeNode* g_tree_node_rotate_left           (GTreeNode        *node);
 100 static GTreeNode* g_tree_node_rotate_right          (GTreeNode        *node);
 101 static void       g_tree_node_check                 (GTreeNode        *node);
 102
 103
 104 G_LOCK_DEFINE_STATIC (g_tree_global);
 105 static GMemChunk *node_mem_chunk = NULL;
 106 static GTreeNode *node_free_list = NULL;
 107
 108
 109 static GTreeNode*
 110 g_tree_node_new (gpointer key,
 111                  gpointer value)
 112 {
 113   GTreeNode *node;
 114
 115   G_LOCK (g_tree_global);
 116   if (node_free_list)
 117     {
 118       node = node_free_list;
 119       node_free_list = node->right;
 120     }
 121   else
 122     {
 123       if (!node_mem_chunk)
 124         node_mem_chunk = g_mem_chunk_new ("GLib GTreeNode mem chunk",
 125                                           sizeof (GTreeNode),
 126                                           1024,
 127                                           G_ALLOC_ONLY);
 128
 129       node = g_chunk_new (GTreeNode, node_mem_chunk);
 130    }
 131   G_UNLOCK (g_tree_global);
 132
 133   node->balance = 0;
 134   node->left = NULL;
 135   node->right = NULL;
 136   node->key = key;
 137   node->value = value;
 138
 139   return node;
 140 }
 141
 142 static void
 143 g_tree_node_destroy (GTreeNode      *node,
 144                      GDestroyNotify  key_destroy_func,
 145                      GDestroyNotify  value_destroy_func)
 146 {
 147   if (node)
 148     {
 149       g_tree_node_destroy (node->right,
 150                            key_destroy_func, value_destroy_func);
 151       g_tree_node_destroy (node->left,
 152                            key_destroy_func, value_destroy_func);
 153
 154       if (key_destroy_func)
 155         key_destroy_func (node->key);
 156       if (value_destroy_func)
 157         value_destroy_func (node->value);
 158
 159 #ifdef ENABLE_GC_FRIENDLY
 160       node->left = NULL;
 161       node->key = NULL;
 162       node->value = NULL;
 163 #endif /* ENABLE_GC_FRIENDLY */
 164
 165       G_LOCK (g_tree_global);
 166       node->right = node_free_list;
 167       node_free_list = node;
 168       G_UNLOCK (g_tree_global);
 169    }
 170 }
 171
 172 /**
 173  * g_tree_new:
 174  * @key_compare_func: the function used to order the nodes in the #GTree.
 175  *   It should return values similar to the standard
 176  *   <function>strcmp()</function> function -
 177  *   0 if the two arguments are equal, a negative value if the first argument
 178  *   comes before the second, or a positive value if the first argument comes
 179  *   after the second.
 180  *
 181  * Creates a new #GTree.
 182  *
 183  * Return value: a new #GTree.
 184  **/
 185 GTree*
 186 g_tree_new (GCompareFunc key_compare_func)
 187 {
 188   g_return_val_if_fail (key_compare_func != NULL, NULL);
 189
 190   return g_tree_new_full ((GCompareDataFunc) key_compare_func, NULL,
 191                           NULL, NULL);
 192 }
 193
 194 /**
 195  * g_tree_new_with_data:
 196  * @key_compare_func: <function>qsort()</function>-style comparison function.
 197  * @key_compare_data: data to pass to comparison function.
 198  *
 199  * Creates a new #GTree with a comparison function that accepts user data.
 200  * See g_tree_new() for more details.
 201  *
 202  * Return value: a new #GTree.
 203  **/
 204 GTree*
 205 g_tree_new_with_data (GCompareDataFunc key_compare_func,
 206                       gpointer         key_compare_data)
 207 {
 208   g_return_val_if_fail (key_compare_func != NULL, NULL);
 209
 210   return g_tree_new_full (key_compare_func, key_compare_data,
 211                           NULL, NULL);
 212 }
 213
 214 /**
 215  * g_tree_new_full:
 216  * @key_compare_func: <function>qsort()</function>-style comparison function.
 217  * @key_compare_data: data to pass to comparison function.
 218  * @key_destroy_func: a function to free the memory allocated for the key
 219  *   used when removing the entry from the #GTree or %NULL if you don't
 220  *   want to supply such a function.
 221  * @value_destroy_func: a function to free the memory allocated for the
 222  *   value used when removing the entry from the #GTree or %NULL if you
 223  *   don't want to supply such a function.
 224  *
 225  * Creates a new #GTree like g_tree_new() and allows to specify functions
 226  * to free the memory allocated for the key and value that get called when
 227  * removing the entry from the #GTree.
 228  *
 229  * Return value: a new #GTree.
 230  **/
 231 GTree*
 232 g_tree_new_full (GCompareDataFunc key_compare_func,
 233                  gpointer         key_compare_data,
 234                  GDestroyNotify   key_destroy_func,
 235                  GDestroyNotify   value_destroy_func)
 236 {
 237   GTree *tree;
 238
 239   g_return_val_if_fail (key_compare_func != NULL, NULL);
 240
 241   tree = g_new (GTree, 1);
 242   tree->root               = NULL;
 243   tree->key_compare        = key_compare_func;
 244   tree->key_destroy_func   = key_destroy_func;
 245   tree->value_destroy_func = value_destroy_func;
 246   tree->key_compare_data   = key_compare_data;
 247
 248   return tree;
 249 }
 250
 251 /**
 252  * g_tree_destroy:
 253  * @tree: a #GTree.
 254  *
 255  * Destroys the #GTree. If keys and/or values are dynamically allocated, you
 256  * should either free them first or create the #GTree using g_tree_new_full().
 257  * In the latter case the destroy functions you supplied will be called on
 258  * all keys and values before destroying the #GTree.
 259  **/
 260 void
 261 g_tree_destroy (GTree *tree)
 262 {
 263   g_return_if_fail (tree != NULL);
 264
 265   g_tree_node_destroy (tree->root,
 266                        tree->key_destroy_func,
 267                        tree->value_destroy_func);
 268
 269   g_free (tree);
 270 }
 271
 272 /**
 273  * g_tree_insert:
 274  * @tree: a #GTree.
 275  * @key: the key to insert.
 276  * @value: the value corresponding to the key.
 277  *
 278  * Inserts a key/value pair into a #GTree. If the given key already exists
 279  * in the #GTree its corresponding value is set to the new value. If you
 280  * supplied a value_destroy_func when creating the #GTree, the old value is
 281  * freed using that function. If you supplied a @key_destroy_func when
 282  * creating the #GTree, the passed key is freed using that function.
 283  *
 284  * The tree is automatically 'balanced' as new key/value pairs are added,
 285  * so that the distance from the root to every leaf is as small as possible.
 286  **/
 287 void
 288 g_tree_insert (GTree    *tree,
 289                gpointer  key,
 290                gpointer  value)
 291 {
 292   gboolean   inserted;
 293
 294   g_return_if_fail (tree != NULL);
 295
 296   inserted = FALSE;
 297   tree->root = g_tree_node_insert (tree,
 298                                    tree->root,
 299                                    key, value,
 300                                    FALSE, &inserted);
 301 }
 302
 303 /**
 304  * g_tree_replace:
 305  * @tree: a #GTree.
 306  * @key: the key to insert.
 307  * @value: the value corresponding to the key.
 308  *
 309  * Inserts a new key and value into a #GTree similar to g_tree_insert().
 310  * The difference is that if the key already exists in the #GTree, it gets
 311  * replaced by the new key. If you supplied a @value_destroy_func when
 312  * creating the #GTree, the old value is freed using that function. If you
 313  * supplied a @key_destroy_func when creating the #GTree, the old key is
 314  * freed using that function.
 315  *
 316  * The tree is automatically 'balanced' as new key/value pairs are added,
 317  * so that the distance from the root to every leaf is as small as possible.
 318  **/
 319 void
 320 g_tree_replace (GTree    *tree,
 321                 gpointer  key,
 322                 gpointer  value)
 323 {
 324   gboolean   inserted;
 325
 326   g_return_if_fail (tree != NULL);
 327
 328   inserted = FALSE;
 329   tree->root = g_tree_node_insert (tree,
 330                                    tree->root,
 331                                    key, value,
 332                                    TRUE, &inserted);
 333 }
 334
 335 /**
 336  * g_tree_remove:
 337  * @tree: a #GTree.
 338  * @key: the key to remove.
 339  *
 340  * Removes a key/value pair from a #GTree.
 341  *
 342  * If the #GTree was created using g_tree_new_full(), the key and value
 343  * are freed using the supplied destroy functions, otherwise you have to
 344  * make sure that any dynamically allocated values are freed yourself.
 345  **/
 346 void
 347 g_tree_remove (GTree         *tree,
 348                gconstpointer  key)
 349 {
 350   g_return_if_fail (tree != NULL);
 351
 352   tree->root = g_tree_node_remove (tree, tree->root, key, TRUE);
 353 }
 354
 355 /**
 356  * g_tree_steal:
 357  * @tree: a #GTree.
 358  * @key: the key to remove.
 359  *
 360  * Removes a key and its associated value from a #GTree without calling
 361  * the key and value destroy functions.
 362  **/
 363 void
 364 g_tree_steal (GTree         *tree,
 365               gconstpointer  key)
 366 {
 367   g_return_if_fail (tree != NULL);
 368
 369   tree->root = g_tree_node_remove (tree, tree->root, key, FALSE);
 370 }
 371
 372 /**
 373  * g_tree_lookup:
 374  * @tree: a #GTree.
 375  * @key: the key to look up.
 376  *
 377  * Gets the value corresponding to the given key. Since a #GTree is
 378  * automatically balanced as key/value pairs are added, key lookup is very
 379  * fast.
 380  *
 381  * Return value: the value corresponding to the key.
 382  **/
 383 gpointer
 384 g_tree_lookup (GTree         *tree,
 385                gconstpointer  key)
 386 {
 387   GTreeNode *node;
 388
 389   g_return_val_if_fail (tree != NULL, NULL);
 390
 391   node = g_tree_node_lookup (tree->root,
 392                              tree->key_compare, tree->key_compare_data, key);
 393
 394   return node ? node->value : NULL;
 395 }
 396
 397 /**
 398  * g_tree_lookup_extended:
 399  * @tree: a #GTree.
 400  * @lookup_key: the key to look up.
 401  * @orig_key: returns the original key.
 402  * @value: returns the value associated with the key.
 403  *
 404  * Looks up a key in the #GTree, returning the original key and the
 405  * associated value and a #gboolean which is %TRUE if the key was found. This
 406  * is useful if you need to free the memory allocated for the original key,
 407  * for example before calling g_tree_remove().
 408  *
 409  * Return value: %TRUE if the key was found in the #GTree.
 410  **/
 411 gboolean
 412 g_tree_lookup_extended (GTree         *tree,
 413                         gconstpointer  lookup_key,
 414                         gpointer      *orig_key,
 415                         gpointer      *value)
 416 {
 417   GTreeNode *node;
 418
 419   g_return_val_if_fail (tree != NULL, FALSE);
 420
 421   node = g_tree_node_lookup (tree->root,
 422                              tree->key_compare, tree->key_compare_data, lookup_key);
 423
 424   if (node)
 425     {
 426       if (orig_key)
 427         *orig_key = node->key;
 428       if (value)
 429         *value = node->value;
 430       return TRUE;
 431     }
 432   else
 433     return FALSE;
 434 }
 435
 436 /**
 437  * g_tree_foreach:
 438  * @tree: a #GTree.
 439  * @func: the function to call for each node visited. If this function
 440  *   returns %TRUE, the traversal is stopped.
 441  * @user_data: user data to pass to the function.
 442  *
 443  * Calls the given function for each of the key/value pairs in the #GTree.
 444  * The function is passed the key and value of each pair, and the given
 445  * @data parameter. The tree is traversed in sorted order.
 446  *
 447  * The tree may not be modified while iterating over it (you can't
 448  * add/remove items). To remove all items matching a predicate, you need
 449  * to add each item to a list in your #GTraverseFunc as you walk over
 450  * the tree, then walk the list and remove each item.
 451  **/
 452 void
 453 g_tree_foreach (GTree         *tree,
 454                 GTraverseFunc  func,
 455                 gpointer       user_data)
 456 {
 457   g_return_if_fail (tree != NULL);
 458
 459   if (!tree->root)
 460     return;
 461
 462   g_tree_node_in_order (tree->root, func, user_data);
 463 }
 464
 465 /**
 466  * g_tree_traverse:
 467  * @tree: a #GTree.
 468  * @traverse_func: the function to call for each node visited. If this
 469  *   function returns %TRUE, the traversal is stopped.
 470  * @traverse_type: the order in which nodes are visited, one of %G_IN_ORDER,
 471  *   %G_PRE_ORDER and %G_POST_ORDER.
 472  * @user_data: user data to pass to the function.
 473  *
 474  * Calls the given function for each node in the #GTree.
 475  *
 476  * Deprecated: The order of a balanced tree is somewhat arbitrary. If you
 477  * just want to visit all nodes in sorted order, use g_tree_foreach()
 478  * instead. If you really need to visit nodes in a different order, consider
 479  * using an <link linkend="glib-N-ary-Trees">N-ary Tree</link>.
 480  **/
 481 void
 482 g_tree_traverse (GTree         *tree,
 483                  GTraverseFunc  traverse_func,
 484                  GTraverseType  traverse_type,
 485                  gpointer       user_data)
 486 {
 487   g_return_if_fail (tree != NULL);
 488
 489   if (!tree->root)
 490     return;
 491
 492   switch (traverse_type)
 493     {
 494     case G_PRE_ORDER:
 495       g_tree_node_pre_order (tree->root, traverse_func, user_data);
 496       break;
 497
 498     case G_IN_ORDER:
 499       g_tree_node_in_order (tree->root, traverse_func, user_data);
 500       break;
 501
 502     case G_POST_ORDER:
 503       g_tree_node_post_order (tree->root, traverse_func, user_data);
 504       break;
 505
 506     case G_LEVEL_ORDER:
 507       g_warning ("g_tree_traverse(): traverse type G_LEVEL_ORDER isn't implemented.");
 508       break;
 509     }
 510 }
 511
 512 /**
 513  * g_tree_search:
 514  * @tree: a #GTree.
 515  * @search_func: a function used to search the #GTree.
 516  * @user_data: the data passed as the second argument to the @search_func
 517  * function.
 518  *
 519  * Searches a #GTree using @search_func.
 520  *
 521  * The @search_func is called with a pointer to the key of a key/value pair in the tree,
 522  * and the passed in @user_data. If @search_func returns 0 for a key/value pair, then
 523  * g_tree_search_func() will return the value of that pair. If @search_func returns -1,
 524  * searching will proceed among the key/value pairs that have a smaller key; if @search_func
 525  * returns 1, searching will proceed among the key/value pairs that have a larger key.
 526  *
 527  * Return value: the value corresponding to the found key, or %NULL if the key
 528  * was not found.
 529  **/
 530 gpointer
 531 g_tree_search (GTree         *tree,
 532                GCompareFunc   search_func,
 533                gconstpointer  user_data)
 534 {
 535   g_return_val_if_fail (tree != NULL, NULL);
 536
 537   if (tree->root)
 538     return g_tree_node_search (tree->root, search_func, user_data);
 539   else
 540     return NULL;
 541 }
 542
 543 /**
 544  * g_tree_height:
 545  * @tree: a #GTree.
 546  *
 547  * Gets the height of a #GTree.
 548  *
 549  * If the #GTree contains no nodes, the height is 0.
 550  * If the #GTree contains only one root node the height is 1.
 551  * If the root node has children the height is 2, etc.
 552  *
 553  * Return value: the height of the #GTree.
 554  **/
 555 gint
 556 g_tree_height (GTree *tree)
 557 {
 558   g_return_val_if_fail (tree != NULL, 0);
 559
 560   if (tree->root)
 561     return g_tree_node_height (tree->root);
 562   else
 563     return 0;
 564 }
 565
 566 /**
 567  * g_tree_nnodes:
 568  * @tree: a #GTree.
 569  *
 570  * Gets the number of nodes in a #GTree.
 571  *
 572  * Return value: the number of nodes in the #GTree.
 573  **/
 574 gint
 575 g_tree_nnodes (GTree *tree)
 576 {
 577   g_return_val_if_fail (tree != NULL, 0);
 578
 579   if (tree->root)
 580     return g_tree_node_count (tree->root);
 581   else
 582     return 0;
 583 }
 584
 585 static GTreeNode*
 586 g_tree_node_insert (GTree     *tree,
 587                     GTreeNode *node,
 588                     gpointer   key,
 589                     gpointer   value,
 590                     gboolean   replace,
 591                     gboolean  *inserted)
 592 {
 593   gint  old_balance;
 594   gint  cmp;
 595
 596   if (!node)
 597     {
 598       *inserted = TRUE;
 599       return g_tree_node_new (key, value);
 600     }
 601
 602   cmp = tree->key_compare (key, node->key, tree->key_compare_data);
 603   if (cmp == 0)
 604     {
 605       *inserted = FALSE;
 606
 607       if (tree->value_destroy_func)
 608         tree->value_destroy_func (node->value);
 609
 610       node->value = value;
 611
 612       if (replace)
 613         {
 614           if (tree->key_destroy_func)
 615             tree->key_destroy_func (node->key);
 616
 617           node->key = key;
 618         }
 619       else
 620         {
 621           /* free the passed key */
 622           if (tree->key_destroy_func)
 623             tree->key_destroy_func (key);
 624         }
 625
 626       return node;
 627     }
 628
 629   if (cmp < 0)
 630     {
 631       if (node->left)
 632         {
 633           old_balance = node->left->balance;
 634           node->left = g_tree_node_insert (tree,
 635                                            node->left,
 636                                            key, value,
 637                                            replace, inserted);
 638
 639           if ((old_balance != node->left->balance) && node->left->balance)
 640             node->balance -= 1;
 641         }
 642       else
 643         {
 644           *inserted = TRUE;
 645           node->left = g_tree_node_new (key, value);
 646           node->balance -= 1;
 647         }
 648     }
 649   else if (cmp > 0)
 650     {
 651       if (node->right)
 652         {
 653           old_balance = node->right->balance;
 654           node->right = g_tree_node_insert (tree,
 655                                             node->right,
 656                                             key, value,
 657                                             replace, inserted);
 658
 659           if ((old_balance != node->right->balance) && node->right->balance)
 660             node->balance += 1;
 661         }
 662       else
 663         {
 664           *inserted = TRUE;
 665           node->right = g_tree_node_new (key, value);
 666           node->balance += 1;
 667         }
 668     }
 669
 670   if (*inserted)
 671     {
 672       if ((node->balance < -1) || (node->balance > 1))
 673         node = g_tree_node_balance (node);
 674     }
 675
 676   return node;
 677 }
 678
 679 static GTreeNode*
 680 g_tree_node_remove (GTree         *tree,
 681                     GTreeNode     *node,
 682                     gconstpointer  key,
 683                     gboolean       notify)
 684 {
 685   GTreeNode *new_root;
 686   gint old_balance;
 687   gint cmp;
 688
 689   if (!node)
 690     return NULL;
 691
 692   cmp = tree->key_compare (key, node->key, tree->key_compare_data);
 693   if (cmp == 0)
 694     {
 695       GTreeNode *garbage;
 696
 697       garbage = node;
 698
 699       if (!node->right)
 700         {
 701           node = node->left;
 702         }
 703       else
 704         {
 705           old_balance = node->right->balance;
 706           node->right = g_tree_node_remove_leftmost (node->right, &new_root);
 707           new_root->left = node->left;
 708           new_root->right = node->right;
 709           new_root->balance = node->balance;
 710           node = g_tree_node_restore_right_balance (new_root, old_balance);
 711         }
 712
 713       if (notify)
 714         {
 715           if (tree->key_destroy_func)
 716             tree->key_destroy_func (garbage->key);
 717           if (tree->value_destroy_func)
 718             tree->value_destroy_func (garbage->value);
 719         }
 720
 721 #ifdef ENABLE_GC_FRIENDLY
 722       garbage->left = NULL;
 723       garbage->key = NULL;
 724       garbage->value = NULL;
 725 #endif /* ENABLE_GC_FRIENDLY */
 726
 727       G_LOCK (g_tree_global);
 728       garbage->right = node_free_list;
 729       node_free_list = garbage;
 730       G_UNLOCK (g_tree_global);
 731    }
 732   else if (cmp < 0)
 733     {
 734       if (node->left)
 735         {
 736           old_balance = node->left->balance;
 737           node->left = g_tree_node_remove (tree, node->left, key, notify);
 738           node = g_tree_node_restore_left_balance (node, old_balance);
 739         }
 740     }
 741   else if (cmp > 0)
 742     {
 743       if (node->right)
 744         {
 745           old_balance = node->right->balance;
 746           node->right = g_tree_node_remove (tree, node->right, key, notify);
 747           node = g_tree_node_restore_right_balance (node, old_balance);
 748         }
 749     }
 750
 751   return node;
 752 }
 753
 754 static GTreeNode*
 755 g_tree_node_balance (GTreeNode *node)
 756 {
 757   if (node->balance < -1)
 758     {
 759       if (node->left->balance > 0)
 760         node->left = g_tree_node_rotate_left (node->left);
 761       node = g_tree_node_rotate_right (node);
 762     }
 763   else if (node->balance > 1)
 764     {
 765       if (node->right->balance < 0)
 766         node->right = g_tree_node_rotate_right (node->right);
 767       node = g_tree_node_rotate_left (node);
 768     }
 769
 770   return node;
 771 }
 772
 773 static GTreeNode*
 774 g_tree_node_remove_leftmost (GTreeNode  *node,
 775                              GTreeNode **leftmost)
 776 {
 777   gint old_balance;
 778
 779   if (!node->left)
 780     {
 781       *leftmost = node;
 782       return node->right;
 783     }
 784
 785   old_balance = node->left->balance;
 786   node->left = g_tree_node_remove_leftmost (node->left, leftmost);
 787   return g_tree_node_restore_left_balance (node, old_balance);
 788 }
 789
 790 static GTreeNode*
 791 g_tree_node_restore_left_balance (GTreeNode *node,
 792                                   gint       old_balance)
 793 {
 794   if (!node->left)
 795     node->balance += 1;
 796   else if ((node->left->balance != old_balance) &&
 797            (node->left->balance == 0))
 798     node->balance += 1;
 799
 800   if (node->balance > 1)
 801     return g_tree_node_balance (node);
 802   return node;
 803 }
 804
 805 static GTreeNode*
 806 g_tree_node_restore_right_balance (GTreeNode *node,
 807                                    gint       old_balance)
 808 {
 809   if (!node->right)
 810     node->balance -= 1;
 811   else if ((node->right->balance != old_balance) &&
 812            (node->right->balance == 0))
 813     node->balance -= 1;
 814
 815   if (node->balance < -1)
 816     return g_tree_node_balance (node);
 817   return node;
 818 }
 819
 820 static GTreeNode *
 821 g_tree_node_lookup (GTreeNode        *node,
 822                     GCompareDataFunc  compare,
 823                     gpointer          compare_data,
 824                     gconstpointer     key)
 825 {
 826   gint cmp;
 827
 828   if (!node)
 829     return NULL;
 830
 831   cmp = (* compare) (key, node->key, compare_data);
 832   if (cmp == 0)
 833     return node;
 834
 835   if (cmp < 0)
 836     {
 837       if (node->left)
 838         return g_tree_node_lookup (node->left, compare, compare_data, key);
 839     }
 840   else if (cmp > 0)
 841     {
 842       if (node->right)
 843         return g_tree_node_lookup (node->right, compare, compare_data, key);
 844     }
 845
 846   return NULL;
 847 }
 848
 849 static gint
 850 g_tree_node_count (GTreeNode *node)
 851 {
 852   gint count;
 853
 854   count = 1;
 855   if (node->left)
 856     count += g_tree_node_count (node->left);
 857   if (node->right)
 858     count += g_tree_node_count (node->right);
 859
 860   return count;
 861 }
 862
 863 static gint
 864 g_tree_node_pre_order (GTreeNode     *node,
 865                        GTraverseFunc  traverse_func,
 866                        gpointer       data)
 867 {
 868   if ((*traverse_func) (node->key, node->value, data))
 869     return TRUE;
 870   if (node->left)
 871     {
 872       if (g_tree_node_pre_order (node->left, traverse_func, data))
 873         return TRUE;
 874     }
 875   if (node->right)
 876     {
 877       if (g_tree_node_pre_order (node->right, traverse_func, data))
 878         return TRUE;
 879     }
 880
 881   return FALSE;
 882 }
 883
 884 static gint
 885 g_tree_node_in_order (GTreeNode     *node,
 886                       GTraverseFunc  traverse_func,
 887                       gpointer       data)
 888 {
 889   if (node->left)
 890     {
 891       if (g_tree_node_in_order (node->left, traverse_func, data))
 892         return TRUE;
 893     }
 894   if ((*traverse_func) (node->key, node->value, data))
 895     return TRUE;
 896   if (node->right)
 897     {
 898       if (g_tree_node_in_order (node->right, traverse_func, data))
 899         return TRUE;
 900     }
 901
 902   return FALSE;
 903 }
 904
 905 static gint
 906 g_tree_node_post_order (GTreeNode     *node,
 907                         GTraverseFunc  traverse_func,
 908                         gpointer       data)
 909 {
 910   if (node->left)
 911     {
 912       if (g_tree_node_post_order (node->left, traverse_func, data))
 913         return TRUE;
 914     }
 915   if (node->right)
 916     {
 917       if (g_tree_node_post_order (node->right, traverse_func, data))
 918         return TRUE;
 919     }
 920   if ((*traverse_func) (node->key, node->value, data))
 921     return TRUE;
 922
 923   return FALSE;
 924 }
 925
 926 static gpointer
 927 g_tree_node_search (GTreeNode     *node,
 928                     GCompareFunc   search_func,
 929                     gconstpointer  data)
 930 {
 931   gint dir;
 932
 933   if (!node)
 934     return NULL;
 935
 936   do {
 937     dir = (* search_func) (node->key, data);
 938     if (dir == 0)
 939       return node->value;
 940
 941     if (dir < 0)
 942       node = node->left;
 943     else if (dir > 0)
 944       node = node->right;
 945   } while (node);
 946
 947   return NULL;
 948 }
 949
 950 static gint
 951 g_tree_node_height (GTreeNode *node)
 952 {
 953   gint left_height;
 954   gint right_height;
 955
 956   if (node)
 957     {
 958       left_height = 0;
 959       right_height = 0;
 960
 961       if (node->left)
 962         left_height = g_tree_node_height (node->left);
 963
 964       if (node->right)
 965         right_height = g_tree_node_height (node->right);
 966
 967       return MAX (left_height, right_height) + 1;
 968     }
 969
 970   return 0;
 971 }
 972
 973 static GTreeNode*
 974 g_tree_node_rotate_left (GTreeNode *node)
 975 {
 976   GTreeNode *right;
 977   gint a_bal;
 978   gint b_bal;
 979
 980   right = node->right;
 981
 982   node->right = right->left;
 983   right->left = node;
 984
 985   a_bal = node->balance;
 986   b_bal = right->balance;
 987
 988   if (b_bal <= 0)
 989     {
 990       if (a_bal >= 1)
 991         right->balance = b_bal - 1;
 992       else
 993         right->balance = a_bal + b_bal - 2;
 994       node->balance = a_bal - 1;
 995     }
 996   else
 997     {
 998       if (a_bal <= b_bal)
 999         right->balance = a_bal - 2;
1000       else
1001         right->balance = b_bal - 1;
1002       node->balance = a_bal - b_bal - 1;
1003     }
1004
1005   return right;
1006 }
1007
1008 static GTreeNode*
1009 g_tree_node_rotate_right (GTreeNode *node)
1010 {
1011   GTreeNode *left;
1012   gint a_bal;
1013   gint b_bal;
1014
1015   left = node->left;
1016
1017   node->left = left->right;
1018   left->right = node;
1019
1020   a_bal = node->balance;
1021   b_bal = left->balance;
1022
1023   if (b_bal <= 0)
1024     {
1025       if (b_bal > a_bal)
1026         left->balance = b_bal + 1;
1027       else
1028         left->balance = a_bal + 2;
1029       node->balance = a_bal - b_bal + 1;
1030     }
1031   else
1032     {
1033       if (a_bal <= -1)
1034         left->balance = b_bal + 1;
1035       else
1036         left->balance = a_bal + b_bal + 2;
1037       node->balance = a_bal + 1;
1038     }
1039
1040   return left;
1041 }
1042
1043 static void
1044 g_tree_node_check (GTreeNode *node)
1045 {
1046   gint left_height;
1047   gint right_height;
1048   gint balance;
1049
1050   if (node)
1051     {
1052       left_height = 0;
1053       right_height = 0;
1054
1055       if (node->left)
1056         left_height = g_tree_node_height (node->left);
1057       if (node->right)
1058         right_height = g_tree_node_height (node->right);
1059
1060       balance = right_height - left_height;
1061       if (balance != node->balance)
1062         g_log (G_LOG_DOMAIN, G_LOG_LEVEL_INFO,
1063                "g_tree_node_check: failed: %d ( %d )\n",
1064                balance, node->balance);
1065
1066       if (node->left)
1067         g_tree_node_check (node->left);
1068       if (node->right)
1069         g_tree_node_check (node->right);
1070     }
1071 }