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