glib/gsequence.c

   1 /* GLIB - Library of useful routines for C programming
   2  * Copyright (C) 2002, 2003, 2004, 2005, 2006, 2007
   3  * Soeren Sandmann (sandmann@daimi.au.dk)
   4  *
   5  * This library is free software; you can redistribute it and/or
   6  * modify it under the terms of the GNU Lesser General Public
   7  * License as published by the Free Software Foundation; either
   8  * version 2 of the License, or (at your option) any later version.
   9  *
  10  * This library is distributed in the hope that it will be useful,
  11  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  13  * Lesser General Public License for more details.
  14  *
  15  * You should have received a copy of the GNU Lesser General Public
  16  * License along with this library; if not, write to the
  17  * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
  18  * Boston, MA 02111-1307, USA.
  19  */
  20
  21 #include "config.h"
  22
  23 #include "gsequence.h"
  24
  25 #include "gmem.h"
  26 #include "gtestutils.h"
  27 /**
  28  * SECTION: sequence
  29  * @title: Sequences
  30  * @short_description: scalable lists
  31  *
  32  * The #GSequence data structure has the API of a list, but is
  33  * implemented internally with a balanced binary tree. This means that
  34  * it is possible to maintain a sorted list of n elements in time O(n
  35  * log n). The data contained in each element can be either integer
  36  * values, by using of the <link
  37  * linkend="glib-Type-Conversion-Macros">Type Conversion Macros</link>,
  38  * or simply pointers to any type of data.
  39  *
  40  * A #GSequence is accessed through <firstterm>iterators</firstterm>,
  41  * represented by a #GSequenceIter. An iterator represents a position
  42  * between two elements of the sequence. For example, the
  43  * <firstterm>begin</firstterm> iterator represents the gap immediately
  44  * before the first element of the sequence, and the
  45  * <firstterm>end</firstterm> iterator represents the gap immediately
  46  * after the last element. In an empty sequence, the begin and end
  47  * iterators are the same.
  48  *
  49  * Some methods on #GSequence operate on ranges of items. For example
  50  * g_sequence_foreach_range() will call a user-specified function on
  51  * each element with the given range. The range is delimited by the
  52  * gaps represented by the passed-in iterators, so if you pass in the
  53  * begin and end iterators, the range in question is the entire
  54  * sequence.
  55  *
  56  * The function g_sequence_get() is used with an iterator to access the
  57  * element immediately following the gap that the iterator represents.
  58  * The iterator is said to <firstterm>point</firstterm> to that element.
  59  *
  60  * Iterators are stable across most operations on a #GSequence. For
  61  * example an iterator pointing to some element of a sequence will
  62  * continue to point to that element even after the sequence is sorted.
  63  * Even moving an element to another sequence using for example
  64  * g_sequence_move_range() will not invalidate the iterators pointing
  65  * to it. The only operation that will invalidate an iterator is when
  66  * the element it points to is removed from any sequence.
  67  **/
  68
  69 /**
  70  * GSequenceIter:
  71  *
  72  * The #GSequenceIter struct is an opaque data type representing an
  73  * iterator pointing into a #GSequence.
  74  **/
  75
  76 /**
  77  * GSequenceIterCompareFunc:
  78  * @a: a #GSequenceIter
  79  * @b: a #GSequenceIter
  80  * @data: user data
  81  * @Returns: zero if the iterators are equal, a negative value if @a
  82  *           comes before @b, and a positive value if @b comes before
  83  *           @a.
  84  *
  85  * A #GSequenceIterCompareFunc is a function used to compare iterators.
  86  * It must return zero if the iterators compare equal, a negative value
  87  * if @a comes before @b, and a positive value if @b comes before @a.
  88  **/
  89
  90 typedef struct _GSequenceNode GSequenceNode;
  91
  92 /**
  93  * GSequence:
  94  *
  95  * The #GSequence struct is an opaque data type representing a
  96  * <link linkend="glib-Sequences">Sequence</link> data type.
  97  **/
  98 struct _GSequence
  99 {
 100   GSequenceNode *       end_node;
 101   GDestroyNotify        data_destroy_notify;
 102   gboolean              access_prohibited;
 103
 104   /* The 'real_sequence' is used when temporary sequences are created
 105    * to hold nodes that are being rearranged. The 'real_sequence' of such
 106    * a temporary sequence points to the sequence that is actually being
 107    * manipulated. The only reason we need this is so that when the
 108    * sort/sort_changed/search_iter() functions call out to the application
 109    * g_sequence_iter_get_sequence() will return the correct sequence.
 110    */
 111   GSequence *           real_sequence;
 112 };
 113
 114 struct _GSequenceNode
 115 {
 116   gint                  n_nodes;
 117   GSequenceNode *       parent;
 118   GSequenceNode *       left;
 119   GSequenceNode *       right;
 120   gpointer              data;   /* For the end node, this field points
 121                                  * to the sequence
 122                                  */
 123 };
 124
 125 /*
 126  * Declaration of GSequenceNode methods
 127  */
 128 static GSequenceNode *node_new           (gpointer                  data);
 129 static GSequenceNode *node_get_first     (GSequenceNode            *node);
 130 static GSequenceNode *node_get_last      (GSequenceNode            *node);
 131 static GSequenceNode *node_get_prev      (GSequenceNode            *node);
 132 static GSequenceNode *node_get_next      (GSequenceNode            *node);
 133 static gint           node_get_pos       (GSequenceNode            *node);
 134 static GSequenceNode *node_get_by_pos    (GSequenceNode            *node,
 135                                           gint                      pos);
 136 static GSequenceNode *node_find          (GSequenceNode            *haystack,
 137                                           GSequenceNode            *needle,
 138                                           GSequenceNode            *end,
 139                                           GSequenceIterCompareFunc  cmp,
 140                                           gpointer                  user_data);
 141 static GSequenceNode *node_find_closest  (GSequenceNode            *haystack,
 142                                           GSequenceNode            *needle,
 143                                           GSequenceNode            *end,
 144                                           GSequenceIterCompareFunc  cmp,
 145                                           gpointer                  user_data);
 146 static gint           node_get_length    (GSequenceNode            *node);
 147 static void           node_free          (GSequenceNode            *node,
 148                                           GSequence                *seq);
 149 static void           node_cut           (GSequenceNode            *split);
 150 static void           node_insert_before (GSequenceNode            *node,
 151                                           GSequenceNode            *new);
 152 static void           node_unlink        (GSequenceNode            *node);
 153 static void           node_join          (GSequenceNode            *left,
 154                                           GSequenceNode            *right);
 155 static void           node_insert_sorted (GSequenceNode            *node,
 156                                           GSequenceNode            *new,
 157                                           GSequenceNode            *end,
 158                                           GSequenceIterCompareFunc  cmp_func,
 159                                           gpointer                  cmp_data);
 160
 161
 162 /*
 163  * Various helper functions
 164  */
 165 static void
 166 check_seq_access (GSequence *seq)
 167 {
 168   if (G_UNLIKELY (seq->access_prohibited))
 169     {
 170       g_warning ("Accessing a sequence while it is "
 171                  "being sorted or searched is not allowed");
 172     }
 173 }
 174
 175 static GSequence *
 176 get_sequence (GSequenceNode *node)
 177 {
 178   return (GSequence *)node_get_last (node)->data;
 179 }
 180
 181 static void
 182 check_iter_access (GSequenceIter *iter)
 183 {
 184   check_seq_access (get_sequence (iter));
 185 }
 186
 187 static gboolean
 188 is_end (GSequenceIter *iter)
 189 {
 190   GSequence *seq;
 191
 192   if (iter->right)
 193     return FALSE;
 194
 195   if (!iter->parent)
 196     return TRUE;
 197
 198   if (iter->parent->right != iter)
 199     return FALSE;
 200
 201   seq = get_sequence (iter);
 202
 203   return seq->end_node == iter;
 204 }
 205
 206 typedef struct
 207 {
 208   GCompareDataFunc  cmp_func;
 209   gpointer          cmp_data;
 210   GSequenceNode    *end_node;
 211 } SortInfo;
 212
 213 /* This function compares two iters using a normal compare
 214  * function and user_data passed in in a SortInfo struct
 215  */
 216 static gint
 217 iter_compare (GSequenceIter *node1,
 218               GSequenceIter *node2,
 219               gpointer       data)
 220 {
 221   const SortInfo *info = data;
 222   gint retval;
 223
 224   if (node1 == info->end_node)
 225     return 1;
 226
 227   if (node2 == info->end_node)
 228     return -1;
 229
 230   retval = info->cmp_func (node1->data, node2->data, info->cmp_data);
 231
 232   return retval;
 233 }
 234
 235 /*
 236  * Public API
 237  */
 238
 239 /**
 240  * g_sequence_new:
 241  * @data_destroy: a #GDestroyNotify function, or %NULL
 242  *
 243  * Creates a new GSequence. The @data_destroy function, if non-%NULL will
 244  * be called on all items when the sequence is destroyed and on items that
 245  * are removed from the sequence.
 246  *
 247  * Return value: a new #GSequence
 248  *
 249  * Since: 2.14
 250  **/
 251 GSequence *
 252 g_sequence_new (GDestroyNotify data_destroy)
 253 {
 254   GSequence *seq = g_new (GSequence, 1);
 255   seq->data_destroy_notify = data_destroy;
 256
 257   seq->end_node = node_new (seq);
 258
 259   seq->access_prohibited = FALSE;
 260
 261   seq->real_sequence = seq;
 262
 263   return seq;
 264 }
 265
 266 /**
 267  * g_sequence_free:
 268  * @seq: a #GSequence
 269  *
 270  * Frees the memory allocated for @seq. If @seq has a data destroy
 271  * function associated with it, that function is called on all items in
 272  * @seq.
 273  *
 274  * Since: 2.14
 275  **/
 276 void
 277 g_sequence_free (GSequence *seq)
 278 {
 279   g_return_if_fail (seq != NULL);
 280
 281   check_seq_access (seq);
 282
 283   node_free (seq->end_node, seq);
 284
 285   g_free (seq);
 286 }
 287
 288 /**
 289  * g_sequence_foreach_range:
 290  * @begin: a #GSequenceIter
 291  * @end: a #GSequenceIter
 292  * @func: a #GFunc
 293  * @user_data: user data passed to @func
 294  *
 295  * Calls @func for each item in the range (@begin, @end) passing
 296  * @user_data to the function.
 297  *
 298  * Since: 2.14
 299  **/
 300 void
 301 g_sequence_foreach_range (GSequenceIter *begin,
 302                           GSequenceIter *end,
 303                           GFunc          func,
 304                           gpointer       user_data)
 305 {
 306   GSequence *seq;
 307   GSequenceIter *iter;
 308
 309   g_return_if_fail (func != NULL);
 310   g_return_if_fail (begin != NULL);
 311   g_return_if_fail (end != NULL);
 312
 313   seq = get_sequence (begin);
 314
 315   seq->access_prohibited = TRUE;
 316
 317   iter = begin;
 318   while (iter != end)
 319     {
 320       GSequenceIter *next = node_get_next (iter);
 321
 322       func (iter->data, user_data);
 323
 324       iter = next;
 325     }
 326
 327   seq->access_prohibited = FALSE;
 328 }
 329
 330 /**
 331  * g_sequence_foreach:
 332  * @seq: a #GSequence
 333  * @func: the function to call for each item in @seq
 334  * @user_data: user data passed to @func
 335  *
 336  * Calls @func for each item in the sequence passing @user_data
 337  * to the function.
 338  *
 339  * Since: 2.14
 340  **/
 341 void
 342 g_sequence_foreach (GSequence *seq,
 343                     GFunc      func,
 344                     gpointer   user_data)
 345 {
 346   GSequenceIter *begin, *end;
 347
 348   check_seq_access (seq);
 349
 350   begin = g_sequence_get_begin_iter (seq);
 351   end   = g_sequence_get_end_iter (seq);
 352
 353   g_sequence_foreach_range (begin, end, func, user_data);
 354 }
 355
 356 /**
 357  * g_sequence_range_get_midpoint:
 358  * @begin: a #GSequenceIter
 359  * @end: a #GSequenceIter
 360  *
 361  * Finds an iterator somewhere in the range (@begin, @end). This
 362  * iterator will be close to the middle of the range, but is not
 363  * guaranteed to be <emphasis>exactly</emphasis> in the middle.
 364  *
 365  * The @begin and @end iterators must both point to the same sequence and
 366  * @begin must come before or be equal to @end in the sequence.
 367  *
 368  * Return value: A #GSequenceIter pointing somewhere in the
 369  * (@begin, @end) range.
 370  *
 371  * Since: 2.14
 372  **/
 373 GSequenceIter *
 374 g_sequence_range_get_midpoint (GSequenceIter *begin,
 375                                GSequenceIter *end)
 376 {
 377   int begin_pos, end_pos, mid_pos;
 378
 379   g_return_val_if_fail (begin != NULL, NULL);
 380   g_return_val_if_fail (end != NULL, NULL);
 381   g_return_val_if_fail (get_sequence (begin) == get_sequence (end), NULL);
 382
 383   begin_pos = node_get_pos (begin);
 384   end_pos = node_get_pos (end);
 385
 386   g_return_val_if_fail (end_pos >= begin_pos, NULL);
 387
 388   mid_pos = begin_pos + (end_pos - begin_pos) / 2;
 389
 390   return node_get_by_pos (begin, mid_pos);
 391 }
 392
 393 /**
 394  * g_sequence_iter_compare:
 395  * @a: a #GSequenceIter
 396  * @b: a #GSequenceIter
 397  *
 398  * Returns a negative number if @a comes before @b, 0 if they are equal,
 399  * and a positive number if @a comes after @b.
 400  *
 401  * The @a and @b iterators must point into the same sequence.
 402  *
 403  * Return value: A negative number if @a comes before @b, 0 if they are
 404  * equal, and a positive number if @a comes after @b.
 405  *
 406  * Since: 2.14
 407  **/
 408 gint
 409 g_sequence_iter_compare (GSequenceIter *a,
 410                          GSequenceIter *b)
 411 {
 412   gint a_pos, b_pos;
 413
 414   g_return_val_if_fail (a != NULL, 0);
 415   g_return_val_if_fail (b != NULL, 0);
 416   g_return_val_if_fail (get_sequence (a) == get_sequence (b), 0);
 417
 418   check_iter_access (a);
 419   check_iter_access (b);
 420
 421   a_pos = node_get_pos (a);
 422   b_pos = node_get_pos (b);
 423
 424   if (a_pos == b_pos)
 425     return 0;
 426   else if (a_pos > b_pos)
 427     return 1;
 428   else
 429     return -1;
 430 }
 431
 432 /**
 433  * g_sequence_append:
 434  * @seq: a #GSequencePointer
 435  * @data: the data for the new item
 436  *
 437  * Adds a new item to the end of @seq.
 438  *
 439  * Return value: an iterator pointing to the new item
 440  *
 441  * Since: 2.14
 442  **/
 443 GSequenceIter *
 444 g_sequence_append (GSequence *seq,
 445                    gpointer   data)
 446 {
 447   GSequenceNode *node;
 448
 449   g_return_val_if_fail (seq != NULL, NULL);
 450
 451   check_seq_access (seq);
 452
 453   node = node_new (data);
 454   node_insert_before (seq->end_node, node);
 455
 456   return node;
 457 }
 458
 459 /**
 460  * g_sequence_prepend:
 461  * @seq: a #GSequence
 462  * @data: the data for the new item
 463  *
 464  * Adds a new item to the front of @seq
 465  *
 466  * Return value: an iterator pointing to the new item
 467  *
 468  * Since: 2.14
 469  **/
 470 GSequenceIter *
 471 g_sequence_prepend (GSequence *seq,
 472                     gpointer   data)
 473 {
 474   GSequenceNode *node, *first;
 475
 476   g_return_val_if_fail (seq != NULL, NULL);
 477
 478   check_seq_access (seq);
 479
 480   node = node_new (data);
 481   first = node_get_first (seq->end_node);
 482
 483   node_insert_before (first, node);
 484
 485   return node;
 486 }
 487
 488 /**
 489  * g_sequence_insert_before:
 490  * @iter: a #GSequenceIter
 491  * @data: the data for the new item
 492  *
 493  * Inserts a new item just before the item pointed to by @iter.
 494  *
 495  * Return value: an iterator pointing to the new item
 496  *
 497  * Since: 2.14
 498  **/
 499 GSequenceIter *
 500 g_sequence_insert_before (GSequenceIter *iter,
 501                           gpointer       data)
 502 {
 503   GSequenceNode *node;
 504
 505   g_return_val_if_fail (iter != NULL, NULL);
 506
 507   check_iter_access (iter);
 508
 509   node = node_new (data);
 510
 511   node_insert_before (iter, node);
 512
 513   return node;
 514 }
 515
 516 /**
 517  * g_sequence_remove:
 518  * @iter: a #GSequenceIter
 519  *
 520  * Removes the item pointed to by @iter. It is an error to pass the
 521  * end iterator to this function.
 522  *
 523  * If the sequnce has a data destroy function associated with it, this
 524  * function is called on the data for the removed item.
 525  *
 526  * Since: 2.14
 527  **/
 528 void
 529 g_sequence_remove (GSequenceIter *iter)
 530 {
 531   GSequence *seq;
 532
 533   g_return_if_fail (iter != NULL);
 534   g_return_if_fail (!is_end (iter));
 535
 536   check_iter_access (iter);
 537
 538   seq = get_sequence (iter);
 539
 540   node_unlink (iter);
 541   node_free (iter, seq);
 542 }
 543
 544 /**
 545  * g_sequence_remove_range:
 546  * @begin: a #GSequenceIter
 547  * @end: a #GSequenceIter
 548  *
 549  * Removes all items in the (@begin, @end) range.
 550  *
 551  * If the sequence has a data destroy function associated with it, this
 552  * function is called on the data for the removed items.
 553  *
 554  * Since: 2.14
 555  **/
 556 void
 557 g_sequence_remove_range (GSequenceIter *begin,
 558                          GSequenceIter *end)
 559 {
 560   g_return_if_fail (get_sequence (begin) == get_sequence (end));
 561
 562   check_iter_access (begin);
 563   check_iter_access (end);
 564
 565   g_sequence_move_range (NULL, begin, end);
 566 }
 567
 568 /**
 569  * g_sequence_move_range:
 570  * @dest: a #GSequenceIter
 571  * @begin: a #GSequenceIter
 572  * @end: a #GSequenceIter
 573  *
 574  * Inserts the (@begin, @end) range at the destination pointed to by ptr.
 575  * The @begin and @end iters must point into the same sequence. It is
 576  * allowed for @dest to point to a different sequence than the one pointed
 577  * into by @begin and @end.
 578  *
 579  * If @dest is NULL, the range indicated by @begin and @end is
 580  * removed from the sequence. If @dest iter points to a place within
 581  * the (@begin, @end) range, the range does not move.
 582  *
 583  * Since: 2.14
 584  **/
 585 void
 586 g_sequence_move_range (GSequenceIter *dest,
 587                        GSequenceIter *begin,
 588                        GSequenceIter *end)
 589 {
 590   GSequence *src_seq;
 591   GSequenceNode *first;
 592
 593   g_return_if_fail (begin != NULL);
 594   g_return_if_fail (end != NULL);
 595
 596   check_iter_access (begin);
 597   check_iter_access (end);
 598   if (dest)
 599     check_iter_access (dest);
 600
 601   src_seq = get_sequence (begin);
 602
 603   g_return_if_fail (src_seq == get_sequence (end));
 604
 605   /* Dest points to begin or end? */
 606   if (dest == begin || dest == end)
 607     return;
 608
 609   /* begin comes after end? */
 610   if (g_sequence_iter_compare (begin, end) >= 0)
 611     return;
 612
 613   /* dest points somewhere in the (begin, end) range? */
 614   if (dest && get_sequence (dest) == src_seq &&
 615       g_sequence_iter_compare (dest, begin) > 0 &&
 616       g_sequence_iter_compare (dest, end) < 0)
 617     {
 618       return;
 619     }
 620
 621   src_seq = get_sequence (begin);
 622
 623   first = node_get_first (begin);
 624
 625   node_cut (begin);
 626
 627   node_cut (end);
 628
 629   if (first != begin)
 630     node_join (first, end);
 631
 632   if (dest)
 633     {
 634       first = node_get_first (dest);
 635
 636       node_cut (dest);
 637
 638       node_join (begin, dest);
 639
 640       if (dest != first)
 641         node_join (first, begin);
 642     }
 643   else
 644     {
 645       node_free (begin, src_seq);
 646     }
 647 }
 648
 649 /**
 650  * g_sequence_sort:
 651  * @seq: a #GSequence
 652  * @cmp_func: the #GCompareDataFunc used to sort @seq. This function is
 653  *       passed two items of @seq and should return 0 if they are equal,
 654  *       a negative value if the first comes before the second, and a
 655  *       positive value if the second comes before the first.
 656  * @cmp_data: user data passed to @cmp_func
 657  *
 658  * Sorts @seq using @cmp_func.
 659  *
 660  * Since: 2.14
 661  **/
 662 void
 663 g_sequence_sort (GSequence        *seq,
 664                  GCompareDataFunc  cmp_func,
 665                  gpointer          cmp_data)
 666 {
 667   SortInfo info;
 668
 669   info.cmp_func = cmp_func;
 670   info.cmp_data = cmp_data;
 671   info.end_node = seq->end_node;
 672
 673   check_seq_access (seq);
 674
 675   g_sequence_sort_iter (seq, iter_compare, &info);
 676 }
 677
 678 /**
 679  * g_sequence_insert_sorted:
 680  * @seq: a #GSequence
 681  * @data: the data to insert
 682  * @cmp_func: the #GCompareDataFunc used to compare items in the sequence. It
 683  *     is called with two items of the @seq and @user_data. It should
 684  *     return 0 if the items are equal, a negative value if the first
 685  *     item comes before the second, and a positive value if the second
 686  *     item comes before the first.
 687  * @cmp_data: user data passed to @cmp_func.
 688  *
 689  * Inserts @data into @sequence using @func to determine the new position.
 690  * The sequence must already be sorted according to @cmp_func; otherwise the
 691  * new position of @data is undefined.
 692  *
 693  * Return value: a #GSequenceIter pointing to the new item.
 694  *
 695  * Since: 2.14
 696  **/
 697 GSequenceIter *
 698 g_sequence_insert_sorted (GSequence        *seq,
 699                           gpointer          data,
 700                           GCompareDataFunc  cmp_func,
 701                           gpointer          cmp_data)
 702 {
 703   SortInfo info;
 704
 705   g_return_val_if_fail (seq != NULL, NULL);
 706   g_return_val_if_fail (cmp_func != NULL, NULL);
 707
 708   info.cmp_func = cmp_func;
 709   info.cmp_data = cmp_data;
 710   info.end_node = seq->end_node;
 711   check_seq_access (seq);
 712
 713   return g_sequence_insert_sorted_iter (seq, data, iter_compare, &info);
 714 }
 715
 716 /**
 717  * g_sequence_sort_changed:
 718  * @iter: A #GSequenceIter
 719  * @cmp_func: the #GCompareDataFunc used to compare items in the sequence. It
 720  *     is called with two items of the @seq and @user_data. It should
 721  *     return 0 if the items are equal, a negative value if the first
 722  *     item comes before the second, and a positive value if the second
 723  *     item comes before the first.
 724  * @cmp_data: user data passed to @cmp_func.
 725  *
 726  * Moves the data pointed to a new position as indicated by @cmp_func. This
 727  * function should be called for items in a sequence already sorted according
 728  * to @cmp_func whenever some aspect of an item changes so that @cmp_func
 729  * may return different values for that item.
 730  *
 731  * Since: 2.14
 732  **/
 733 void
 734 g_sequence_sort_changed (GSequenceIter    *iter,
 735                          GCompareDataFunc  cmp_func,
 736                          gpointer          cmp_data)
 737 {
 738   SortInfo info;
 739
 740   g_return_if_fail (!is_end (iter));
 741
 742   info.cmp_func = cmp_func;
 743   info.cmp_data = cmp_data;
 744   info.end_node = get_sequence (iter)->end_node;
 745   check_iter_access (iter);
 746
 747   g_sequence_sort_changed_iter (iter, iter_compare, &info);
 748 }
 749
 750 /**
 751  * g_sequence_search:
 752  * @seq: a #GSequence
 753  * @data: data for the new item
 754  * @cmp_func: the #GCompareDataFunc used to compare items in the sequence. It
 755  *     is called with two items of the @seq and @user_data. It should
 756  *     return 0 if the items are equal, a negative value if the first
 757  *     item comes before the second, and a positive value if the second
 758  *     item comes before the first.
 759  * @cmp_data: user data passed to @cmp_func.
 760  *
 761  * Returns an iterator pointing to the position where @data would
 762  * be inserted according to @cmp_func and @cmp_data.
 763  *
 764  * Return value: an #GSequenceIter pointing to the position where @data
 765  * would have been inserted according to @cmp_func and @cmp_data.
 766  *
 767  * Since: 2.14
 768  **/
 769 GSequenceIter *
 770 g_sequence_search (GSequence        *seq,
 771                    gpointer          data,
 772                    GCompareDataFunc  cmp_func,
 773                    gpointer          cmp_data)
 774 {
 775   SortInfo info;
 776
 777   g_return_val_if_fail (seq != NULL, NULL);
 778
 779   info.cmp_func = cmp_func;
 780   info.cmp_data = cmp_data;
 781   info.end_node = seq->end_node;
 782   check_seq_access (seq);
 783
 784   return g_sequence_search_iter (seq, data, iter_compare, &info);
 785 }
 786
 787 /**
 788  * g_sequence_lookup:
 789  * @seq: a #GSequence
 790  * @data: data to lookup
 791  * @cmp_func: the #GCompareDataFunc used to compare items in the sequence. It
 792  *     is called with two items of the @seq and @user_data. It should
 793  *     return 0 if the items are equal, a negative value if the first
 794  *     item comes before the second, and a positive value if the second
 795  *     item comes before the first.
 796  * @cmp_data: user data passed to @cmp_func.
 797  *
 798  * Returns an iterator pointing to the position of the first item found
 799  * equal to @data according to @cmp_func and @cmp_data. If more than one item
 800  * is equal, it is not guaranteed that it is the first which is returned.
 801  * In that case, you can use g_sequence_iter_next() and g_sequence_iter_prev()
 802  * to get others.
 803  *
 804  * Return value: an #GSequenceIter pointing to the position of the first item
 805  * found equal to @data according to @cmp_func and @cmp_data.
 806  *
 807  * Since: 2.26
 808  **/
 809 GSequenceIter *
 810 g_sequence_lookup (GSequence *seq,
 811                    gpointer data,
 812                    GCompareDataFunc cmp_func,
 813                    gpointer cmp_data)
 814 {
 815   SortInfo info;
 816
 817   g_return_val_if_fail (seq != NULL, NULL);
 818
 819   info.cmp_func = cmp_func;
 820   info.cmp_data = cmp_data;
 821   info.end_node = seq->end_node;
 822   check_seq_access (seq);
 823
 824   return g_sequence_lookup_iter (seq, data, iter_compare, &info);
 825 }
 826
 827 /**
 828  * g_sequence_sort_iter:
 829  * @seq: a #GSequence
 830  * @cmp_func: the #GSequenceItercompare used to compare iterators in the
 831  *     sequence. It is called with two iterators pointing into @seq. It should
 832  *     return 0 if the iterators are equal, a negative value if the first
 833  *     iterator comes before the second, and a positive value if the second
 834  *     iterator comes before the first.
 835  * @cmp_data: user data passed to @cmp_func
 836  *
 837  * Like g_sequence_sort(), but uses a #GSequenceIterCompareFunc instead
 838  * of a GCompareDataFunc as the compare function
 839  *
 840  * Since: 2.14
 841  **/
 842 void
 843 g_sequence_sort_iter (GSequence                *seq,
 844                       GSequenceIterCompareFunc  cmp_func,
 845                       gpointer                  cmp_data)
 846 {
 847   GSequence *tmp;
 848   GSequenceNode *begin, *end;
 849
 850   g_return_if_fail (seq != NULL);
 851   g_return_if_fail (cmp_func != NULL);
 852
 853   check_seq_access (seq);
 854
 855   begin = g_sequence_get_begin_iter (seq);
 856   end   = g_sequence_get_end_iter (seq);
 857
 858   tmp = g_sequence_new (NULL);
 859   tmp->real_sequence = seq;
 860
 861   g_sequence_move_range (g_sequence_get_begin_iter (tmp), begin, end);
 862
 863   seq->access_prohibited = TRUE;
 864   tmp->access_prohibited = TRUE;
 865
 866   while (g_sequence_get_length (tmp) > 0)
 867     {
 868       GSequenceNode *node = g_sequence_get_begin_iter (tmp);
 869
 870       node_insert_sorted (seq->end_node, node, seq->end_node,
 871                           cmp_func, cmp_data);
 872     }
 873
 874   tmp->access_prohibited = FALSE;
 875   seq->access_prohibited = FALSE;
 876
 877   g_sequence_free (tmp);
 878 }
 879
 880 /**
 881  * g_sequence_sort_changed_iter:
 882  * @iter: a #GSequenceIter
 883  * @iter_cmp: the #GSequenceItercompare used to compare iterators in the
 884  *     sequence. It is called with two iterators pointing into @seq. It should
 885  *     return 0 if the iterators are equal, a negative value if the first
 886  *     iterator comes before the second, and a positive value if the second
 887  *     iterator comes before the first.
 888  * @cmp_data: user data passed to @cmp_func
 889  *
 890  * Like g_sequence_sort_changed(), but uses
 891  * a #GSequenceIterCompareFunc instead of a #GCompareDataFunc as
 892  * the compare function.
 893  *
 894  * Since: 2.14
 895  **/
 896 void
 897 g_sequence_sort_changed_iter (GSequenceIter            *iter,
 898                               GSequenceIterCompareFunc  iter_cmp,
 899                               gpointer                  cmp_data)
 900 {
 901   GSequence *seq, *tmp_seq;
 902   GSequenceIter *next, *prev;
 903
 904   g_return_if_fail (iter != NULL);
 905   g_return_if_fail (!is_end (iter));
 906   g_return_if_fail (iter_cmp != NULL);
 907   check_iter_access (iter);
 908
 909   /* If one of the neighbours is equal to iter, then
 910    * don't move it. This ensures that sort_changed() is
 911    * a stable operation.
 912    */
 913
 914   next = node_get_next (iter);
 915   prev = node_get_prev (iter);
 916
 917   if (prev != iter && iter_cmp (prev, iter, cmp_data) == 0)
 918     return;
 919
 920   if (!is_end (next) && iter_cmp (next, iter, cmp_data) == 0)
 921     return;
 922
 923   seq = get_sequence (iter);
 924
 925   seq->access_prohibited = TRUE;
 926
 927   tmp_seq = g_sequence_new (NULL);
 928   tmp_seq->real_sequence = seq;
 929
 930   node_unlink (iter);
 931   node_insert_before (tmp_seq->end_node, iter);
 932
 933   node_insert_sorted (seq->end_node, iter, seq->end_node,
 934                       iter_cmp, cmp_data);
 935
 936   g_sequence_free (tmp_seq);
 937
 938   seq->access_prohibited = FALSE;
 939 }
 940
 941 /**
 942  * g_sequence_insert_sorted_iter:
 943  * @seq: a #GSequence
 944  * @data: data for the new item
 945  * @iter_cmp: the #GSequenceItercompare used to compare iterators in the
 946  *     sequence. It is called with two iterators pointing into @seq. It should
 947  *     return 0 if the iterators are equal, a negative value if the first
 948  *     iterator comes before the second, and a positive value if the second
 949  *     iterator comes before the first.
 950  * @cmp_data: user data passed to @cmp_func
 951  *
 952  * Like g_sequence_insert_sorted(), but uses
 953  * a #GSequenceIterCompareFunc instead of a #GCompareDataFunc as
 954  * the compare function.
 955  *
 956  * Return value: a #GSequenceIter pointing to the new item
 957  *
 958  * Since: 2.14
 959  **/
 960 GSequenceIter *
 961 g_sequence_insert_sorted_iter (GSequence                *seq,
 962                                gpointer                  data,
 963                                GSequenceIterCompareFunc  iter_cmp,
 964                                gpointer                  cmp_data)
 965 {
 966   GSequenceNode *new_node;
 967   GSequence *tmp_seq;
 968
 969   g_return_val_if_fail (seq != NULL, NULL);
 970   g_return_val_if_fail (iter_cmp != NULL, NULL);
 971
 972   check_seq_access (seq);
 973
 974   seq->access_prohibited = TRUE;
 975
 976   /* Create a new temporary sequence and put the new node into
 977    * that. The reason for this is that the user compare function
 978    * will be called with the new node, and if it dereferences,
 979    * "is_end" will be called on it. But that will crash if the
 980    * node is not actually in a sequence.
 981    *
 982    * node_insert_sorted() makes sure the node is unlinked before
 983    * it is inserted.
 984    *
 985    * The reason we need the "iter" versions at all is that that
 986    * is the only kind of compare functions GtkTreeView can use.
 987    */
 988   tmp_seq = g_sequence_new (NULL);
 989   tmp_seq->real_sequence = seq;
 990
 991   new_node = g_sequence_append (tmp_seq, data);
 992
 993   node_insert_sorted (seq->end_node, new_node,
 994                       seq->end_node, iter_cmp, cmp_data);
 995
 996   g_sequence_free (tmp_seq);
 997
 998   seq->access_prohibited = FALSE;
 999
1000   return new_node;
1001 }
1002
1003 /**
1004  * g_sequence_search_iter:
1005  * @seq: a #GSequence
1006  * @data: data for the new item
1007  * @iter_cmp: the #GSequenceIterCompare function used to compare iterators
1008  *     in the sequence. It is called with two iterators pointing into @seq.
1009  *     It should return 0 if the iterators are equal, a negative value if the
1010  *     first iterator comes before the second, and a positive value if the
1011  *     second iterator comes before the first.
1012  * @cmp_data: user data passed to @iter_cmp
1013  *
1014  * Like g_sequence_search(), but uses
1015  * a #GSequenceIterCompareFunc instead of a #GCompareDataFunc as
1016  * the compare function.
1017  *
1018  * Return value: a #GSequenceIter pointing to the position in @seq
1019  * where @data would have been inserted according to @iter_cmp and @cmp_data.
1020  *
1021  * Since: 2.14
1022  **/
1023 GSequenceIter *
1024 g_sequence_search_iter (GSequence                *seq,
1025                         gpointer                  data,
1026                         GSequenceIterCompareFunc  iter_cmp,
1027                         gpointer                  cmp_data)
1028 {
1029   GSequenceNode *node;
1030   GSequenceNode *dummy;
1031   GSequence *tmp_seq;
1032
1033   g_return_val_if_fail (seq != NULL, NULL);
1034
1035   check_seq_access (seq);
1036
1037   seq->access_prohibited = TRUE;
1038
1039   tmp_seq = g_sequence_new (NULL);
1040   tmp_seq->real_sequence = seq;
1041
1042   dummy = g_sequence_append (tmp_seq, data);
1043
1044   node = node_find_closest (seq->end_node, dummy,
1045                             seq->end_node, iter_cmp, cmp_data);
1046
1047   g_sequence_free (tmp_seq);
1048
1049   seq->access_prohibited = FALSE;
1050
1051   return node;
1052 }
1053
1054 /**
1055  * g_sequence_lookup_iter:
1056  * @seq: a #GSequence
1057  * @data: data to lookup
1058  * @iter_cmp: the #GSequenceIterCompare function used to compare iterators
1059  *     in the sequence. It is called with two iterators pointing into @seq.
1060  *     It should return 0 if the iterators are equal, a negative value if the
1061  *     first iterator comes before the second, and a positive value if the
1062  *     second iterator comes before the first.
1063  * @cmp_data: user data passed to @iter_cmp
1064  *
1065  * Like g_sequence_lookup(), but uses
1066  * a #GSequenceIterCompareFunc instead of a #GCompareDataFunc as
1067  * the compare function.
1068  *
1069  * Return value: an #GSequenceIter pointing to the position of the first item
1070  * found equal to @data according to @cmp_func and @cmp_data.
1071  *
1072  * Since: 2.26
1073  **/
1074 GSequenceIter *
1075 g_sequence_lookup_iter (GSequence *seq,
1076                         gpointer data,
1077                         GSequenceIterCompareFunc iter_cmp,
1078                         gpointer cmp_data)
1079 {
1080   GSequenceNode *node;
1081   GSequenceNode *dummy;
1082   GSequence *tmp_seq;
1083
1084   g_return_val_if_fail (seq != NULL, NULL);
1085
1086   check_seq_access (seq);
1087
1088   seq->access_prohibited = TRUE;
1089
1090   tmp_seq = g_sequence_new (NULL);
1091   tmp_seq->real_sequence = seq;
1092
1093   dummy = g_sequence_append (tmp_seq, data);
1094
1095   node = node_find (seq->end_node, dummy,
1096                     seq->end_node, iter_cmp, cmp_data);
1097
1098   g_sequence_free (tmp_seq);
1099
1100   seq->access_prohibited = FALSE;
1101
1102   return node;
1103 }
1104
1105 /**
1106  * g_sequence_iter_get_sequence:
1107  * @iter: a #GSequenceIter
1108  *
1109  * Returns the #GSequence that @iter points into.
1110  *
1111  * Return value: the #GSequence that @iter points into.
1112  *
1113  * Since: 2.14
1114  **/
1115 GSequence *
1116 g_sequence_iter_get_sequence (GSequenceIter *iter)
1117 {
1118   GSequence *seq;
1119
1120   g_return_val_if_fail (iter != NULL, NULL);
1121
1122   seq = get_sequence (iter);
1123
1124   /* For temporary sequences, this points to the sequence that
1125    * is actually being manipulated
1126    */
1127   return seq->real_sequence;
1128 }
1129
1130 /**
1131  * g_sequence_get:
1132  * @iter: a #GSequenceIter
1133  *
1134  * Returns the data that @iter points to.
1135  *
1136  * Return value: the data that @iter points to
1137  *
1138  * Since: 2.14
1139  **/
1140 gpointer
1141 g_sequence_get (GSequenceIter *iter)
1142 {
1143   g_return_val_if_fail (iter != NULL, NULL);
1144   g_return_val_if_fail (!is_end (iter), NULL);
1145
1146   return iter->data;
1147 }
1148
1149 /**
1150  * g_sequence_set:
1151  * @iter: a #GSequenceIter
1152  * @data: new data for the item
1153  *
1154  * Changes the data for the item pointed to by @iter to be @data. If
1155  * the sequence has a data destroy function associated with it, that
1156  * function is called on the existing data that @iter pointed to.
1157  *
1158  * Since: 2.14
1159  **/
1160 void
1161 g_sequence_set (GSequenceIter *iter,
1162                 gpointer       data)
1163 {
1164   GSequence *seq;
1165
1166   g_return_if_fail (iter != NULL);
1167   g_return_if_fail (!is_end (iter));
1168
1169   seq = get_sequence (iter);
1170
1171   /* If @data is identical to iter->data, it is destroyed
1172    * here. This will work right in case of ref-counted objects. Also
1173    * it is similar to what ghashtables do.
1174    *
1175    * For non-refcounted data it's a little less convenient, but
1176    * code relying on self-setting not destroying would be
1177    * pretty dubious anyway ...
1178    */
1179
1180   if (seq->data_destroy_notify)
1181     seq->data_destroy_notify (iter->data);
1182
1183   iter->data = data;
1184 }
1185
1186 /**
1187  * g_sequence_get_length:
1188  * @seq: a #GSequence
1189  *
1190  * Returns the length of @seq
1191  *
1192  * Return value: the length of @seq
1193  *
1194  * Since: 2.14
1195  **/
1196 gint
1197 g_sequence_get_length (GSequence *seq)
1198 {
1199   return node_get_length (seq->end_node) - 1;
1200 }
1201
1202 /**
1203  * g_sequence_get_end_iter:
1204  * @seq: a #GSequence
1205  *
1206  * Returns the end iterator for @seg
1207  *
1208  * Return value: the end iterator for @seq
1209  *
1210  * Since: 2.14
1211  **/
1212 GSequenceIter *
1213 g_sequence_get_end_iter (GSequence *seq)
1214 {
1215   g_return_val_if_fail (seq != NULL, NULL);
1216
1217   return seq->end_node;
1218 }
1219
1220 /**
1221  * g_sequence_get_begin_iter:
1222  * @seq: a #GSequence
1223  *
1224  * Returns the begin iterator for @seq.
1225  *
1226  * Return value: the begin iterator for @seq.
1227  *
1228  * Since: 2.14
1229  **/
1230 GSequenceIter *
1231 g_sequence_get_begin_iter (GSequence *seq)
1232 {
1233   g_return_val_if_fail (seq != NULL, NULL);
1234
1235   return node_get_first (seq->end_node);
1236 }
1237
1238 static int
1239 clamp_position (GSequence *seq,
1240                 int        pos)
1241 {
1242   gint len = g_sequence_get_length (seq);
1243
1244   if (pos > len || pos < 0)
1245     pos = len;
1246
1247   return pos;
1248 }
1249
1250 /*
1251  * if pos > number of items or -1, will return end pointer
1252  */
1253 /**
1254  * g_sequence_get_iter_at_pos:
1255  * @seq: a #GSequence
1256  * @pos: a position in @seq, or -1 for the end.
1257  *
1258  * Returns the iterator at position @pos. If @pos is negative or larger
1259  * than the number of items in @seq, the end iterator is returned.
1260  *
1261  * Return value: The #GSequenceIter at position @pos
1262  *
1263  * Since: 2.14
1264  **/
1265 GSequenceIter *
1266 g_sequence_get_iter_at_pos (GSequence *seq,
1267                             gint       pos)
1268 {
1269   g_return_val_if_fail (seq != NULL, NULL);
1270
1271   pos = clamp_position (seq, pos);
1272
1273   return node_get_by_pos (seq->end_node, pos);
1274 }
1275
1276 /**
1277  * g_sequence_move:
1278  * @src: a #GSequenceIter pointing to the item to move
1279  * @dest: a #GSequenceIter pointing to the position to which
1280  *        the item is moved.
1281  *
1282  * Moves the item pointed to by @src to the position indicated by @dest.
1283  * After calling this function @dest will point to the position immediately
1284  * after @src. It is allowed for @src and @dest to point into different
1285  * sequences.
1286  *
1287  * Since: 2.14
1288  **/
1289 void
1290 g_sequence_move (GSequenceIter *src,
1291                  GSequenceIter *dest)
1292 {
1293   g_return_if_fail (src != NULL);
1294   g_return_if_fail (dest != NULL);
1295   g_return_if_fail (!is_end (src));
1296
1297   if (src == dest)
1298     return;
1299
1300   node_unlink (src);
1301   node_insert_before (dest, src);
1302 }
1303
1304 /* GSequenceIter */
1305
1306 /**
1307  * g_sequence_iter_is_end:
1308  * @iter: a #GSequenceIter
1309  *
1310  * Returns whether @iter is the end iterator
1311  *
1312  * Return value: Whether @iter is the end iterator.
1313  *
1314  * Since: 2.14
1315  **/
1316 gboolean
1317 g_sequence_iter_is_end (GSequenceIter *iter)
1318 {
1319   g_return_val_if_fail (iter != NULL, FALSE);
1320
1321   return is_end (iter);
1322 }
1323
1324 /**
1325  * g_sequence_iter_is_begin:
1326  * @iter: a #GSequenceIter
1327  *
1328  * Returns whether @iter is the begin iterator
1329  *
1330  * Return value: whether @iter is the begin iterator
1331  *
1332  * Since: 2.14
1333  **/
1334 gboolean
1335 g_sequence_iter_is_begin (GSequenceIter *iter)
1336 {
1337   g_return_val_if_fail (iter != NULL, FALSE);
1338
1339   return (node_get_prev (iter) == iter);
1340 }
1341
1342 /**
1343  * g_sequence_iter_get_position:
1344  * @iter: a #GSequenceIter
1345  *
1346  * Returns the position of @iter
1347  *
1348  * Return value: the position of @iter
1349  *
1350  * Since: 2.14
1351  **/
1352 gint
1353 g_sequence_iter_get_position (GSequenceIter *iter)
1354 {
1355   g_return_val_if_fail (iter != NULL, -1);
1356
1357   return node_get_pos (iter);
1358 }
1359
1360 /**
1361  * g_sequence_iter_next:
1362  * @iter: a #GSequenceIter
1363  *
1364  * Returns an iterator pointing to the next position after @iter. If
1365  * @iter is the end iterator, the end iterator is returned.
1366  *
1367  * Return value: a #GSequenceIter pointing to the next position after @iter.
1368  *
1369  * Since: 2.14
1370  **/
1371 GSequenceIter *
1372 g_sequence_iter_next (GSequenceIter *iter)
1373 {
1374   g_return_val_if_fail (iter != NULL, NULL);
1375
1376   return node_get_next (iter);
1377 }
1378
1379 /**
1380  * g_sequence_iter_prev:
1381  * @iter: a #GSequenceIter
1382  *
1383  * Returns an iterator pointing to the previous position before @iter. If
1384  * @iter is the begin iterator, the begin iterator is returned.
1385  *
1386  * Return value: a #GSequenceIter pointing to the previous position before
1387  * @iter.
1388  *
1389  * Since: 2.14
1390  **/
1391 GSequenceIter *
1392 g_sequence_iter_prev (GSequenceIter *iter)
1393 {
1394   g_return_val_if_fail (iter != NULL, NULL);
1395
1396   return node_get_prev (iter);
1397 }
1398
1399 /**
1400  * g_sequence_iter_move:
1401  * @iter: a #GSequenceIter
1402  * @delta: A positive or negative number indicating how many positions away
1403  *    from @iter the returned #GSequenceIter will be.
1404  *
1405  * Returns the #GSequenceIter which is @delta positions away from @iter.
1406  * If @iter is closer than -@delta positions to the beginning of the sequence,
1407  * the begin iterator is returned. If @iter is closer than @delta positions
1408  * to the end of the sequence, the end iterator is returned.
1409  *
1410  * Return value: a #GSequenceIter which is @delta positions away from @iter.
1411  *
1412  * Since: 2.14
1413  **/
1414 GSequenceIter *
1415 g_sequence_iter_move (GSequenceIter *iter,
1416                       gint           delta)
1417 {
1418   gint new_pos;
1419
1420   g_return_val_if_fail (iter != NULL, NULL);
1421
1422   new_pos = node_get_pos (iter) + delta;
1423
1424   new_pos = clamp_position (get_sequence (iter), new_pos);
1425
1426   return node_get_by_pos (iter, new_pos);
1427 }
1428
1429 /**
1430  * g_sequence_swap:
1431  * @a: a #GSequenceIter
1432  * @b: a #GSequenceIter
1433  *
1434  * Swaps the items pointed to by @a and @b. It is allowed for @a and @b
1435  * to point into difference sequences.
1436  *
1437  * Since: 2.14
1438  **/
1439 void
1440 g_sequence_swap (GSequenceIter *a,
1441                  GSequenceIter *b)
1442 {
1443   GSequenceNode *leftmost, *rightmost, *rightmost_next;
1444   int a_pos, b_pos;
1445
1446   g_return_if_fail (!g_sequence_iter_is_end (a));
1447   g_return_if_fail (!g_sequence_iter_is_end (b));
1448
1449   if (a == b)
1450     return;
1451
1452   a_pos = g_sequence_iter_get_position (a);
1453   b_pos = g_sequence_iter_get_position (b);
1454
1455   if (a_pos > b_pos)
1456     {
1457       leftmost = b;
1458       rightmost = a;
1459     }
1460   else
1461     {
1462       leftmost = a;
1463       rightmost = b;
1464     }
1465
1466   rightmost_next = node_get_next (rightmost);
1467
1468   /* The situation is now like this:
1469    *
1470    *     ..., leftmost, ......., rightmost, rightmost_next, ...
1471    *
1472    */
1473   g_sequence_move (rightmost, leftmost);
1474   g_sequence_move (leftmost, rightmost_next);
1475 }
1476
1477 /*
1478  * Implementation of a treap
1479  *
1480  *
1481  */
1482 static guint
1483 get_priority (GSequenceNode *node)
1484 {
1485   guint key = GPOINTER_TO_UINT (node);
1486
1487   /* This hash function is based on one found on Thomas Wang's
1488    * web page at
1489    *
1490    *    http://www.concentric.net/~Ttwang/tech/inthash.htm
1491    *
1492    */
1493   key = (key << 15) - key - 1;
1494   key = key ^ (key >> 12);
1495   key = key + (key << 2);
1496   key = key ^ (key >> 4);
1497   key = key + (key << 3) + (key << 11);
1498   key = key ^ (key >> 16);
1499
1500   /* We rely on 0 being less than all other priorities */
1501   return key? key : 1;
1502 }
1503
1504 static GSequenceNode *
1505 find_root (GSequenceNode *node)
1506 {
1507   while (node->parent)
1508     node = node->parent;
1509
1510   return node;
1511 }
1512
1513 static GSequenceNode *
1514 node_new (gpointer data)
1515 {
1516   GSequenceNode *node = g_slice_new0 (GSequenceNode);
1517
1518   node->n_nodes = 1;
1519   node->data = data;
1520   node->left = NULL;
1521   node->right = NULL;
1522   node->parent = NULL;
1523
1524   return node;
1525 }
1526
1527 static GSequenceNode *
1528 node_get_first (GSequenceNode *node)
1529 {
1530   node = find_root (node);
1531
1532   while (node->left)
1533     node = node->left;
1534
1535   return node;
1536 }
1537
1538 static GSequenceNode *
1539 node_get_last (GSequenceNode *node)
1540 {
1541   node = find_root (node);
1542
1543   while (node->right)
1544     node = node->right;
1545
1546   return node;
1547 }
1548
1549 #define NODE_LEFT_CHILD(n)  (((n)->parent) && ((n)->parent->left) == (n))
1550 #define NODE_RIGHT_CHILD(n) (((n)->parent) && ((n)->parent->right) == (n))
1551
1552 static GSequenceNode *
1553 node_get_next (GSequenceNode *node)
1554 {
1555   GSequenceNode *n = node;
1556
1557   if (n->right)
1558     {
1559       n = n->right;
1560       while (n->left)
1561         n = n->left;
1562     }
1563   else
1564     {
1565       while (NODE_RIGHT_CHILD (n))
1566         n = n->parent;
1567
1568       if (n->parent)
1569         n = n->parent;
1570       else
1571         n = node;
1572     }
1573
1574   return n;
1575 }
1576
1577 static GSequenceNode *
1578 node_get_prev (GSequenceNode *node)
1579 {
1580   GSequenceNode *n = node;
1581
1582   if (n->left)
1583     {
1584       n = n->left;
1585       while (n->right)
1586         n = n->right;
1587     }
1588   else
1589     {
1590       while (NODE_LEFT_CHILD (n))
1591         n = n->parent;
1592
1593       if (n->parent)
1594         n = n->parent;
1595       else
1596         n = node;
1597     }
1598
1599   return n;
1600 }
1601
1602 #define N_NODES(n) ((n)? (n)->n_nodes : 0)
1603
1604 static gint
1605 node_get_pos (GSequenceNode *node)
1606 {
1607   int n_smaller = 0;
1608
1609   if (node->left)
1610     n_smaller = node->left->n_nodes;
1611
1612   while (node)
1613     {
1614       if (NODE_RIGHT_CHILD (node))
1615         n_smaller += N_NODES (node->parent->left) + 1;
1616
1617       node = node->parent;
1618     }
1619
1620   return n_smaller;
1621 }
1622
1623 static GSequenceNode *
1624 node_get_by_pos (GSequenceNode *node,
1625                  gint           pos)
1626 {
1627   int i;
1628
1629   node = find_root (node);
1630
1631   while ((i = N_NODES (node->left)) != pos)
1632     {
1633       if (i < pos)
1634         {
1635           node = node->right;
1636           pos -= (i + 1);
1637         }
1638       else
1639         {
1640           node = node->left;
1641         }
1642     }
1643
1644   return node;
1645 }
1646
1647 static GSequenceNode *
1648 node_find (GSequenceNode            *haystack,
1649            GSequenceNode            *needle,
1650            GSequenceNode            *end,
1651            GSequenceIterCompareFunc  iter_cmp,
1652            gpointer                  cmp_data)
1653 {
1654   gint c;
1655
1656   haystack = find_root (haystack);
1657
1658   do
1659     {
1660       /* iter_cmp can't be passed the end node, since the function may
1661        * be user-supplied
1662        */
1663       if (haystack == end)
1664         c = 1;
1665       else
1666         c = iter_cmp (haystack, needle, cmp_data);
1667
1668       if (c == 0)
1669         break;
1670
1671       if (c > 0)
1672         haystack = haystack->left;
1673       else
1674         haystack = haystack->right;
1675     }
1676   while (haystack != NULL);
1677
1678   return haystack;
1679 }
1680
1681 static GSequenceNode *
1682 node_find_closest (GSequenceNode            *haystack,
1683                    GSequenceNode            *needle,
1684                    GSequenceNode            *end,
1685                    GSequenceIterCompareFunc  iter_cmp,
1686                    gpointer                  cmp_data)
1687 {
1688   GSequenceNode *best;
1689   gint c;
1690
1691   haystack = find_root (haystack);
1692
1693   do
1694     {
1695       best = haystack;
1696
1697       /* iter_cmp can't be passed the end node, since the function may
1698        * be user-supplied
1699        */
1700       if (haystack == end)
1701         c = 1;
1702       else
1703         c = iter_cmp (haystack, needle, cmp_data);
1704
1705       /* In the following we don't break even if c == 0. Instead we go on
1706        * searching along the 'bigger' nodes, so that we find the last one
1707        * that is equal to the needle.
1708        */
1709       if (c > 0)
1710         haystack = haystack->left;
1711       else
1712         haystack = haystack->right;
1713     }
1714   while (haystack != NULL);
1715
1716   /* If the best node is smaller or equal to the data, then move one step
1717    * to the right to make sure the best one is strictly bigger than the data
1718    */
1719   if (best != end && c <= 0)
1720     best = node_get_next (best);
1721
1722   return best;
1723 }
1724
1725 static gint
1726 node_get_length    (GSequenceNode            *node)
1727 {
1728   node = find_root (node);
1729
1730   return node->n_nodes;
1731 }
1732
1733 static void
1734 real_node_free (GSequenceNode *node,
1735                 GSequence     *seq)
1736 {
1737   if (node)
1738     {
1739       real_node_free (node->left, seq);
1740       real_node_free (node->right, seq);
1741
1742       if (seq && seq->data_destroy_notify && node != seq->end_node)
1743         seq->data_destroy_notify (node->data);
1744
1745       g_slice_free (GSequenceNode, node);
1746     }
1747 }
1748
1749 static void
1750 node_free (GSequenceNode *node,
1751            GSequence *seq)
1752 {
1753   node = find_root (node);
1754
1755   real_node_free (node, seq);
1756 }
1757
1758 static void
1759 node_update_fields (GSequenceNode *node)
1760 {
1761   int n_nodes = 1;
1762
1763   n_nodes += N_NODES (node->left);
1764   n_nodes += N_NODES (node->right);
1765
1766   node->n_nodes = n_nodes;
1767 }
1768
1769 static void
1770 node_rotate (GSequenceNode *node)
1771 {
1772   GSequenceNode *tmp, *old;
1773
1774   g_assert (node->parent);
1775   g_assert (node->parent != node);
1776
1777   if (NODE_LEFT_CHILD (node))
1778     {
1779       /* rotate right */
1780       tmp = node->right;
1781
1782       node->right = node->parent;
1783       node->parent = node->parent->parent;
1784       if (node->parent)
1785         {
1786           if (node->parent->left == node->right)
1787             node->parent->left = node;
1788           else
1789             node->parent->right = node;
1790         }
1791
1792       g_assert (node->right);
1793
1794       node->right->parent = node;
1795       node->right->left = tmp;
1796
1797       if (node->right->left)
1798         node->right->left->parent = node->right;
1799
1800       old = node->right;
1801     }
1802   else
1803     {
1804       /* rotate left */
1805       tmp = node->left;
1806
1807       node->left = node->parent;
1808       node->parent = node->parent->parent;
1809       if (node->parent)
1810         {
1811           if (node->parent->right == node->left)
1812             node->parent->right = node;
1813           else
1814             node->parent->left = node;
1815         }
1816
1817       g_assert (node->left);
1818
1819       node->left->parent = node;
1820       node->left->right = tmp;
1821
1822       if (node->left->right)
1823         node->left->right->parent = node->left;
1824
1825       old = node->left;
1826     }
1827
1828   node_update_fields (old);
1829   node_update_fields (node);
1830 }
1831
1832 static void
1833 node_update_fields_deep (GSequenceNode *node)
1834 {
1835   if (node)
1836     {
1837       node_update_fields (node);
1838
1839       node_update_fields_deep (node->parent);
1840     }
1841 }
1842
1843 static void
1844 rotate_down (GSequenceNode *node,
1845              guint          priority)
1846 {
1847   guint left, right;
1848
1849   left = node->left ? get_priority (node->left)  : 0;
1850   right = node->right ? get_priority (node->right) : 0;
1851
1852   while (priority < left || priority < right)
1853     {
1854       if (left > right)
1855         node_rotate (node->left);
1856       else
1857         node_rotate (node->right);
1858
1859       left = node->left ? get_priority (node->left)  : 0;
1860       right = node->right ? get_priority (node->right) : 0;
1861     }
1862 }
1863
1864 static void
1865 node_cut (GSequenceNode *node)
1866 {
1867   while (node->parent)
1868     node_rotate (node);
1869
1870   if (node->left)
1871     node->left->parent = NULL;
1872
1873   node->left = NULL;
1874   node_update_fields (node);
1875
1876   rotate_down (node, get_priority (node));
1877 }
1878
1879 static void
1880 node_join (GSequenceNode *left,
1881            GSequenceNode *right)
1882 {
1883   GSequenceNode *fake = node_new (NULL);
1884
1885   fake->left = find_root (left);
1886   fake->right = find_root (right);
1887   fake->left->parent = fake;
1888   fake->right->parent = fake;
1889
1890   node_update_fields (fake);
1891
1892   node_unlink (fake);
1893
1894   node_free (fake, NULL);
1895 }
1896
1897 static void
1898 node_insert_before (GSequenceNode *node,
1899                     GSequenceNode *new)
1900 {
1901   new->left = node->left;
1902   if (new->left)
1903     new->left->parent = new;
1904
1905   new->parent = node;
1906   node->left = new;
1907
1908   node_update_fields_deep (new);
1909
1910   while (new->parent && get_priority (new) > get_priority (new->parent))
1911     node_rotate (new);
1912
1913   rotate_down (new, get_priority (new));
1914 }
1915
1916 static void
1917 node_unlink (GSequenceNode *node)
1918 {
1919   rotate_down (node, 0);
1920
1921   if (NODE_RIGHT_CHILD (node))
1922     node->parent->right = NULL;
1923   else if (NODE_LEFT_CHILD (node))
1924     node->parent->left = NULL;
1925
1926   if (node->parent)
1927     node_update_fields_deep (node->parent);
1928
1929   node->parent = NULL;
1930 }
1931
1932 static void
1933 node_insert_sorted (GSequenceNode            *node,
1934                     GSequenceNode            *new,
1935                     GSequenceNode            *end,
1936                     GSequenceIterCompareFunc  iter_cmp,
1937                     gpointer                  cmp_data)
1938 {
1939   GSequenceNode *closest;
1940
1941   closest = node_find_closest (node, new, end, iter_cmp, cmp_data);
1942
1943   node_unlink (new);
1944
1945   node_insert_before (closest, new);
1946 }