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