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