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. This function is
 475  * deprecated, since the order of a balanced tree is somewhat arbitrary.
 476  * If you just want to visit all nodes in sorted order, use g_tree_foreach()
 477  * instead. If you really need to visit nodes in a different order, consider
 478  * using an <link linkend="glib-N-ary-Trees">N-ary Tree</link>.
 479  **/
 480 void
 481 g_tree_traverse (GTree         *tree,
 482                  GTraverseFunc  traverse_func,
 483                  GTraverseType  traverse_type,
 484                  gpointer       user_data)
 485 {
 486   g_return_if_fail (tree != NULL);
 487
 488   if (!tree->root)
 489     return;
 490
 491   switch (traverse_type)
 492     {
 493     case G_PRE_ORDER:
 494       g_tree_node_pre_order (tree->root, traverse_func, user_data);
 495       break;
 496
 497     case G_IN_ORDER:
 498       g_tree_node_in_order (tree->root, traverse_func, user_data);
 499       break;
 500
 501     case G_POST_ORDER:
 502       g_tree_node_post_order (tree->root, traverse_func, user_data);
 503       break;
 504
 505     case G_LEVEL_ORDER:
 506       g_warning ("g_tree_traverse(): traverse type G_LEVEL_ORDER isn't implemented.");
 507       break;
 508     }
 509 }
 510
 511 /**
 512  * g_tree_search:
 513  * @tree: a #GTree.
 514  * @search_func: the comparison function used to search the #GTree.
 515  * @user_data: the data passed as the second argument to the @search_func
 516  * function.
 517  *
 518  * Searches a #GTree using an alternative form of the comparison function.
 519  *
 520  * This function is not as useful as it sounds.
 521  * It allows you to use a different function for performing the lookup of
 522  * a key. However, since the tree is ordered according to the @key_compare_func
 523  * function passed to g_tree_new(), the function you pass to g_tree_search()
 524  * must return exactly the same value as would be returned by the comparison
 525  * function, for each pair of tree nodes, or the search will not work.
 526  *
 527  * To search for a specific value, you can use g_tree_foreach().
 528  *
 529  * Return value: the value corresponding to the found key, or %NULL if the key
 530  * is not found.
 531  **/
 532 gpointer
 533 g_tree_search (GTree         *tree,
 534                GCompareFunc   search_func,
 535                gconstpointer  user_data)
 536 {
 537   g_return_val_if_fail (tree != NULL, NULL);
 538
 539   if (tree->root)
 540     return g_tree_node_search (tree->root, search_func, user_data);
 541   else
 542     return NULL;
 543 }
 544
 545 /**
 546  * g_tree_height:
 547  * @tree: a #GTree.
 548  *
 549  * Gets the height of a #GTree.
 550  *
 551  * If the #GTree contains no nodes, the height is 0.
 552  * If the #GTree contains only one root node the height is 1.
 553  * If the root node has children the height is 2, etc.
 554  *
 555  * Return value: the height of the #GTree.
 556  **/
 557 gint
 558 g_tree_height (GTree *tree)
 559 {
 560   g_return_val_if_fail (tree != NULL, 0);
 561
 562   if (tree->root)
 563     return g_tree_node_height (tree->root);
 564   else
 565     return 0;
 566 }
 567
 568 /**
 569  * g_tree_nnodes:
 570  * @tree: a #GTree.
 571  *
 572  * Gets the number of nodes in a #GTree.
 573  *
 574  * Return value: the number of nodes in the #GTree.
 575  **/
 576 gint
 577 g_tree_nnodes (GTree *tree)
 578 {
 579   g_return_val_if_fail (tree != NULL, 0);
 580
 581   if (tree->root)
 582     return g_tree_node_count (tree->root);
 583   else
 584     return 0;
 585 }
 586
 587 static GTreeNode*
 588 g_tree_node_insert (GTree     *tree,
 589                     GTreeNode *node,
 590                     gpointer   key,
 591                     gpointer   value,
 592                     gboolean   replace,
 593                     gboolean  *inserted)
 594 {
 595   gint  old_balance;
 596   gint  cmp;
 597
 598   if (!node)
 599     {
 600       *inserted = TRUE;
 601       return g_tree_node_new (key, value);
 602     }
 603
 604   cmp = tree->key_compare (key, node->key, tree->key_compare_data);
 605   if (cmp == 0)
 606     {
 607       *inserted = FALSE;
 608
 609       if (tree->value_destroy_func)
 610         tree->value_destroy_func (node->value);
 611
 612       node->value = value;
 613
 614       if (replace)
 615         {
 616           if (tree->key_destroy_func)
 617             tree->key_destroy_func (node->key);
 618
 619           node->key = key;
 620         }
 621       else
 622         {
 623           /* free the passed key */
 624           if (tree->key_destroy_func)
 625             tree->key_destroy_func (key);
 626         }
 627
 628       return node;
 629     }
 630
 631   if (cmp < 0)
 632     {
 633       if (node->left)
 634         {
 635           old_balance = node->left->balance;
 636           node->left = g_tree_node_insert (tree,
 637                                            node->left,
 638                                            key, value,
 639                                            replace, inserted);
 640
 641           if ((old_balance != node->left->balance) && node->left->balance)
 642             node->balance -= 1;
 643         }
 644       else
 645         {
 646           *inserted = TRUE;
 647           node->left = g_tree_node_new (key, value);
 648           node->balance -= 1;
 649         }
 650     }
 651   else if (cmp > 0)
 652     {
 653       if (node->right)
 654         {
 655           old_balance = node->right->balance;
 656           node->right = g_tree_node_insert (tree,
 657                                             node->right,
 658                                             key, value,
 659                                             replace, inserted);
 660
 661           if ((old_balance != node->right->balance) && node->right->balance)
 662             node->balance += 1;
 663         }
 664       else
 665         {
 666           *inserted = TRUE;
 667           node->right = g_tree_node_new (key, value);
 668           node->balance += 1;
 669         }
 670     }
 671
 672   if (*inserted)
 673     {
 674       if ((node->balance < -1) || (node->balance > 1))
 675         node = g_tree_node_balance (node);
 676     }
 677
 678   return node;
 679 }
 680
 681 static GTreeNode*
 682 g_tree_node_remove (GTree         *tree,
 683                     GTreeNode     *node,
 684                     gconstpointer  key,
 685                     gboolean       notify)
 686 {
 687   GTreeNode *new_root;
 688   gint old_balance;
 689   gint cmp;
 690
 691   if (!node)
 692     return NULL;
 693
 694   cmp = tree->key_compare (key, node->key, tree->key_compare_data);
 695   if (cmp == 0)
 696     {
 697       GTreeNode *garbage;
 698
 699       garbage = node;
 700
 701       if (!node->right)
 702         {
 703           node = node->left;
 704         }
 705       else
 706         {
 707           old_balance = node->right->balance;
 708           node->right = g_tree_node_remove_leftmost (node->right, &new_root);
 709           new_root->left = node->left;
 710           new_root->right = node->right;
 711           new_root->balance = node->balance;
 712           node = g_tree_node_restore_right_balance (new_root, old_balance);
 713         }
 714
 715       if (notify)
 716         {
 717           if (tree->key_destroy_func)
 718             tree->key_destroy_func (garbage->key);
 719           if (tree->value_destroy_func)
 720             tree->value_destroy_func (garbage->value);
 721         }
 722
 723 #ifdef ENABLE_GC_FRIENDLY
 724       garbage->left = NULL;
 725       garbage->key = NULL;
 726       garbage->value = NULL;
 727 #endif /* ENABLE_GC_FRIENDLY */
 728
 729       G_LOCK (g_tree_global);
 730       garbage->right = node_free_list;
 731       node_free_list = garbage;
 732       G_UNLOCK (g_tree_global);
 733    }
 734   else if (cmp < 0)
 735     {
 736       if (node->left)
 737         {
 738           old_balance = node->left->balance;
 739           node->left = g_tree_node_remove (tree, node->left, key, notify);
 740           node = g_tree_node_restore_left_balance (node, old_balance);
 741         }
 742     }
 743   else if (cmp > 0)
 744     {
 745       if (node->right)
 746         {
 747           old_balance = node->right->balance;
 748           node->right = g_tree_node_remove (tree, node->right, key, notify);
 749           node = g_tree_node_restore_right_balance (node, old_balance);
 750         }
 751     }
 752
 753   return node;
 754 }
 755
 756 static GTreeNode*
 757 g_tree_node_balance (GTreeNode *node)
 758 {
 759   if (node->balance < -1)
 760     {
 761       if (node->left->balance > 0)
 762         node->left = g_tree_node_rotate_left (node->left);
 763       node = g_tree_node_rotate_right (node);
 764     }
 765   else if (node->balance > 1)
 766     {
 767       if (node->right->balance < 0)
 768         node->right = g_tree_node_rotate_right (node->right);
 769       node = g_tree_node_rotate_left (node);
 770     }
 771
 772   return node;
 773 }
 774
 775 static GTreeNode*
 776 g_tree_node_remove_leftmost (GTreeNode  *node,
 777                              GTreeNode **leftmost)
 778 {
 779   gint old_balance;
 780
 781   if (!node->left)
 782     {
 783       *leftmost = node;
 784       return node->right;
 785     }
 786
 787   old_balance = node->left->balance;
 788   node->left = g_tree_node_remove_leftmost (node->left, leftmost);
 789   return g_tree_node_restore_left_balance (node, old_balance);
 790 }
 791
 792 static GTreeNode*
 793 g_tree_node_restore_left_balance (GTreeNode *node,
 794                                   gint       old_balance)
 795 {
 796   if (!node->left)
 797     node->balance += 1;
 798   else if ((node->left->balance != old_balance) &&
 799            (node->left->balance == 0))
 800     node->balance += 1;
 801
 802   if (node->balance > 1)
 803     return g_tree_node_balance (node);
 804   return node;
 805 }
 806
 807 static GTreeNode*
 808 g_tree_node_restore_right_balance (GTreeNode *node,
 809                                    gint       old_balance)
 810 {
 811   if (!node->right)
 812     node->balance -= 1;
 813   else if ((node->right->balance != old_balance) &&
 814            (node->right->balance == 0))
 815     node->balance -= 1;
 816
 817   if (node->balance < -1)
 818     return g_tree_node_balance (node);
 819   return node;
 820 }
 821
 822 static GTreeNode *
 823 g_tree_node_lookup (GTreeNode        *node,
 824                     GCompareDataFunc  compare,
 825                     gpointer          compare_data,
 826                     gconstpointer     key)
 827 {
 828   gint cmp;
 829
 830   if (!node)
 831     return NULL;
 832
 833   cmp = (* compare) (key, node->key, compare_data);
 834   if (cmp == 0)
 835     return node;
 836
 837   if (cmp < 0)
 838     {
 839       if (node->left)
 840         return g_tree_node_lookup (node->left, compare, compare_data, key);
 841     }
 842   else if (cmp > 0)
 843     {
 844       if (node->right)
 845         return g_tree_node_lookup (node->right, compare, compare_data, key);
 846     }
 847
 848   return NULL;
 849 }
 850
 851 static gint
 852 g_tree_node_count (GTreeNode *node)
 853 {
 854   gint count;
 855
 856   count = 1;
 857   if (node->left)
 858     count += g_tree_node_count (node->left);
 859   if (node->right)
 860     count += g_tree_node_count (node->right);
 861
 862   return count;
 863 }
 864
 865 static gint
 866 g_tree_node_pre_order (GTreeNode     *node,
 867                        GTraverseFunc  traverse_func,
 868                        gpointer       data)
 869 {
 870   if ((*traverse_func) (node->key, node->value, data))
 871     return TRUE;
 872   if (node->left)
 873     {
 874       if (g_tree_node_pre_order (node->left, traverse_func, data))
 875         return TRUE;
 876     }
 877   if (node->right)
 878     {
 879       if (g_tree_node_pre_order (node->right, traverse_func, data))
 880         return TRUE;
 881     }
 882
 883   return FALSE;
 884 }
 885
 886 static gint
 887 g_tree_node_in_order (GTreeNode     *node,
 888                       GTraverseFunc  traverse_func,
 889                       gpointer       data)
 890 {
 891   if (node->left)
 892     {
 893       if (g_tree_node_in_order (node->left, traverse_func, data))
 894         return TRUE;
 895     }
 896   if ((*traverse_func) (node->key, node->value, data))
 897     return TRUE;
 898   if (node->right)
 899     {
 900       if (g_tree_node_in_order (node->right, traverse_func, data))
 901         return TRUE;
 902     }
 903
 904   return FALSE;
 905 }
 906
 907 static gint
 908 g_tree_node_post_order (GTreeNode     *node,
 909                         GTraverseFunc  traverse_func,
 910                         gpointer       data)
 911 {
 912   if (node->left)
 913     {
 914       if (g_tree_node_post_order (node->left, traverse_func, data))
 915         return TRUE;
 916     }
 917   if (node->right)
 918     {
 919       if (g_tree_node_post_order (node->right, traverse_func, data))
 920         return TRUE;
 921     }
 922   if ((*traverse_func) (node->key, node->value, data))
 923     return TRUE;
 924
 925   return FALSE;
 926 }
 927
 928 static gpointer
 929 g_tree_node_search (GTreeNode     *node,
 930                     GCompareFunc   search_func,
 931                     gconstpointer  data)
 932 {
 933   gint dir;
 934
 935   if (!node)
 936     return NULL;
 937
 938   do {
 939     dir = (* search_func) (node->key, data);
 940     if (dir == 0)
 941       return node->value;
 942
 943     if (dir < 0)
 944       node = node->left;
 945     else if (dir > 0)
 946       node = node->right;
 947   } while (node);
 948
 949   return NULL;
 950 }
 951
 952 static gint
 953 g_tree_node_height (GTreeNode *node)
 954 {
 955   gint left_height;
 956   gint right_height;
 957
 958   if (node)
 959     {
 960       left_height = 0;
 961       right_height = 0;
 962
 963       if (node->left)
 964         left_height = g_tree_node_height (node->left);
 965
 966       if (node->right)
 967         right_height = g_tree_node_height (node->right);
 968
 969       return MAX (left_height, right_height) + 1;
 970     }
 971
 972   return 0;
 973 }
 974
 975 static GTreeNode*
 976 g_tree_node_rotate_left (GTreeNode *node)
 977 {
 978   GTreeNode *right;
 979   gint a_bal;
 980   gint b_bal;
 981
 982   right = node->right;
 983
 984   node->right = right->left;
 985   right->left = node;
 986
 987   a_bal = node->balance;
 988   b_bal = right->balance;
 989
 990   if (b_bal <= 0)
 991     {
 992       if (a_bal >= 1)
 993         right->balance = b_bal - 1;
 994       else
 995         right->balance = a_bal + b_bal - 2;
 996       node->balance = a_bal - 1;
 997     }
 998   else
 999     {
1000       if (a_bal <= b_bal)
1001         right->balance = a_bal - 2;
1002       else
1003         right->balance = b_bal - 1;
1004       node->balance = a_bal - b_bal - 1;
1005     }
1006
1007   return right;
1008 }
1009
1010 static GTreeNode*
1011 g_tree_node_rotate_right (GTreeNode *node)
1012 {
1013   GTreeNode *left;
1014   gint a_bal;
1015   gint b_bal;
1016
1017   left = node->left;
1018
1019   node->left = left->right;
1020   left->right = node;
1021
1022   a_bal = node->balance;
1023   b_bal = left->balance;
1024
1025   if (b_bal <= 0)
1026     {
1027       if (b_bal > a_bal)
1028         left->balance = b_bal + 1;
1029       else
1030         left->balance = a_bal + 2;
1031       node->balance = a_bal - b_bal + 1;
1032     }
1033   else
1034     {
1035       if (a_bal <= -1)
1036         left->balance = b_bal + 1;
1037       else
1038         left->balance = a_bal + b_bal + 2;
1039       node->balance = a_bal + 1;
1040     }
1041
1042   return left;
1043 }
1044
1045 static void
1046 g_tree_node_check (GTreeNode *node)
1047 {
1048   gint left_height;
1049   gint right_height;
1050   gint balance;
1051
1052   if (node)
1053     {
1054       left_height = 0;
1055       right_height = 0;
1056
1057       if (node->left)
1058         left_height = g_tree_node_height (node->left);
1059       if (node->right)
1060         right_height = g_tree_node_height (node->right);
1061
1062       balance = right_height - left_height;
1063       if (balance != node->balance)
1064         g_log (G_LOG_DOMAIN, G_LOG_LEVEL_INFO,
1065                "g_tree_node_check: failed: %d ( %d )\n",
1066                balance, node->balance);
1067
1068       if (node->left)
1069         g_tree_node_check (node->left);
1070       if (node->right)
1071         g_tree_node_check (node->right);
1072     }
1073 }