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

   1 /* gtktreemodelsort.c
   2  * Copyright (C) 2000,2001  Red Hat, Inc.,  Jonathan Blandford <jrb@redhat.com>
   3  * Copyright (C) 2001,2002  Kristian Rietveld <kris@gtk.org>
   4  *
   5  * This library is free software; you can redistribute it and/or
   6  * modify it under the terms of the GNU Library 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  * Library General Public License for more details.
  14  *
  15  * You should have received a copy of the GNU Library 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 /* NOTE: There is a potential for confusion in this code as to whether an iter,
  22  * path or value refers to the GtkTreeModelSort model, or the child model being
  23  * sorted.  As a convention, variables referencing the child model will have an
  24  * s_ prefix before them (ie. s_iter, s_value, s_path);
  25  */
  26
  27 /* ITER FORMAT:
  28  *
  29  * iter->stamp = tree_model_sort->stamp
  30  * iter->user_data = SortLevel
  31  * iter->user_data2 = SortElt
  32  */
  33
  34 /* WARNING: this code is dangerous, can cause sleepless nights,
  35  * can cause your dog to die among other bad things
  36  *
  37  * we warned you and we're not liable for any head injuries.
  38  */
  39
  40 #include <string.h>
  41
  42 #include "gtktreemodelsort.h"
  43 #include "gtktreesortable.h"
  44 #include "gtktreestore.h"
  45 #include "gtktreedatalist.h"
  46 #include "gtkintl.h"
  47
  48 typedef struct _SortElt SortElt;
  49 typedef struct _SortLevel SortLevel;
  50 typedef struct _SortData SortData;
  51 typedef struct _SortTuple SortTuple;
  52
  53 struct _SortElt
  54 {
  55   GtkTreeIter  iter;
  56   SortLevel   *children;
  57   gint         offset;
  58   gint         ref_count;
  59   gint         zero_ref_count;
  60 };
  61
  62 struct _SortLevel
  63 {
  64   GArray    *array;
  65   gint       ref_count;
  66   SortElt   *parent_elt;
  67   SortLevel *parent_level;
  68 };
  69
  70 struct _SortData
  71 {
  72   GtkTreeModelSort *tree_model_sort;
  73   GtkTreePath *parent_path;
  74   gint parent_path_depth;
  75   gint *parent_path_indices;
  76   GtkTreeIterCompareFunc sort_func;
  77   gpointer sort_data;
  78 };
  79
  80 struct _SortTuple
  81 {
  82   SortElt   *elt;
  83   gint       offset;
  84 };
  85
  86 /* Properties */
  87 enum {
  88   PROP_0,
  89   /* Construct args */
  90   PROP_MODEL
  91 };
  92
  93
  94
  95 #define GTK_TREE_MODEL_SORT_CACHE_CHILD_ITERS(tree_model_sort) \
  96         (((GtkTreeModelSort *)tree_model_sort)->child_flags&GTK_TREE_MODEL_ITERS_PERSIST)
  97 #define SORT_ELT(sort_elt) ((SortElt *)sort_elt)
  98 #define SORT_LEVEL(sort_level) ((SortLevel *)sort_level)
  99
 100 #define GET_CHILD_ITER(tree_model_sort,child_iter,sort_iter) gtk_tree_model_sort_convert_iter_to_child_iter(GTK_TREE_MODEL_SORT (tree_model_sort), child_iter, sort_iter);
 101
 102 #define NO_SORT_FUNC ((GtkTreeIterCompareFunc) 0x1)
 103
 104 #define VALID_ITER(iter, tree_model_sort) (iter != NULL && iter->user_data != NULL && iter->user_data2 != NULL && tree_model_sort->stamp == iter->stamp)
 105
 106 /* general (object/interface init, etc) */
 107 static void gtk_tree_model_sort_init                  (GtkTreeModelSort      *tree_model_sort);
 108 static void gtk_tree_model_sort_class_init            (GtkTreeModelSortClass *tree_model_sort_class);
 109 static void gtk_tree_model_sort_tree_model_init       (GtkTreeModelIface     *iface);
 110 static void gtk_tree_model_sort_tree_sortable_init    (GtkTreeSortableIface  *iface);
 111 static void gtk_tree_model_sort_finalize              (GObject               *object);
 112 static void gtk_tree_model_sort_set_property          (GObject               *object,
 113                                                        guint                  prop_id,
 114                                                        const GValue          *value,
 115                                                        GParamSpec            *pspec);
 116 static void gtk_tree_model_sort_get_property          (GObject               *object,
 117                                                        guint                  prop_id,
 118                                                        GValue                *value,
 119                                                        GParamSpec            *pspec);
 120
 121 /* our signal handlers */
 122 static void gtk_tree_model_sort_row_changed           (GtkTreeModel          *model,
 123                                                        GtkTreePath           *start_path,
 124                                                        GtkTreeIter           *start_iter,
 125                                                        gpointer               data);
 126 static void gtk_tree_model_sort_row_inserted          (GtkTreeModel          *model,
 127                                                        GtkTreePath           *path,
 128                                                        GtkTreeIter           *iter,
 129                                                        gpointer               data);
 130 static void gtk_tree_model_sort_row_has_child_toggled (GtkTreeModel          *model,
 131                                                        GtkTreePath           *path,
 132                                                        GtkTreeIter           *iter,
 133                                                        gpointer               data);
 134 static void gtk_tree_model_sort_row_deleted           (GtkTreeModel          *model,
 135                                                        GtkTreePath           *path,
 136                                                        gpointer               data);
 137 static void gtk_tree_model_sort_rows_reordered        (GtkTreeModel          *s_model,
 138                                                        GtkTreePath           *s_path,
 139                                                        GtkTreeIter           *s_iter,
 140                                                        gint                  *new_order,
 141                                                        gpointer               data);
 142
 143 /* TreeModel interface */
 144 static GtkTreeModelFlags gtk_tree_model_sort_get_flags     (GtkTreeModel          *tree_model);
 145 static gint         gtk_tree_model_sort_get_n_columns      (GtkTreeModel          *tree_model);
 146 static GType        gtk_tree_model_sort_get_column_type    (GtkTreeModel          *tree_model,
 147                                                             gint                   index);
 148 static gboolean     gtk_tree_model_sort_get_iter           (GtkTreeModel          *tree_model,
 149                                                             GtkTreeIter           *iter,
 150                                                             GtkTreePath           *path);
 151 static GtkTreePath *gtk_tree_model_sort_get_path           (GtkTreeModel          *tree_model,
 152                                                             GtkTreeIter           *iter);
 153 static void         gtk_tree_model_sort_get_value          (GtkTreeModel          *tree_model,
 154                                                             GtkTreeIter           *iter,
 155                                                             gint                   column,
 156                                                             GValue                *value);
 157 static gboolean     gtk_tree_model_sort_iter_next          (GtkTreeModel          *tree_model,
 158                                                             GtkTreeIter           *iter);
 159 static gboolean     gtk_tree_model_sort_iter_children      (GtkTreeModel          *tree_model,
 160                                                             GtkTreeIter           *iter,
 161                                                             GtkTreeIter           *parent);
 162 static gboolean     gtk_tree_model_sort_iter_has_child     (GtkTreeModel          *tree_model,
 163                                                             GtkTreeIter           *iter);
 164 static gint         gtk_tree_model_sort_iter_n_children    (GtkTreeModel          *tree_model,
 165                                                             GtkTreeIter           *iter);
 166 static gboolean     gtk_tree_model_sort_iter_nth_child     (GtkTreeModel          *tree_model,
 167                                                             GtkTreeIter           *iter,
 168                                                             GtkTreeIter           *parent,
 169                                                             gint                   n);
 170 static gboolean     gtk_tree_model_sort_iter_parent        (GtkTreeModel          *tree_model,
 171                                                             GtkTreeIter           *iter,
 172                                                             GtkTreeIter           *child);
 173 static void         gtk_tree_model_sort_ref_node           (GtkTreeModel          *tree_model,
 174                                                             GtkTreeIter           *iter);
 175 static void         gtk_tree_model_sort_real_unref_node    (GtkTreeModel          *tree_model,
 176                                                             GtkTreeIter           *iter,
 177                                                             gboolean               propagate_unref);
 178 static void         gtk_tree_model_sort_unref_node         (GtkTreeModel          *tree_model,
 179                                                             GtkTreeIter           *iter);
 180
 181 /* TreeSortable interface */
 182 static gboolean     gtk_tree_model_sort_get_sort_column_id    (GtkTreeSortable        *sortable,
 183                                                                gint                   *sort_column_id,
 184                                                                GtkSortType            *order);
 185 static void         gtk_tree_model_sort_set_sort_column_id    (GtkTreeSortable        *sortable,
 186                                                                gint                    sort_column_id,
 187                                                                GtkSortType        order);
 188 static void         gtk_tree_model_sort_set_sort_func         (GtkTreeSortable        *sortable,
 189                                                                gint                    sort_column_id,
 190                                                                GtkTreeIterCompareFunc  func,
 191                                                                gpointer                data,
 192                                                                GtkDestroyNotify        destroy);
 193 static void         gtk_tree_model_sort_set_default_sort_func (GtkTreeSortable        *sortable,
 194                                                                GtkTreeIterCompareFunc  func,
 195                                                                gpointer                data,
 196                                                                GtkDestroyNotify        destroy);
 197 static gboolean     gtk_tree_model_sort_has_default_sort_func (GtkTreeSortable     *sortable);
 198
 199 /* Private functions (sort funcs, level handling and other utils) */
 200 static void         gtk_tree_model_sort_build_level       (GtkTreeModelSort *tree_model_sort,
 201                                                            SortLevel        *parent_level,
 202                                                            SortElt          *parent_elt);
 203 static void         gtk_tree_model_sort_free_level        (GtkTreeModelSort *tree_model_sort,
 204                                                            SortLevel        *sort_level);
 205 static void         gtk_tree_model_sort_increment_stamp   (GtkTreeModelSort *tree_model_sort);
 206 static void         gtk_tree_model_sort_sort_level        (GtkTreeModelSort *tree_model_sort,
 207                                                            SortLevel        *level,
 208                                                            gboolean          recurse,
 209                                                            gboolean          emit_reordered);
 210 static void         gtk_tree_model_sort_sort              (GtkTreeModelSort *tree_model_sort);
 211 static gint         gtk_tree_model_sort_level_find_insert (GtkTreeModelSort *tree_model_sort,
 212                                                            SortLevel        *level,
 213                                                            GtkTreeIter      *iter,
 214                                                            gint             skip_index);
 215 static gboolean     gtk_tree_model_sort_insert_value      (GtkTreeModelSort *tree_model_sort,
 216                                                            SortLevel        *level,
 217                                                            GtkTreePath      *s_path,
 218                                                            GtkTreeIter      *s_iter);
 219 static GtkTreePath *gtk_tree_model_sort_elt_get_path      (SortLevel        *level,
 220                                                            SortElt          *elt);
 221 static void         gtk_tree_model_sort_set_model         (GtkTreeModelSort *tree_model_sort,
 222                                                            GtkTreeModel     *child_model);
 223 static GtkTreePath *gtk_real_tree_model_sort_convert_child_path_to_path (GtkTreeModelSort *tree_model_sort,
 224                                                                          GtkTreePath      *child_path,
 225                                                                          gboolean          build_levels);
 226
 227 static GObjectClass *parent_class = NULL;
 228
 229 GType
 230 gtk_tree_model_sort_get_type (void)
 231 {
 232   static GType tree_model_sort_type = 0;
 233
 234   if (!tree_model_sort_type)
 235     {
 236       static const GTypeInfo tree_model_sort_info =
 237       {
 238         sizeof (GtkTreeModelSortClass),
 239         NULL,           /* base_init */
 240         NULL,           /* base_finalize */
 241         (GClassInitFunc) gtk_tree_model_sort_class_init,
 242         NULL,           /* class_finalize */
 243         NULL,           /* class_data */
 244         sizeof (GtkTreeModelSort),
 245         0,              /* n_preallocs */
 246         (GInstanceInitFunc) gtk_tree_model_sort_init
 247       };
 248
 249       static const GInterfaceInfo tree_model_info =
 250       {
 251         (GInterfaceInitFunc) gtk_tree_model_sort_tree_model_init,
 252         NULL,
 253         NULL
 254       };
 255
 256       static const GInterfaceInfo sortable_info =
 257       {
 258         (GInterfaceInitFunc) gtk_tree_model_sort_tree_sortable_init,
 259         NULL,
 260         NULL
 261       };
 262
 263       tree_model_sort_type =
 264         g_type_register_static (G_TYPE_OBJECT, "GtkTreeModelSort",
 265                                 &tree_model_sort_info, 0);
 266
 267       g_type_add_interface_static (tree_model_sort_type,
 268                                    GTK_TYPE_TREE_MODEL,
 269                                    &tree_model_info);
 270
 271       g_type_add_interface_static (tree_model_sort_type,
 272                                    GTK_TYPE_TREE_SORTABLE,
 273                                    &sortable_info);
 274     }
 275
 276   return tree_model_sort_type;
 277 }
 278
 279 static void
 280 gtk_tree_model_sort_init (GtkTreeModelSort *tree_model_sort)
 281 {
 282   tree_model_sort->sort_column_id = GTK_TREE_SORTABLE_DEFAULT_SORT_COLUMN_ID;
 283   tree_model_sort->stamp = 0;
 284   tree_model_sort->zero_ref_count = 0;
 285   tree_model_sort->root = NULL;
 286   tree_model_sort->sort_list = NULL;
 287 }
 288
 289 static void
 290 gtk_tree_model_sort_class_init (GtkTreeModelSortClass *class)
 291 {
 292   GObjectClass *object_class;
 293
 294   object_class = (GObjectClass *) class;
 295   parent_class = g_type_class_peek_parent (class);
 296
 297   object_class->set_property = gtk_tree_model_sort_set_property;
 298   object_class->get_property = gtk_tree_model_sort_get_property;
 299
 300   object_class->finalize = gtk_tree_model_sort_finalize;
 301
 302   /* Properties */
 303   g_object_class_install_property (object_class,
 304                                    PROP_MODEL,
 305                                    g_param_spec_object ("model",
 306                                                         _("TreeModelSort Model"),
 307                                                         _("The model for the TreeModelSort to sort"),
 308                                                         GTK_TYPE_TREE_MODEL,
 309                                                         G_PARAM_READWRITE | G_PARAM_CONSTRUCT_ONLY));
 310 }
 311
 312 static void
 313 gtk_tree_model_sort_tree_model_init (GtkTreeModelIface *iface)
 314 {
 315   iface->get_flags = gtk_tree_model_sort_get_flags;
 316   iface->get_n_columns = gtk_tree_model_sort_get_n_columns;
 317   iface->get_column_type = gtk_tree_model_sort_get_column_type;
 318   iface->get_iter = gtk_tree_model_sort_get_iter;
 319   iface->get_path = gtk_tree_model_sort_get_path;
 320   iface->get_value = gtk_tree_model_sort_get_value;
 321   iface->iter_next = gtk_tree_model_sort_iter_next;
 322   iface->iter_children = gtk_tree_model_sort_iter_children;
 323   iface->iter_has_child = gtk_tree_model_sort_iter_has_child;
 324   iface->iter_n_children = gtk_tree_model_sort_iter_n_children;
 325   iface->iter_nth_child = gtk_tree_model_sort_iter_nth_child;
 326   iface->iter_parent = gtk_tree_model_sort_iter_parent;
 327   iface->ref_node = gtk_tree_model_sort_ref_node;
 328   iface->unref_node = gtk_tree_model_sort_unref_node;
 329 }
 330
 331 static void
 332 gtk_tree_model_sort_tree_sortable_init (GtkTreeSortableIface *iface)
 333 {
 334   iface->get_sort_column_id = gtk_tree_model_sort_get_sort_column_id;
 335   iface->set_sort_column_id = gtk_tree_model_sort_set_sort_column_id;
 336   iface->set_sort_func = gtk_tree_model_sort_set_sort_func;
 337   iface->set_default_sort_func = gtk_tree_model_sort_set_default_sort_func;
 338   iface->has_default_sort_func = gtk_tree_model_sort_has_default_sort_func;
 339 }
 340
 341 /**
 342  * gtk_tree_model_sort_new_with_model:
 343  * @child_model: A #GtkTreeModel
 344  *
 345  * Creates a new #GtkTreeModel, with @child_model as the child_model.
 346  *
 347  * Return value: A new #GtkTreeModel.
 348  */
 349 GtkTreeModel *
 350 gtk_tree_model_sort_new_with_model (GtkTreeModel      *child_model)
 351 {
 352   GtkTreeModel *retval;
 353
 354   g_return_val_if_fail (GTK_IS_TREE_MODEL (child_model), NULL);
 355
 356   retval = g_object_new (gtk_tree_model_sort_get_type (), NULL);
 357
 358   gtk_tree_model_sort_set_model (GTK_TREE_MODEL_SORT (retval), child_model);
 359
 360   return retval;
 361 }
 362
 363 /* GObject callbacks */
 364 static void
 365 gtk_tree_model_sort_finalize (GObject *object)
 366 {
 367   GtkTreeModelSort *tree_model_sort = (GtkTreeModelSort *) object;
 368
 369   gtk_tree_model_sort_set_model (tree_model_sort, NULL);
 370
 371   if (tree_model_sort->root)
 372     gtk_tree_model_sort_free_level (tree_model_sort, tree_model_sort->root);
 373
 374   if (tree_model_sort->sort_list)
 375     {
 376       _gtk_tree_data_list_header_free (tree_model_sort->sort_list);
 377       tree_model_sort->sort_list = NULL;
 378     }
 379
 380   /* must chain up */
 381   parent_class->finalize (object);
 382 }
 383
 384 static void
 385 gtk_tree_model_sort_set_property (GObject      *object,
 386                                   guint         prop_id,
 387                                   const GValue *value,
 388                                   GParamSpec   *pspec)
 389 {
 390   GtkTreeModelSort *tree_model_sort = GTK_TREE_MODEL_SORT (object);
 391
 392   switch (prop_id)
 393     {
 394     case PROP_MODEL:
 395       gtk_tree_model_sort_set_model (tree_model_sort, g_value_get_object (value));
 396       break;
 397     default:
 398       G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
 399       break;
 400     }
 401 }
 402
 403 static void
 404 gtk_tree_model_sort_get_property (GObject    *object,
 405                                   guint       prop_id,
 406                                   GValue     *value,
 407                                   GParamSpec *pspec)
 408 {
 409   GtkTreeModelSort *tree_model_sort = GTK_TREE_MODEL_SORT (object);
 410
 411   switch (prop_id)
 412     {
 413     case PROP_MODEL:
 414       g_value_set_object (value, gtk_tree_model_sort_get_model(tree_model_sort));
 415       break;
 416     default:
 417       G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
 418       break;
 419     }
 420 }
 421
 422 static void
 423 gtk_tree_model_sort_row_changed (GtkTreeModel *s_model,
 424                                  GtkTreePath  *start_s_path,
 425                                  GtkTreeIter  *start_s_iter,
 426                                  gpointer      data)
 427 {
 428   GtkTreeModelSort *tree_model_sort = GTK_TREE_MODEL_SORT (data);
 429   GtkTreePath *path = NULL;
 430   GtkTreeIter iter;
 431   GtkTreeIter tmpiter;
 432
 433   SortElt tmp;
 434   SortElt *elt;
 435   SortLevel *level;
 436
 437   gboolean free_s_path = FALSE;
 438
 439   gint index = 0, old_index, i;
 440
 441   g_return_if_fail (start_s_path != NULL || start_s_iter != NULL);
 442
 443   if (!start_s_path)
 444     {
 445       free_s_path = TRUE;
 446       start_s_path = gtk_tree_model_get_path (s_model, start_s_iter);
 447     }
 448
 449   path = gtk_real_tree_model_sort_convert_child_path_to_path (tree_model_sort,
 450                                                               start_s_path,
 451                                                               FALSE);
 452   if (!path)
 453     {
 454       if (free_s_path)
 455         gtk_tree_path_free (start_s_path);
 456       return;
 457     }
 458
 459   gtk_tree_model_get_iter (GTK_TREE_MODEL (data), &iter, path);
 460
 461   level = iter.user_data;
 462   elt = iter.user_data2;
 463
 464   if (level->array->len < 2 ||
 465       (tree_model_sort->sort_column_id == GTK_TREE_SORTABLE_DEFAULT_SORT_COLUMN_ID &&
 466        tree_model_sort->default_sort_func == NO_SORT_FUNC))
 467     {
 468       if (free_s_path)
 469         gtk_tree_path_free (start_s_path);
 470
 471       gtk_tree_model_row_changed (GTK_TREE_MODEL (data), path, &iter);
 472
 473       gtk_tree_path_free (path);
 474
 475       return;
 476     }
 477
 478   if (!GTK_TREE_MODEL_SORT_CACHE_CHILD_ITERS (tree_model_sort))
 479     {
 480       gtk_tree_model_get_iter (tree_model_sort->child_model,
 481                                &tmpiter, start_s_path);
 482     }
 483
 484   old_index = elt - SORT_ELT (level->array->data);
 485
 486   memcpy (&tmp, elt, sizeof (SortElt));
 487
 488   if (GTK_TREE_MODEL_SORT_CACHE_CHILD_ITERS (tree_model_sort))
 489     index = gtk_tree_model_sort_level_find_insert (tree_model_sort,
 490                                                    level,
 491                                                    &tmp.iter,
 492                                                    old_index);
 493   else
 494     index = gtk_tree_model_sort_level_find_insert (tree_model_sort,
 495                                                    level,
 496                                                    &tmpiter,
 497                                                    old_index);
 498
 499   if (index < old_index)
 500     {
 501       g_memmove (level->array->data + ((index + 1)*sizeof (SortElt)),
 502                  level->array->data + ((index)*sizeof (SortElt)),
 503                  (old_index - index)* sizeof(SortElt));
 504     }
 505   else if (index > old_index)
 506     {
 507       g_memmove (level->array->data + ((old_index)*sizeof (SortElt)),
 508                  level->array->data + ((old_index + 1)*sizeof (SortElt)),
 509                  (index - old_index)* sizeof(SortElt));
 510     }
 511   memcpy (level->array->data + ((index)*sizeof (SortElt)),
 512           &tmp, sizeof (SortElt));
 513
 514   for (i = 0; i < level->array->len; i++)
 515     if (g_array_index (level->array, SortElt, i).children)
 516       g_array_index (level->array, SortElt, i).children->parent_elt = &g_array_index (level->array, SortElt, i);
 517
 518   gtk_tree_path_up (path);
 519   gtk_tree_path_append_index (path, index);
 520
 521   gtk_tree_model_sort_increment_stamp (tree_model_sort);
 522
 523   /* if the item moved, then emit rows_reordered */
 524   if (old_index != index)
 525     {
 526       gint *new_order;
 527       gint j;
 528
 529       GtkTreePath *tmppath;
 530
 531       new_order = g_new (gint, level->array->len);
 532
 533       for (j = 0; j < level->array->len; j++)
 534         {
 535           if (index > old_index)
 536             {
 537               if (j == index)
 538                 new_order[j] = old_index;
 539               else if (j >= old_index && j < index)
 540                 new_order[j] = j + 1;
 541               else
 542                 new_order[j] = j;
 543             }
 544           else if (index < old_index)
 545             {
 546               if (j == index)
 547                 new_order[j] = old_index;
 548               else if (j > index && j <= old_index)
 549                 new_order[j] = j - 1;
 550               else
 551                 new_order[j] = j;
 552             }
 553           /* else? shouldn't really happen */
 554         }
 555
 556       if (level->parent_elt)
 557         {
 558           iter.stamp = tree_model_sort->stamp;
 559           iter.user_data = level->parent_level;
 560           iter.user_data2 = level->parent_elt;
 561
 562           tmppath = gtk_tree_model_get_path (GTK_TREE_MODEL (tree_model_sort), &iter);
 563
 564           gtk_tree_model_rows_reordered (GTK_TREE_MODEL (tree_model_sort),
 565                                          tmppath, &iter, new_order);
 566         }
 567       else
 568         {
 569           /* toplevel */
 570           tmppath = gtk_tree_path_new ();
 571
 572           gtk_tree_model_rows_reordered (GTK_TREE_MODEL (tree_model_sort), tmppath,
 573                                          NULL, new_order);
 574         }
 575
 576       gtk_tree_path_free (tmppath);
 577       g_free (new_order);
 578     }
 579
 580   /* emit row_changed signal (at new location) */
 581   gtk_tree_model_get_iter (GTK_TREE_MODEL (data), &iter, path);
 582   gtk_tree_model_row_changed (GTK_TREE_MODEL (data), path, &iter);
 583
 584   gtk_tree_path_free (path);
 585   if (free_s_path)
 586     gtk_tree_path_free (start_s_path);
 587 }
 588
 589 static void
 590 gtk_tree_model_sort_row_inserted (GtkTreeModel          *s_model,
 591                                   GtkTreePath           *s_path,
 592                                   GtkTreeIter           *s_iter,
 593                                   gpointer               data)
 594 {
 595   GtkTreeModelSort *tree_model_sort = GTK_TREE_MODEL_SORT (data);
 596   GtkTreePath *path;
 597   GtkTreeIter iter;
 598   GtkTreeIter real_s_iter;
 599
 600   gint i = 0;
 601
 602   gboolean free_s_path = FALSE;
 603
 604   SortElt *elt;
 605   SortLevel *level;
 606   SortLevel *parent_level = NULL;
 607
 608   parent_level = level = SORT_LEVEL (tree_model_sort->root);
 609
 610   g_return_if_fail (s_path != NULL || s_iter != NULL);
 611
 612   if (!s_path)
 613     {
 614       s_path = gtk_tree_model_get_path (s_model, s_iter);
 615       free_s_path = TRUE;
 616     }
 617
 618   if (!s_iter)
 619     gtk_tree_model_get_iter (s_model, &real_s_iter, s_path);
 620   else
 621     real_s_iter = *s_iter;
 622
 623   if (!tree_model_sort->root)
 624     {
 625       gtk_tree_model_sort_build_level (tree_model_sort, NULL, NULL);
 626
 627       /* the build level already put the inserted iter in the level,
 628          so no need to handle this signal anymore */
 629
 630       goto done_and_submit;
 631     }
 632
 633   /* find the parent level */
 634   while (i < gtk_tree_path_get_depth (s_path) - 1)
 635     {
 636       gint j;
 637
 638       if (!level)
 639         {
 640           /* level not yet build, we won't cover this signal */
 641           goto done;
 642         }
 643
 644       if (level->array->len < gtk_tree_path_get_indices (s_path)[i])
 645         {
 646           g_warning ("A node was inserted with a parent that's not in the tree.\n"
 647                      "This possibly means that a GtkTreeModel inserted a child node\n"
 648                      "before the parent was inserted.");
 649           goto done;
 650         }
 651
 652       elt = NULL;
 653       for (j = 0; j < level->array->len; j++)
 654         if (g_array_index (level->array, SortElt, j).offset == gtk_tree_path_get_indices (s_path)[i])
 655           {
 656             elt = &g_array_index (level->array, SortElt, j);
 657             break;
 658           }
 659
 660       g_return_if_fail (elt != NULL);
 661
 662       if (!elt->children)
 663         {
 664           GtkTreePath *tmppath;
 665           GtkTreeIter  tmpiter;
 666
 667           tmpiter.stamp = tree_model_sort->stamp;
 668           tmpiter.user_data = level;
 669           tmpiter.user_data2 = elt;
 670
 671           tmppath = gtk_tree_model_get_path (GTK_TREE_MODEL (data), &tmpiter);
 672           if (tmppath)
 673             {
 674               gtk_tree_model_row_has_child_toggled (GTK_TREE_MODEL (data),
 675                                                     tmppath,
 676                                                     &tmpiter);
 677               gtk_tree_path_free (tmppath);
 678             }
 679
 680           /* not covering this signal */
 681           goto done;
 682         }
 683
 684       level = elt->children;
 685       parent_level = level;
 686       i++;
 687     }
 688
 689   if (!parent_level)
 690     goto done;
 691
 692   if (!gtk_tree_model_sort_insert_value (tree_model_sort,
 693                                          parent_level,
 694                                          s_path,
 695                                          &real_s_iter))
 696     goto done;
 697
 698  done_and_submit:
 699   path = gtk_real_tree_model_sort_convert_child_path_to_path (tree_model_sort,
 700                                                               s_path,
 701                                                               FALSE);
 702
 703   if (!path)
 704     return;
 705
 706   gtk_tree_model_sort_increment_stamp (tree_model_sort);
 707
 708   gtk_tree_model_get_iter (GTK_TREE_MODEL (data), &iter, path);
 709   gtk_tree_model_row_inserted (GTK_TREE_MODEL (data), path, &iter);
 710   gtk_tree_path_free (path);
 711
 712  done:
 713   if (free_s_path)
 714     gtk_tree_path_free (s_path);
 715
 716   return;
 717 }
 718
 719 static void
 720 gtk_tree_model_sort_row_has_child_toggled (GtkTreeModel *s_model,
 721                                            GtkTreePath  *s_path,
 722                                            GtkTreeIter  *s_iter,
 723                                            gpointer      data)
 724 {
 725   GtkTreeModelSort *tree_model_sort = GTK_TREE_MODEL_SORT (data);
 726   GtkTreePath *path;
 727   GtkTreeIter iter;
 728
 729   g_return_if_fail (s_path != NULL && s_iter != NULL);
 730
 731   path = gtk_real_tree_model_sort_convert_child_path_to_path (tree_model_sort, s_path, FALSE);
 732   if (path == NULL)
 733     return;
 734
 735   gtk_tree_model_get_iter (GTK_TREE_MODEL (data), &iter, path);
 736   gtk_tree_model_row_has_child_toggled (GTK_TREE_MODEL (data), path, &iter);
 737
 738   gtk_tree_path_free (path);
 739 }
 740
 741 /* FIXME: I still have doubts if this works */
 742 static void
 743 gtk_tree_model_sort_row_deleted (GtkTreeModel *s_model,
 744                                  GtkTreePath  *s_path,
 745                                  gpointer      data)
 746 {
 747   GtkTreeModelSort *tree_model_sort = GTK_TREE_MODEL_SORT (data);
 748   GtkTreePath *path = NULL;
 749   SortElt *elt;
 750   SortLevel *level;
 751   GtkTreeIter iter;
 752   gint offset;
 753   gint i;
 754
 755   g_return_if_fail (s_path != NULL);
 756
 757   path = gtk_real_tree_model_sort_convert_child_path_to_path (tree_model_sort, s_path, FALSE);
 758   if (path == NULL)
 759     return;
 760
 761   gtk_tree_model_get_iter (GTK_TREE_MODEL (data), &iter, path);
 762
 763   level = SORT_LEVEL (iter.user_data);
 764   elt = SORT_ELT (iter.user_data2);
 765   offset = elt->offset;
 766
 767   /* we _need_ to emit ::row_deleted before we start unreffing the node
 768    * itself. This is because of the row refs, which start unreffing nodes
 769    * when we emit ::row_deleted
 770    */
 771   gtk_tree_model_row_deleted (GTK_TREE_MODEL (data), path);
 772
 773   gtk_tree_model_get_iter (GTK_TREE_MODEL (data), &iter, path);
 774
 775   while (elt->ref_count > 0)
 776     gtk_tree_model_sort_real_unref_node (GTK_TREE_MODEL (data), &iter, FALSE);
 777
 778   if (level->ref_count == 0 && level != tree_model_sort->root)
 779     {
 780       /* This will prune the level, so I can just emit the signal and not worry
 781        * about cleaning this level up. */
 782       gtk_tree_model_sort_increment_stamp (tree_model_sort);
 783       gtk_tree_path_free (path);
 784       return;
 785     }
 786
 787   gtk_tree_model_sort_increment_stamp (tree_model_sort);
 788
 789   /* Remove the row */
 790   for (i = 0; i < level->array->len; i++)
 791     if (elt->offset == g_array_index (level->array, SortElt, i).offset)
 792       break;
 793
 794   g_array_remove_index (level->array, i);
 795
 796   /* update all offsets */
 797   for (i = 0; i < level->array->len; i++)
 798     {
 799       elt = & (g_array_index (level->array, SortElt, i));
 800       if (elt->offset > offset)
 801         elt->offset--;
 802       if (elt->children)
 803         elt->children->parent_elt = elt;
 804     }
 805
 806   gtk_tree_path_free (path);
 807 }
 808
 809 static void
 810 gtk_tree_model_sort_rows_reordered (GtkTreeModel *s_model,
 811                                     GtkTreePath  *s_path,
 812                                     GtkTreeIter  *s_iter,
 813                                     gint         *new_order,
 814                                     gpointer      data)
 815 {
 816   SortElt *elt;
 817   SortLevel *level;
 818   GtkTreeIter iter;
 819   gint *tmp_array;
 820   int i, j;
 821   GtkTreePath *path;
 822   GtkTreeModelSort *tree_model_sort = GTK_TREE_MODEL_SORT (data);
 823
 824   g_return_if_fail (new_order != NULL);
 825
 826   if (s_path == NULL || gtk_tree_path_get_indices (s_path) == NULL)
 827     {
 828       if (tree_model_sort->root == NULL)
 829         return;
 830       path = gtk_tree_path_new ();
 831       level = SORT_LEVEL (tree_model_sort->root);
 832     }
 833   else
 834     {
 835       path = gtk_real_tree_model_sort_convert_child_path_to_path (tree_model_sort, s_path, FALSE);
 836       if (path == NULL)
 837         return;
 838       gtk_tree_model_get_iter (GTK_TREE_MODEL (data), &iter, path);
 839
 840       level = SORT_LEVEL (iter.user_data);
 841       elt = SORT_ELT (iter.user_data2);
 842
 843       if (!elt->children)
 844         {
 845           gtk_tree_path_free (path);
 846           return;
 847         }
 848
 849       level = elt->children;
 850     }
 851
 852   if (level->array->len < 2)
 853     {
 854       gtk_tree_path_free (path);
 855       return;
 856     }
 857
 858   tmp_array = g_new (int, level->array->len);
 859   for (i = 0; i < level->array->len; i++)
 860     {
 861       for (j = 0; j < level->array->len; j++)
 862         {
 863           if (g_array_index (level->array, SortElt, i).offset == new_order[j])
 864             tmp_array[i] = j;
 865         }
 866     }
 867
 868   for (i = 0; i < level->array->len; i++)
 869     g_array_index (level->array, SortElt, i).offset = tmp_array[i];
 870   g_free (tmp_array);
 871
 872   if (tree_model_sort->sort_column_id == GTK_TREE_SORTABLE_DEFAULT_SORT_COLUMN_ID &&
 873       tree_model_sort->default_sort_func == NO_SORT_FUNC)
 874     {
 875
 876       gtk_tree_model_sort_sort_level (tree_model_sort, level,
 877                                       FALSE, FALSE);
 878       gtk_tree_model_sort_increment_stamp (tree_model_sort);
 879
 880       if (gtk_tree_path_get_depth (path))
 881         {
 882           gtk_tree_model_get_iter (GTK_TREE_MODEL (tree_model_sort),
 883                                    &iter,
 884                                    path);
 885           gtk_tree_model_rows_reordered (GTK_TREE_MODEL (tree_model_sort),
 886                                          path, &iter, new_order);
 887         }
 888       else
 889         {
 890           gtk_tree_model_rows_reordered (GTK_TREE_MODEL (tree_model_sort),
 891                                          path, NULL, new_order);
 892         }
 893     }
 894
 895   gtk_tree_path_free (path);
 896 }
 897
 898 /* Fulfill our model requirements */
 899 static GtkTreeModelFlags
 900 gtk_tree_model_sort_get_flags (GtkTreeModel *tree_model)
 901 {
 902   g_return_val_if_fail (GTK_IS_TREE_MODEL_SORT (tree_model), 0);
 903
 904   return 0;
 905 }
 906
 907 static gint
 908 gtk_tree_model_sort_get_n_columns (GtkTreeModel *tree_model)
 909 {
 910   GtkTreeModelSort *tree_model_sort = (GtkTreeModelSort *) tree_model;
 911
 912   g_return_val_if_fail (GTK_IS_TREE_MODEL_SORT (tree_model), 0);
 913
 914   if (tree_model_sort->child_model == 0)
 915     return 0;
 916
 917   return gtk_tree_model_get_n_columns (tree_model_sort->child_model);
 918 }
 919
 920 static GType
 921 gtk_tree_model_sort_get_column_type (GtkTreeModel *tree_model,
 922                                      gint          index)
 923 {
 924   g_return_val_if_fail (GTK_IS_TREE_MODEL_SORT (tree_model), G_TYPE_INVALID);
 925   g_return_val_if_fail (GTK_TREE_MODEL_SORT (tree_model)->child_model != NULL, G_TYPE_INVALID);
 926
 927   return gtk_tree_model_get_column_type (GTK_TREE_MODEL_SORT (tree_model)->child_model, index);
 928 }
 929
 930 static gboolean
 931 gtk_tree_model_sort_get_iter (GtkTreeModel *tree_model,
 932                               GtkTreeIter  *iter,
 933                               GtkTreePath  *path)
 934 {
 935   GtkTreeModelSort *tree_model_sort;
 936   gint *indices;
 937   SortLevel *level;
 938   gint depth, i;
 939
 940   g_return_val_if_fail (GTK_IS_TREE_MODEL_SORT (tree_model), FALSE);
 941   g_return_val_if_fail (GTK_TREE_MODEL_SORT (tree_model)->child_model != NULL, FALSE);
 942
 943   tree_model_sort = (GtkTreeModelSort *) tree_model;
 944   indices = gtk_tree_path_get_indices (path);
 945
 946   if (tree_model_sort->root == NULL)
 947     gtk_tree_model_sort_build_level (tree_model_sort, NULL, NULL);
 948   level = SORT_LEVEL (tree_model_sort->root);
 949
 950   depth = gtk_tree_path_get_depth (path);
 951   if (depth == 0)
 952     return FALSE;
 953
 954   for (i = 0; i < depth - 1; i++)
 955     {
 956       if ((level == NULL) ||
 957           (indices[i] >= level->array->len))
 958         return FALSE;
 959
 960       if (g_array_index (level->array, SortElt, indices[i]).children == NULL)
 961         gtk_tree_model_sort_build_level (tree_model_sort, level, &g_array_index (level->array, SortElt, indices[i]));
 962       level = g_array_index (level->array, SortElt, indices[i]).children;
 963     }
 964
 965   if (level == NULL)
 966     return FALSE;
 967   iter->stamp = tree_model_sort->stamp;
 968   iter->user_data = level;
 969   iter->user_data2 = &g_array_index (level->array, SortElt, indices[depth - 1]);
 970
 971   return TRUE;
 972 }
 973
 974 static GtkTreePath *
 975 gtk_tree_model_sort_get_path (GtkTreeModel *tree_model,
 976                               GtkTreeIter  *iter)
 977 {
 978   GtkTreePath *retval;
 979   SortLevel *level;
 980   SortElt *elt;
 981
 982   g_return_val_if_fail (GTK_IS_TREE_MODEL_SORT (tree_model), NULL);
 983   g_return_val_if_fail (GTK_TREE_MODEL_SORT (tree_model)->child_model != NULL, NULL);
 984   g_return_val_if_fail (GTK_TREE_MODEL_SORT (tree_model)->stamp == iter->stamp, NULL);
 985
 986   retval = gtk_tree_path_new ();
 987   level = iter->user_data;
 988   elt = iter->user_data2;
 989   while (level != NULL)
 990     {
 991       gtk_tree_path_prepend_index (retval, elt - (SortElt *)level->array->data);
 992
 993       elt = level->parent_elt;
 994       level = level->parent_level;
 995     }
 996
 997   return retval;
 998 }
 999
