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