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;
1377   SortElt *elt;
1378
1379   g_return_if_fail (priv->child_model != NULL);
1380   g_return_if_fail (VALID_ITER (iter, tree_model_sort));
1381
1382   GET_CHILD_ITER (tree_model_sort, &child_iter, iter);
1383
1384   /* Reference the node in the child model */
1385   gtk_tree_model_ref_node (priv->child_model, &child_iter);
1386
1387   /* Increase the reference count of this element and its level */
1388   level = iter->user_data;
1389   elt = iter->user_data2;
1390
1391   elt->ref_count++;
1392   level->ref_count++;
1393
1394   if (level->ref_count == 1)
1395     {
1396       SortLevel *parent_level = level->parent_level;
1397       gint parent_elt_index = level->parent_elt_index;
1398
1399       /* We were at zero -- time to decrement the zero_ref_count val */
1400       while (parent_level)
1401         {
1402           g_array_index (parent_level->array, SortElt, parent_elt_index).zero_ref_count--;
1403
1404           parent_elt_index = parent_level->parent_elt_index;
1405           parent_level = parent_level->parent_level;
1406         }
1407
1408       if (priv->root != level)
1409         priv->zero_ref_count--;
1410     }
1411 }
1412
1413 static void
1414 gtk_tree_model_sort_real_unref_node (GtkTreeModel *tree_model,
1415                                      GtkTreeIter  *iter,
1416                                      gboolean      propagate_unref)
1417 {
1418   GtkTreeModelSort *tree_model_sort = (GtkTreeModelSort *) tree_model;
1419   GtkTreeModelSortPrivate *priv = tree_model_sort->priv;
1420   SortLevel *level;
1421   SortElt *elt;
1422
1423   g_return_if_fail (priv->child_model != NULL);
1424   g_return_if_fail (VALID_ITER (iter, tree_model_sort));
1425
1426   if (propagate_unref)
1427     {
1428       GtkTreeIter child_iter;
1429
1430       GET_CHILD_ITER (tree_model_sort, &child_iter, iter);
1431       gtk_tree_model_unref_node (priv->child_model, &child_iter);
1432     }
1433
1434   level = iter->user_data;
1435   elt = iter->user_data2;
1436
1437   g_return_if_fail (elt->ref_count > 0);
1438
1439   elt->ref_count--;
1440   level->ref_count--;
1441
1442   if (level->ref_count == 0)
1443     {
1444       SortLevel *parent_level = level->parent_level;
1445       gint parent_elt_index = level->parent_elt_index;
1446
1447       /* We are at zero -- time to increment the zero_ref_count val */
1448       while (parent_level)
1449         {
1450           g_array_index (parent_level->array, SortElt, parent_elt_index).zero_ref_count++;
1451
1452           parent_elt_index = parent_level->parent_elt_index;
1453           parent_level = parent_level->parent_level;
1454         }
1455
1456       if (priv->root != level)
1457         priv->zero_ref_count++;
1458     }
1459 }
1460
1461 static void
1462 gtk_tree_model_sort_unref_node (GtkTreeModel *tree_model,
1463                                 GtkTreeIter  *iter)
1464 {
1465   gtk_tree_model_sort_real_unref_node (tree_model, iter, TRUE);
1466 }
1467
1468 /* Sortable interface */
1469 static gboolean
1470 gtk_tree_model_sort_get_sort_column_id (GtkTreeSortable *sortable,
1471                                         gint            *sort_column_id,
1472                                         GtkSortType     *order)
1473 {
1474   GtkTreeModelSort *tree_model_sort = (GtkTreeModelSort *)sortable;
1475   GtkTreeModelSortPrivate *priv = tree_model_sort->priv;
1476
1477   if (sort_column_id)
1478     *sort_column_id = priv->sort_column_id;
1479   if (order)
1480     *order = priv->order;
1481
1482   if (priv->sort_column_id == GTK_TREE_SORTABLE_DEFAULT_SORT_COLUMN_ID ||
1483       priv->sort_column_id == GTK_TREE_SORTABLE_UNSORTED_SORT_COLUMN_ID)
1484     return FALSE;
1485
1486   return TRUE;
1487 }
1488
1489 static void
1490 gtk_tree_model_sort_set_sort_column_id (GtkTreeSortable *sortable,
1491                                         gint             sort_column_id,
1492                                         GtkSortType      order)
1493 {
1494   GtkTreeModelSort *tree_model_sort = (GtkTreeModelSort *)sortable;
1495   GtkTreeModelSortPrivate *priv = tree_model_sort->priv;
1496
1497   if (sort_column_id != GTK_TREE_SORTABLE_UNSORTED_SORT_COLUMN_ID)
1498     {
1499       if (sort_column_id != GTK_TREE_SORTABLE_DEFAULT_SORT_COLUMN_ID)
1500         {
1501           GtkTreeDataSortHeader *header = NULL;
1502
1503           header = _gtk_tree_data_list_get_header (priv->sort_list,
1504                                                    sort_column_id);
1505
1506           /* we want to make sure that we have a function */
1507           g_return_if_fail (header != NULL);
1508           g_return_if_fail (header->func != NULL);
1509         }
1510       else
1511         g_return_if_fail (priv->default_sort_func != NULL);
1512
1513       if (priv->sort_column_id == sort_column_id)
1514         {
1515           if (sort_column_id != GTK_TREE_SORTABLE_DEFAULT_SORT_COLUMN_ID)
1516             {
1517               if (priv->order == order)
1518                 return;
1519             }
1520           else
1521             return;
1522         }
1523     }
1524
1525   priv->sort_column_id = sort_column_id;
1526   priv->order = order;
1527
1528   gtk_tree_sortable_sort_column_changed (sortable);
1529
1530   gtk_tree_model_sort_sort (tree_model_sort);
1531 }
1532
1533 static void
1534 gtk_tree_model_sort_set_sort_func (GtkTreeSortable        *sortable,
1535                                    gint                    sort_column_id,
1536                                    GtkTreeIterCompareFunc  func,
1537                                    gpointer                data,
1538                                    GDestroyNotify          destroy)
1539 {
1540   GtkTreeModelSort *tree_model_sort = (GtkTreeModelSort *) sortable;
1541   GtkTreeModelSortPrivate *priv = tree_model_sort->priv;
1542
1543   priv->sort_list = _gtk_tree_data_list_set_header (priv->sort_list,
1544                                                     sort_column_id,
1545                                                     func, data, destroy);
1546
1547   if (priv->sort_column_id == sort_column_id)
1548     gtk_tree_model_sort_sort (tree_model_sort);
1549 }
1550
1551 static void
1552 gtk_tree_model_sort_set_default_sort_func (GtkTreeSortable        *sortable,
1553                                            GtkTreeIterCompareFunc  func,
1554                                            gpointer                data,
1555                                            GDestroyNotify          destroy)
1556 {
1557   GtkTreeModelSort *tree_model_sort = (GtkTreeModelSort *)sortable;
1558   GtkTreeModelSortPrivate *priv = tree_model_sort->priv;
1559
1560   if (priv->default_sort_destroy)
1561     {
1562       GDestroyNotify d = priv->default_sort_destroy;
1563
1564       priv->default_sort_destroy = NULL;
1565       d (priv->default_sort_data);
1566     }
1567
1568   priv->default_sort_func = func;
1569   priv->default_sort_data = data;
1570   priv->default_sort_destroy = destroy;
1571
1572   if (priv->sort_column_id == GTK_TREE_SORTABLE_DEFAULT_SORT_COLUMN_ID)
1573     gtk_tree_model_sort_sort (tree_model_sort);
1574 }
1575
1576 static gboolean
1577 gtk_tree_model_sort_has_default_sort_func (GtkTreeSortable *sortable)
1578 {
1579   GtkTreeModelSort *tree_model_sort = (GtkTreeModelSort *)sortable;
1580
1581   return (tree_model_sort->priv->default_sort_func != NULL);
1582 }
1583
1584 /* DragSource interface */
1585 static gboolean
1586 gtk_tree_model_sort_row_draggable (GtkTreeDragSource *drag_source,
1587                                    GtkTreePath       *path)
1588 {
1589   GtkTreeModelSort *tree_model_sort = (GtkTreeModelSort *)drag_source;
1590   GtkTreePath *child_path;
1591   gboolean draggable;
1592
1593   child_path = gtk_tree_model_sort_convert_path_to_child_path (tree_model_sort,
1594                                                                path);
1595   draggable = gtk_tree_drag_source_row_draggable (GTK_TREE_DRAG_SOURCE (tree_model_sort->priv->child_model), child_path);
1596   gtk_tree_path_free (child_path);
1597
1598   return draggable;
1599 }
1600
1601 static gboolean
1602 gtk_tree_model_sort_drag_data_get (GtkTreeDragSource *drag_source,
1603                                    GtkTreePath       *path,
1604                                    GtkSelectionData  *selection_data)
1605 {
1606   GtkTreeModelSort *tree_model_sort = (GtkTreeModelSort *)drag_source;
1607   GtkTreePath *child_path;
1608   gboolean gotten;
1609
1610   child_path = gtk_tree_model_sort_convert_path_to_child_path (tree_model_sort, path);
1611   gotten = gtk_tree_drag_source_drag_data_get (GTK_TREE_DRAG_SOURCE (tree_model_sort->priv->child_model), child_path, selection_data);
1612   gtk_tree_path_free (child_path);
1613
1614   return gotten;
1615 }
1616
1617 static gboolean
1618 gtk_tree_model_sort_drag_data_delete (GtkTreeDragSource *drag_source,
1619                                       GtkTreePath       *path)
1620 {
1621   GtkTreeModelSort *tree_model_sort = (GtkTreeModelSort *)drag_source;
1622   GtkTreePath *child_path;
1623   gboolean deleted;
1624
1625   child_path = gtk_tree_model_sort_convert_path_to_child_path (tree_model_sort, path);
1626   deleted = gtk_tree_drag_source_drag_data_delete (GTK_TREE_DRAG_SOURCE (tree_model_sort->priv->child_model), child_path);
1627   gtk_tree_path_free (child_path);
1628
1629   return deleted;
1630 }
1631
1632 /* sorting code - private */
1633 static gint
1634 gtk_tree_model_sort_compare_func (gconstpointer a,
1635                                   gconstpointer b,
1636                                   gpointer      user_data)
1637 {
1638   SortData *data = (SortData *)user_data;
1639   GtkTreeModelSort *tree_model_sort = data->tree_model_sort;
1640   GtkTreeModelSortPrivate *priv = tree_model_sort->priv;
1641   SortTuple *sa = (SortTuple *)a;
1642   SortTuple *sb = (SortTuple *)b;
1643
1644   GtkTreeIter iter_a, iter_b;
1645   gint retval;
1646
1647   /* shortcut, if we've the same offsets here, they should be equal */
1648   if (sa->offset == sb->offset)
1649     return 0;
1650
1651   if (GTK_TREE_MODEL_SORT_CACHE_CHILD_ITERS (tree_model_sort))
1652     {
1653       iter_a = sa->elt->iter;
1654       iter_b = sb->elt->iter;
1655     }
1656   else
1657     {
1658       data->parent_path_indices [data->parent_path_depth-1] = sa->elt->offset;
1659       gtk_tree_model_get_iter (GTK_TREE_MODEL (priv->child_model), &iter_a, data->parent_path);
1660       data->parent_path_indices [data->parent_path_depth-1] = sb->elt->offset;
1661       gtk_tree_model_get_iter (GTK_TREE_MODEL (priv->child_model), &iter_b, data->parent_path);
1662     }
1663
1664   retval = (* data->sort_func) (GTK_TREE_MODEL (priv->child_model),
1665                                 &iter_a, &iter_b,
1666                                 data->sort_data);
1667
1668   if (priv->order == GTK_SORT_DESCENDING)
1669     {
1670       if (retval > 0)
1671         retval = -1;
1672       else if (retval < 0)
1673         retval = 1;
1674     }
1675
1676   return retval;
1677 }
1678
1679 static gint
1680 gtk_tree_model_sort_offset_compare_func (gconstpointer a,
1681                                          gconstpointer b,
1682                                          gpointer      user_data)
1683 {
1684   gint retval;
1685
1686   SortTuple *sa = (SortTuple *)a;
1687   SortTuple *sb = (SortTuple *)b;
1688
1689   SortData *data = (SortData *)user_data;
1690
1691   if (sa->elt->offset < sb->elt->offset)
1692     retval = -1;
1693   else if (sa->elt->offset > sb->elt->offset)
1694     retval = 1;
1695   else
1696     retval = 0;
1697
1698   if (data->tree_model_sort->priv->order == GTK_SORT_DESCENDING)
1699     {
1700       if (retval > 0)
1701         retval = -1;
1702       else if (retval < 0)
1703         retval = 1;
1704     }
1705
1706   return retval;
1707 }
1708
1709 static void
1710 gtk_tree_model_sort_sort_level (GtkTreeModelSort *tree_model_sort,
1711                                 SortLevel        *level,
1712                                 gboolean          recurse,
1713                                 gboolean          emit_reordered)
1714 {
1715   GtkTreeModelSortPrivate *priv = tree_model_sort->priv;
1716   gint i;
1717   gint ref_offset;
1718   GArray *sort_array;
1719   GArray *new_array;
1720   gint *new_order;
1721
1722   GtkTreeIter iter;
1723   GtkTreePath *path;
1724
1725   SortData data;
1726
1727   g_return_if_fail (level != NULL);
1728
1729   if (level->array->len < 1 && !((SortElt *)level->array->data)->children)
1730     return;
1731
1732   iter.stamp = priv->stamp;
1733   iter.user_data = level;
1734   iter.user_data2 = &g_array_index (level->array, SortElt, 0);
1735
1736   gtk_tree_model_sort_ref_node (GTK_TREE_MODEL (tree_model_sort), &iter);
1737   ref_offset = g_array_index (level->array, SortElt, 0).offset;
1738
1739   /* Set up data */
1740   data.tree_model_sort = tree_model_sort;
1741   if (level->parent_elt_index >= 0)
1742     {
1743       data.parent_path = gtk_tree_model_sort_elt_get_path (level->parent_level,
1744                                                            SORT_LEVEL_PARENT_ELT (level));
1745       gtk_tree_path_append_index (data.parent_path, 0);
1746     }
1747   else
1748     {
1749       data.parent_path = gtk_tree_path_new_first ();
1750     }
1751   data.parent_path_depth = gtk_tree_path_get_depth (data.parent_path);
1752   data.parent_path_indices = gtk_tree_path_get_indices (data.parent_path);
1753
1754   /* make the array to be sorted */
1755   sort_array = g_array_sized_new (FALSE, FALSE, sizeof (SortTuple), level->array->len);
1756   for (i = 0; i < level->array->len; i++)
1757     {
1758       SortTuple tuple;
1759
1760       tuple.elt = &g_array_index (level->array, SortElt, i);
1761       tuple.offset = i;
1762
1763       g_array_append_val (sort_array, tuple);
1764     }
1765
1766     if (priv->sort_column_id != GTK_TREE_SORTABLE_DEFAULT_SORT_COLUMN_ID)
1767       {
1768         GtkTreeDataSortHeader *header = NULL;
1769
1770         header = _gtk_tree_data_list_get_header (priv->sort_list,
1771                                                  priv->sort_column_id);
1772
1773         g_return_if_fail (header != NULL);
1774         g_return_if_fail (header->func != NULL);
1775
1776         data.sort_func = header->func;
1777         data.sort_data = header->data;
1778       }
1779     else
1780       {
1781         /* absolutely SHOULD NOT happen: */
1782         g_return_if_fail (priv->default_sort_func != NULL);
1783
1784         data.sort_func = priv->default_sort_func;
1785         data.sort_data = priv->default_sort_data;
1786       }
1787
1788   if (data.sort_func == NO_SORT_FUNC)
1789     g_array_sort_with_data (sort_array,
1790                             gtk_tree_model_sort_offset_compare_func,
1791                             &data);
1792   else
1793     g_array_sort_with_data (sort_array,
1794                             gtk_tree_model_sort_compare_func,
1795                             &data);
1796
1797   gtk_tree_path_free (data.parent_path);
1798
1799   new_array = g_array_sized_new (FALSE, FALSE, sizeof (SortElt), level->array->len);
1800   new_order = g_new (gint, level->array->len);
1801
1802   for (i = 0; i < level->array->len; i++)
1803     {
1804       SortElt *elt;
1805
1806       elt = g_array_index (sort_array, SortTuple, i).elt;
1807       new_order[i] = g_array_index (sort_array, SortTuple, i).offset;
1808
1809       g_array_append_val (new_array, *elt);
1810       if (elt->children)
1811         elt->children->parent_elt_index = i;
1812     }
1813
1814   g_array_free (level->array, TRUE);
1815   level->array = new_array;
1816   g_array_free (sort_array, TRUE);
1817
1818   if (emit_reordered)
1819     {
1820       gtk_tree_model_sort_increment_stamp (tree_model_sort);
1821       if (level->parent_elt_index >= 0)
1822         {
1823           iter.stamp = priv->stamp;
1824           iter.user_data = level->parent_level;
1825           iter.user_data2 = SORT_LEVEL_PARENT_ELT (level);
1826
1827           path = gtk_tree_model_get_path (GTK_TREE_MODEL (tree_model_sort),
1828                                           &iter);
1829
1830           gtk_tree_model_rows_reordered (GTK_TREE_MODEL (tree_model_sort), path,
1831                                          &iter, new_order);
1832         }
1833       else
1834         {
1835           /* toplevel list */
1836           path = gtk_tree_path_new ();
1837           gtk_tree_model_rows_reordered (GTK_TREE_MODEL (tree_model_sort), path,
1838                                          NULL, new_order);
1839         }
1840
1841       gtk_tree_path_free (path);
1842     }
1843
1844   /* recurse, if possible */
1845   if (recurse)
1846     {
1847       for (i = 0; i < level->array->len; i++)
1848         {
1849           SortElt *elt = &g_array_index (level->array, SortElt, i);
1850
1851           if (elt->children)
1852             gtk_tree_model_sort_sort_level (tree_model_sort,
1853                                             elt->children,
1854                                             TRUE, emit_reordered);
1855         }
1856     }
1857
1858   g_free (new_order);
1859
1860   /* get the iter we referenced at the beginning of this function and
1861    * unref it again
1862    */
1863   iter.stamp = priv->stamp;
1864   iter.user_data = level;
1865
1866   for (i = 0; i < level->array->len; i++)
1867     {
1868       if (g_array_index (level->array, SortElt, i).offset == ref_offset)
1869         {
1870           iter.user_data2 = &g_array_index (level->array, SortElt, i);
1871           break;
1872         }
1873     }
1874
1875   gtk_tree_model_sort_unref_node (GTK_TREE_MODEL (tree_model_sort), &iter);
1876 }
1877
1878 static void
1879 gtk_tree_model_sort_sort (GtkTreeModelSort *tree_model_sort)
1880 {
1881   GtkTreeModelSortPrivate *priv = tree_model_sort->priv;
1882
1883   if (priv->sort_column_id == GTK_TREE_SORTABLE_UNSORTED_SORT_COLUMN_ID)
1884     return;
1885
1886   if (!priv->root)
1887     return;
1888
1889   if (priv->sort_column_id != GTK_TREE_SORTABLE_DEFAULT_SORT_COLUMN_ID)
1890     {
1891       GtkTreeDataSortHeader *header = NULL;
1892
1893       header = _gtk_tree_data_list_get_header (priv->sort_list,
1894                                                priv->sort_column_id);
1895
1896       /* we want to make sure that we have a function */
1897       g_return_if_fail (header != NULL);
1898       g_return_if_fail (header->func != NULL);
1899     }
1900   else
1901     g_return_if_fail (priv->default_sort_func != NULL);
1902
1903   gtk_tree_model_sort_sort_level (tree_model_sort, priv->root,
1904                                   TRUE, TRUE);
1905 }
1906
1907 /* signal helpers */
1908 static gint
1909 gtk_tree_model_sort_level_find_insert (GtkTreeModelSort *tree_model_sort,
1910                                        SortLevel        *level,
1911                                        GtkTreeIter      *iter,
1912                                        gint             skip_index)
1913 {
1914   GtkTreeModelSortPrivate *priv = tree_model_sort->priv;
1915   gint start, middle, end;
1916   gint cmp;
1917   SortElt *tmp_elt;
1918   GtkTreeIter tmp_iter;
1919
1920   GtkTreeIterCompareFunc func;
1921   gpointer data;
1922
1923   if (priv->sort_column_id != GTK_TREE_SORTABLE_DEFAULT_SORT_COLUMN_ID)
1924     {
1925       GtkTreeDataSortHeader *header;
1926
1927       header = _gtk_tree_data_list_get_header (priv->sort_list,
1928                                                priv->sort_column_id);
1929
1930       g_return_val_if_fail (header != NULL, 0);
1931
1932       func = header->func;
1933       data = header->data;
1934     }
1935   else
1936     {
1937       func = priv->default_sort_func;
1938       data = priv->default_sort_data;
1939
1940       g_return_val_if_fail (func != NO_SORT_FUNC, 0);
1941     }
1942
1943   g_return_val_if_fail (func != NULL, 0);
1944
1945   start = 0;
1946   end = level->array->len;
1947   if (skip_index < 0)
1948     skip_index = end;
1949   else
1950     end--;
1951
1952   if (start == end)
1953     return 0;
1954
1955   while (start != end)
1956     {
1957       middle = (start + end) / 2;
1958
1959       if (middle < skip_index)
1960         tmp_elt = &(g_array_index (level->array, SortElt, middle));
1961       else
1962         tmp_elt = &(g_array_index (level->array, SortElt, middle + 1));
1963
1964       if (!GTK_TREE_MODEL_SORT_CACHE_CHILD_ITERS (tree_model_sort))
1965         {
1966           GtkTreePath *path = gtk_tree_model_sort_elt_get_path (level, tmp_elt);
1967           gtk_tree_model_get_iter (priv->child_model,
1968                                    &tmp_iter, path);
1969           gtk_tree_path_free (path);
1970         }
1971       else
1972         tmp_iter = tmp_elt->iter;
1973
1974       if (priv->order == GTK_SORT_ASCENDING)
1975         cmp = (* func) (GTK_TREE_MODEL (priv->child_model),
1976                         &tmp_iter, iter, data);
1977       else
1978         cmp = (* func) (GTK_TREE_MODEL (priv->child_model),
1979                         iter, &tmp_iter, data);
1980
1981       if (cmp <= 0)
1982         start = middle + 1;
1983       else
1984         end = middle;
1985     }
1986
1987   if (cmp <= 0)
1988     return middle + 1;
1989   else
1990     return middle;
1991 }
1992
1993 static gboolean
1994 gtk_tree_model_sort_insert_value (GtkTreeModelSort *tree_model_sort,
1995                                   SortLevel        *level,
1996                                   GtkTreePath      *s_path,
1997                                   GtkTreeIter      *s_iter)
1998 {
1999   GtkTreeModelSortPrivate *priv = tree_model_sort->priv;
2000   gint offset, index, i;
2001
2002   SortElt elt;
2003   SortElt *tmp_elt;
2004
2005   offset = gtk_tree_path_get_indices (s_path)[gtk_tree_path_get_depth (s_path) - 1];
2006
2007   if (GTK_TREE_MODEL_SORT_CACHE_CHILD_ITERS (tree_model_sort))
2008     elt.iter = *s_iter;
2009   elt.offset = offset;
2010   elt.zero_ref_count = 0;
2011   elt.ref_count = 0;
2012   elt.children = NULL;
2013
2014   /* update all larger offsets */
2015   tmp_elt = SORT_ELT (level->array->data);
2016   for (i = 0; i < level->array->len; i++, tmp_elt++)
2017     if (tmp_elt->offset >= offset)
2018       tmp_elt->offset++;
2019
2020   if (priv->sort_column_id == GTK_TREE_SORTABLE_DEFAULT_SORT_COLUMN_ID &&
2021       priv->default_sort_func == NO_SORT_FUNC)
2022     index = offset;
2023   else
2024     index = gtk_tree_model_sort_level_find_insert (tree_model_sort,
2025                                                    level, s_iter,
2026                                                    -1);
2027
2028   g_array_insert_vals (level->array, index, &elt, 1);
2029   tmp_elt = SORT_ELT (level->array->data);
2030   for (i = 0; i < level->array->len; i++, tmp_elt++)
2031     if (tmp_elt->children)
2032       tmp_elt->children->parent_elt_index = i;
2033
2034   return TRUE;
2035 }
2036
2037 /* sort elt stuff */
2038 static GtkTreePath *
2039 gtk_tree_model_sort_elt_get_path (SortLevel *level,
2040                                   SortElt *elt)
2041 {
2042   SortLevel *walker = level;
2043   SortElt *walker2 = elt;
2044   GtkTreePath *path;
2045
2046   g_return_val_if_fail (level != NULL, NULL);
2047   g_return_val_if_fail (elt != NULL, NULL);
2048
2049   path = gtk_tree_path_new ();
2050
2051   while (walker)
2052     {
2053       gtk_tree_path_prepend_index (path, walker2->offset);
2054
2055       if (!walker->parent_level)
2056         break;
2057
2058       walker2 = SORT_LEVEL_PARENT_ELT (walker);
2059       walker = walker->parent_level;
2060     }
2061
2062   return path;
2063 }
2064
2065 /**
2066  * gtk_tree_model_sort_set_model:
2067  * @tree_model_sort: The #GtkTreeModelSort.
2068  * @child_model: (allow-none): A #GtkTreeModel, or %NULL.
2069  *
2070  * Sets the model of @tree_model_sort to be @model.  If @model is %NULL,
2071  * then the old model is unset.  The sort function is unset as a result
2072  * of this call. The model will be in an unsorted state until a sort
2073  * function is set.
2074  **/
2075 static void
2076 gtk_tree_model_sort_set_model (GtkTreeModelSort *tree_model_sort,
2077                                GtkTreeModel     *child_model)
2078 {
2079   GtkTreeModelSortPrivate *priv = tree_model_sort->priv;
2080
2081   if (child_model)
2082     g_object_ref (child_model);
2083
2084   if (priv->child_model)
2085     {
2086       g_signal_handler_disconnect (priv->child_model,
2087                                    priv->changed_id);
2088       g_signal_handler_disconnect (priv->child_model,
2089                                    priv->inserted_id);
2090       g_signal_handler_disconnect (priv->child_model,
2091                                    priv->has_child_toggled_id);
2092       g_signal_handler_disconnect (priv->child_model,
2093                                    priv->deleted_id);
2094       g_signal_handler_disconnect (priv->child_model,
2095                                    priv->reordered_id);
2096
2097       /* reset our state */
2098       if (priv->root)
2099         gtk_tree_model_sort_free_level (tree_model_sort, priv->root);
2100       priv->root = NULL;
2101       _gtk_tree_data_list_header_free (priv->sort_list);
2102       priv->sort_list = NULL;
2103       g_object_unref (priv->child_model);
2104     }
2105
2106   priv->child_model = child_model;
2107
2108   if (child_model)
2109     {
2110       GType *types;
2111       gint i, n_columns;
2112
2113       priv->changed_id =
2114         g_signal_connect (child_model, "row-changed",
2115                           G_CALLBACK (gtk_tree_model_sort_row_changed),
2116                           tree_model_sort);
2117       priv->inserted_id =
2118         g_signal_connect (child_model, "row-inserted",
2119                           G_CALLBACK (gtk_tree_model_sort_row_inserted),
2120                           tree_model_sort);
2121       priv->has_child_toggled_id =
2122         g_signal_connect (child_model, "row-has-child-toggled",
2123                           G_CALLBACK (gtk_tree_model_sort_row_has_child_toggled),
2124                           tree_model_sort);
2125       priv->deleted_id =
2126         g_signal_connect (child_model, "row-deleted",
2127                           G_CALLBACK (gtk_tree_model_sort_row_deleted),
2128                           tree_model_sort);
2129       priv->reordered_id =
2130         g_signal_connect (child_model, "rows-reordered",
2131                           G_CALLBACK (gtk_tree_model_sort_rows_reordered),
2132                           tree_model_sort);
2133
2134       priv->child_flags = gtk_tree_model_get_flags (child_model);
2135       n_columns = gtk_tree_model_get_n_columns (child_model);
2136
2137       types = g_new (GType, n_columns);
2138       for (i = 0; i < n_columns; i++)
2139         types[i] = gtk_tree_model_get_column_type (child_model, i);
2140
2141       priv->sort_list = _gtk_tree_data_list_header_new (n_columns, types);
2142       g_free (types);
2143
2144       priv->default_sort_func = NO_SORT_FUNC;
2145       priv->stamp = g_random_int ();
2146     }
2147 }
2148
2149 /**
2150  * gtk_tree_model_sort_get_model:
2151  * @tree_model: a #GtkTreeModelSort
2152  *
2153  * Returns the model the #GtkTreeModelSort is sorting.
2154  *
2155  * Return value: (transfer none): the "child model" being sorted
2156  **/
2157 GtkTreeModel *
2158 gtk_tree_model_sort_get_model (GtkTreeModelSort *tree_model)
2159 {
2160   g_return_val_if_fail (GTK_IS_TREE_MODEL_SORT (tree_model), NULL);
2161
2162   return tree_model->priv->child_model;
2163 }
2164
2165
2166 static GtkTreePath *
2167 gtk_real_tree_model_sort_convert_child_path_to_path (GtkTreeModelSort *tree_model_sort,
2168                                                      GtkTreePath      *child_path,
2169                                                      gboolean          build_levels)
2170 {
2171   GtkTreeModelSortPrivate *priv = tree_model_sort->priv;
2172   gint *child_indices;
2173   GtkTreePath *retval;
2174   SortLevel *level;
2175   gint i;
2176
2177   g_return_val_if_fail (priv->child_model != NULL, NULL);
2178   g_return_val_if_fail (child_path != NULL, NULL);
2179
2180   retval = gtk_tree_path_new ();
2181   child_indices = gtk_tree_path_get_indices (child_path);
2182
2183   if (priv->root == NULL && build_levels)
2184     gtk_tree_model_sort_build_level (tree_model_sort, NULL, -1);
2185   level = SORT_LEVEL (priv->root);
2186
2187   for (i = 0; i < gtk_tree_path_get_depth (child_path); i++)
2188     {
2189       gint j;
2190       gboolean found_child = FALSE;
2191
2192       if (!level)
2193         {
2194           gtk_tree_path_free (retval);
2195           return NULL;
2196         }
2197
2198       if (child_indices[i] >= level->array->len)
2199         {
2200           gtk_tree_path_free (retval);
2201           return NULL;
2202         }
2203       for (j = 0; j < level->array->len; j++)
2204         {
2205           if ((g_array_index (level->array, SortElt, j)).offset == child_indices[i])
2206             {
2207               gtk_tree_path_append_index (retval, j);
2208               if (g_array_index (level->array, SortElt, j).children == NULL && build_levels)
2209                 {
2210                   gtk_tree_model_sort_build_level (tree_model_sort, level, j);
2211                 }
2212               level = g_array_index (level->array, SortElt, j).children;
2213               found_child = TRUE;
2214               break;
2215             }
2216         }
2217       if (! found_child)
2218         {
2219           gtk_tree_path_free (retval);
2220           return NULL;
2221         }
2222     }
2223
2224   return retval;
2225 }
2226
2227
2228 /**
2229  * gtk_tree_model_sort_convert_child_path_to_path:
2230  * @tree_model_sort: A #GtkTreeModelSort
2231  * @child_path: A #GtkTreePath to convert
2232  *
2233  * Converts @child_path to a path relative to @tree_model_sort.  That is,
2234  * @child_path points to a path in the child model.  The returned path will
2235  * point to the same row in the sorted model.  If @child_path isn't a valid
2236  * path on the child model, then %NULL is returned.
2237  *
2238  * Return value: A newly allocated #GtkTreePath, or %NULL
2239  **/
2240 GtkTreePath *
2241 gtk_tree_model_sort_convert_child_path_to_path (GtkTreeModelSort *tree_model_sort,
2242                                                 GtkTreePath      *child_path)
2243 {
2244   g_return_val_if_fail (GTK_IS_TREE_MODEL_SORT (tree_model_sort), NULL);
2245   g_return_val_if_fail (tree_model_sort->priv->child_model != NULL, NULL);
2246   g_return_val_if_fail (child_path != NULL, NULL);
2247
2248   return gtk_real_tree_model_sort_convert_child_path_to_path (tree_model_sort, child_path, TRUE);
2249 }
2250
2251 /**
2252  * gtk_tree_model_sort_convert_child_iter_to_iter:
2253  * @tree_model_sort: A #GtkTreeModelSort
2254  * @sort_iter: (out): An uninitialized #GtkTreeIter.
2255  * @child_iter: A valid #GtkTreeIter pointing to a row on the child model
2256  *
2257  * Sets @sort_iter to point to the row in @tree_model_sort that corresponds to
2258  * the row pointed at by @child_iter.  If @sort_iter was not set, %FALSE
2259  * is returned.  Note: a boolean is only returned since 2.14.
2260  *
2261  * Return value: %TRUE, if @sort_iter was set, i.e. if @sort_iter is a
2262  * valid iterator pointer to a visible row in the child model.
2263  **/
2264 gboolean
2265 gtk_tree_model_sort_convert_child_iter_to_iter (GtkTreeModelSort *tree_model_sort,
2266                                                 GtkTreeIter      *sort_iter,
2267                                                 GtkTreeIter      *child_iter)
2268 {
2269   gboolean ret;
2270   GtkTreePath *child_path, *path;
2271   GtkTreeModelSortPrivate *priv = tree_model_sort->priv;
2272
2273   g_return_val_if_fail (GTK_IS_TREE_MODEL_SORT (tree_model_sort), FALSE);
2274   g_return_val_if_fail (priv->child_model != NULL, FALSE);
2275   g_return_val_if_fail (sort_iter != NULL, FALSE);
2276   g_return_val_if_fail (child_iter != NULL, FALSE);
2277   g_return_val_if_fail (sort_iter != child_iter, FALSE);
2278
2279   sort_iter->stamp = 0;
2280
2281   child_path = gtk_tree_model_get_path (priv->child_model, child_iter);
2282   g_return_val_if_fail (child_path != NULL, FALSE);
2283
2284   path = gtk_tree_model_sort_convert_child_path_to_path (tree_model_sort, child_path);
2285   gtk_tree_path_free (child_path);
2286
2287   if (!path)
2288     {
2289       g_warning ("%s: The conversion of the child path to a GtkTreeModel sort path failed", G_STRLOC);
2290       return FALSE;
2291     }
2292
2293   ret = gtk_tree_model_get_iter (GTK_TREE_MODEL (tree_model_sort),
2294                                  sort_iter, path);
2295   gtk_tree_path_free (path);
2296
2297   return ret;
2298 }
2299
2300 /**
2301  * gtk_tree_model_sort_convert_path_to_child_path:
2302  * @tree_model_sort: A #GtkTreeModelSort
2303  * @sorted_path: A #GtkTreePath to convert
2304  *
2305  * Converts @sorted_path to a path on the child model of @tree_model_sort.
2306  * That is, @sorted_path points to a location in @tree_model_sort.  The
2307  * returned path will point to the same location in the model not being
2308  * sorted.  If @sorted_path does not point to a location in the child model,
2309  * %NULL is returned.
2310  *
2311  * Return value: A newly allocated #GtkTreePath, or %NULL
2312  **/
2313 GtkTreePath *
2314 gtk_tree_model_sort_convert_path_to_child_path (GtkTreeModelSort *tree_model_sort,
2315                                                 GtkTreePath      *sorted_path)
2316 {
2317   GtkTreeModelSortPrivate *priv = tree_model_sort->priv;
2318   gint *sorted_indices;
2319   GtkTreePath *retval;
2320   SortLevel *level;
2321   gint i;
2322
2323   g_return_val_if_fail (GTK_IS_TREE_MODEL_SORT (tree_model_sort), NULL);
2324   g_return_val_if_fail (priv->child_model != NULL, NULL);
2325   g_return_val_if_fail (sorted_path != NULL, NULL);
2326
2327   retval = gtk_tree_path_new ();
2328   sorted_indices = gtk_tree_path_get_indices (sorted_path);
2329   if (priv->root == NULL)
2330     gtk_tree_model_sort_build_level (tree_model_sort, NULL, -1);
2331   level = SORT_LEVEL (priv->root);
2332
2333   for (i = 0; i < gtk_tree_path_get_depth (sorted_path); i++)
2334     {
2335       gint count = sorted_indices[i];
2336
2337       if ((level == NULL) ||
2338           (level->array->len <= count))
2339         {
2340           gtk_tree_path_free (retval);
2341           return NULL;
2342         }
2343
2344       if (g_array_index (level->array, SortElt, count).children == NULL)
2345         gtk_tree_model_sort_build_level (tree_model_sort, level, count);
2346
2347       if (level == NULL)
2348         {
2349           gtk_tree_path_free (retval);
2350           break;
2351         }
2352
2353       gtk_tree_path_append_index (retval, g_array_index (level->array, SortElt, count).offset);
2354       level = g_array_index (level->array, SortElt, count).children;
2355     }
2356
2357   return retval;
2358 }
2359
2360 /**
2361  * gtk_tree_model_sort_convert_iter_to_child_iter:
2362  * @tree_model_sort: A #GtkTreeModelSort
2363  * @child_iter: (out): An uninitialized #GtkTreeIter
2364  * @sorted_iter: A valid #GtkTreeIter pointing to a row on @tree_model_sort.
2365  *
2366  * Sets @child_iter to point to the row pointed to by @sorted_iter.
2367  **/
2368 void
2369 gtk_tree_model_sort_convert_iter_to_child_iter (GtkTreeModelSort *tree_model_sort,
2370                                                 GtkTreeIter      *child_iter,
2371                                                 GtkTreeIter      *sorted_iter)
2372 {
2373   GtkTreeModelSortPrivate *priv = tree_model_sort->priv;
2374   g_return_if_fail (GTK_IS_TREE_MODEL_SORT (tree_model_sort));
2375   g_return_if_fail (priv->child_model != NULL);
2376   g_return_if_fail (child_iter != NULL);
2377   g_return_if_fail (VALID_ITER (sorted_iter, tree_model_sort));
2378   g_return_if_fail (sorted_iter != child_iter);
2379
2380   if (GTK_TREE_MODEL_SORT_CACHE_CHILD_ITERS (tree_model_sort))
2381     {
2382       *child_iter = SORT_ELT (sorted_iter->user_data2)->iter;
2383     }
2384   else
2385     {
2386       GtkTreePath *path;
2387       gboolean valid = FALSE;
2388
2389       path = gtk_tree_model_sort_elt_get_path (sorted_iter->user_data,
2390                                                sorted_iter->user_data2);
2391       valid = gtk_tree_model_get_iter (priv->child_model, child_iter, path);
2392       gtk_tree_path_free (path);
2393
2394       g_return_if_fail (valid == TRUE);
2395     }
2396 }
2397
2398 static void
2399 gtk_tree_model_sort_build_level (GtkTreeModelSort *tree_model_sort,
2400                                  SortLevel        *parent_level,
2401                                  gint              parent_elt_index)
2402 {
2403   GtkTreeModelSortPrivate *priv = tree_model_sort->priv;
2404   GtkTreeIter iter;
2405   SortElt *parent_elt = NULL;
2406   SortLevel *new_level;
2407   gint length = 0;
2408   gint i;
2409
2410   g_assert (priv->child_model != NULL);
2411
2412   if (parent_level == NULL)
2413     {
2414       if (gtk_tree_model_get_iter_first (priv->child_model, &iter) == FALSE)
2415         return;
2416       length = gtk_tree_model_iter_n_children (priv->child_model, NULL);
2417     }
2418   else
2419     {
2420       GtkTreeIter parent_iter;
2421       GtkTreeIter child_parent_iter;
2422
2423       parent_elt = &g_array_index (parent_level->array, SortElt, parent_elt_index);
2424
2425       parent_iter.stamp = priv->stamp;
2426       parent_iter.user_data = parent_level;
2427       parent_iter.user_data2 = parent_elt;
2428
2429       gtk_tree_model_sort_convert_iter_to_child_iter (tree_model_sort,
2430                                                       &child_parent_iter,
2431                                                       &parent_iter);
2432       if (gtk_tree_model_iter_children (priv->child_model,
2433                                         &iter,
2434                                         &child_parent_iter) == FALSE)
2435         return;
2436
2437       /* stamp may have changed */
2438       gtk_tree_model_sort_convert_iter_to_child_iter (tree_model_sort,
2439                                                       &child_parent_iter,
2440                                                       &parent_iter);
2441
2442       length = gtk_tree_model_iter_n_children (priv->child_model, &child_parent_iter);
2443
2444       gtk_tree_model_sort_ref_node (GTK_TREE_MODEL (tree_model_sort),
2445                                     &parent_iter);
2446     }
2447
2448   g_return_if_fail (length > 0);
2449
2450   new_level = g_new (SortLevel, 1);
2451   new_level->array = g_array_sized_new (FALSE, FALSE, sizeof (SortElt), length);
2452   new_level->ref_count = 0;
2453   new_level->parent_level = parent_level;
2454   new_level->parent_elt_index = parent_elt_index;
2455
2456   if (parent_elt_index >= 0)
2457     parent_elt->children = new_level;
2458   else
2459     priv->root = new_level;
2460
2461   /* increase the count of zero ref_counts.*/
2462   while (parent_level)
2463     {
2464       g_array_index (parent_level->array, SortElt, parent_elt_index).zero_ref_count++;
2465
2466       parent_elt_index = parent_level->parent_elt_index;
2467       parent_level = parent_level->parent_level;
2468     }
2469
2470   if (new_level != priv->root)
2471     priv->zero_ref_count++;
2472
2473   for (i = 0; i < length; i++)
2474     {
2475       SortElt sort_elt;
2476       sort_elt.offset = i;
2477       sort_elt.zero_ref_count = 0;
2478       sort_elt.ref_count = 0;
2479       sort_elt.children = NULL;
2480
2481       if (GTK_TREE_MODEL_SORT_CACHE_CHILD_ITERS (tree_model_sort))
2482         {
2483           sort_elt.iter = iter;
2484           if (gtk_tree_model_iter_next (priv->child_model, &iter) == FALSE &&
2485               i < length - 1)
2486             {
2487               if (parent_level)
2488                 {
2489                   GtkTreePath *level;
2490                   gchar *str;
2491
2492                   level = gtk_tree_model_sort_elt_get_path (parent_level,
2493                                                             parent_elt);
2494                   str = gtk_tree_path_to_string (level);
2495                   gtk_tree_path_free (level);
2496
2497                   g_warning ("%s: There is a discrepancy between the sort model "
2498                              "and the child model.  The child model is "
2499                              "advertising a wrong length for level %s:.",
2500                              G_STRLOC, str);
2501                   g_free (str);
2502                 }
2503               else
2504                 {
2505                   g_warning ("%s: There is a discrepancy between the sort model "
2506                              "and the child model.  The child model is "
2507                              "advertising a wrong length for the root level.",
2508                              G_STRLOC);
2509                 }
2510
2511               return;
2512             }
2513         }
2514       g_array_append_val (new_level->array, sort_elt);
2515     }
2516
2517   /* sort level */
2518   gtk_tree_model_sort_sort_level (tree_model_sort, new_level,
2519                                   FALSE, FALSE);
2520 }
2521
2522 static void
2523 gtk_tree_model_sort_free_level (GtkTreeModelSort *tree_model_sort,
2524                                 SortLevel        *sort_level)
2525 {
2526   GtkTreeModelSortPrivate *priv = tree_model_sort->priv;
2527   gint i;
2528
2529   g_assert (sort_level);
2530
2531   for (i = 0; i < sort_level->array->len; i++)
2532     {
2533       if (g_array_index (sort_level->array, SortElt, i).children)
2534         gtk_tree_model_sort_free_level (tree_model_sort,
2535                                         SORT_LEVEL (g_array_index (sort_level->array, SortElt, i).children));
2536     }
2537
2538   if (sort_level->ref_count == 0)
2539     {
2540       SortLevel *parent_level = sort_level->parent_level;
2541       gint parent_elt_index = sort_level->parent_elt_index;
2542
2543       while (parent_level)
2544         {
2545           g_array_index (parent_level->array, SortElt, parent_elt_index).zero_ref_count--;
2546
2547           parent_elt_index = parent_level->parent_elt_index;
2548           parent_level = parent_level->parent_level;
2549         }
2550
2551       if (sort_level != priv->root)
2552         priv->zero_ref_count--;
2553     }
2554
2555   if (sort_level->parent_elt_index >= 0)
2556     {
2557       GtkTreeIter parent_iter;
2558
2559       parent_iter.stamp = tree_model_sort->priv->stamp;
2560       parent_iter.user_data = sort_level->parent_level;
2561       parent_iter.user_data2 = SORT_LEVEL_PARENT_ELT (sort_level);
2562
2563       gtk_tree_model_sort_unref_node (GTK_TREE_MODEL (tree_model_sort),
2564                                       &parent_iter);
2565
2566       SORT_LEVEL_PARENT_ELT (sort_level)->children = NULL;
2567     }
2568   else
2569     priv->root = NULL;
2570
2571   g_array_free (sort_level->array, TRUE);
2572   sort_level->array = NULL;
2573
2574   g_free (sort_level);
2575   sort_level = NULL;
2576 }
2577
2578 static void
2579 gtk_tree_model_sort_increment_stamp (GtkTreeModelSort *tree_model_sort)
2580 {
2581   GtkTreeModelSortPrivate *priv = tree_model_sort->priv;
2582
2583   do
2584     {
2585       priv->stamp++;
2586     }
2587   while (priv->stamp == 0);
2588
2589   gtk_tree_model_sort_clear_cache (tree_model_sort);
2590 }
2591
2592 static void
2593 gtk_tree_model_sort_clear_cache_helper (GtkTreeModelSort *tree_model_sort,
2594                                         SortLevel        *level)
2595 {
2596   gint i;
2597
2598   g_assert (level != NULL);
2599
2600   for (i = 0; i < level->array->len; i++)
2601     {
2602       if (g_array_index (level->array, SortElt, i).zero_ref_count > 0)
2603         gtk_tree_model_sort_clear_cache_helper (tree_model_sort, g_array_index (level->array, SortElt, i).children);
2604     }
2605
2606   if (level->ref_count == 0 && level != tree_model_sort->priv->root)
2607     gtk_tree_model_sort_free_level (tree_model_sort, level);
2608 }
2609
2610 /**
2611  * gtk_tree_model_sort_reset_default_sort_func:
2612  * @tree_model_sort: A #GtkTreeModelSort
2613  *
2614  * This resets the default sort function to be in the 'unsorted' state.  That
2615  * is, it is in the same order as the child model. It will re-sort the model
2616  * to be in the same order as the child model only if the #GtkTreeModelSort
2617  * is in 'unsorted' state.
2618  **/
2619 void
2620 gtk_tree_model_sort_reset_default_sort_func (GtkTreeModelSort *tree_model_sort)
2621 {
2622   GtkTreeModelSortPrivate *priv = tree_model_sort->priv;
2623
2624   g_return_if_fail (GTK_IS_TREE_MODEL_SORT (tree_model_sort));
2625
2626   if (priv->default_sort_destroy)
2627     {
2628       GDestroyNotify d = priv->default_sort_destroy;
2629
2630       priv->default_sort_destroy = NULL;
2631       d (priv->default_sort_data);
2632     }
2633
2634   priv->default_sort_func = NO_SORT_FUNC;
2635   priv->default_sort_data = NULL;
2636   priv->default_sort_destroy = NULL;
2637
2638   if (priv->sort_column_id == GTK_TREE_SORTABLE_DEFAULT_SORT_COLUMN_ID)
2639     gtk_tree_model_sort_sort (tree_model_sort);
2640   priv->sort_column_id = GTK_TREE_SORTABLE_DEFAULT_SORT_COLUMN_ID;
2641 }
2642
2643 /**
2644  * gtk_tree_model_sort_clear_cache:
2645  * @tree_model_sort: A #GtkTreeModelSort
2646  *
2647  * This function should almost never be called.  It clears the @tree_model_sort
2648  * of any cached iterators that haven't been reffed with
2649  * gtk_tree_model_ref_node().  This might be useful if the child model being
2650  * sorted is static (and doesn't change often) and there has been a lot of
2651  * unreffed access to nodes.  As a side effect of this function, all unreffed
2652  * iters will be invalid.
2653  **/
2654 void
2655 gtk_tree_model_sort_clear_cache (GtkTreeModelSort *tree_model_sort)
2656 {
2657   g_return_if_fail (GTK_IS_TREE_MODEL_SORT (tree_model_sort));
2658
2659   if (tree_model_sort->priv->zero_ref_count > 0)
2660     gtk_tree_model_sort_clear_cache_helper (tree_model_sort, (SortLevel *)tree_model_sort->priv->root);
2661 }
2662
2663 static gboolean
2664 gtk_tree_model_sort_iter_is_valid_helper (GtkTreeIter *iter,
2665                                           SortLevel   *level)
2666 {
2667   gint i;
2668
2669   for (i = 0; i < level->array->len; i++)
2670     {
2671       SortElt *elt = &g_array_index (level->array, SortElt, i);
2672
2673       if (iter->user_data == level && iter->user_data2 == elt)
2674         return TRUE;
2675
2676       if (elt->children)
2677         if (gtk_tree_model_sort_iter_is_valid_helper (iter, elt->children))
2678           return TRUE;
2679     }
2680
2681   return FALSE;
2682 }
2683
2684 /**
2685  * gtk_tree_model_sort_iter_is_valid:
2686  * @tree_model_sort: A #GtkTreeModelSort.
2687  * @iter: A #GtkTreeIter.
2688  *
2689  * <warning><para>
2690  * This function is slow. Only use it for debugging and/or testing purposes.
2691  * </para></warning>
2692  *
2693  * Checks if the given iter is a valid iter for this #GtkTreeModelSort.
2694  *
2695  * Return value: %TRUE if the iter is valid, %FALSE if the iter is invalid.
2696  *
2697  * Since: 2.2
2698  **/
2699 gboolean
2700 gtk_tree_model_sort_iter_is_valid (GtkTreeModelSort *tree_model_sort,
2701                                    GtkTreeIter      *iter)
2702 {
2703   g_return_val_if_fail (GTK_IS_TREE_MODEL_SORT (tree_model_sort), FALSE);
2704   g_return_val_if_fail (iter != NULL, FALSE);
2705
2706   if (!VALID_ITER (iter, tree_model_sort))
2707     return FALSE;
2708
2709   return gtk_tree_model_sort_iter_is_valid_helper (iter,
2710                                                    tree_model_sort->priv->root);
2711 }