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           tmppath = gtk_tree_model_sort_elt_get_path (level, elt);
 599           if (tmppath)
 600             {
 601               gtk_tree_model_get_iter (GTK_TREE_MODEL (data), &tmpiter,
 602                                        tmppath);
 603               gtk_tree_model_row_has_child_toggled (GTK_TREE_MODEL (data),
 604                                                     tmppath,
 605                                                     &tmpiter);
 606               gtk_tree_path_free (tmppath);
 607             }
 608
 609           /* not covering this signal */
 610           goto done;
 611         }
 612
 613       level = elt->children;
 614       parent_level = level;
 615       i++;
 616     }
 617
 618   if (!parent_level)
 619     goto done;
 620
 621   if (!gtk_tree_model_sort_insert_value (tree_model_sort,
 622                                          parent_level,
 623                                          s_path,
 624                                          &real_s_iter))
 625     goto done;
 626
 627  done_and_submit:
 628   path = gtk_real_tree_model_sort_convert_child_path_to_path (tree_model_sort,
 629                                                               s_path,
 630                                                               FALSE);
 631
 632   if (!path)
 633     return;
 634
 635   gtk_tree_model_sort_increment_stamp (tree_model_sort);
 636
 637   gtk_tree_model_get_iter (GTK_TREE_MODEL (data), &iter, path);
 638   gtk_tree_model_row_inserted (GTK_TREE_MODEL (data), path, &iter);
 639   gtk_tree_path_free (path);
 640
 641  done:
 642   if (free_s_path)
 643     gtk_tree_path_free (s_path);
 644
 645   return;
 646 }
 647
 648 static void
 649 gtk_tree_model_sort_row_has_child_toggled (GtkTreeModel *s_model,
 650                                            GtkTreePath  *s_path,
 651                                            GtkTreeIter  *s_iter,
 652                                            gpointer      data)
 653 {
 654   GtkTreeModelSort *tree_model_sort = GTK_TREE_MODEL_SORT (data);
 655   GtkTreePath *path;
 656   GtkTreeIter iter;
 657
 658   g_return_if_fail (s_path != NULL && s_iter != NULL);
 659
 660   path = gtk_real_tree_model_sort_convert_child_path_to_path (tree_model_sort, s_path, FALSE);
 661   if (path == NULL)
 662     return;
 663
 664   gtk_tree_model_get_iter (GTK_TREE_MODEL (data), &iter, path);
 665   gtk_tree_model_row_has_child_toggled (GTK_TREE_MODEL (data), path, &iter);
 666
 667   gtk_tree_path_free (path);
 668 }
 669
 670 /* FIXME: I still have doubts if this works */
 671 static void
 672 gtk_tree_model_sort_row_deleted (GtkTreeModel *s_model,
 673                                  GtkTreePath  *s_path,
 674                                  gpointer      data)
 675 {
 676   GtkTreeModelSort *tree_model_sort = GTK_TREE_MODEL_SORT (data);
 677   GtkTreePath *path = NULL;
 678   SortElt *elt;
 679   SortLevel *level;
 680   GtkTreeIter iter;
 681   gint offset;
 682   gint i;
 683
 684   g_return_if_fail (s_path != NULL);
 685
 686   path = gtk_real_tree_model_sort_convert_child_path_to_path (tree_model_sort, s_path, FALSE);
 687   if (path == NULL)
 688     return;
 689
 690   gtk_tree_model_get_iter (GTK_TREE_MODEL (data), &iter, path);
 691
 692   level = SORT_LEVEL (iter.user_data);
 693   elt = SORT_ELT (iter.user_data2);
 694   offset = elt->offset;
 695
 696   /* we _need_ to emit ::row_deleted before we start unreffing the node
 697    * itself. This is because of the row refs, which start unreffing nodes
 698    * when we emit ::row_deleted
 699    */
 700   gtk_tree_model_row_deleted (GTK_TREE_MODEL (data), path);
 701
 702   gtk_tree_model_get_iter (GTK_TREE_MODEL (data), &iter, path);
 703
 704   while (elt->ref_count > 0)
 705     gtk_tree_model_sort_real_unref_node (GTK_TREE_MODEL (data), &iter, FALSE);
 706
 707   if (level->ref_count == 0 && level != tree_model_sort->root)
 708     {
 709       /* This will prune the level, so I can just emit the signal and not worry
 710        * about cleaning this level up. */
 711       gtk_tree_model_sort_increment_stamp (tree_model_sort);
 712       gtk_tree_path_free (path);
 713       return;
 714     }
 715
 716   gtk_tree_model_sort_increment_stamp (tree_model_sort);
 717
 718   /* Remove the row */
 719   for (i = 0; i < level->array->len; i++)
 720     if (elt->offset == g_array_index (level->array, SortElt, i).offset)
 721       break;
 722
 723   g_array_remove_index (level->array, i);
 724
 725   /* update all offsets */
 726   for (i = 0; i < level->array->len; i++)
 727     {
 728       elt = & (g_array_index (level->array, SortElt, i));
 729       if (elt->offset > offset)
 730         elt->offset--;
 731       if (elt->children)
 732         elt->children->parent_elt = elt;
 733     }
 734
 735   gtk_tree_path_free (path);
 736 }
 737
 738 static void
 739 gtk_tree_model_sort_rows_reordered (GtkTreeModel *s_model,
 740                                     GtkTreePath  *s_path,
 741                                     GtkTreeIter  *s_iter,
 742                                     gint         *new_order,
 743                                     gpointer      data)
 744 {
 745   SortElt *elt;
 746   SortLevel *level;
 747   GtkTreeIter iter;
 748   gint *tmp_array;
 749   int i, j;
 750   GtkTreePath *path;
 751   GtkTreeModelSort *tree_model_sort = GTK_TREE_MODEL_SORT (data);
 752
 753   g_return_if_fail (new_order != NULL);
 754
 755   if (s_path == NULL || gtk_tree_path_get_indices (s_path) == NULL)
 756     {
 757       if (tree_model_sort->root == NULL)
 758         return;
 759       path = gtk_tree_path_new ();
 760       level = SORT_LEVEL (tree_model_sort->root);
 761     }
 762   else
 763     {
 764       path = gtk_real_tree_model_sort_convert_child_path_to_path (tree_model_sort, s_path, FALSE);
 765       if (path == NULL)
 766         return;
 767       gtk_tree_model_get_iter (GTK_TREE_MODEL (data), &iter, path);
 768
 769       level = SORT_LEVEL (iter.user_data);
 770       elt = SORT_ELT (iter.user_data2);
 771
 772       if (!elt->children)
 773         {
 774           gtk_tree_path_free (path);
 775           return;
 776         }
 777
 778       level = elt->children;
 779     }
 780
 781   if (level->array->len < 2)
 782     {
 783       gtk_tree_path_free (path);
 784       return;
 785     }
 786
 787   tmp_array = g_new (int, level->array->len);
 788   for (i = 0; i < level->array->len; i++)
 789     {
 790       for (j = 0; j < level->array->len; j++)
 791         {
 792           if (g_array_index (level->array, SortElt, i).offset == new_order[j])
 793             tmp_array[i] = j;
 794         }
 795     }
 796
 797   for (i = 0; i < level->array->len; i++)
 798     g_array_index (level->array, SortElt, i).offset = tmp_array[i];
 799   g_free (tmp_array);
 800
 801   if (tree_model_sort->sort_column_id == GTK_TREE_SORTABLE_DEFAULT_SORT_COLUMN_ID &&
 802       tree_model_sort->default_sort_func == NO_SORT_FUNC)
 803     {
 804
 805       gtk_tree_model_sort_sort_level (tree_model_sort, level,
 806                                       FALSE, FALSE);
 807
 808       if (gtk_tree_path_get_depth (path))
 809         {
 810           gtk_tree_model_get_iter (GTK_TREE_MODEL (tree_model_sort),
 811                                    &iter,
 812                                    path);
 813           gtk_tree_model_rows_reordered (GTK_TREE_MODEL (tree_model_sort),
 814                                          path, &iter, new_order);
 815         }
 816       else
 817         {
 818           gtk_tree_model_rows_reordered (GTK_TREE_MODEL (tree_model_sort),
 819                                          path, NULL, new_order);
 820         }
 821     }
 822
 823   gtk_tree_path_free (path);
 824 }
 825
 826 /* Fulfill our model requirements */
 827 static guint
 828 gtk_tree_model_sort_get_flags (GtkTreeModel *tree_model)
 829 {
 830   g_return_val_if_fail (GTK_IS_TREE_MODEL_SORT (tree_model), 0);
 831
 832   return 0;
 833 }
 834
 835 static gint
 836 gtk_tree_model_sort_get_n_columns (GtkTreeModel *tree_model)
 837 {
 838   GtkTreeModelSort *tree_model_sort = (GtkTreeModelSort *) tree_model;
 839
 840   g_return_val_if_fail (GTK_IS_TREE_MODEL_SORT (tree_model), 0);
 841
 842   if (tree_model_sort->child_model == 0)
 843     return 0;
 844
 845   return gtk_tree_model_get_n_columns (tree_model_sort->child_model);
 846 }
 847
 848 static GType
 849 gtk_tree_model_sort_get_column_type (GtkTreeModel *tree_model,
 850                                      gint          index)
 851 {
 852   g_return_val_if_fail (GTK_IS_TREE_MODEL_SORT (tree_model), G_TYPE_INVALID);
 853   g_return_val_if_fail (GTK_TREE_MODEL_SORT (tree_model)->child_model != NULL, G_TYPE_INVALID);
 854
 855   return gtk_tree_model_get_column_type (GTK_TREE_MODEL_SORT (tree_model)->child_model, index);
 856 }
 857
 858 static gboolean
 859 gtk_tree_model_sort_get_iter (GtkTreeModel *tree_model,
 860                               GtkTreeIter  *iter,
 861                               GtkTreePath  *path)
 862 {
 863   GtkTreeModelSort *tree_model_sort;
 864   gint *indices;
 865   SortLevel *level;
 866   gint depth, i;
 867
 868   g_return_val_if_fail (GTK_IS_TREE_MODEL_SORT (tree_model), FALSE);
 869   g_return_val_if_fail (GTK_TREE_MODEL_SORT (tree_model)->child_model != NULL, FALSE);
 870
 871   tree_model_sort = (GtkTreeModelSort *) tree_model;
 872   indices = gtk_tree_path_get_indices (path);
 873
 874   if (tree_model_sort->root == NULL)
 875     gtk_tree_model_sort_build_level (tree_model_sort, NULL, NULL);
 876   level = SORT_LEVEL (tree_model_sort->root);
 877
 878   depth = gtk_tree_path_get_depth (path);
 879   if (depth == 0)
 880     return FALSE;
 881
 882   for (i = 0; i < depth - 1; i++)
 883     {
 884       if ((level == NULL) ||
 885           (level->array->len < indices[i]))
 886         return FALSE;
 887
 888       if (g_array_index (level->array, SortElt, indices[i]).children == NULL)
 889         gtk_tree_model_sort_build_level (tree_model_sort, level, &g_array_index (level->array, SortElt, indices[i]));
 890       level = g_array_index (level->array, SortElt, indices[i]).children;
 891     }
 892
 893   if (level == NULL)
 894     return FALSE;
 895   iter->stamp = tree_model_sort->stamp;
 896   iter->user_data = level;
 897   iter->user_data2 = &g_array_index (level->array, SortElt, indices[depth - 1]);
 898
 899   return TRUE;
 900 }
 901
 902 static GtkTreePath *
 903 gtk_tree_model_sort_get_path (GtkTreeModel *tree_model,
 904                               GtkTreeIter  *iter)
 905 {
 906   GtkTreePath *retval;
 907   SortLevel *level;
 908   SortElt *elt;
 909
 910   g_return_val_if_fail (GTK_IS_TREE_MODEL_SORT (tree_model), NULL);
 911   g_return_val_if_fail (GTK_TREE_MODEL_SORT (tree_model)->child_model != NULL, NULL);
 912   g_return_val_if_fail (GTK_TREE_MODEL_SORT (tree_model)->stamp == iter->stamp, NULL);
 913
 914   retval = gtk_tree_path_new ();
 915   level = iter->user_data;
 916   elt = iter->user_data2;
 917   while (level != NULL)
 918     {
 919       gtk_tree_path_prepend_index (retval, elt - (SortElt *)level->array->data);
 920
 921       elt = level->parent_elt;
 922       level = level->parent_level;
 923     }
 924
 925   return retval;
 926 }
 927
 928 static void
 929 gtk_tree_model_sort_get_value (GtkTreeModel *tree_model,
 930                                GtkTreeIter  *iter,
 931                                gint          column,
 932                                GValue       *value)
 933 {
 934   GtkTreeIter child_iter;
 935
 936   g_return_if_fail (GTK_IS_TREE_MODEL_SORT (tree_model));
 937   g_return_if_fail (GTK_TREE_MODEL_SORT (tree_model)->child_model != NULL);
 938   g_return_if_fail (GTK_TREE_MODEL_SORT (tree_model)->stamp == iter->stamp);
 939
 940   GET_CHILD_ITER (tree_model, &child_iter, iter);
 941   gtk_tree_model_get_value (GTK_TREE_MODEL_SORT (tree_model)->child_model,
 942                             &child_iter, column, value);
 943 }
 944
 945 static gboolean
 946 gtk_tree_model_sort_iter_next (GtkTreeModel *tree_model,
 947                                GtkTreeIter  *iter)
 948 {
 949   SortLevel *level;
 950   SortElt *elt;
 951
 952   g_return_val_if_fail (GTK_IS_TREE_MODEL_SORT (tree_model), FALSE);
 953   g_return_val_if_fail (GTK_TREE_MODEL_SORT (tree_model)->child_model != NULL, FALSE);
 954   g_return_val_if_fail (GTK_TREE_MODEL_SORT (tree_model)->stamp == iter->stamp, FALSE);
 955
 956   level = iter->user_data;
 957   elt = iter->user_data2;
 958
 959   if (elt - (SortElt *)level->array->data >= level->array->len - 1)
 960     {
 961       iter->stamp = 0;
 962       return FALSE;
 963     }
 964   iter->user_data2 = elt + 1;
 965
 966   return TRUE;
 967 }
 968
 969 static gboolean
 970 gtk_tree_model_sort_iter_children (GtkTreeModel *tree_model,
 971                                    GtkTreeIter  *iter,
 972                                    GtkTreeIter  *parent)
 973 {
 974   GtkTreeModelSort *tree_model_sort = (GtkTreeModelSort *) tree_model;
 975   SortLevel *level;
 976
 977   iter->stamp = 0;
 978   g_return_val_if_fail (GTK_IS_TREE_MODEL_SORT (tree_model), FALSE);
 979   g_return_val_if_fail (tree_model_sort->child_model != NULL, FALSE);
 980   if (parent) g_return_val_if_fail (tree_model_sort->stamp == parent->stamp, FALSE);
 981
 982   if (parent == NULL)
 983     {
 984       if (tree_model_sort->root == NULL)
 985         gtk_tree_model_sort_build_level (tree_model_sort, NULL, NULL);
 986       if (tree_model_sort->root == NULL)
 987         return FALSE;
 988
 989       level = tree_model_sort->root;
 990       iter->stamp = tree_model_sort->stamp;
 991       iter->user_data = level;
 992       iter->user_data2 = level->array->data;
 993     }
 994   else
 995     {
 996       if (((SortElt *)parent->user_data2)->children == NULL)
 997         gtk_tree_model_sort_build_level (tree_model_sort,
 998                                          (SortLevel *)parent->user_data,
 999                                          (SortElt *)parent->user_data2);
1000       if (((SortElt *)parent->user_data2)->children == NULL)
1001         return FALSE;
1002       iter->stamp = tree_model_sort->stamp;
1003       iter->user_data = ((SortElt *)parent->user_data2)->children;
1004       iter->user_data2 = ((SortLevel *)iter->user_data)->array->data;
1005     }
1006
1007   return TRUE;
1008 }
1009
1010 static gboolean
1011 gtk_tree_model_sort_iter_has_child (GtkTreeModel *tree_model,
1012                                     GtkTreeIter  *iter)
1013 {
1014   GtkTreeIter child_iter;
1015
1016   g_return_val_if_fail (GTK_IS_TREE_MODEL_SORT (tree_model), FALSE);
1017   g_return_val_if_fail (GTK_TREE_MODEL_SORT (tree_model)->child_model != NULL, FALSE);
1018   g_return_val_if_fail (GTK_TREE_MODEL_SORT (tree_model)->stamp == iter->stamp, FALSE);
1019
1020   GET_CHILD_ITER (tree_model, &child_iter, iter);
1021
1022   return gtk_tree_model_iter_has_child (GTK_TREE_MODEL_SORT (tree_model)->child_model, &child_iter);
1023 }
1024
1025 static gint
1026 gtk_tree_model_sort_iter_n_children (GtkTreeModel *tree_model,
1027                                      GtkTreeIter  *iter)
1028 {
1029   GtkTreeIter child_iter;
1030
1031   g_return_val_if_fail (GTK_IS_TREE_MODEL_SORT (tree_model), 0);
1032   g_return_val_if_fail (GTK_TREE_MODEL_SORT (tree_model)->child_model != NULL, 0);
1033   if (iter) g_return_val_if_fail (GTK_TREE_MODEL_SORT (tree_model)->stamp == iter->stamp, 0);
1034
1035   if (iter == NULL)
1036     return gtk_tree_model_iter_n_children (GTK_TREE_MODEL_SORT (tree_model)->child_model, NULL);
1037
1038   GET_CHILD_ITER (tree_model, &child_iter, iter);
1039
1040   return gtk_tree_model_iter_n_children (GTK_TREE_MODEL_SORT (tree_model)->child_model, &child_iter);
1041 }
1042
1043 static gboolean
1044 gtk_tree_model_sort_iter_nth_child (GtkTreeModel *tree_model,
1045                                     GtkTreeIter  *iter,
1046                                     GtkTreeIter  *parent,
1047                                     gint          n)
1048 {
1049   SortLevel *level;
1050   /* We have this for the iter == parent case */
1051   GtkTreeIter children;
1052
1053   g_return_val_if_fail (GTK_IS_TREE_MODEL_SORT (tree_model), FALSE);
1054   if (parent) g_return_val_if_fail (GTK_TREE_MODEL_SORT (tree_model)->stamp == parent->stamp, FALSE);
1055
1056   /* Use this instead of has_child to force us to build the level, if needed */
1057   if (gtk_tree_model_sort_iter_children (tree_model, &children, parent) == FALSE)
1058     {
1059       iter->stamp = 0;
1060       return FALSE;
1061     }
1062
1063   level = children.user_data;
1064   if (n >= level->array->len)
1065     {
1066       iter->stamp = 0;
1067       return FALSE;
1068     }
1069
1070   iter->stamp = GTK_TREE_MODEL_SORT (tree_model)->stamp;
1071   iter->user_data = level;
1072   iter->user_data2 = &g_array_index (level->array, SortElt, n);
1073
1074   return TRUE;
1075 }
1076
1077 static gboolean
1078 gtk_tree_model_sort_iter_parent (GtkTreeModel *tree_model,
1079                                  GtkTreeIter  *iter,
1080                                  GtkTreeIter  *child)
1081 {
1082   SortLevel *level;
1083
1084   iter->stamp = 0;
1085   g_return_val_if_fail (GTK_IS_TREE_MODEL_SORT (tree_model), FALSE);
1086   g_return_val_if_fail (GTK_TREE_MODEL_SORT (tree_model)->child_model != NULL, FALSE);
1087   g_return_val_if_fail (GTK_TREE_MODEL_SORT (tree_model)->stamp == child->stamp, FALSE);
1088
1089   level = child->user_data;
1090
1091   if (level->parent_level)
1092     {
1093       iter->stamp = GTK_TREE_MODEL_SORT (tree_model)->stamp;
1094       iter->user_data = level->parent_level;
1095       iter->user_data2 = level->parent_elt;
1096
1097       return TRUE;
1098     }
1099   return FALSE;
1100 }
1101
1102 static void
1103 gtk_tree_model_sort_ref_node (GtkTreeModel *tree_model,
1104                               GtkTreeIter  *iter)
1105 {
1106   GtkTreeModelSort *tree_model_sort = (GtkTreeModelSort *) tree_model;
1107   GtkTreeIter child_iter;
1108   SortLevel *level;
1109   SortElt *elt;
1110
1111   g_return_if_fail (GTK_IS_TREE_MODEL_SORT (tree_model));
1112   g_return_if_fail (GTK_TREE_MODEL_SORT (tree_model)->child_model != NULL);
1113   g_return_if_fail (GTK_TREE_MODEL_SORT (tree_model)->stamp == iter->stamp);
1114
1115   GET_CHILD_ITER (tree_model, &child_iter, iter);
1116
1117   gtk_tree_model_ref_node (GTK_TREE_MODEL_SORT (tree_model)->child_model, &child_iter);
1118
1119   level = iter->user_data;
1120   elt = iter->user_data2;
1121
1122   elt->ref_count++;
1123   level->ref_count++;
1124   if (level->ref_count == 1)
1125     {
1126       SortLevel *parent_level = level->parent_level;
1127       SortElt *parent_elt = level->parent_elt;
1128       /* We were at zero -- time to decrement the zero_ref_count val */
1129       do
1130         {
1131           if (parent_elt)
1132             parent_elt->zero_ref_count--;
1133           else
1134             tree_model_sort->zero_ref_count--;
1135
1136           if (parent_level)
1137             {
1138               parent_elt = parent_level->parent_elt;
1139               parent_level = parent_level->parent_level;
1140             }
1141         }
1142       while (parent_level);
1143     }
1144 }
1145
1146 static void
1147 gtk_tree_model_sort_real_unref_node (GtkTreeModel *tree_model,
1148                                      GtkTreeIter  *iter,
1149                                      gboolean      propagate_unref)
1150 {
1151   GtkTreeModelSort *tree_model_sort = (GtkTreeModelSort *) tree_model;
1152   GtkTreeIter child_iter;
1153   SortLevel *level;
1154   SortElt *elt;
1155
1156   g_return_if_fail (GTK_IS_TREE_MODEL_SORT (tree_model));
1157   g_return_if_fail (GTK_TREE_MODEL_SORT (tree_model)->child_model != NULL);
1158   g_return_if_fail (GTK_TREE_MODEL_SORT (tree_model)->stamp == iter->stamp);
1159
1160   GET_CHILD_ITER (tree_model, &child_iter, iter);
1161
1162   if (propagate_unref)
1163     gtk_tree_model_unref_node (GTK_TREE_MODEL_SORT (tree_model)->child_model, &child_iter);
1164
1165   level = iter->user_data;
1166   elt = iter->user_data2;
1167
1168   g_return_if_fail (elt->ref_count > 0);
1169
1170   elt->ref_count--;
1171   level->ref_count--;
1172   if (level->ref_count == 0)
1173     {
1174       SortLevel *parent_level = level->parent_level;
1175       SortElt *parent_elt = level->parent_elt;
1176
1177       /* We are at zero -- time to increment the zero_ref_count val */
1178       while (parent_level)
1179         {
1180           parent_elt->zero_ref_count++;
1181
1182           parent_elt = parent_level->parent_elt;
1183           parent_level = parent_level->parent_level;
1184         }
1185       tree_model_sort->zero_ref_count++;
1186     }
1187 }
1188
1189 static void
1190 gtk_tree_model_sort_unref_node (GtkTreeModel *tree_model,
1191                                 GtkTreeIter  *iter)
1192 {
1193   gtk_tree_model_sort_real_unref_node (tree_model, iter, TRUE);
1194 }
1195
1196 /* Sortable interface */
1197 static gboolean
1198 gtk_tree_model_sort_get_sort_column_id (GtkTreeSortable *sortable,
1199                                         gint            *sort_column_id,
1200                                         GtkSortType     *order)
1201 {
1202   GtkTreeModelSort *tree_model_sort = (GtkTreeModelSort *)sortable;
1203
1204   g_return_val_if_fail (GTK_IS_TREE_MODEL_SORT (sortable), FALSE);
1205
1206   if (tree_model_sort->sort_column_id == GTK_TREE_SORTABLE_DEFAULT_SORT_COLUMN_ID)
1207     return FALSE;
1208
1209   if (sort_column_id)
1210     *sort_column_id = tree_model_sort->sort_column_id;
1211   if (order)
1212     *order = tree_model_sort->order;
1213
1214   return TRUE;
1215 }
1216
1217 static void
1218 gtk_tree_model_sort_set_sort_column_id (GtkTreeSortable *sortable,
1219                                         gint             sort_column_id,
1220                                         GtkSortType      order)
1221 {
1222   GtkTreeModelSort *tree_model_sort = (GtkTreeModelSort *)sortable;
1223
1224   g_return_if_fail (GTK_IS_TREE_MODEL_SORT (sortable));
1225
1226   if (sort_column_id != GTK_TREE_SORTABLE_DEFAULT_SORT_COLUMN_ID)
1227     {
1228       GtkTreeDataSortHeader *header = NULL;
1229
1230       header = _gtk_tree_data_list_get_header (tree_model_sort->sort_list,
1231                                                sort_column_id);
1232
1233       /* we want to make sure that we have a function */
1234       g_return_if_fail (header != NULL);
1235       g_return_if_fail (header->func != NULL);
1236     }
1237   else
1238     g_return_if_fail (tree_model_sort->default_sort_func != NULL);
1239
1240   if (tree_model_sort->sort_column_id == sort_column_id)
1241     {
1242       if (sort_column_id != GTK_TREE_SORTABLE_DEFAULT_SORT_COLUMN_ID)
1243         {
1244           if (tree_model_sort->order == order)
1245             return;
1246         }
1247       else
1248         return;
1249     }
1250
1251   tree_model_sort->sort_column_id = sort_column_id;
1252   tree_model_sort->order = order;
1253
1254   gtk_tree_model_sort_sort (tree_model_sort);
1255   gtk_tree_sortable_sort_column_changed (sortable);
1256 }
1257
1258 static void
1259 gtk_tree_model_sort_set_sort_func (GtkTreeSortable        *sortable,
1260                                    gint                    sort_column_id,
1261                                    GtkTreeIterCompareFunc  func,
1262                                    gpointer                data,
1263                                    GtkDestroyNotify        destroy)
1264 {
1265   GtkTreeModelSort *tree_model_sort = (GtkTreeModelSort *) sortable;
1266   GtkTreeDataSortHeader *header = NULL;
1267   GList *list;
1268
1269   g_return_if_fail (GTK_IS_TREE_MODEL_SORT (sortable));
1270   g_return_if_fail (func != NULL);
1271
1272   for (list = tree_model_sort->sort_list; list; list = list->next)
1273     {
1274       header = (GtkTreeDataSortHeader *) list->data;
1275
1276       if (header->sort_column_id == sort_column_id)
1277         break;
1278     }
1279
1280   if (header == NULL)
1281     {
1282       header = g_new0 (GtkTreeDataSortHeader, 1);
1283       header->sort_column_id = sort_column_id;
1284       tree_model_sort->sort_list = g_list_append (tree_model_sort->sort_list,
1285                                                   header);
1286     }
1287
1288   if (header->destroy)
1289     {
1290       GtkDestroyNotify d = header->destroy;
1291
1292       header->destroy = NULL;
1293       d (header->data);
1294     }
1295
1296   header->func = func;
1297   header->data = data;
1298   header->destroy = destroy;
1299 }
1300
1301 static void
1302 gtk_tree_model_sort_set_default_sort_func (GtkTreeSortable        *sortable,
1303                                            GtkTreeIterCompareFunc  func,
1304                                            gpointer                data,
1305                                            GtkDestroyNotify        destroy)
1306 {
1307   GtkTreeModelSort *tree_model_sort = (GtkTreeModelSort *)sortable;
1308
1309   g_return_if_fail (GTK_IS_TREE_MODEL_SORT (sortable));
1310
1311   if (tree_model_sort->default_sort_destroy)
1312     {
1313       GtkDestroyNotify d = tree_model_sort->default_sort_destroy;
1314
1315       tree_model_sort->default_sort_destroy = NULL;
1316       d (tree_model_sort->default_sort_data);
1317     }
1318
1319   tree_model_sort->default_sort_func = func;
1320   tree_model_sort->default_sort_data = data;
1321   tree_model_sort->default_sort_destroy = destroy;
1322 }
1323
1324 static gboolean
1325 gtk_tree_model_sort_has_default_sort_func (GtkTreeSortable *sortable)
1326 {
1327   GtkTreeModelSort *tree_model_sort = (GtkTreeModelSort *)sortable;
1328
1329   g_return_val_if_fail (GTK_IS_TREE_MODEL_SORT (sortable), FALSE);
1330
1331   return (tree_model_sort->default_sort_func != NULL);
1332 }
1333
1334 /* sorting code - private */
1335 static gint
1336 gtk_tree_model_sort_compare_func (gconstpointer a,
1337                                   gconstpointer b,
1338                                   gpointer      user_data)
1339 {
1340   SortData *data = (SortData *)user_data;
1341   GtkTreeModelSort *tree_model_sort = data->tree_model_sort;
1342   SortTuple *sa = (SortTuple *)a;
1343   SortTuple *sb = (SortTuple *)b;
1344
1345   GtkTreeIter iter_a, iter_b;
1346   gint retval;
1347
1348   /* shortcut, if we've the same offsets here, they should be equal */
1349   if (sa->offset == sb->offset)
1350     return 0;
1351
1352   if (GTK_TREE_MODEL_SORT_CACHE_CHILD_ITERS (tree_model_sort))
1353     {
1354       iter_a = sa->elt->iter;
1355       iter_b = sb->elt->iter;
1356     }
1357   else
1358     {
1359       data->parent_path_indices [data->parent_path_depth-1] = sa->elt->offset;
1360       gtk_tree_model_get_iter (GTK_TREE_MODEL (tree_model_sort->child_model), &iter_a, data->parent_path);
1361       data->parent_path_indices [data->parent_path_depth-1] = sb->elt->offset;
1362       gtk_tree_model_get_iter (GTK_TREE_MODEL (tree_model_sort->child_model), &iter_b, data->parent_path);
1363     }
1364
1365   retval = (* data->sort_func) (GTK_TREE_MODEL (tree_model_sort->child_model),
1366                                 &iter_a, &iter_b,
1367                                 data->sort_data);
1368
1369   if (tree_model_sort->order == GTK_SORT_DESCENDING)
1370     {
1371       if (retval > 0)
1372         retval = -1;
1373       else if (retval < 0)
1374         retval = 1;
1375     }
1376
1377   return retval;
1378 }
1379
1380 static gint
1381 gtk_tree_model_sort_offset_compare_func (gconstpointer a,
1382                                          gconstpointer b,
1383                                          gpointer      user_data)
1384 {
1385   gint retval;
1386
1387   SortTuple *sa = (SortTuple *)a;
1388   SortTuple *sb = (SortTuple *)b;
1389
1390   SortData *data = (SortData *)user_data;
1391
1392   if (sa->elt->offset < sb->elt->offset)
1393     retval = -1;
1394   else if (sa->elt->offset > sb->elt->offset)
1395     retval = 1;
1396   else
1397     retval = 0;
1398
1399   if (data->tree_model_sort->order == GTK_SORT_DESCENDING)
1400     {
1401       if (retval > 0)
1402         retval = -1;
1403       else if (retval < 0)
1404         retval = 1;
1405     }
1406
1407   return retval;
1408 }
1409
1410 static void
1411 gtk_tree_model_sort_sort_level (GtkTreeModelSort *tree_model_sort,
1412                                 SortLevel        *level,
1413                                 gboolean          recurse,
1414                                 gboolean          emit_reordered)
1415 {
1416   gint i;
1417   GArray *sort_array;
1418   GArray *new_array;
1419   gint *new_order;
1420
1421   GtkTreeIter iter;
1422   GtkTreePath *path;
1423
1424   SortData data;
1425
1426   g_return_if_fail (GTK_IS_TREE_MODEL_SORT (tree_model_sort));
1427   g_return_if_fail (level != NULL);
1428
1429   if (level->array->len < 1 && !((SortElt *)level->array->data)->children)
1430     return;
1431
1432   /* Set up data */
1433   data.tree_model_sort = tree_model_sort;
1434   if (level->parent_elt)
1435     {
1436       data.parent_path = gtk_tree_model_sort_elt_get_path (level->parent_level,
1437                                                            level->parent_elt);
1438       gtk_tree_path_append_index (data.parent_path, 0);
1439     }
1440   else
1441     {
1442       data.parent_path = gtk_tree_path_new_first ();
1443     }
1444   data.parent_path_depth = gtk_tree_path_get_depth (data.parent_path);
1445   data.parent_path_indices = gtk_tree_path_get_indices (data.parent_path);
1446
1447   /* make the array to be sorted */
1448   sort_array = g_array_sized_new (FALSE, FALSE, sizeof (SortTuple), level->array->len);
1449   for (i = 0; i < level->array->len; i++)
1450     {
1451       SortTuple tuple;
1452
1453       tuple.elt = &g_array_index (level->array, SortElt, i);
1454       tuple.offset = i;
1455
1456       g_array_append_val (sort_array, tuple);
1457     }
1458
1459     if (tree_model_sort->sort_column_id != GTK_TREE_SORTABLE_DEFAULT_SORT_COLUMN_ID)
1460       {
1461         GtkTreeDataSortHeader *header = NULL;
1462
1463         header = _gtk_tree_data_list_get_header (tree_model_sort->sort_list,
1464                                                  tree_model_sort->sort_column_id);
1465
1466         g_return_if_fail (header != NULL);
1467         g_return_if_fail (header->func != NULL);
1468
1469         data.sort_func = header->func;
1470         data.sort_data = header->data;
1471       }
1472     else
1473       {
1474         /* absolutely SHOULD NOT happen: */
1475         g_return_if_fail (tree_model_sort->default_sort_func != NULL);
1476
1477         data.sort_func = tree_model_sort->default_sort_func;
1478         data.sort_data = tree_model_sort->default_sort_data;
1479       }
1480
1481   if (data.sort_func == NO_SORT_FUNC)
1482     g_array_sort_with_data (sort_array,
1483                             gtk_tree_model_sort_offset_compare_func,
1484                             &data);
1485   else
1486     g_array_sort_with_data (sort_array,
1487                             gtk_tree_model_sort_compare_func,
1488                             &data);
1489
1490   gtk_tree_path_free (data.parent_path);
1491
1492   new_array = g_array_sized_new (FALSE, FALSE, sizeof (SortElt), level->array->len);
1493   new_order = g_new (gint, level->array->len);
1494
1495   for (i = 0; i < level->array->len; i++)
1496     {
1497       SortElt *elt;
1498
1499       elt = g_array_index (sort_array, SortTuple, i).elt;
1500       new_order[i] = g_array_index (sort_array, SortTuple, i).offset;
1501
1502       g_array_append_val (new_array, *elt);
1503       elt = &g_array_index (new_array, SortElt, i);
1504       if (elt->children)
1505         elt->children->parent_elt = elt;
1506     }
1507
1508   g_array_free (level->array, TRUE);
1509   level->array = new_array;
1510   g_array_free (sort_array, TRUE);
1511
1512   if (emit_reordered)
1513     {
1514       if (level->parent_elt)
1515         {
1516           iter.stamp = tree_model_sort->stamp;
1517           iter.user_data = level->parent_level;
1518           iter.user_data2 = level->parent_elt;
1519
1520           path = gtk_tree_model_get_path (GTK_TREE_MODEL (tree_model_sort),
1521                                           &iter);
1522
1523           gtk_tree_model_rows_reordered (GTK_TREE_MODEL (tree_model_sort), path,
1524                                          &iter, new_order);
1525         }
1526       else
1527         {
1528           /* toplevel list */
1529           path = gtk_tree_path_new ();
1530           gtk_tree_model_rows_reordered (GTK_TREE_MODEL (tree_model_sort), path,
1531                                          NULL, new_order);
1532         }
1533
1534       gtk_tree_path_free (path);
1535     }
1536
1537   gtk_tree_model_sort_increment_stamp (tree_model_sort);
1538
1539   /* recurse, if possible */
1540   if (recurse)
1541     {
1542       for (i = 0; i < level->array->len; i++)
1543         {
1544           SortElt *elt = &g_array_index (level->array, SortElt, i);
1545
1546           if (elt->children)
1547             gtk_tree_model_sort_sort_level (tree_model_sort,
1548                                             elt->children,
1549                                             TRUE, emit_reordered);
1550         }
1551     }
1552
1553   g_free (new_order);
1554 }
1555
1556 static void
1557 gtk_tree_model_sort_sort (GtkTreeModelSort *tree_model_sort)
1558 {
1559   g_return_if_fail (GTK_IS_TREE_MODEL_SORT (tree_model_sort));
1560
1561   if (!tree_model_sort->root)
1562     return;
1563
1564   if (tree_model_sort->sort_column_id != GTK_TREE_SORTABLE_DEFAULT_SORT_COLUMN_ID)
1565     {
1566       GtkTreeDataSortHeader *header = NULL;
1567
1568       header = _gtk_tree_data_list_get_header (tree_model_sort->sort_list,
1569                                                tree_model_sort->sort_column_id);
1570
1571       /* we want to make sure that we have a function */
1572       g_return_if_fail (header != NULL);
1573       g_return_if_fail (header->func != NULL);
1574     }
1575   else
1576     g_return_if_fail (tree_model_sort->default_sort_func != NULL);
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   if (tree_model_sort->sort_column_id != GTK_TREE_SORTABLE_DEFAULT_SORT_COLUMN_ID)
1600     {
1601       GtkTreeDataSortHeader *header;
1602
1603       header = _gtk_tree_data_list_get_header (tree_model_sort->sort_list,
1604                                                tree_model_sort->sort_column_id);
1605
1606       g_return_val_if_fail (header != NULL, 0);
1607
1608       func = header->func;
1609       data = header->data;
1610     }
1611   else
1612     {
1613       func = tree_model_sort->default_sort_func;
1614       data = tree_model_sort->default_sort_data;
1615
1616       g_return_val_if_fail (func != NO_SORT_FUNC, 0);
1617     }
1618
1619   g_return_val_if_fail (func != NULL, 0);
1620
1621   for (middle = 0; middle < level->array->len; middle++)
1622     {
1623       tmp_elt = &(g_array_index (level->array, SortElt, middle));
1624
1625       if (!skip_sort_elt && SORT_ELT (iter->user_data2) == tmp_elt)
1626         continue;
1627
1628       path = gtk_tree_model_sort_elt_get_path (level, tmp_elt);
1629       gtk_tree_model_get_iter (tree_model_sort->child_model,
1630                                &tmp_iter, path);
1631       gtk_tree_path_free (path);
1632
1633       if (tree_model_sort->order == GTK_SORT_ASCENDING)
1634         cmp = (* func) (GTK_TREE_MODEL (tree_model_sort->child_model),
1635                         &tmp_iter, iter, data);
1636       else
1637         cmp = (* func) (GTK_TREE_MODEL (tree_model_sort->child_model),
1638                         iter, &tmp_iter, data);
1639
1640       if (cmp > 0)
1641         break;
1642     }
1643
1644   return middle;
1645 }
1646
1647 static gboolean
1648 gtk_tree_model_sort_insert_value (GtkTreeModelSort *tree_model_sort,
1649                                   SortLevel        *level,
1650                                   GtkTreePath      *s_path,
1651                                   GtkTreeIter      *s_iter)
1652 {
1653   gint offset, index, i;
1654
1655   SortElt elt;
1656   SortElt *tmp_elt;
1657
1658   offset = gtk_tree_path_get_indices (s_path)[gtk_tree_path_get_depth (s_path) - 1];
1659
1660   if (GTK_TREE_MODEL_SORT_CACHE_CHILD_ITERS (tree_model_sort))
1661     elt.iter = *s_iter;
1662   elt.offset = offset;
1663   elt.zero_ref_count = 0;
1664   elt.ref_count = 0;
1665   elt.children = NULL;
1666
1667   /* update all larger offsets */
1668   tmp_elt = SORT_ELT (level->array->data);
1669   for (i = 0; i < level->array->len; i++, tmp_elt++)
1670     if (tmp_elt->offset >= offset)
1671       tmp_elt->offset++;
1672
1673   if (tree_model_sort->sort_column_id == GTK_TREE_SORTABLE_DEFAULT_SORT_COLUMN_ID &&
1674       tree_model_sort->default_sort_func == NO_SORT_FUNC)
1675     index = offset;
1676   else
1677     index = gtk_tree_model_sort_level_find_insert (tree_model_sort,
1678                                                    level, s_iter,
1679                                                    FALSE);
1680
1681   g_array_insert_vals (level->array, index, &elt, 1);
1682   tmp_elt = SORT_ELT (level->array->data);
1683   for (i = 0; i < level->array->len; i++, tmp_elt++)
1684     if (tmp_elt->children)
1685       tmp_elt->children->parent_elt = tmp_elt;
1686
1687   return TRUE;
1688 }
1689
1690 /* sort elt stuff */
1691 static GtkTreePath *
1692 gtk_tree_model_sort_elt_get_path (SortLevel *level,
1693                                   SortElt *elt)
1694 {
1695   SortLevel *walker = level;
1696   SortElt *walker2 = elt;
1697   GtkTreePath *path;
1698
1699   g_return_val_if_fail (level != NULL, NULL);
1700   g_return_val_if_fail (elt != NULL, NULL);
1701
1702   path = gtk_tree_path_new ();
1703
1704   while (walker)
1705     {
1706       gtk_tree_path_prepend_index (path, walker2->offset);
1707
1708       walker2 = walker->parent_elt;
1709       walker = walker->parent_level;
1710     }
1711
1712   return path;
1713 }
1714
1715 /**
1716  * gtk_tree_model_sort_set_model:
1717  * @tree_model_sort: The #GtkTreeModelSort.
1718  * @child_model: A #GtkTreeModel, or NULL.
1719  *
1720  * Sets the model of @tree_model_sort to be @model.  If @model is NULL, then the
1721  * old model is unset.  The sort function is unset as a result of this call.
1722  * The model will be in an unsorted state until a sort function is set.
1723  **/
1724 static void
1725 gtk_tree_model_sort_set_model (GtkTreeModelSort *tree_model_sort,
1726                                GtkTreeModel     *child_model)
1727 {
1728   g_return_if_fail (GTK_IS_TREE_MODEL_SORT (tree_model_sort));
1729
1730   if (child_model)
1731     g_object_ref (G_OBJECT (child_model));
1732
1733   if (tree_model_sort->child_model)
1734     {
1735       g_signal_handler_disconnect (G_OBJECT (tree_model_sort->child_model),
1736                                    tree_model_sort->changed_id);
1737       g_signal_handler_disconnect (G_OBJECT (tree_model_sort->child_model),
1738                                    tree_model_sort->inserted_id);
1739       g_signal_handler_disconnect (G_OBJECT (tree_model_sort->child_model),
1740                                    tree_model_sort->has_child_toggled_id);
1741       g_signal_handler_disconnect (G_OBJECT (tree_model_sort->child_model),
1742                                    tree_model_sort->deleted_id);
1743       g_signal_handler_disconnect (G_OBJECT (tree_model_sort->child_model),
1744                                    tree_model_sort->reordered_id);
1745
1746       /* reset our state */
1747       if (tree_model_sort->root)
1748         gtk_tree_model_sort_free_level (tree_model_sort, tree_model_sort->root);
1749       tree_model_sort->root = NULL;
1750       _gtk_tree_data_list_header_free (tree_model_sort->sort_list);
1751       tree_model_sort->sort_list = NULL;
1752       g_object_unref (G_OBJECT (tree_model_sort->child_model));
1753     }
1754
1755   tree_model_sort->child_model = child_model;
1756
1757   if (child_model)
1758     {
1759       GType *types;
1760       gint i, n_columns;
1761
1762       g_object_ref (tree_model_sort->child_model);
1763       tree_model_sort->changed_id =
1764         g_signal_connect (child_model, "row_changed",
1765                           G_CALLBACK (gtk_tree_model_sort_row_changed),
1766                           tree_model_sort);
1767       tree_model_sort->inserted_id =
1768         g_signal_connect (child_model, "row_inserted",
1769                           G_CALLBACK (gtk_tree_model_sort_row_inserted),
1770                           tree_model_sort);
1771       tree_model_sort->has_child_toggled_id =
1772         g_signal_connect (child_model, "row_has_child_toggled",
1773                           G_CALLBACK (gtk_tree_model_sort_row_has_child_toggled),
1774                           tree_model_sort);
1775       tree_model_sort->deleted_id =
1776         g_signal_connect (child_model, "row_deleted",
1777                           G_CALLBACK (gtk_tree_model_sort_row_deleted),
1778                           tree_model_sort);
1779       tree_model_sort->reordered_id =
1780         g_signal_connect (child_model, "rows_reordered",
1781                           G_CALLBACK (gtk_tree_model_sort_rows_reordered),
1782                           tree_model_sort);
1783
1784       tree_model_sort->child_flags = gtk_tree_model_get_flags (child_model);
1785       n_columns = gtk_tree_model_get_n_columns (child_model);
1786
1787       types = g_new (GType, n_columns);
1788       for (i = 0; i < n_columns; i++)
1789         types[i] = gtk_tree_model_get_column_type (child_model, i);
1790
1791       tree_model_sort->sort_list = _gtk_tree_data_list_header_new (n_columns, types);
1792       g_free (types);
1793
1794       tree_model_sort->default_sort_func = NO_SORT_FUNC;
1795       tree_model_sort->stamp = g_random_int ();
1796     }
1797 }
1798
1799 /**
1800  * gtk_tree_model_sort_get_model:
1801  * @tree_model: a #GtkTreeModelSort
1802  *
1803  * Returns the model the #GtkTreeModelSort is sorting.
1804  *
1805  * Return value: the "child model" being sorted
1806  **/
1807 GtkTreeModel *
1808 gtk_tree_model_sort_get_model (GtkTreeModelSort  *tree_model)
1809 {
1810   g_return_val_if_fail (GTK_IS_TREE_MODEL_SORT (tree_model), NULL);
1811
1812   return tree_model->child_model;
1813 }
1814
1815
1816 static GtkTreePath *
1817 gtk_real_tree_model_sort_convert_child_path_to_path (GtkTreeModelSort *tree_model_sort,
1818                                                      GtkTreePath      *child_path,
1819                                                      gboolean          build_levels)
1820 {
1821   gint *child_indices;
1822   GtkTreePath *retval;
1823   SortLevel *level;
1824   gint i;
1825
1826   g_return_val_if_fail (GTK_IS_TREE_MODEL_SORT (tree_model_sort), NULL);
1827   g_return_val_if_fail (tree_model_sort->child_model != NULL, NULL);
1828   g_return_val_if_fail (child_path != NULL, NULL);
1829
1830   retval = gtk_tree_path_new ();
1831   child_indices = gtk_tree_path_get_indices (child_path);
1832
1833   if (tree_model_sort->root == NULL && build_levels)
1834     gtk_tree_model_sort_build_level (tree_model_sort, NULL, NULL);
1835   level = SORT_LEVEL (tree_model_sort->root);
1836
1837   for (i = 0; i < gtk_tree_path_get_depth (child_path); i++)
1838     {
1839       gint j;
1840       gboolean found_child = FALSE;
1841
1842       if (!level)
1843         {
1844           gtk_tree_path_free (retval);
1845           return NULL;
1846         }
1847
1848       if (child_indices[i] >= level->array->len)
1849         {
1850           gtk_tree_path_free (retval);
1851           return NULL;
1852         }
1853       for (j = 0; j < level->array->len; j++)
1854         {
1855           if ((g_array_index (level->array, SortElt, j)).offset == child_indices[i])
1856             {
1857               gtk_tree_path_append_index (retval, j);
1858               if (g_array_index (level->array, SortElt, j).children == NULL && build_levels)
1859                 {
1860                   gtk_tree_model_sort_build_level (tree_model_sort, level, &g_array_index (level->array, SortElt, j));
1861                 }
1862               level = g_array_index (level->array, SortElt, j).children;
1863               found_child = TRUE;
1864               break;
1865             }
1866         }
1867       if (! found_child)
1868         {
1869           gtk_tree_path_free (retval);
1870           return NULL;
1871         }
1872     }
1873
1874   return retval;
1875 }
1876
1877
1878 /**
1879  * gtk_tree_model_sort_convert_child_path_to_path:
1880  * @tree_model_sort: A #GtkTreeModelSort
1881  * @child_path: A #GtkTreePath to convert
1882  *
1883  * Converts @child_path to a path relative to @tree_model_sort.  That is,
1884  * @child_path points to a path in the child model.  The returned path will
1885  * point to the same row in the sorted model.  If @child_path isn't a valid path
1886  * on the child model, then %NULL is returned.
1887  *
1888  * Return value: A newly allocated #GtkTreePath, or %NULL
1889  **/
1890 GtkTreePath *
1891 gtk_tree_model_sort_convert_child_path_to_path (GtkTreeModelSort *tree_model_sort,
1892                                                 GtkTreePath      *child_path)
1893 {
1894   g_return_val_if_fail (GTK_IS_TREE_MODEL_SORT (tree_model_sort), NULL);
1895   g_return_val_if_fail (tree_model_sort->child_model != NULL, NULL);
1896   g_return_val_if_fail (child_path != NULL, NULL);
1897
1898   return gtk_real_tree_model_sort_convert_child_path_to_path (tree_model_sort, child_path, TRUE);
1899 }
1900
1901 /**
1902  * gtk_tree_model_sort_convert_child_iter_to_iter:
1903  * @tree_model_sort: A #GtkTreeModelSort
1904  * @sort_iter: An uninitialized #GtkTreeIter.
1905  * @child_iter: A valid #GtkTreeIter pointing to a row on the child model
1906  *
1907  * Sets @sort_iter to point to the row in @tree_model_sort that corresponds to
1908  * the row pointed at by @child_iter.
1909  **/
1910 void
1911 gtk_tree_model_sort_convert_child_iter_to_iter (GtkTreeModelSort *tree_model_sort,
1912                                                 GtkTreeIter      *sort_iter,
1913                                                 GtkTreeIter      *child_iter)
1914 {
1915   GtkTreePath *child_path, *path;
1916
1917   g_return_if_fail (GTK_IS_TREE_MODEL_SORT (tree_model_sort));
1918   g_return_if_fail (tree_model_sort->child_model != NULL);
1919   g_return_if_fail (sort_iter != NULL);
1920   g_return_if_fail (child_iter != NULL);
1921
1922   sort_iter->stamp = 0;
1923
1924   child_path = gtk_tree_model_get_path (tree_model_sort->child_model, child_iter);
1925   g_return_if_fail (child_path != NULL);
1926
1927   path = gtk_tree_model_sort_convert_child_path_to_path (tree_model_sort, child_path);
1928   gtk_tree_path_free (child_path);
1929   g_return_if_fail (path != NULL);
1930
1931   gtk_tree_model_get_iter (GTK_TREE_MODEL (tree_model_sort), sort_iter, path);
1932   gtk_tree_path_free (path);
1933 }
1934
1935 /**
1936  * gtk_tree_model_sort_convert_path_to_child_path:
1937  * @tree_model_sort: A #GtkTreeModelSort
1938  * @sorted_path: A #GtkTreePath to convert
1939  *
1940  * Converts @sort_path to a path on the child model of @tree_model_sort.  That
1941  * is, @sort_path points ot a location in @tree_model_sort.  The returned path
1942  * will point to the same location in the model not being sorted.  If @path does not point to a
1943  *
1944  * Return value: A newly allocated #GtkTreePath, or %NULL
1945  **/
1946 GtkTreePath *
1947 gtk_tree_model_sort_convert_path_to_child_path (GtkTreeModelSort *tree_model_sort,
1948                                                 GtkTreePath      *sorted_path)
1949 {
1950   gint *sorted_indices;
1951   GtkTreePath *retval;
1952   SortLevel *level;
1953   gint i;
1954
1955   g_return_val_if_fail (GTK_IS_TREE_MODEL_SORT (tree_model_sort), NULL);
1956   g_return_val_if_fail (tree_model_sort->child_model != NULL, NULL);
1957   g_return_val_if_fail (sorted_path != NULL, NULL);
1958
1959   retval = gtk_tree_path_new ();
1960   sorted_indices = gtk_tree_path_get_indices (sorted_path);
1961   if (tree_model_sort->root == NULL)
1962     gtk_tree_model_sort_build_level (tree_model_sort, NULL, NULL);
1963   level = SORT_LEVEL (tree_model_sort->root);
1964
1965   for (i = 0; i < gtk_tree_path_get_depth (sorted_path); i++)
1966     {
1967       if ((level == NULL) ||
1968           (level->array->len <= sorted_indices[i]))
1969         {
1970           gtk_tree_path_free (retval);
1971           return NULL;
1972         }
1973       if (g_array_index (level->array, SortElt, sorted_indices[i]).children == NULL)
1974         gtk_tree_model_sort_build_level (tree_model_sort, level, &g_array_index (level->array, SortElt, sorted_indices[i]));
1975
1976       if (level == NULL)
1977         break;
1978
1979       gtk_tree_path_append_index (retval, g_array_index (level->array, SortElt, i).offset);
1980     }
1981
1982   return retval;
1983 }
1984
1985 /**
1986  * gtk_tree_model_sort_convert_iter_to_child_iter:
1987  * @tree_model_sort: A #GtkTreeModelSort
1988  * @child_iter: An uninitialized #GtkTreeIter
1989  * @sorted_iter: A valid #GtkTreeIter pointing to a row on @tree_model_sort.
1990  *
1991  * Sets @child_iter to point to the row pointed to by @sorted_iter.
1992  **/
1993 void
1994 gtk_tree_model_sort_convert_iter_to_child_iter (GtkTreeModelSort *tree_model_sort,
1995                                                 GtkTreeIter      *child_iter,
1996                                                 GtkTreeIter      *sorted_iter)
1997 {
1998   g_return_if_fail (GTK_IS_TREE_MODEL_SORT (tree_model_sort));
1999   g_return_if_fail (tree_model_sort->child_model != NULL);
2000   g_return_if_fail (child_iter != NULL);
2001   g_return_if_fail (sorted_iter != NULL);
2002   g_return_if_fail (sorted_iter->stamp == tree_model_sort->stamp);
2003
2004   if (GTK_TREE_MODEL_SORT_CACHE_CHILD_ITERS (tree_model_sort))
2005     {
2006       *child_iter = SORT_ELT (sorted_iter->user_data2)->iter;
2007     }
2008   else
2009     {
2010       GtkTreePath *path;
2011
2012       path = gtk_tree_model_sort_elt_get_path (sorted_iter->user_data,
2013                                                sorted_iter->user_data2);
2014       gtk_tree_model_get_iter (tree_model_sort->child_model, child_iter, path);
2015       gtk_tree_path_free (path);
2016     }
2017 }
2018
2019 static void
2020 gtk_tree_model_sort_build_level (GtkTreeModelSort *tree_model_sort,
2021                                  SortLevel        *parent_level,
2022                                  SortElt          *parent_elt)
2023 {
2024   GtkTreeIter iter;
2025   SortLevel *new_level;
2026   gint length = 0;
2027   gint i;
2028
2029   g_assert (tree_model_sort->child_model != NULL);
2030
2031   if (parent_level == NULL)
2032     {
2033       if (gtk_tree_model_get_iter_first (tree_model_sort->child_model, &iter) == FALSE)
2034         return;
2035       length = gtk_tree_model_iter_n_children (tree_model_sort->child_model, NULL);
2036     }
2037   else
2038     {
2039       GtkTreeIter parent_iter;
2040       GtkTreeIter child_parent_iter;
2041
2042       parent_iter.stamp = tree_model_sort->stamp;
2043       parent_iter.user_data = parent_level;
2044       parent_iter.user_data2 = parent_elt;
2045
2046       gtk_tree_model_sort_convert_iter_to_child_iter (tree_model_sort,
2047                                                       &child_parent_iter,
2048                                                       &parent_iter);
2049       if (gtk_tree_model_iter_children (tree_model_sort->child_model,
2050                                         &iter,
2051                                         &child_parent_iter) == FALSE)
2052         return;
2053
2054       /* stamp may have changed */
2055       gtk_tree_model_sort_convert_iter_to_child_iter (tree_model_sort,
2056                                                       &child_parent_iter,
2057                                                       &parent_iter);
2058
2059       length = gtk_tree_model_iter_n_children (tree_model_sort->child_model, &child_parent_iter);
2060     }
2061
2062   g_return_if_fail (length > 0);
2063
2064   new_level = g_new (SortLevel, 1);
2065   new_level->array = g_array_sized_new (FALSE, FALSE, sizeof (SortElt), length);
2066   new_level->ref_count = 0;
2067   new_level->parent_elt = parent_elt;
2068   new_level->parent_level = parent_level;
2069
2070   if (parent_elt)
2071     parent_elt->children = new_level;
2072   else
2073     tree_model_sort->root = new_level;
2074
2075   /* increase the count of zero ref_counts.*/
2076   while (parent_level)
2077     {
2078       parent_elt->zero_ref_count++;
2079
2080       parent_elt = parent_level->parent_elt;
2081       parent_level = parent_level->parent_level;
2082     }
2083   if (new_level != tree_model_sort->root)
2084     tree_model_sort->zero_ref_count++;
2085
2086   for (i = 0; i < length; i++)
2087     {
2088       SortElt sort_elt;
2089       sort_elt.offset = i;
2090       sort_elt.zero_ref_count = 0;
2091       sort_elt.ref_count = 0;
2092       sort_elt.children = NULL;
2093
2094       if (GTK_TREE_MODEL_SORT_CACHE_CHILD_ITERS (tree_model_sort))
2095         {
2096           sort_elt.iter = iter;
2097           if (gtk_tree_model_iter_next (tree_model_sort->child_model, &iter) == FALSE &&
2098               i < length - 1)
2099             {
2100               g_warning ("There is a discrepency between the sort model and the child model.");
2101               return;
2102             }
2103         }
2104       g_array_append_val (new_level->array, sort_elt);
2105     }
2106
2107   /* sort level */
2108   gtk_tree_model_sort_sort_level (tree_model_sort, new_level,
2109                                   FALSE, FALSE);
2110 }
2111
2112 static void
2113 gtk_tree_model_sort_free_level (GtkTreeModelSort *tree_model_sort,
2114                                 SortLevel        *sort_level)
2115 {
2116   gint i;
2117
2118   g_assert (sort_level);
2119
2120   if (sort_level->ref_count == 0)
2121     {
2122       SortLevel *parent_level = sort_level->parent_level;
2123       SortElt *parent_elt = sort_level->parent_elt;
2124
2125       do
2126         {
2127           if (parent_elt)
2128             parent_elt->zero_ref_count--;
2129           else
2130             tree_model_sort->zero_ref_count--;
2131
2132           if (parent_level)
2133             {
2134               parent_elt = parent_level->parent_elt;
2135               parent_level = parent_level->parent_level;
2136             }
2137         }
2138       while (parent_level);
2139     }
2140
2141   for (i = 0; i < sort_level->array->len; i++)
2142     {
2143       if (g_array_index (sort_level->array, SortElt, i).children)
2144         gtk_tree_model_sort_free_level (tree_model_sort,
2145                                         SORT_LEVEL(g_array_index (sort_level->array, SortElt, i).children));
2146     }
2147
2148   if (sort_level->parent_elt)
2149     sort_level->parent_elt->children = NULL;
2150   else
2151     tree_model_sort->root = NULL;
2152
2153   g_array_free (sort_level->array, TRUE);
2154   sort_level->array = NULL;
2155
2156   g_free (sort_level);
2157   sort_level = NULL;
2158 }
2159
2160 static void
2161 gtk_tree_model_sort_increment_stamp (GtkTreeModelSort *tree_model_sort)
2162 {
2163   do
2164     {
2165       tree_model_sort->stamp++;
2166     }
2167   while (tree_model_sort->stamp == 0);
2168
2169   gtk_tree_model_sort_clear_cache (tree_model_sort);
2170 }
2171
2172 static void
2173 gtk_tree_model_sort_clear_cache_helper (GtkTreeModelSort *tree_model_sort,
2174                                         SortLevel        *level)
2175 {
2176   gint i;
2177
2178   g_assert (level != NULL);
2179
2180   for (i = 0; i < level->array->len; i++)
2181     {
2182       if (g_array_index (level->array, SortElt, i).zero_ref_count > 0)
2183         gtk_tree_model_sort_clear_cache_helper (tree_model_sort, g_array_index (level->array, SortElt, i).children);
2184     }
2185
2186   if (level->ref_count == 0 && level != tree_model_sort->root)
2187     gtk_tree_model_sort_free_level (tree_model_sort, level);
2188 }
2189
2190 /**
2191  * gtk_tree_model_sort_reset_default_sort_func:
2192  * @tree_model_sort: A #GtkTreeModelSort
2193  *
2194  * This resets the default sort function to be in the 'unsorted' state.  That
2195  * is, it is in the same order as the child model.
2196  **/
2197 void
2198 gtk_tree_model_sort_reset_default_sort_func (GtkTreeModelSort *tree_model_sort)
2199 {
2200   g_return_if_fail (GTK_IS_TREE_MODEL_SORT (tree_model_sort));
2201
2202   if (tree_model_sort->default_sort_destroy)
2203     {
2204       GtkDestroyNotify d = tree_model_sort->default_sort_destroy;
2205
2206       tree_model_sort->default_sort_destroy = NULL;
2207       d (tree_model_sort->default_sort_data);
2208     }
2209
2210   tree_model_sort->default_sort_func = NO_SORT_FUNC;
2211   tree_model_sort->default_sort_data = NULL;
2212   tree_model_sort->default_sort_destroy = NULL;
2213   tree_model_sort->sort_column_id = GTK_TREE_SORTABLE_DEFAULT_SORT_COLUMN_ID;
2214 }
2215
2216 /**
2217  * gtk_tree_model_sort_clear_cache:
2218  * @tree_model_sort: A #GtkTreeModelSort
2219  *
2220  * This function should almost never be called.  It clears the @tree_model_sort
2221  * of any cached iterators that haven't been reffed with
2222  * gtk_tree_model_ref_node().  This might be useful if the child model being
2223  * sorted is static (and doesn't change often) and there has been a lot of
2224  * unreffed access to nodes.  As a side effect of this function, all unreffed
2225  * iters will be invalid.
2226  **/
2227 void
2228 gtk_tree_model_sort_clear_cache (GtkTreeModelSort *tree_model_sort)
2229 {
2230   g_return_if_fail (GTK_IS_TREE_MODEL_SORT (tree_model_sort));
2231
2232   if (tree_model_sort->zero_ref_count)
2233     gtk_tree_model_sort_clear_cache_helper (tree_model_sort, (SortLevel *)tree_model_sort->root);
2234 }