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