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

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