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