1000 static void
1001 gtk_tree_model_sort_get_value (GtkTreeModel *tree_model,
1002                                GtkTreeIter  *iter,
1003                                gint          column,
1004                                GValue       *value)
1005 {
1006   GtkTreeIter child_iter;
1007
1008   g_return_if_fail (GTK_IS_TREE_MODEL_SORT (tree_model));
1009   g_return_if_fail (GTK_TREE_MODEL_SORT (tree_model)->child_model != NULL);
1010   g_return_if_fail (GTK_TREE_MODEL_SORT (tree_model)->stamp == iter->stamp);
1011
1012   GET_CHILD_ITER (tree_model, &child_iter, iter);
1013   gtk_tree_model_get_value (GTK_TREE_MODEL_SORT (tree_model)->child_model,
1014                             &child_iter, column, value);
1015 }
1016
1017 static gboolean
1018 gtk_tree_model_sort_iter_next (GtkTreeModel *tree_model,
1019                                GtkTreeIter  *iter)
1020 {
1021   SortLevel *level;
1022   SortElt *elt;
1023
1024   g_return_val_if_fail (GTK_IS_TREE_MODEL_SORT (tree_model), FALSE);
1025   g_return_val_if_fail (GTK_TREE_MODEL_SORT (tree_model)->child_model != NULL, FALSE);
1026   g_return_val_if_fail (GTK_TREE_MODEL_SORT (tree_model)->stamp == iter->stamp, FALSE);
1027
1028   level = iter->user_data;
1029   elt = iter->user_data2;
1030
1031   if (elt - (SortElt *)level->array->data >= level->array->len - 1)
1032     {
1033       iter->stamp = 0;
1034       return FALSE;
1035     }
1036   iter->user_data2 = elt + 1;
1037
1038   return TRUE;
1039 }
1040
1041 static gboolean
1042 gtk_tree_model_sort_iter_children (GtkTreeModel *tree_model,
1043                                    GtkTreeIter  *iter,
1044                                    GtkTreeIter  *parent)
1045 {
1046   GtkTreeModelSort *tree_model_sort = (GtkTreeModelSort *) tree_model;
1047   SortLevel *level;
1048
1049   iter->stamp = 0;
1050   g_return_val_if_fail (GTK_IS_TREE_MODEL_SORT (tree_model), FALSE);
1051   g_return_val_if_fail (tree_model_sort->child_model != NULL, FALSE);
1052   if (parent) g_return_val_if_fail (tree_model_sort->stamp == parent->stamp, FALSE);
1053
1054   if (parent == NULL)
1055     {
1056       if (tree_model_sort->root == NULL)
1057         gtk_tree_model_sort_build_level (tree_model_sort, NULL, NULL);
1058       if (tree_model_sort->root == NULL)
1059         return FALSE;
1060
1061       level = tree_model_sort->root;
1062       iter->stamp = tree_model_sort->stamp;
1063       iter->user_data = level;
1064       iter->user_data2 = level->array->data;
1065     }
1066   else
1067     {
1068       if (((SortElt *)parent->user_data2)->children == NULL)
1069         gtk_tree_model_sort_build_level (tree_model_sort,
1070                                          (SortLevel *)parent->user_data,
1071                                          (SortElt *)parent->user_data2);
1072       if (((SortElt *)parent->user_data2)->children == NULL)
1073         return FALSE;
1074       iter->stamp = tree_model_sort->stamp;
1075       iter->user_data = ((SortElt *)parent->user_data2)->children;
1076       iter->user_data2 = ((SortLevel *)iter->user_data)->array->data;
1077     }
1078
1079   return TRUE;
1080 }
1081
1082 static gboolean
1083 gtk_tree_model_sort_iter_has_child (GtkTreeModel *tree_model,
1084                                     GtkTreeIter  *iter)
1085 {
1086   GtkTreeIter child_iter;
1087
1088   g_return_val_if_fail (GTK_IS_TREE_MODEL_SORT (tree_model), FALSE);
1089   g_return_val_if_fail (GTK_TREE_MODEL_SORT (tree_model)->child_model != NULL, FALSE);
1090   g_return_val_if_fail (GTK_TREE_MODEL_SORT (tree_model)->stamp == iter->stamp, FALSE);
1091
1092   GET_CHILD_ITER (tree_model, &child_iter, iter);
1093
1094   return gtk_tree_model_iter_has_child (GTK_TREE_MODEL_SORT (tree_model)->child_model, &child_iter);
1095 }
1096
1097 static gint
1098 gtk_tree_model_sort_iter_n_children (GtkTreeModel *tree_model,
1099                                      GtkTreeIter  *iter)
1100 {
1101   GtkTreeIter child_iter;
1102
1103   g_return_val_if_fail (GTK_IS_TREE_MODEL_SORT (tree_model), 0);
1104   g_return_val_if_fail (GTK_TREE_MODEL_SORT (tree_model)->child_model != NULL, 0);
1105   if (iter) g_return_val_if_fail (GTK_TREE_MODEL_SORT (tree_model)->stamp == iter->stamp, 0);
1106
1107   if (iter == NULL)
1108     return gtk_tree_model_iter_n_children (GTK_TREE_MODEL_SORT (tree_model)->child_model, NULL);
1109
1110   GET_CHILD_ITER (tree_model, &child_iter, iter);
1111
1112   return gtk_tree_model_iter_n_children (GTK_TREE_MODEL_SORT (tree_model)->child_model, &child_iter);
1113 }
1114
1115 static gboolean
1116 gtk_tree_model_sort_iter_nth_child (GtkTreeModel *tree_model,
1117                                     GtkTreeIter  *iter,
1118                                     GtkTreeIter  *parent,
1119                                     gint          n)
1120 {
1121   SortLevel *level;
1122   /* We have this for the iter == parent case */
1123   GtkTreeIter children;
1124
1125   g_return_val_if_fail (GTK_IS_TREE_MODEL_SORT (tree_model), FALSE);
1126   if (parent) g_return_val_if_fail (GTK_TREE_MODEL_SORT (tree_model)->stamp == parent->stamp, FALSE);
1127
1128   /* Use this instead of has_child to force us to build the level, if needed */
1129   if (gtk_tree_model_sort_iter_children (tree_model, &children, parent) == FALSE)
1130     {
1131       iter->stamp = 0;
1132       return FALSE;
1133     }
1134
1135   level = children.user_data;
1136   if (n >= level->array->len)
1137     {
1138       iter->stamp = 0;
1139       return FALSE;
1140     }
1141
1142   iter->stamp = GTK_TREE_MODEL_SORT (tree_model)->stamp;
1143   iter->user_data = level;
1144   iter->user_data2 = &g_array_index (level->array, SortElt, n);
1145
1146   return TRUE;
1147 }
1148
1149 static gboolean
1150 gtk_tree_model_sort_iter_parent (GtkTreeModel *tree_model,
1151                                  GtkTreeIter  *iter,
1152                                  GtkTreeIter  *child)
1153 {
1154   SortLevel *level;
1155
1156   iter->stamp = 0;
1157   g_return_val_if_fail (GTK_IS_TREE_MODEL_SORT (tree_model), FALSE);
1158   g_return_val_if_fail (GTK_TREE_MODEL_SORT (tree_model)->child_model != NULL, FALSE);
1159   g_return_val_if_fail (GTK_TREE_MODEL_SORT (tree_model)->stamp == child->stamp, FALSE);
1160
1161   level = child->user_data;
1162
1163   if (level->parent_level)
1164     {
1165       iter->stamp = GTK_TREE_MODEL_SORT (tree_model)->stamp;
1166       iter->user_data = level->parent_level;
1167       iter->user_data2 = level->parent_elt;
1168
1169       return TRUE;
1170     }
1171   return FALSE;
1172 }
1173
1174 static void
1175 gtk_tree_model_sort_ref_node (GtkTreeModel *tree_model,
1176                               GtkTreeIter  *iter)
1177 {
1178   GtkTreeModelSort *tree_model_sort = (GtkTreeModelSort *) tree_model;
1179   GtkTreeIter child_iter;
1180   SortLevel *level;
1181   SortElt *elt;
1182
1183   g_return_if_fail (GTK_IS_TREE_MODEL_SORT (tree_model));
1184   g_return_if_fail (GTK_TREE_MODEL_SORT (tree_model)->child_model != NULL);
1185   g_return_if_fail (GTK_TREE_MODEL_SORT (tree_model)->stamp == iter->stamp);
1186
1187   GET_CHILD_ITER (tree_model, &child_iter, iter);
1188
1189   gtk_tree_model_ref_node (GTK_TREE_MODEL_SORT (tree_model)->child_model, &child_iter);
1190
1191   level = iter->user_data;
1192   elt = iter->user_data2;
1193
1194   elt->ref_count++;
1195   level->ref_count++;
1196   if (level->ref_count == 1)
1197     {
1198       SortLevel *parent_level = level->parent_level;
1199       SortElt *parent_elt = level->parent_elt;
1200       /* We were at zero -- time to decrement the zero_ref_count val */
1201       do
1202         {
1203           if (parent_elt)
1204             parent_elt->zero_ref_count--;
1205           else
1206             tree_model_sort->zero_ref_count--;
1207
1208           if (parent_level)
1209             {
1210               parent_elt = parent_level->parent_elt;
1211               parent_level = parent_level->parent_level;
1212             }
1213         }
1214       while (parent_level);
1215     }
1216 }
1217
1218 static void
1219 gtk_tree_model_sort_real_unref_node (GtkTreeModel *tree_model,
1220                                      GtkTreeIter  *iter,
1221                                      gboolean      propagate_unref)
1222 {
1223   GtkTreeModelSort *tree_model_sort = (GtkTreeModelSort *) tree_model;
1224   GtkTreeIter child_iter;
1225   SortLevel *level;
1226   SortElt *elt;
1227
1228   g_return_if_fail (GTK_IS_TREE_MODEL_SORT (tree_model));
1229   g_return_if_fail (GTK_TREE_MODEL_SORT (tree_model)->child_model != NULL);
1230   g_return_if_fail (GTK_TREE_MODEL_SORT (tree_model)->stamp == iter->stamp);
1231
1232   GET_CHILD_ITER (tree_model, &child_iter, iter);
1233
1234   if (propagate_unref)
1235     gtk_tree_model_unref_node (GTK_TREE_MODEL_SORT (tree_model)->child_model, &child_iter);
1236
1237   level = iter->user_data;
1238   elt = iter->user_data2;
1239
1240   g_return_if_fail (elt->ref_count > 0);
1241
1242   elt->ref_count--;
1243   level->ref_count--;
1244
1245   if (level->ref_count == 0)
1246     {
1247       SortLevel *parent_level = level->parent_level;
1248       SortElt *parent_elt = level->parent_elt;
1249
1250       /* We are at zero -- time to increment the zero_ref_count val */
1251       while (parent_level)
1252         {
1253           parent_elt->zero_ref_count++;
1254
1255           parent_elt = parent_level->parent_elt;
1256           parent_level = parent_level->parent_level;
1257         }
1258       tree_model_sort->zero_ref_count++;
1259     }
1260 }
1261
1262 static void
1263 gtk_tree_model_sort_unref_node (GtkTreeModel *tree_model,
1264                                 GtkTreeIter  *iter)
1265 {
1266   gtk_tree_model_sort_real_unref_node (tree_model, iter, TRUE);
1267 }
1268
1269 /* Sortable interface */
1270 static gboolean
1271 gtk_tree_model_sort_get_sort_column_id (GtkTreeSortable *sortable,
1272                                         gint            *sort_column_id,
1273                                         GtkSortType     *order)
1274 {
1275   GtkTreeModelSort *tree_model_sort = (GtkTreeModelSort *)sortable;
1276
1277   g_return_val_if_fail (GTK_IS_TREE_MODEL_SORT (sortable), FALSE);
1278
1279   if (tree_model_sort->sort_column_id == GTK_TREE_SORTABLE_DEFAULT_SORT_COLUMN_ID)
1280     return FALSE;
1281
1282   if (sort_column_id)
1283     *sort_column_id = tree_model_sort->sort_column_id;
1284   if (order)
1285     *order = tree_model_sort->order;
1286
1287   return TRUE;
1288 }
1289
1290 static void
1291 gtk_tree_model_sort_set_sort_column_id (GtkTreeSortable *sortable,
1292                                         gint             sort_column_id,
1293                                         GtkSortType      order)
1294 {
1295   GtkTreeModelSort *tree_model_sort = (GtkTreeModelSort *)sortable;
1296
1297   g_return_if_fail (GTK_IS_TREE_MODEL_SORT (sortable));
1298
1299   if (sort_column_id != GTK_TREE_SORTABLE_DEFAULT_SORT_COLUMN_ID)
1300     {
1301       GtkTreeDataSortHeader *header = NULL;
1302
1303       header = _gtk_tree_data_list_get_header (tree_model_sort->sort_list,
1304                                                sort_column_id);
1305
1306       /* we want to make sure that we have a function */
1307       g_return_if_fail (header != NULL);
1308       g_return_if_fail (header->func != NULL);
1309     }
1310   else
1311     g_return_if_fail (tree_model_sort->default_sort_func != NULL);
1312
1313   if (tree_model_sort->sort_column_id == sort_column_id)
1314     {
1315       if (sort_column_id != GTK_TREE_SORTABLE_DEFAULT_SORT_COLUMN_ID)
1316         {
1317           if (tree_model_sort->order == order)
1318             return;
1319         }
1320       else
1321         return;
1322     }
1323
1324   tree_model_sort->sort_column_id = sort_column_id;
1325   tree_model_sort->order = order;
1326
1327   gtk_tree_sortable_sort_column_changed (sortable);
1328
1329   gtk_tree_model_sort_sort (tree_model_sort);
1330 }
1331
1332 static void
1333 gtk_tree_model_sort_set_sort_func (GtkTreeSortable        *sortable,
1334                                    gint                    sort_column_id,
1335                                    GtkTreeIterCompareFunc  func,
1336                                    gpointer                data,
1337                                    GtkDestroyNotify        destroy)
1338 {
1339   GtkTreeModelSort *tree_model_sort = (GtkTreeModelSort *) sortable;
1340   GtkTreeDataSortHeader *header = NULL;
1341   GList *list;
1342
1343   g_return_if_fail (GTK_IS_TREE_MODEL_SORT (sortable));
1344   g_return_if_fail (func != NULL);
1345
1346   for (list = tree_model_sort->sort_list; list; list = list->next)
1347     {
1348       GtkTreeDataSortHeader *list_header;
1349
1350       list_header = (GtkTreeDataSortHeader*) list->data;
1351       if (list_header->sort_column_id == sort_column_id)
1352         {
1353           header = list_header;
1354           break;
1355         }
1356     }
1357
1358   if (header == NULL)
1359     {
1360       header = g_new0 (GtkTreeDataSortHeader, 1);
1361       header->sort_column_id = sort_column_id;
1362       tree_model_sort->sort_list = g_list_append (tree_model_sort->sort_list,
1363                                                   header);
1364     }
1365
1366   if (header->destroy)
1367     {
1368       GtkDestroyNotify d = header->destroy;
1369
1370       header->destroy = NULL;
1371       d (header->data);
1372     }
1373
1374   header->func = func;
1375   header->data = data;
1376   header->destroy = destroy;
1377
1378   if (tree_model_sort->sort_column_id == sort_column_id)
1379     gtk_tree_model_sort_sort (tree_model_sort);
1380 }
1381
1382 static void
1383 gtk_tree_model_sort_set_default_sort_func (GtkTreeSortable        *sortable,
1384                                            GtkTreeIterCompareFunc  func,
1385                                            gpointer                data,
1386                                            GtkDestroyNotify        destroy)
1387 {
1388   GtkTreeModelSort *tree_model_sort = (GtkTreeModelSort *)sortable;
1389
1390   g_return_if_fail (GTK_IS_TREE_MODEL_SORT (sortable));
1391
1392   if (tree_model_sort->default_sort_destroy)
1393     {
1394       GtkDestroyNotify d = tree_model_sort->default_sort_destroy;
1395
1396       tree_model_sort->default_sort_destroy = NULL;
1397       d (tree_model_sort->default_sort_data);
1398     }
1399
1400   tree_model_sort->default_sort_func = func;
1401   tree_model_sort->default_sort_data = data;
1402   tree_model_sort->default_sort_destroy = destroy;
1403
1404   if (tree_model_sort->sort_column_id == GTK_TREE_SORTABLE_DEFAULT_SORT_COLUMN_ID)
1405     gtk_tree_model_sort_sort (tree_model_sort);
1406 }
1407
1408 static gboolean
1409 gtk_tree_model_sort_has_default_sort_func (GtkTreeSortable *sortable)
1410 {
1411   GtkTreeModelSort *tree_model_sort = (GtkTreeModelSort *)sortable;
1412
1413   g_return_val_if_fail (GTK_IS_TREE_MODEL_SORT (sortable), FALSE);
1414
1415   return (tree_model_sort->default_sort_func != NULL);
1416 }
1417
1418 /* sorting code - private */
1419 static gint
1420 gtk_tree_model_sort_compare_func (gconstpointer a,
1421                                   gconstpointer b,
1422                                   gpointer      user_data)
1423 {
1424   SortData *data = (SortData *)user_data;
1425   GtkTreeModelSort *tree_model_sort = data->tree_model_sort;
1426   SortTuple *sa = (SortTuple *)a;
1427   SortTuple *sb = (SortTuple *)b;
1428
1429   GtkTreeIter iter_a, iter_b;
1430   gint retval;
1431
1432   /* shortcut, if we've the same offsets here, they should be equal */
1433   if (sa->offset == sb->offset)
1434     return 0;
1435
1436   if (GTK_TREE_MODEL_SORT_CACHE_CHILD_ITERS (tree_model_sort))
1437     {
1438       iter_a = sa->elt->iter;
1439       iter_b = sb->elt->iter;
1440     }
1441   else
1442     {
1443       data->parent_path_indices [data->parent_path_depth-1] = sa->elt->offset;
1444       gtk_tree_model_get_iter (GTK_TREE_MODEL (tree_model_sort->child_model), &iter_a, data->parent_path);
1445       data->parent_path_indices [data->parent_path_depth-1] = sb->elt->offset;
1446       gtk_tree_model_get_iter (GTK_TREE_MODEL (tree_model_sort->child_model), &iter_b, data->parent_path);
1447     }
1448
1449   retval = (* data->sort_func) (GTK_TREE_MODEL (tree_model_sort->child_model),
1450                                 &iter_a, &iter_b,
1451                                 data->sort_data);
1452
1453   if (tree_model_sort->order == GTK_SORT_DESCENDING)
1454     {
1455       if (retval > 0)
1456         retval = -1;
1457       else if (retval < 0)
1458         retval = 1;
1459     }
1460
1461   return retval;
1462 }
1463
1464 static gint
1465 gtk_tree_model_sort_offset_compare_func (gconstpointer a,
1466                                          gconstpointer b,
1467                                          gpointer      user_data)
1468 {
1469   gint retval;
1470
1471   SortTuple *sa = (SortTuple *)a;
1472   SortTuple *sb = (SortTuple *)b;
1473
1474   SortData *data = (SortData *)user_data;
1475
1476   if (sa->elt->offset < sb->elt->offset)
1477     retval = -1;
1478   else if (sa->elt->offset > sb->elt->offset)
1479     retval = 1;
1480   else
1481     retval = 0;
1482
1483   if (data->tree_model_sort->order == GTK_SORT_DESCENDING)
1484     {
1485       if (retval > 0)
1486         retval = -1;
1487       else if (retval < 0)
1488         retval = 1;
1489     }
1490
1491   return retval;
1492 }
1493
1494 static void
1495 gtk_tree_model_sort_sort_level (GtkTreeModelSort *tree_model_sort,
1496                                 SortLevel        *level,
1497                                 gboolean          recurse,
1498                                 gboolean          emit_reordered)
1499 {
1500   gint i;
1501   GArray *sort_array;
1502   GArray *new_array;
1503   gint *new_order;
1504
1505   GtkTreeIter iter;
1506   GtkTreePath *path;
1507
1508   SortData data;
1509
1510   g_return_if_fail (GTK_IS_TREE_MODEL_SORT (tree_model_sort));
1511   g_return_if_fail (level != NULL);
1512
1513   if (level->array->len < 1 && !((SortElt *)level->array->data)->children)
1514     return;
1515
1516   /* Set up data */
1517   data.tree_model_sort = tree_model_sort;
1518   if (level->parent_elt)
1519     {
1520       data.parent_path = gtk_tree_model_sort_elt_get_path (level->parent_level,
1521                                                            level->parent_elt);
1522       gtk_tree_path_append_index (data.parent_path, 0);
1523     }
1524   else
1525     {
1526       data.parent_path = gtk_tree_path_new_first ();
1527     }
1528   data.parent_path_depth = gtk_tree_path_get_depth (data.parent_path);
1529   data.parent_path_indices = gtk_tree_path_get_indices (data.parent_path);
1530
1531   /* make the array to be sorted */
1532   sort_array = g_array_sized_new (FALSE, FALSE, sizeof (SortTuple), level->array->len);
1533   for (i = 0; i < level->array->len; i++)
1534     {
1535       SortTuple tuple;
1536
1537       tuple.elt = &g_array_index (level->array, SortElt, i);
1538       tuple.offset = i;
1539
1540       g_array_append_val (sort_array, tuple);
1541     }
1542
1543     if (tree_model_sort->sort_column_id != GTK_TREE_SORTABLE_DEFAULT_SORT_COLUMN_ID)
1544       {
1545         GtkTreeDataSortHeader *header = NULL;
1546
1547         header = _gtk_tree_data_list_get_header (tree_model_sort->sort_list,
1548                                                  tree_model_sort->sort_column_id);
1549
1550         g_return_if_fail (header != NULL);
1551         g_return_if_fail (header->func != NULL);
1552
1553         data.sort_func = header->func;
1554         data.sort_data = header->data;
1555       }
1556     else
1557       {
1558         /* absolutely SHOULD NOT happen: */
1559         g_return_if_fail (tree_model_sort->default_sort_func != NULL);
1560
1561         data.sort_func = tree_model_sort->default_sort_func;
1562         data.sort_data = tree_model_sort->default_sort_data;
1563       }
1564
1565   if (data.sort_func == NO_SORT_FUNC)
1566     g_array_sort_with_data (sort_array,
1567                             gtk_tree_model_sort_offset_compare_func,
1568                             &data);
1569   else
1570     g_array_sort_with_data (sort_array,
1571                             gtk_tree_model_sort_compare_func,
1572                             &data);
1573
1574   gtk_tree_path_free (data.parent_path);
1575
1576   new_array = g_array_sized_new (FALSE, FALSE, sizeof (SortElt), level->array->len);
1577   new_order = g_new (gint, level->array->len);
1578
1579   for (i = 0; i < level->array->len; i++)
1580     {
1581       SortElt *elt;
1582
1583       elt = g_array_index (sort_array, SortTuple, i).elt;
1584       new_order[i] = g_array_index (sort_array, SortTuple, i).offset;
1585
1586       g_array_append_val (new_array, *elt);
1587       elt = &g_array_index (new_array, SortElt, i);
1588       if (elt->children)
1589         elt->children->parent_elt = elt;
1590     }
1591
1592   g_array_free (level->array, TRUE);
1593   level->array = new_array;
1594   g_array_free (sort_array, TRUE);
1595
1596   if (emit_reordered)
1597     {
1598       gtk_tree_model_sort_increment_stamp (tree_model_sort);
1599       if (level->parent_elt)
1600         {
1601           iter.stamp = tree_model_sort->stamp;
1602           iter.user_data = level->parent_level;
1603           iter.user_data2 = level->parent_elt;
1604
1605           path = gtk_tree_model_get_path (GTK_TREE_MODEL (tree_model_sort),
1606                                           &iter);
1607
1608           gtk_tree_model_rows_reordered (GTK_TREE_MODEL (tree_model_sort), path,
1609                                          &iter, new_order);
1610         }
1611       else
1612         {
1613           /* toplevel list */
1614           path = gtk_tree_path_new ();
1615           gtk_tree_model_rows_reordered (GTK_TREE_MODEL (tree_model_sort), path,
1616                                          NULL, new_order);
1617         }
1618
1619       gtk_tree_path_free (path);
1620     }
1621
1622   /* recurse, if possible */
1623   if (recurse)
1624     {
1625       for (i = 0; i < level->array->len; i++)
1626         {
1627           SortElt *elt = &g_array_index (level->array, SortElt, i);
1628
1629           if (elt->children)
1630             gtk_tree_model_sort_sort_level (tree_model_sort,
1631                                             elt->children,
1632                                             TRUE, emit_reordered);
1633         }
1634     }
1635
1636   g_free (new_order);
1637 }
1638
1639 static void
1640 gtk_tree_model_sort_sort (GtkTreeModelSort *tree_model_sort)
1641 {
1642   g_return_if_fail (GTK_IS_TREE_MODEL_SORT (tree_model_sort));
1643
1644   if (!tree_model_sort->root)
1645     return;
1646
1647   if (tree_model_sort->sort_column_id != GTK_TREE_SORTABLE_DEFAULT_SORT_COLUMN_ID)
1648     {
1649       GtkTreeDataSortHeader *header = NULL;
1650
1651       header = _gtk_tree_data_list_get_header (tree_model_sort->sort_list,
1652                                                tree_model_sort->sort_column_id);
1653
1654       /* we want to make sure that we have a function */
1655       g_return_if_fail (header != NULL);
1656       g_return_if_fail (header->func != NULL);
1657     }
1658   else
1659     g_return_if_fail (tree_model_sort->default_sort_func != NULL);
1660
1661   gtk_tree_model_sort_sort_level (tree_model_sort, tree_model_sort->root,
1662                                   TRUE, TRUE);
1663 }
1664
1665 /* signal helpers */
1666 static gint
1667 gtk_tree_model_sort_level_find_insert (GtkTreeModelSort *tree_model_sort,
1668                                        SortLevel        *level,
1669                                        GtkTreeIter      *iter,
1670                                        gint             skip_index)
1671 {
1672   gint start, middle, end;
1673   gint cmp;
1674   SortElt *tmp_elt;
1675   GtkTreeIter tmp_iter;
1676
1677   GtkTreeIterCompareFunc func;
1678   gpointer data;
1679
1680   if (tree_model_sort->sort_column_id != GTK_TREE_SORTABLE_DEFAULT_SORT_COLUMN_ID)
1681     {
1682       GtkTreeDataSortHeader *header;
1683
1684       header = _gtk_tree_data_list_get_header (tree_model_sort->sort_list,
1685                                                tree_model_sort->sort_column_id);
1686
1687       g_return_val_if_fail (header != NULL, 0);
1688
1689       func = header->func;
1690       data = header->data;
1691     }
1692   else
1693     {
1694       func = tree_model_sort->default_sort_func;
1695       data = tree_model_sort->default_sort_data;
1696
1697       g_return_val_if_fail (func != NO_SORT_FUNC, 0);
1698     }
1699
1700   g_return_val_if_fail (func != NULL, 0);
1701
1702   start = 0;
1703   end = level->array->len;
1704   if (skip_index < 0)
1705     skip_index = end;
1706   else
1707     end--;
1708
1709   if (start == end)
1710     return 0;
1711
1712   while (start != end)
1713     {
1714       middle = (start + end) / 2;
1715
1716       if (middle < skip_index)
1717         tmp_elt = &(g_array_index (level->array, SortElt, middle));
1718       else
1719         tmp_elt = &(g_array_index (level->array, SortElt, middle + 1));
1720
1721       if (!GTK_TREE_MODEL_SORT_CACHE_CHILD_ITERS (tree_model_sort))
1722         {
1723           GtkTreePath *path = gtk_tree_model_sort_elt_get_path (level, tmp_elt);
1724           gtk_tree_model_get_iter (tree_model_sort->child_model,
1725                                    &tmp_iter, path);
1726           gtk_tree_path_free (path);
1727         }
1728       else
1729         tmp_iter = tmp_elt->iter;
1730
1731       if (tree_model_sort->order == GTK_SORT_ASCENDING)
1732         cmp = (* func) (GTK_TREE_MODEL (tree_model_sort->child_model),
1733                         &tmp_iter, iter, data);
1734       else
1735         cmp = (* func) (GTK_TREE_MODEL (tree_model_sort->child_model),
1736                         iter, &tmp_iter, data);
1737
1738       if (cmp <= 0)
1739         start = middle + 1;
1740       else
1741         end = middle;
1742     }
1743
1744   if (cmp <= 0)
1745     return middle + 1;
1746   else
1747     return middle;
1748 }
1749
1750 static gboolean
1751 gtk_tree_model_sort_insert_value (GtkTreeModelSort *tree_model_sort,
1752                                   SortLevel        *level,
1753                                   GtkTreePath      *s_path,
1754                                   GtkTreeIter      *s_iter)
1755 {
1756   gint offset, index, i;
1757
1758   SortElt elt;
1759   SortElt *tmp_elt;
1760
1761   offset = gtk_tree_path_get_indices (s_path)[gtk_tree_path_get_depth (s_path) - 1];
1762
1763   if (GTK_TREE_MODEL_SORT_CACHE_CHILD_ITERS (tree_model_sort))
1764     elt.iter = *s_iter;
1765   elt.offset = offset;
1766   elt.zero_ref_count = 0;
1767   elt.ref_count = 0;
1768   elt.children = NULL;
1769
1770   /* update all larger offsets */
1771   tmp_elt = SORT_ELT (level->array->data);
1772   for (i = 0; i < level->array->len; i++, tmp_elt++)
1773     if (tmp_elt->offset >= offset)
1774       tmp_elt->offset++;
1775
1776   if (tree_model_sort->sort_column_id == GTK_TREE_SORTABLE_DEFAULT_SORT_COLUMN_ID &&
1777       tree_model_sort->default_sort_func == NO_SORT_FUNC)
1778     index = offset;
1779   else
1780     index = gtk_tree_model_sort_level_find_insert (tree_model_sort,
1781                                                    level, s_iter,
1782                                                    -1);
1783
1784   g_array_insert_vals (level->array, index, &elt, 1);
1785   tmp_elt = SORT_ELT (level->array->data);
1786   for (i = 0; i < level->array->len; i++, tmp_elt++)
1787     if (tmp_elt->children)
1788       tmp_elt->children->parent_elt = tmp_elt;
1789
1790   return TRUE;
1791 }
1792
1793 /* sort elt stuff */
1794 static GtkTreePath *
1795 gtk_tree_model_sort_elt_get_path (SortLevel *level,
1796                                   SortElt *elt)
1797 {
1798   SortLevel *walker = level;
1799   SortElt *walker2 = elt;
1800   GtkTreePath *path;
1801
1802   g_return_val_if_fail (level != NULL, NULL);
1803   g_return_val_if_fail (elt != NULL, NULL);
1804
1805   path = gtk_tree_path_new ();
1806
1807   while (walker)
1808     {
1809       gtk_tree_path_prepend_index (path, walker2->offset);
1810
1811       walker2 = walker->parent_elt;
1812       walker = walker->parent_level;
1813     }
1814
1815   return path;
1816 }
1817
1818 /**
1819  * gtk_tree_model_sort_set_model:
1820  * @tree_model_sort: The #GtkTreeModelSort.
1821  * @child_model: A #GtkTreeModel, or NULL.
1822  *
1823  * Sets the model of @tree_model_sort to be @model.  If @model is NULL, then the
1824  * old model is unset.  The sort function is unset as a result of this call.
1825  * The model will be in an unsorted state until a sort function is set.
1826  **/
1827 static void
1828 gtk_tree_model_sort_set_model (GtkTreeModelSort *tree_model_sort,
1829                                GtkTreeModel     *child_model)
1830 {
1831   g_return_if_fail (GTK_IS_TREE_MODEL_SORT (tree_model_sort));
1832
1833   if (child_model)
1834     g_object_ref (child_model);
1835
1836   if (tree_model_sort->child_model)
1837     {
1838       g_signal_handler_disconnect (tree_model_sort->child_model,
1839                                    tree_model_sort->changed_id);
1840       g_signal_handler_disconnect (tree_model_sort->child_model,
1841                                    tree_model_sort->inserted_id);
1842       g_signal_handler_disconnect (tree_model_sort->child_model,
1843                                    tree_model_sort->has_child_toggled_id);
1844       g_signal_handler_disconnect (tree_model_sort->child_model,
1845                                    tree_model_sort->deleted_id);
1846       g_signal_handler_disconnect (tree_model_sort->child_model,
1847                                    tree_model_sort->reordered_id);
1848
1849       /* reset our state */
1850       if (tree_model_sort->root)
1851         gtk_tree_model_sort_free_level (tree_model_sort, tree_model_sort->root);
1852       tree_model_sort->root = NULL;
1853       _gtk_tree_data_list_header_free (tree_model_sort->sort_list);
1854       tree_model_sort->sort_list = NULL;
1855       g_object_unref (tree_model_sort->child_model);
1856     }
1857
1858   tree_model_sort->child_model = child_model;
1859
1860   if (child_model)
1861     {
1862       GType *types;
1863       gint i, n_columns;
1864
1865       tree_model_sort->changed_id =
1866         g_signal_connect (child_model, "row_changed",
1867                           G_CALLBACK (gtk_tree_model_sort_row_changed),
1868                           tree_model_sort);
1869       tree_model_sort->inserted_id =
1870         g_signal_connect (child_model, "row_inserted",
1871                           G_CALLBACK (gtk_tree_model_sort_row_inserted),
1872                           tree_model_sort);
1873       tree_model_sort->has_child_toggled_id =
1874         g_signal_connect (child_model, "row_has_child_toggled",
1875                           G_CALLBACK (gtk_tree_model_sort_row_has_child_toggled),
1876                           tree_model_sort);
1877       tree_model_sort->deleted_id =
1878         g_signal_connect (child_model, "row_deleted",
1879                           G_CALLBACK (gtk_tree_model_sort_row_deleted),
1880                           tree_model_sort);
1881       tree_model_sort->reordered_id =
1882         g_signal_connect (child_model, "rows_reordered",
1883                           G_CALLBACK (gtk_tree_model_sort_rows_reordered),
1884                           tree_model_sort);
1885
1886       tree_model_sort->child_flags = gtk_tree_model_get_flags (child_model);
1887       n_columns = gtk_tree_model_get_n_columns (child_model);
1888
1889       types = g_new (GType, n_columns);
1890       for (i = 0; i < n_columns; i++)
1891         types[i] = gtk_tree_model_get_column_type (child_model, i);
1892
1893       tree_model_sort->sort_list = _gtk_tree_data_list_header_new (n_columns, types);
1894       g_free (types);
1895
1896       tree_model_sort->default_sort_func = NO_SORT_FUNC;
1897       tree_model_sort->stamp = g_random_int ();
1898     }
1899 }
1900
1901 /**
1902  * gtk_tree_model_sort_get_model:
1903  * @tree_model: a #GtkTreeModelSort
1904  *
1905  * Returns the model the #GtkTreeModelSort is sorting.
1906  *
1907  * Return value: the "child model" being sorted
1908  **/
1909 GtkTreeModel *
1910 gtk_tree_model_sort_get_model (GtkTreeModelSort  *tree_model)
1911 {
1912   g_return_val_if_fail (GTK_IS_TREE_MODEL_SORT (tree_model), NULL);
1913
1914   return tree_model->child_model;
1915 }
1916
1917
1918 static GtkTreePath *
1919 gtk_real_tree_model_sort_convert_child_path_to_path (GtkTreeModelSort *tree_model_sort,
1920                                                      GtkTreePath      *child_path,
1921                                                      gboolean          build_levels)
1922 {
1923   gint *child_indices;
1924   GtkTreePath *retval;
1925   SortLevel *level;
1926   gint i;
1927
1928   g_return_val_if_fail (GTK_IS_TREE_MODEL_SORT (tree_model_sort), NULL);
1929   g_return_val_if_fail (tree_model_sort->child_model != NULL, NULL);
1930   g_return_val_if_fail (child_path != NULL, NULL);
1931
1932   retval = gtk_tree_path_new ();
1933   child_indices = gtk_tree_path_get_indices (child_path);
1934
1935   if (tree_model_sort->root == NULL && build_levels)
1936     gtk_tree_model_sort_build_level (tree_model_sort, NULL, NULL);
1937   level = SORT_LEVEL (tree_model_sort->root);
1938
1939   for (i = 0; i < gtk_tree_path_get_depth (child_path); i++)
1940     {
1941       gint j;
1942       gboolean found_child = FALSE;
1943
1944       if (!level)
1945         {
1946           gtk_tree_path_free (retval);
1947           return NULL;
1948         }
1949
1950       if (child_indices[i] >= level->array->len)
1951         {
1952           gtk_tree_path_free (retval);
1953           return NULL;
1954         }
1955       for (j = 0; j < level->array->len; j++)
1956         {
1957           if ((g_array_index (level->array, SortElt, j)).offset == child_indices[i])
1958             {
1959               gtk_tree_path_append_index (retval, j);
1960               if (g_array_index (level->array, SortElt, j).children == NULL && build_levels)
1961                 {
1962                   gtk_tree_model_sort_build_level (tree_model_sort, level, &g_array_index (level->array, SortElt, j));
1963                 }
1964               level = g_array_index (level->array, SortElt, j).children;
1965               found_child = TRUE;
1966               break;
1967             }
1968         }
1969       if (! found_child)
1970         {
1971           gtk_tree_path_free (retval);
1972           return NULL;
1973         }
1974     }
1975
1976   return retval;
1977 }
1978
1979
1980 /**
1981  * gtk_tree_model_sort_convert_child_path_to_path:
1982  * @tree_model_sort: A #GtkTreeModelSort
1983  * @child_path: A #GtkTreePath to convert
1984  *
1985  * Converts @child_path to a path relative to @tree_model_sort.  That is,
1986  * @child_path points to a path in the child model.  The returned path will
1987  * point to the same row in the sorted model.  If @child_path isn't a valid path
1988  * on the child model, then %NULL is returned.
1989  *
1990  * Return value: A newly allocated #GtkTreePath, or %NULL
1991  **/
1992 GtkTreePath *
1993 gtk_tree_model_sort_convert_child_path_to_path (GtkTreeModelSort *tree_model_sort,
1994                                                 GtkTreePath      *child_path)
1995 {
1996   g_return_val_if_fail (GTK_IS_TREE_MODEL_SORT (tree_model_sort), NULL);
1997   g_return_val_if_fail (tree_model_sort->child_model != NULL, NULL);
1998   g_return_val_if_fail (child_path != NULL, NULL);
1999
2000   return gtk_real_tree_model_sort_convert_child_path_to_path (tree_model_sort, child_path, TRUE);
2001 }
2002
2003 /**
2004  * gtk_tree_model_sort_convert_child_iter_to_iter:
2005  * @tree_model_sort: A #GtkTreeModelSort
2006  * @sort_iter: An uninitialized #GtkTreeIter.
2007  * @child_iter: A valid #GtkTreeIter pointing to a row on the child model
2008  *
2009  * Sets @sort_iter to point to the row in @tree_model_sort that corresponds to
2010  * the row pointed at by @child_iter.
2011  **/
2012 void
2013 gtk_tree_model_sort_convert_child_iter_to_iter (GtkTreeModelSort *tree_model_sort,
2014                                                 GtkTreeIter      *sort_iter,
2015                                                 GtkTreeIter      *child_iter)
2016 {
2017   GtkTreePath *child_path, *path;
2018
2019   g_return_if_fail (GTK_IS_TREE_MODEL_SORT (tree_model_sort));
2020   g_return_if_fail (tree_model_sort->child_model != NULL);
2021   g_return_if_fail (sort_iter != NULL);
2022   g_return_if_fail (child_iter != NULL);
2023
2024   sort_iter->stamp = 0;
2025
2026   child_path = gtk_tree_model_get_path (tree_model_sort->child_model, child_iter);
2027   g_return_if_fail (child_path != NULL);
2028
2029   path = gtk_tree_model_sort_convert_child_path_to_path (tree_model_sort, child_path);
2030   gtk_tree_path_free (child_path);
2031   g_return_if_fail (path != NULL);
2032
2033   gtk_tree_model_get_iter (GTK_TREE_MODEL (tree_model_sort), sort_iter, path);
2034   gtk_tree_path_free (path);
2035 }
2036
2037 /**
2038  * gtk_tree_model_sort_convert_path_to_child_path:
2039  * @tree_model_sort: A #GtkTreeModelSort
2040  * @sorted_path: A #GtkTreePath to convert
2041  *
2042  * Converts @sorted_path to a path on the child model of @tree_model_sort.  That
2043  * is, @sorted_path points to a location in @tree_model_sort.  The returned path
2044  * will point to the same location in the model not being sorted.  If @sorted_path
2045  * does not point to a location in the child model, %NULL is returned.
2046  *
2047  * Return value: A newly allocated #GtkTreePath, or %NULL
2048  **/
2049 GtkTreePath *
2050 gtk_tree_model_sort_convert_path_to_child_path (GtkTreeModelSort *tree_model_sort,
2051                                                 GtkTreePath      *sorted_path)
2052 {
2053   gint *sorted_indices;
2054   GtkTreePath *retval;
2055   SortLevel *level;
2056   gint i;
2057
2058   g_return_val_if_fail (GTK_IS_TREE_MODEL_SORT (tree_model_sort), NULL);
2059   g_return_val_if_fail (tree_model_sort->child_model != NULL, NULL);
2060   g_return_val_if_fail (sorted_path != NULL, NULL);
2061
2062   retval = gtk_tree_path_new ();
2063   sorted_indices = gtk_tree_path_get_indices (sorted_path);
2064   if (tree_model_sort->root == NULL)
2065     gtk_tree_model_sort_build_level (tree_model_sort, NULL, NULL);
2066   level = SORT_LEVEL (tree_model_sort->root);
2067
2068   for (i = 0; i < gtk_tree_path_get_depth (sorted_path); i++)
2069     {
2070       gint count = sorted_indices[i];
2071
2072       if ((level == NULL) ||
2073           (level->array->len <= count))
2074         {
2075           gtk_tree_path_free (retval);
2076           return NULL;
2077         }
2078
2079       if (g_array_index (level->array, SortElt, count).children == NULL)
2080         gtk_tree_model_sort_build_level (tree_model_sort, level, &g_array_index (level->array, SortElt, count));
2081
2082       if (level == NULL)
2083         {
2084           gtk_tree_path_free (retval);
2085           break;
2086         }
2087
2088       gtk_tree_path_append_index (retval, g_array_index (level->array, SortElt, count).offset);
2089       level = g_array_index (level->array, SortElt, count).children;
2090     }
2091
2092   return retval;
2093 }
2094
2095 /**
2096  * gtk_tree_model_sort_convert_iter_to_child_iter:
2097  * @tree_model_sort: A #GtkTreeModelSort
2098  * @child_iter: An uninitialized #GtkTreeIter
2099  * @sorted_iter: A valid #GtkTreeIter pointing to a row on @tree_model_sort.
2100  *
2101  * Sets @child_iter to point to the row pointed to by @sorted_iter.
2102  **/
2103 void
2104 gtk_tree_model_sort_convert_iter_to_child_iter (GtkTreeModelSort *tree_model_sort,
2105                                                 GtkTreeIter      *child_iter,
2106                                                 GtkTreeIter      *sorted_iter)
2107 {
2108   g_return_if_fail (GTK_IS_TREE_MODEL_SORT (tree_model_sort));
2109   g_return_if_fail (tree_model_sort->child_model != NULL);
2110   g_return_if_fail (child_iter != NULL);
2111   g_return_if_fail (sorted_iter != NULL);
2112   g_return_if_fail (sorted_iter->stamp == tree_model_sort->stamp);
2113
2114   if (GTK_TREE_MODEL_SORT_CACHE_CHILD_ITERS (tree_model_sort))
2115     {
2116       *child_iter = SORT_ELT (sorted_iter->user_data2)->iter;
2117     }
2118   else
2119     {
2120       GtkTreePath *path;
2121
2122       path = gtk_tree_model_sort_elt_get_path (sorted_iter->user_data,
2123                                                sorted_iter->user_data2);
2124       gtk_tree_model_get_iter (tree_model_sort->child_model, child_iter, path);
2125       gtk_tree_path_free (path);
2126     }
2127 }
2128
2129 static void
2130 gtk_tree_model_sort_build_level (GtkTreeModelSort *tree_model_sort,
2131                                  SortLevel        *parent_level,
2132                                  SortElt          *parent_elt)
2133 {
2134   GtkTreeIter iter;
2135   SortLevel *new_level;
2136   gint length = 0;
2137   gint i;
2138
2139   g_assert (tree_model_sort->child_model != NULL);
2140
2141   if (parent_level == NULL)
2142     {
2143       if (gtk_tree_model_get_iter_first (tree_model_sort->child_model, &iter) == FALSE)
2144         return;
2145       length = gtk_tree_model_iter_n_children (tree_model_sort->child_model, NULL);
2146     }
2147   else
2148     {
2149       GtkTreeIter parent_iter;
2150       GtkTreeIter child_parent_iter;
2151
2152       parent_iter.stamp = tree_model_sort->stamp;
2153       parent_iter.user_data = parent_level;
2154       parent_iter.user_data2 = parent_elt;
2155
2156       gtk_tree_model_sort_convert_iter_to_child_iter (tree_model_sort,
2157                                                       &child_parent_iter,
2158                                                       &parent_iter);
2159       if (gtk_tree_model_iter_children (tree_model_sort->child_model,
2160                                         &iter,
2161                                         &child_parent_iter) == FALSE)
2162         return;
2163
2164       /* stamp may have changed */
2165       gtk_tree_model_sort_convert_iter_to_child_iter (tree_model_sort,
2166                                                       &child_parent_iter,
2167                                                       &parent_iter);
2168
2169       length = gtk_tree_model_iter_n_children (tree_model_sort->child_model, &child_parent_iter);
2170     }
2171
2172   g_return_if_fail (length > 0);
2173
2174   new_level = g_new (SortLevel, 1);
2175   new_level->array = g_array_sized_new (FALSE, FALSE, sizeof (SortElt), length);
2176   new_level->ref_count = 0;
2177   new_level->parent_elt = parent_elt;
2178   new_level->parent_level = parent_level;
2179
2180   if (parent_elt)
2181     parent_elt->children = new_level;
2182   else
2183     tree_model_sort->root = new_level;
2184
2185   /* increase the count of zero ref_counts.*/
2186   while (parent_level)
2187     {
2188       parent_elt->zero_ref_count++;
2189
2190       parent_elt = parent_level->parent_elt;
2191       parent_level = parent_level->parent_level;
2192     }
2193   if (new_level != tree_model_sort->root)
2194     tree_model_sort->zero_ref_count++;
2195
2196   for (i = 0; i < length; i++)
2197     {
2198       SortElt sort_elt;
2199       sort_elt.offset = i;
2200       sort_elt.zero_ref_count = 0;
2201       sort_elt.ref_count = 0;
2202       sort_elt.children = NULL;
2203
2204       if (GTK_TREE_MODEL_SORT_CACHE_CHILD_ITERS (tree_model_sort))
2205         {
2206           sort_elt.iter = iter;
2207           if (gtk_tree_model_iter_next (tree_model_sort->child_model, &iter) == FALSE &&
2208               i < length - 1)
2209             {
2210               g_warning ("There is a discrepency between the sort model and the child model.");
2211               return;
2212             }
2213         }
2214       g_array_append_val (new_level->array, sort_elt);
2215     }
2216
2217   /* sort level */
2218   gtk_tree_model_sort_sort_level (tree_model_sort, new_level,
2219                                   FALSE, FALSE);
2220 }
2221
2222 static void
2223 gtk_tree_model_sort_free_level (GtkTreeModelSort *tree_model_sort,
2224                                 SortLevel        *sort_level)
2225 {
2226   gint i;
2227
2228   g_assert (sort_level);
2229
2230   if (sort_level->ref_count == 0)
2231     {
2232       SortLevel *parent_level = sort_level->parent_level;
2233       SortElt *parent_elt = sort_level->parent_elt;
2234
2235       do
2236         {
2237           if (parent_elt)
2238             parent_elt->zero_ref_count--;
2239           else
2240             tree_model_sort->zero_ref_count--;
2241
2242           if (parent_level)
2243             {
2244               parent_elt = parent_level->parent_elt;
2245               parent_level = parent_level->parent_level;
2246             }
2247         }
2248       while (parent_level);
2249     }
2250
2251   for (i = 0; i < sort_level->array->len; i++)
2252     {
2253       if (g_array_index (sort_level->array, SortElt, i).children)
2254         gtk_tree_model_sort_free_level (tree_model_sort,
2255                                         SORT_LEVEL(g_array_index (sort_level->array, SortElt, i).children));
2256     }
2257
2258   if (sort_level->parent_elt)
2259     sort_level->parent_elt->children = NULL;
2260   else
2261     tree_model_sort->root = NULL;
2262
2263   g_array_free (sort_level->array, TRUE);
2264   sort_level->array = NULL;
2265
2266   g_free (sort_level);
2267   sort_level = NULL;
2268 }
2269
2270 static void
2271 gtk_tree_model_sort_increment_stamp (GtkTreeModelSort *tree_model_sort)
2272 {
2273   do
2274     {
2275       tree_model_sort->stamp++;
2276     }
2277   while (tree_model_sort->stamp == 0);
2278
2279   gtk_tree_model_sort_clear_cache (tree_model_sort);
2280 }
2281
2282 static void
2283 gtk_tree_model_sort_clear_cache_helper (GtkTreeModelSort *tree_model_sort,
2284                                         SortLevel        *level)
2285 {
2286   gint i;
2287
2288   g_assert (level != NULL);
2289
2290   for (i = 0; i < level->array->len; i++)
2291     {
2292       if (g_array_index (level->array, SortElt, i).zero_ref_count > 0)
2293         gtk_tree_model_sort_clear_cache_helper (tree_model_sort, g_array_index (level->array, SortElt, i).children);
2294     }
2295
2296   if (level->ref_count == 0 && level != tree_model_sort->root)
2297     gtk_tree_model_sort_free_level (tree_model_sort, level);
2298 }
2299
2300 /**
2301  * gtk_tree_model_sort_reset_default_sort_func:
2302  * @tree_model_sort: A #GtkTreeModelSort
2303  *
2304  * This resets the default sort function to be in the 'unsorted' state.  That
2305  * is, it is in the same order as the child model. It will re-sort the model
2306  * to be in the same order as the child model only if the #GtkTreeModelSort
2307  * is in 'unsorted' state.
2308  **/
2309 void
2310 gtk_tree_model_sort_reset_default_sort_func (GtkTreeModelSort *tree_model_sort)
2311 {
2312   g_return_if_fail (GTK_IS_TREE_MODEL_SORT (tree_model_sort));
2313
2314   if (tree_model_sort->default_sort_destroy)
2315     {
2316       GtkDestroyNotify d = tree_model_sort->default_sort_destroy;
2317
2318       tree_model_sort->default_sort_destroy = NULL;
2319       d (tree_model_sort->default_sort_data);
2320     }
2321
2322   tree_model_sort->default_sort_func = NO_SORT_FUNC;
2323   tree_model_sort->default_sort_data = NULL;
2324   tree_model_sort->default_sort_destroy = NULL;
2325
2326   if (tree_model_sort->sort_column_id == GTK_TREE_SORTABLE_DEFAULT_SORT_COLUMN_ID)
2327     gtk_tree_model_sort_sort (tree_model_sort);
2328   tree_model_sort->sort_column_id = GTK_TREE_SORTABLE_DEFAULT_SORT_COLUMN_ID;
2329 }
2330
2331 /**
2332  * gtk_tree_model_sort_clear_cache:
2333  * @tree_model_sort: A #GtkTreeModelSort
2334  *
2335  * This function should almost never be called.  It clears the @tree_model_sort
2336  * of any cached iterators that haven't been reffed with
2337  * gtk_tree_model_ref_node().  This might be useful if the child model being
2338  * sorted is static (and doesn't change often) and there has been a lot of
2339  * unreffed access to nodes.  As a side effect of this function, all unreffed
2340  * iters will be invalid.
2341  **/
2342 void
2343 gtk_tree_model_sort_clear_cache (GtkTreeModelSort *tree_model_sort)
2344 {
2345   g_return_if_fail (GTK_IS_TREE_MODEL_SORT (tree_model_sort));
2346
2347   if (tree_model_sort->zero_ref_count)
2348     gtk_tree_model_sort_clear_cache_helper (tree_model_sort, (SortLevel *)tree_model_sort->root);
2349 }
2350
2351 static gboolean
2352 gtk_tree_model_sort_iter_is_valid_helper (GtkTreeIter *iter,
2353                                           SortLevel   *level)
2354 {
2355   gint i;
2356
2357   for (i = 0; i < level->array->len; i++)
2358     {
2359       SortElt *elt = &g_array_index (level->array, SortElt, i);
2360
2361       if (iter->user_data == level && iter->user_data2 == elt)
2362         return TRUE;
2363
2364       if (elt->children)
2365         if (gtk_tree_model_sort_iter_is_valid_helper (iter, elt->children))
2366           return TRUE;
2367     }
2368
2369   return FALSE;
2370 }
2371
2372 /**
2373  * gtk_tree_model_sort_iter_is_valid:
2374  * @tree_model_sort: A #GtkTreeModelSort.
2375  * @iter: A #GtkTreeIter.
2376  *
2377  * WARNING: This function is slow. Only use it for debugging and/or testing
2378  * purposes.
2379  *
2380  * Checks if the given iter is a valid iter for this #GtkTreeModelSort.
2381  *
2382  * Return value: %TRUE if the iter is valid, %FALSE if the iter is invalid.
2383  *
2384  * Since: 2.2
2385  **/
2386 gboolean
2387 gtk_tree_model_sort_iter_is_valid (GtkTreeModelSort *tree_model_sort,
2388                                    GtkTreeIter      *iter)
2389 {
2390   g_return_val_if_fail (GTK_IS_TREE_MODEL_SORT (tree_model_sort), FALSE);
2391   g_return_val_if_fail (iter != NULL, FALSE);
2392
2393   if (!VALID_ITER (iter, tree_model_sort))
2394     return FALSE;
2395
2396   return gtk_tree_model_sort_iter_is_valid_helper (iter,
2397                                                    tree_model_sort->root);
2398 }