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

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