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