Pileus Git - ~andy/gtk/blob - gtk/gtktreemodelsort.c

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