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                                                            gboolean          skip_sort_elt);
 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 offset, 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   offset = elt->offset;
 485
 486   for (i = 0; i < level->array->len; i++)
 487     if (elt->offset == g_array_index (level->array, SortElt, i).offset)
 488       index = i;
 489
 490   memcpy (&tmp, elt, sizeof (SortElt));
 491   g_array_remove_index (level->array, index);
 492
 493   old_index = index;
 494
 495   if (GTK_TREE_MODEL_SORT_CACHE_CHILD_ITERS (tree_model_sort))
 496     index = gtk_tree_model_sort_level_find_insert (tree_model_sort,
 497                                                    level,
 498                                                    &tmp.iter,
 499                                                    TRUE);
 500   else
 501     index = gtk_tree_model_sort_level_find_insert (tree_model_sort,
 502                                                    level,
 503                                                    &tmpiter,
 504                                                    TRUE);
 505
 506   g_array_insert_val (level->array, index, tmp);
 507
 508   for (i = 0; i < level->array->len; i++)
 509     if (g_array_index (level->array, SortElt, i).children)
 510       g_array_index (level->array, SortElt, i).children->parent_elt = &g_array_index (level->array, SortElt, i);
 511
 512   gtk_tree_path_up (path);
 513   gtk_tree_path_append_index (path, index);
 514
 515   gtk_tree_model_sort_increment_stamp (tree_model_sort);
 516
 517   /* if the item moved, then emit rows_reordered */
 518   if (old_index != index)
 519     {
 520       gint *new_order;
 521       gint j;
 522
 523       GtkTreePath *tmppath;
 524
 525       new_order = g_new (gint, level->array->len);
 526
 527       for (j = 0; j < level->array->len; j++)
 528         {
 529           if (index > old_index)
 530             {
 531               if (j == index)
 532                 new_order[j] = old_index;
 533               else if (j >= old_index && j < index)
 534                 new_order[j] = j + 1;
 535               else
 536                 new_order[j] = j;
 537             }
 538           else if (index < old_index)
 539             {
 540               if (j == index)
 541                 new_order[j] = old_index;
 542               else if (j > index && j <= old_index)
 543                 new_order[j] = j - 1;
 544               else
 545                 new_order[j] = j;
 546             }
 547           /* else? shouldn't really happen */
 548         }
 549
 550       if (level->parent_elt)
 551         {
 552           iter.stamp = tree_model_sort->stamp;
 553           iter.user_data = level->parent_level;
 554           iter.user_data2 = level->parent_elt;
 555
 556           tmppath = gtk_tree_model_get_path (GTK_TREE_MODEL (tree_model_sort), &iter);
 557
 558           gtk_tree_model_rows_reordered (GTK_TREE_MODEL (tree_model_sort),
 559                                          tmppath, &iter, new_order);
 560         }
 561       else
 562         {
 563           /* toplevel */
 564           tmppath = gtk_tree_path_new ();
 565
 566           gtk_tree_model_rows_reordered (GTK_TREE_MODEL (tree_model_sort), tmppath,
 567                                          NULL, new_order);
 568         }
 569
 570       gtk_tree_path_free (tmppath);
 571       g_free (new_order);
 572     }
 573
 574   /* emit row_changed signal (at new location) */
 575   gtk_tree_model_get_iter (GTK_TREE_MODEL (data), &iter, path);
 576   gtk_tree_model_row_changed (GTK_TREE_MODEL (data), path, &iter);
 577
 578   gtk_tree_path_free (path);
 579   if (free_s_path)
 580     gtk_tree_path_free (start_s_path);
 581 }
 582
 583 static void
 584 gtk_tree_model_sort_row_inserted (GtkTreeModel          *s_model,
 585                                   GtkTreePath           *s_path,
 586                                   GtkTreeIter           *s_iter,
 587                                   gpointer               data)
 588 {
 589   GtkTreeModelSort *tree_model_sort = GTK_TREE_MODEL_SORT (data);
 590   GtkTreePath *path;
 591   GtkTreeIter iter;
 592   GtkTreeIter real_s_iter;
 593
 594   gint i = 0;
 595
 596   gboolean free_s_path = FALSE;
 597
 598   SortElt *elt;
 599   SortLevel *level;
 600   SortLevel *parent_level = NULL;
 601
 602   parent_level = level = SORT_LEVEL (tree_model_sort->root);
 603
 604   g_return_if_fail (s_path != NULL || s_iter != NULL);
 605
 606   if (!s_path)
 607     {
 608       s_path = gtk_tree_model_get_path (s_model, s_iter);
 609       free_s_path = TRUE;
 610     }
 611
 612   if (!s_iter)
 613     gtk_tree_model_get_iter (s_model, &real_s_iter, s_path);
 614   else
 615     real_s_iter = *s_iter;
 616
 617   if (!tree_model_sort->root)
 618     {
 619       gtk_tree_model_sort_build_level (tree_model_sort, NULL, NULL);
 620
 621       /* the build level already put the inserted iter in the level,
 622          so no need to handle this signal anymore */
 623
 624       goto done_and_submit;
 625     }
 626
 627   /* find the parent level */
 628   while (i < gtk_tree_path_get_depth (s_path) - 1)
 629     {
 630       gint j;
 631
 632       if (!level)
 633         {
 634           /* level not yet build, we won't cover this signal */
 635           goto done;
 636         }
 637
 638       if (level->array->len < gtk_tree_path_get_indices (s_path)[i])
 639         {
 640           g_warning ("A node was inserted with a parent that's not in the tree.\n"
 641                      "This possibly means that a GtkTreeModel inserted a child node\n"
 642                      "before the parent was inserted.");
 643           goto done;
 644         }
 645
 646       elt = NULL;
 647       for (j = 0; j < level->array->len; j++)
 648         if (g_array_index (level->array, SortElt, j).offset == gtk_tree_path_get_indices (s_path)[i])
 649           {
 650             elt = &g_array_index (level->array, SortElt, j);
 651             break;
 652           }
 653
 654       g_return_if_fail (elt != NULL);
 655
 656       if (!elt->children)
 657         {
 658           GtkTreePath *tmppath;
 659           GtkTreeIter  tmpiter;
 660
 661           tmpiter.stamp = tree_model_sort->stamp;
 662           tmpiter.user_data = level;
 663           tmpiter.user_data2 = elt;
 664
 665           tmppath = gtk_tree_model_get_path (GTK_TREE_MODEL (data), &tmpiter);
 666           if (tmppath)
 667             {
 668               gtk_tree_model_row_has_child_toggled (GTK_TREE_MODEL (data),
 669                                                     tmppath,
 670                                                     &tmpiter);
 671               gtk_tree_path_free (tmppath);
 672             }
 673
 674           /* not covering this signal */
 675           goto done;
 676         }
 677
 678       level = elt->children;
 679       parent_level = level;
 680       i++;
 681     }
 682
 683   if (!parent_level)
 684     goto done;
 685
 686   if (!gtk_tree_model_sort_insert_value (tree_model_sort,
 687                                          parent_level,
 688                                          s_path,
 689                                          &real_s_iter))
 690     goto done;
 691
 692  done_and_submit:
 693   path = gtk_real_tree_model_sort_convert_child_path_to_path (tree_model_sort,
 694                                                               s_path,
 695                                                               FALSE);
 696
 697   if (!path)
 698     return;
 699
 700   gtk_tree_model_sort_increment_stamp (tree_model_sort);
 701
 702   gtk_tree_model_get_iter (GTK_TREE_MODEL (data), &iter, path);
 703   gtk_tree_model_row_inserted (GTK_TREE_MODEL (data), path, &iter);
 704   gtk_tree_path_free (path);
 705
 706  done:
 707   if (free_s_path)
 708     gtk_tree_path_free (s_path);
 709
 710   return;
 711 }
 712
 713 static void
 714 gtk_tree_model_sort_row_has_child_toggled (GtkTreeModel *s_model,
 715                                            GtkTreePath  *s_path,
 716                                            GtkTreeIter  *s_iter,
 717                                            gpointer      data)
 718 {
 719   GtkTreeModelSort *tree_model_sort = GTK_TREE_MODEL_SORT (data);
 720   GtkTreePath *path;
 721   GtkTreeIter iter;
 722
 723   g_return_if_fail (s_path != NULL && s_iter != NULL);
 724
 725   path = gtk_real_tree_model_sort_convert_child_path_to_path (tree_model_sort, s_path, FALSE);
 726   if (path == NULL)
 727     return;
 728
 729   gtk_tree_model_get_iter (GTK_TREE_MODEL (data), &iter, path);
 730   gtk_tree_model_row_has_child_toggled (GTK_TREE_MODEL (data), path, &iter);
 731
 732   gtk_tree_path_free (path);
 733 }
 734
 735 /* FIXME: I still have doubts if this works */
 736 static void
 737 gtk_tree_model_sort_row_deleted (GtkTreeModel *s_model,
 738                                  GtkTreePath  *s_path,
 739                                  gpointer      data)
 740 {
 741   GtkTreeModelSort *tree_model_sort = GTK_TREE_MODEL_SORT (data);
 742   GtkTreePath *path = NULL;
 743   SortElt *elt;
 744   SortLevel *level;
 745   GtkTreeIter iter;
 746   gint offset;
 747   gint i;
 748
 749   g_return_if_fail (s_path != NULL);
 750
 751   path = gtk_real_tree_model_sort_convert_child_path_to_path (tree_model_sort, s_path, FALSE);
 752   if (path == NULL)
 753     return;
 754
 755   gtk_tree_model_get_iter (GTK_TREE_MODEL (data), &iter, path);
 756
 757   level = SORT_LEVEL (iter.user_data);
 758   elt = SORT_ELT (iter.user_data2);
 759   offset = elt->offset;
 760
 761   /* we _need_ to emit ::row_deleted before we start unreffing the node
 762    * itself. This is because of the row refs, which start unreffing nodes
 763    * when we emit ::row_deleted
 764    */
 765   gtk_tree_model_row_deleted (GTK_TREE_MODEL (data), path);
 766
 767   gtk_tree_model_get_iter (GTK_TREE_MODEL (data), &iter, path);
 768
 769   while (elt->ref_count > 0)
 770     gtk_tree_model_sort_real_unref_node (GTK_TREE_MODEL (data), &iter, FALSE);
 771
 772   if (level->ref_count == 0 && level != tree_model_sort->root)
 773     {
 774       /* This will prune the level, so I can just emit the signal and not worry
 775        * about cleaning this level up. */
 776       gtk_tree_model_sort_increment_stamp (tree_model_sort);
 777       gtk_tree_path_free (path);
 778       return;
 779     }
 780
 781   gtk_tree_model_sort_increment_stamp (tree_model_sort);
 782
 783   /* Remove the row */
 784   for (i = 0; i < level->array->len; i++)
 785     if (elt->offset == g_array_index (level->array, SortElt, i).offset)
 786       break;
 787
 788   g_array_remove_index (level->array, i);
 789
 790   /* update all offsets */
 791   for (i = 0; i < level->array->len; i++)
 792     {
 793       elt = & (g_array_index (level->array, SortElt, i));
 794       if (elt->offset > offset)
 795         elt->offset--;
 796       if (elt->children)
 797         elt->children->parent_elt = elt;
 798     }
 799
 800   gtk_tree_path_free (path);
 801 }
 802
 803 static void
 804 gtk_tree_model_sort_rows_reordered (GtkTreeModel *s_model,
 805                                     GtkTreePath  *s_path,
 806                                     GtkTreeIter  *s_iter,
 807                                     gint         *new_order,
 808                                     gpointer      data)
 809 {
 810   SortElt *elt;
 811   SortLevel *level;
 812   GtkTreeIter iter;
 813   gint *tmp_array;
 814   int i, j;
 815   GtkTreePath *path;
 816   GtkTreeModelSort *tree_model_sort = GTK_TREE_MODEL_SORT (data);
 817
 818   g_return_if_fail (new_order != NULL);
 819
 820   if (s_path == NULL || gtk_tree_path_get_indices (s_path) == NULL)
 821     {
 822       if (tree_model_sort->root == NULL)
 823         return;
 824       path = gtk_tree_path_new ();
 825       level = SORT_LEVEL (tree_model_sort->root);
 826     }
 827   else
 828     {
 829       path = gtk_real_tree_model_sort_convert_child_path_to_path (tree_model_sort, s_path, FALSE);
 830       if (path == NULL)
 831         return;
 832       gtk_tree_model_get_iter (GTK_TREE_MODEL (data), &iter, path);
 833
 834       level = SORT_LEVEL (iter.user_data);
 835       elt = SORT_ELT (iter.user_data2);
 836
 837       if (!elt->children)
 838         {
 839           gtk_tree_path_free (path);
 840           return;
 841         }
 842
 843       level = elt->children;
 844     }
 845
 846   if (level->array->len < 2)
 847     {
 848       gtk_tree_path_free (path);
 849       return;
 850     }
 851
 852   tmp_array = g_new (int, level->array->len);
 853   for (i = 0; i < level->array->len; i++)
 854     {
 855       for (j = 0; j < level->array->len; j++)
 856         {
 857           if (g_array_index (level->array, SortElt, i).offset == new_order[j])
 858             tmp_array[i] = j;
 859         }
 860     }
 861
 862   for (i = 0; i < level->array->len; i++)
 863     g_array_index (level->array, SortElt, i).offset = tmp_array[i];
 864   g_free (tmp_array);
 865
 866   if (tree_model_sort->sort_column_id == GTK_TREE_SORTABLE_DEFAULT_SORT_COLUMN_ID &&
 867       tree_model_sort->default_sort_func == NO_SORT_FUNC)
 868     {
 869
 870       gtk_tree_model_sort_sort_level (tree_model_sort, level,
 871                                       FALSE, FALSE);
 872       gtk_tree_model_sort_increment_stamp (tree_model_sort);
 873
 874       if (gtk_tree_path_get_depth (path))
 875         {
 876           gtk_tree_model_get_iter (GTK_TREE_MODEL (tree_model_sort),
 877                                    &iter,
 878                                    path);
 879           gtk_tree_model_rows_reordered (GTK_TREE_MODEL (tree_model_sort),
 880                                          path, &iter, new_order);
 881         }
 882       else
 883         {
 884           gtk_tree_model_rows_reordered (GTK_TREE_MODEL (tree_model_sort),
 885                                          path, NULL, new_order);
 886         }
 887     }
 888
 889   gtk_tree_path_free (path);
 890 }
 891
 892 /* Fulfill our model requirements */
 893 static GtkTreeModelFlags
 894 gtk_tree_model_sort_get_flags (GtkTreeModel *tree_model)
 895 {
 896   g_return_val_if_fail (GTK_IS_TREE_MODEL_SORT (tree_model), 0);
 897
 898   return 0;
 899 }
 900
 901 static gint
 902 gtk_tree_model_sort_get_n_columns (GtkTreeModel *tree_model)
 903 {
 904   GtkTreeModelSort *tree_model_sort = (GtkTreeModelSort *) tree_model;
 905
 906   g_return_val_if_fail (GTK_IS_TREE_MODEL_SORT (tree_model), 0);
 907
 908   if (tree_model_sort->child_model == 0)
 909     return 0;
 910
 911   return gtk_tree_model_get_n_columns (tree_model_sort->child_model);
 912 }
 913
 914 static GType
 915 gtk_tree_model_sort_get_column_type (GtkTreeModel *tree_model,
 916                                      gint          index)
 917 {
 918   g_return_val_if_fail (GTK_IS_TREE_MODEL_SORT (tree_model), G_TYPE_INVALID);
 919   g_return_val_if_fail (GTK_TREE_MODEL_SORT (tree_model)->child_model != NULL, G_TYPE_INVALID);
 920
 921   return gtk_tree_model_get_column_type (GTK_TREE_MODEL_SORT (tree_model)->child_model, index);
 922 }
 923
 924 static gboolean
 925 gtk_tree_model_sort_get_iter (GtkTreeModel *tree_model,
 926                               GtkTreeIter  *iter,
 927                               GtkTreePath  *path)
 928 {
 929   GtkTreeModelSort *tree_model_sort;
 930   gint *indices;
 931   SortLevel *level;
 932   gint depth, i;
 933
 934   g_return_val_if_fail (GTK_IS_TREE_MODEL_SORT (tree_model), FALSE);
 935   g_return_val_if_fail (GTK_TREE_MODEL_SORT (tree_model)->child_model != NULL, FALSE);
 936
 937   tree_model_sort = (GtkTreeModelSort *) tree_model;
 938   indices = gtk_tree_path_get_indices (path);
 939
 940   if (tree_model_sort->root == NULL)
 941     gtk_tree_model_sort_build_level (tree_model_sort, NULL, NULL);
 942   level = SORT_LEVEL (tree_model_sort->root);
 943
 944   depth = gtk_tree_path_get_depth (path);
 945   if (depth == 0)
 946     return FALSE;
 947
 948   for (i = 0; i < depth - 1; i++)
 949     {
 950       if ((level == NULL) ||
 951           (indices[i] >= level->array->len))
 952         return FALSE;
 953
 954       if (g_array_index (level->array, SortElt, indices[i]).children == NULL)
 955         gtk_tree_model_sort_build_level (tree_model_sort, level, &g_array_index (level->array, SortElt, indices[i]));
 956       level = g_array_index (level->array, SortElt, indices[i]).children;
 957     }
 958
 959   if (level == NULL)
 960     return FALSE;
 961   iter->stamp = tree_model_sort->stamp;
 962   iter->user_data = level;
 963   iter->user_data2 = &g_array_index (level->array, SortElt, indices[depth - 1]);
 964
 965   return TRUE;
 966 }
 967
 968 static GtkTreePath *
 969 gtk_tree_model_sort_get_path (GtkTreeModel *tree_model,
 970                               GtkTreeIter  *iter)
 971 {
 972   GtkTreePath *retval;
 973   SortLevel *level;
 974   SortElt *elt;
 975
 976   g_return_val_if_fail (GTK_IS_TREE_MODEL_SORT (tree_model), NULL);
 977   g_return_val_if_fail (GTK_TREE_MODEL_SORT (tree_model)->child_model != NULL, NULL);
 978   g_return_val_if_fail (GTK_TREE_MODEL_SORT (tree_model)->stamp == iter->stamp, NULL);
 979
 980   retval = gtk_tree_path_new ();
 981   level = iter->user_data;
 982   elt = iter->user_data2;
 983   while (level != NULL)
 984     {
 985       gtk_tree_path_prepend_index (retval, elt - (SortElt *)level->array->data);
 986
 987       elt = level->parent_elt;
 988       level = level->parent_level;
 989     }
 990
 991   return retval;
 992 }
 993
 994 static void
 995 gtk_tree_model_sort_get_value (GtkTreeModel *tree_model,
 996                                GtkTreeIter  *iter,
 997                                gint          column,
 998                                GValue       *value)
 999 {
1000   GtkTreeIter child_iter;
1001
1002   g_return_if_fail (GTK_IS_TREE_MODEL_SORT (tree_model));
1003   g_return_if_fail (GTK_TREE_MODEL_SORT (tree_model)->child_model != NULL);
1004   g_return_if_fail (GTK_TREE_MODEL_SORT (tree_model)->stamp == iter->stamp);
1005
1006   GET_CHILD_ITER (tree_model, &child_iter, iter);
1007   gtk_tree_model_get_value (GTK_TREE_MODEL_SORT (tree_model)->child_model,
1008                             &child_iter, column, value);
1009 }
1010
1011 static gboolean
1012 gtk_tree_model_sort_iter_next (GtkTreeModel *tree_model,
1013                                GtkTreeIter  *iter)
1014 {
1015   SortLevel *level;
1016   SortElt *elt;
1017
1018   g_return_val_if_fail (GTK_IS_TREE_MODEL_SORT (tree_model), FALSE);
1019   g_return_val_if_fail (GTK_TREE_MODEL_SORT (tree_model)->child_model != NULL, FALSE);
1020   g_return_val_if_fail (GTK_TREE_MODEL_SORT (tree_model)->stamp == iter->stamp, FALSE);
1021
1022   level = iter->user_data;
1023   elt = iter->user_data2;
1024
1025   if (elt - (SortElt *)level->array->data >= level->array->len - 1)
1026     {
1027       iter->stamp = 0;
1028       return FALSE;
1029     }
1030   iter->user_data2 = elt + 1;
1031
1032   return TRUE;
1033 }
1034
1035 static gboolean
1036 gtk_tree_model_sort_iter_children (GtkTreeModel *tree_model,
1037                                    GtkTreeIter  *iter,
1038                                    GtkTreeIter  *parent)
1039 {
1040   GtkTreeModelSort *tree_model_sort = (GtkTreeModelSort *) tree_model;
1041   SortLevel *level;
1042
1043   iter->stamp = 0;
1044   g_return_val_if_fail (GTK_IS_TREE_MODEL_SORT (tree_model), FALSE);
1045   g_return_val_if_fail (tree_model_sort->child_model != NULL, FALSE);
1046   if (parent) g_return_val_if_fail (tree_model_sort->stamp == parent->stamp, FALSE);
1047
1048   if (parent == NULL)
1049     {
1050       if (tree_model_sort->root == NULL)
1051         gtk_tree_model_sort_build_level (tree_model_sort, NULL, NULL);
1052       if (tree_model_sort->root == NULL)
1053         return FALSE;
1054
1055       level = tree_model_sort->root;
1056       iter->stamp = tree_model_sort->stamp;
1057       iter->user_data = level;
1058       iter->user_data2 = level->array->data;
1059     }
1060   else
1061     {
1062       if (((SortElt *)parent->user_data2)->children == NULL)
1063         gtk_tree_model_sort_build_level (tree_model_sort,
1064                                          (SortLevel *)parent->user_data,
1065                                          (SortElt *)parent->user_data2);
1066       if (((SortElt *)parent->user_data2)->children == NULL)
1067         return FALSE;
1068       iter->stamp = tree_model_sort->stamp;
1069       iter->user_data = ((SortElt *)parent->user_data2)->children;
1070       iter->user_data2 = ((SortLevel *)iter->user_data)->array->data;
1071     }
1072
1073   return TRUE;
1074 }
1075
1076 static gboolean
1077 gtk_tree_model_sort_iter_has_child (GtkTreeModel *tree_model,
1078                                     GtkTreeIter  *iter)
1079 {
1080   GtkTreeIter child_iter;
1081
1082   g_return_val_if_fail (GTK_IS_TREE_MODEL_SORT (tree_model), FALSE);
1083   g_return_val_if_fail (GTK_TREE_MODEL_SORT (tree_model)->child_model != NULL, FALSE);
1084   g_return_val_if_fail (GTK_TREE_MODEL_SORT (tree_model)->stamp == iter->stamp, FALSE);
1085
1086   GET_CHILD_ITER (tree_model, &child_iter, iter);
1087
1088   return gtk_tree_model_iter_has_child (GTK_TREE_MODEL_SORT (tree_model)->child_model, &child_iter);
1089 }
1090
1091 static gint
1092 gtk_tree_model_sort_iter_n_children (GtkTreeModel *tree_model,
1093                                      GtkTreeIter  *iter)
1094 {
1095   GtkTreeIter child_iter;
1096
1097   g_return_val_if_fail (GTK_IS_TREE_MODEL_SORT (tree_model), 0);
1098   g_return_val_if_fail (GTK_TREE_MODEL_SORT (tree_model)->child_model != NULL, 0);
1099   if (iter) g_return_val_if_fail (GTK_TREE_MODEL_SORT (tree_model)->stamp == iter->stamp, 0);
1100
1101   if (iter == NULL)
1102     return gtk_tree_model_iter_n_children (GTK_TREE_MODEL_SORT (tree_model)->child_model, NULL);
1103
1104   GET_CHILD_ITER (tree_model, &child_iter, iter);
1105
1106   return gtk_tree_model_iter_n_children (GTK_TREE_MODEL_SORT (tree_model)->child_model, &child_iter);
1107 }
1108
1109 static gboolean
1110 gtk_tree_model_sort_iter_nth_child (GtkTreeModel *tree_model,
1111                                     GtkTreeIter  *iter,
1112                                     GtkTreeIter  *parent,
1113                                     gint          n)
1114 {
1115   SortLevel *level;
1116   /* We have this for the iter == parent case */
1117   GtkTreeIter children;
1118
1119   g_return_val_if_fail (GTK_IS_TREE_MODEL_SORT (tree_model), FALSE);
1120   if (parent) g_return_val_if_fail (GTK_TREE_MODEL_SORT (tree_model)->stamp == parent->stamp, FALSE);
1121
1122   /* Use this instead of has_child to force us to build the level, if needed */
1123   if (gtk_tree_model_sort_iter_children (tree_model, &children, parent) == FALSE)
1124     {
1125       iter->stamp = 0;
1126       return FALSE;
1127     }
1128
1129   level = children.user_data;
1130   if (n >= level->array->len)
1131     {
1132       iter->stamp = 0;
1133       return FALSE;
1134     }
1135
1136   iter->stamp = GTK_TREE_MODEL_SORT (tree_model)->stamp;
1137   iter->user_data = level;
1138   iter->user_data2 = &g_array_index (level->array, SortElt, n);
1139
1140   return TRUE;
1141 }
1142
1143 static gboolean
1144 gtk_tree_model_sort_iter_parent (GtkTreeModel *tree_model,
1145                                  GtkTreeIter  *iter,
1146                                  GtkTreeIter  *child)
1147 {
1148   SortLevel *level;
1149
1150   iter->stamp = 0;
1151   g_return_val_if_fail (GTK_IS_TREE_MODEL_SORT (tree_model), FALSE);
1152   g_return_val_if_fail (GTK_TREE_MODEL_SORT (tree_model)->child_model != NULL, FALSE);
1153   g_return_val_if_fail (GTK_TREE_MODEL_SORT (tree_model)->stamp == child->stamp, FALSE);
1154
1155   level = child->user_data;
1156
1157   if (level->parent_level)
1158     {
1159       iter->stamp = GTK_TREE_MODEL_SORT (tree_model)->stamp;
1160       iter->user_data = level->parent_level;
1161       iter->user_data2 = level->parent_elt;
1162
1163       return TRUE;
1164     }
1165   return FALSE;
1166 }
1167
1168 static void
1169 gtk_tree_model_sort_ref_node (GtkTreeModel *tree_model,
1170                               GtkTreeIter  *iter)
1171 {
1172   GtkTreeModelSort *tree_model_sort = (GtkTreeModelSort *) tree_model;
1173   GtkTreeIter child_iter;
1174   SortLevel *level;
1175   SortElt *elt;
1176
1177   g_return_if_fail (GTK_IS_TREE_MODEL_SORT (tree_model));
1178   g_return_if_fail (GTK_TREE_MODEL_SORT (tree_model)->child_model != NULL);
1179   g_return_if_fail (GTK_TREE_MODEL_SORT (tree_model)->stamp == iter->stamp);
1180
1181   GET_CHILD_ITER (tree_model, &child_iter, iter);
1182
1183   gtk_tree_model_ref_node (GTK_TREE_MODEL_SORT (tree_model)->child_model, &child_iter);
1184
1185   level = iter->user_data;
1186   elt = iter->user_data2;
1187
1188   elt->ref_count++;
1189   level->ref_count++;
1190   if (level->ref_count == 1)
1191     {
1192       SortLevel *parent_level = level->parent_level;
1193       SortElt *parent_elt = level->parent_elt;
1194       /* We were at zero -- time to decrement the zero_ref_count val */
1195       do
1196         {
1197           if (parent_elt)
1198             parent_elt->zero_ref_count--;
1199           else
1200             tree_model_sort->zero_ref_count--;
1201
1202           if (parent_level)
1203             {
1204               parent_elt = parent_level->parent_elt;
1205               parent_level = parent_level->parent_level;
1206             }
1207         }
1208       while (parent_level);
1209     }
1210 }
1211
1212 static void
1213 gtk_tree_model_sort_real_unref_node (GtkTreeModel *tree_model,
1214                                      GtkTreeIter  *iter,
1215                                      gboolean      propagate_unref)
1216 {
1217   GtkTreeModelSort *tree_model_sort = (GtkTreeModelSort *) tree_model;
1218   GtkTreeIter child_iter;
1219   SortLevel *level;
1220   SortElt *elt;
1221
1222   g_return_if_fail (GTK_IS_TREE_MODEL_SORT (tree_model));
1223   g_return_if_fail (GTK_TREE_MODEL_SORT (tree_model)->child_model != NULL);
1224   g_return_if_fail (GTK_TREE_MODEL_SORT (tree_model)->stamp == iter->stamp);
1225
1226   GET_CHILD_ITER (tree_model, &child_iter, iter);
1227
1228   if (propagate_unref)
1229     gtk_tree_model_unref_node (GTK_TREE_MODEL_SORT (tree_model)->child_model, &child_iter);
1230
1231   level = iter->user_data;
1232   elt = iter->user_data2;
1233
1234   g_return_if_fail (elt->ref_count > 0);
1235
1236   elt->ref_count--;
1237   level->ref_count--;
1238
1239   if (level->ref_count == 0)
1240     {
1241       SortLevel *parent_level = level->parent_level;
1242       SortElt *parent_elt = level->parent_elt;
1243
1244       /* We are at zero -- time to increment the zero_ref_count val */
1245       while (parent_level)
1246         {
1247           parent_elt->zero_ref_count++;
1248
1249           parent_elt = parent_level->parent_elt;
1250           parent_level = parent_level->parent_level;
1251         }
1252       tree_model_sort->zero_ref_count++;
1253     }
1254 }
1255
1256 static void
1257 gtk_tree_model_sort_unref_node (GtkTreeModel *tree_model,
1258                                 GtkTreeIter  *iter)
1259 {
1260   gtk_tree_model_sort_real_unref_node (tree_model, iter, TRUE);
1261 }
1262
1263 /* Sortable interface */
1264 static gboolean
1265 gtk_tree_model_sort_get_sort_column_id (GtkTreeSortable *sortable,
1266                                         gint            *sort_column_id,
1267                                         GtkSortType     *order)
1268 {
1269   GtkTreeModelSort *tree_model_sort = (GtkTreeModelSort *)sortable;
1270
1271   g_return_val_if_fail (GTK_IS_TREE_MODEL_SORT (sortable), FALSE);
1272
1273   if (tree_model_sort->sort_column_id == GTK_TREE_SORTABLE_DEFAULT_SORT_COLUMN_ID)
1274     return FALSE;
1275
1276   if (sort_column_id)
1277     *sort_column_id = tree_model_sort->sort_column_id;
1278   if (order)
1279     *order = tree_model_sort->order;
1280
1281   return TRUE;
1282 }
1283
1284 static void
1285 gtk_tree_model_sort_set_sort_column_id (GtkTreeSortable *sortable,
1286                                         gint             sort_column_id,
1287                                         GtkSortType      order)
1288 {
1289   GtkTreeModelSort *tree_model_sort = (GtkTreeModelSort *)sortable;
1290
1291   g_return_if_fail (GTK_IS_TREE_MODEL_SORT (sortable));
1292
1293   if (sort_column_id != GTK_TREE_SORTABLE_DEFAULT_SORT_COLUMN_ID)
1294     {
1295       GtkTreeDataSortHeader *header = NULL;
1296
1297       header = _gtk_tree_data_list_get_header (tree_model_sort->sort_list,
1298                                                sort_column_id);
1299
1300       /* we want to make sure that we have a function */
1301       g_return_if_fail (header != NULL);
1302       g_return_if_fail (header->func != NULL);
1303     }
1304   else
1305     g_return_if_fail (tree_model_sort->default_sort_func != NULL);
1306
1307   if (tree_model_sort->sort_column_id == sort_column_id)
1308     {
1309       if (sort_column_id != GTK_TREE_SORTABLE_DEFAULT_SORT_COLUMN_ID)
1310         {
1311           if (tree_model_sort->order == order)
1312             return;
1313         }
1314       else
1315         return;
1316     }
1317
1318   tree_model_sort->sort_column_id = sort_column_id;
1319   tree_model_sort->order = order;
1320
1321   gtk_tree_sortable_sort_column_changed (sortable);
1322
1323   gtk_tree_model_sort_sort (tree_model_sort);
1324 }
1325
1326 static void
1327 gtk_tree_model_sort_set_sort_func (GtkTreeSortable        *sortable,
1328                                    gint                    sort_column_id,
1329                                    GtkTreeIterCompareFunc  func,
1330                                    gpointer                data,
1331                                    GtkDestroyNotify        destroy)
1332 {
1333   GtkTreeModelSort *tree_model_sort = (GtkTreeModelSort *) sortable;
1334   GtkTreeDataSortHeader *header = NULL;
1335   GList *list;
1336
1337   g_return_if_fail (GTK_IS_TREE_MODEL_SORT (sortable));
1338   g_return_if_fail (func != NULL);
1339
1340   for (list = tree_model_sort->sort_list; list; list = list->next)
1341     {
1342       GtkTreeDataSortHeader *list_header;
1343
1344       list_header = (GtkTreeDataSortHeader*) list->data;
1345       if (list_header->sort_column_id == sort_column_id)
1346         {
1347           header = list_header;
1348           break;
1349         }
1350     }
1351
1352   if (header == NULL)
1353     {
1354       header = g_new0 (GtkTreeDataSortHeader, 1);
1355       header->sort_column_id = sort_column_id;
1356       tree_model_sort->sort_list = g_list_append (tree_model_sort->sort_list,
1357                                                   header);
1358     }
1359
1360   if (header->destroy)
1361     {
1362       GtkDestroyNotify d = header->destroy;
1363
1364       header->destroy = NULL;
1365       d (header->data);
1366     }
1367
1368   header->func = func;
1369   header->data = data;
1370   header->destroy = destroy;
1371
1372   if (tree_model_sort->sort_column_id == sort_column_id)
1373     gtk_tree_model_sort_sort (tree_model_sort);
1374 }
1375
1376 static void
1377 gtk_tree_model_sort_set_default_sort_func (GtkTreeSortable        *sortable,
1378                                            GtkTreeIterCompareFunc  func,
1379                                            gpointer                data,
1380                                            GtkDestroyNotify        destroy)
1381 {
1382   GtkTreeModelSort *tree_model_sort = (GtkTreeModelSort *)sortable;
1383
1384   g_return_if_fail (GTK_IS_TREE_MODEL_SORT (sortable));
1385
1386   if (tree_model_sort->default_sort_destroy)
1387     {
1388       GtkDestroyNotify d = tree_model_sort->default_sort_destroy;
1389
1390       tree_model_sort->default_sort_destroy = NULL;
1391       d (tree_model_sort->default_sort_data);
1392     }
1393
1394   tree_model_sort->default_sort_func = func;
1395   tree_model_sort->default_sort_data = data;
1396   tree_model_sort->default_sort_destroy = destroy;
1397
1398   if (tree_model_sort->sort_column_id == GTK_TREE_SORTABLE_DEFAULT_SORT_COLUMN_ID)
1399     gtk_tree_model_sort_sort (tree_model_sort);
1400 }
1401
1402 static gboolean
1403 gtk_tree_model_sort_has_default_sort_func (GtkTreeSortable *sortable)
1404 {
1405   GtkTreeModelSort *tree_model_sort = (GtkTreeModelSort *)sortable;
1406
1407   g_return_val_if_fail (GTK_IS_TREE_MODEL_SORT (sortable), FALSE);
1408
1409   return (tree_model_sort->default_sort_func != NULL);
1410 }
1411
1412 /* sorting code - private */
1413 static gint
1414 gtk_tree_model_sort_compare_func (gconstpointer a,
1415                                   gconstpointer b,
1416                                   gpointer      user_data)
1417 {
1418   SortData *data = (SortData *)user_data;
1419   GtkTreeModelSort *tree_model_sort = data->tree_model_sort;
1420   SortTuple *sa = (SortTuple *)a;
1421   SortTuple *sb = (SortTuple *)b;
1422
1423   GtkTreeIter iter_a, iter_b;
1424   gint retval;
1425
1426   /* shortcut, if we've the same offsets here, they should be equal */
1427   if (sa->offset == sb->offset)
1428     return 0;
1429
1430   if (GTK_TREE_MODEL_SORT_CACHE_CHILD_ITERS (tree_model_sort))
1431     {
1432       iter_a = sa->elt->iter;
1433       iter_b = sb->elt->iter;
1434     }
1435   else
1436     {
1437       data->parent_path_indices [data->parent_path_depth-1] = sa->elt->offset;
1438       gtk_tree_model_get_iter (GTK_TREE_MODEL (tree_model_sort->child_model), &iter_a, data->parent_path);
1439       data->parent_path_indices [data->parent_path_depth-1] = sb->elt->offset;
1440       gtk_tree_model_get_iter (GTK_TREE_MODEL (tree_model_sort->child_model), &iter_b, data->parent_path);
1441     }
1442
1443   retval = (* data->sort_func) (GTK_TREE_MODEL (tree_model_sort->child_model),
1444                                 &iter_a, &iter_b,
1445                                 data->sort_data);
1446
1447   if (tree_model_sort->order == GTK_SORT_DESCENDING)
1448     {
1449       if (retval > 0)
1450         retval = -1;
1451       else if (retval < 0)
1452         retval = 1;
1453     }
1454
1455   return retval;
1456 }
1457
1458 static gint
1459 gtk_tree_model_sort_offset_compare_func (gconstpointer a,
1460                                          gconstpointer b,
1461                                          gpointer      user_data)
1462 {
1463   gint retval;
1464
1465   SortTuple *sa = (SortTuple *)a;
1466   SortTuple *sb = (SortTuple *)b;
1467
1468   SortData *data = (SortData *)user_data;
1469
1470   if (sa->elt->offset < sb->elt->offset)
1471     retval = -1;
1472   else if (sa->elt->offset > sb->elt->offset)
1473     retval = 1;
1474   else
1475     retval = 0;
1476
1477   if (data->tree_model_sort->order == GTK_SORT_DESCENDING)
1478     {
1479       if (retval > 0)
1480         retval = -1;
1481       else if (retval < 0)
1482         retval = 1;
1483     }
1484
1485   return retval;
1486 }
1487
1488 static void
1489 gtk_tree_model_sort_sort_level (GtkTreeModelSort *tree_model_sort,
1490                                 SortLevel        *level,
1491                                 gboolean          recurse,
1492                                 gboolean          emit_reordered)
1493 {
1494   gint i;
1495   GArray *sort_array;
1496   GArray *new_array;
1497   gint *new_order;
1498
1499   GtkTreeIter iter;
1500   GtkTreePath *path;
1501
1502   SortData data;
1503
1504   g_return_if_fail (GTK_IS_TREE_MODEL_SORT (tree_model_sort));
1505   g_return_if_fail (level != NULL);
1506
1507   if (level->array->len < 1 && !((SortElt *)level->array->data)->children)
1508     return;
1509
1510   /* Set up data */
1511   data.tree_model_sort = tree_model_sort;
1512   if (level->parent_elt)
1513     {
1514       data.parent_path = gtk_tree_model_sort_elt_get_path (level->parent_level,
1515                                                            level->parent_elt);
1516       gtk_tree_path_append_index (data.parent_path, 0);
1517     }
1518   else
1519     {
1520       data.parent_path = gtk_tree_path_new_first ();
1521     }
1522   data.parent_path_depth = gtk_tree_path_get_depth (data.parent_path);
1523   data.parent_path_indices = gtk_tree_path_get_indices (data.parent_path);
1524
1525   /* make the array to be sorted */
1526   sort_array = g_array_sized_new (FALSE, FALSE, sizeof (SortTuple), level->array->len);
1527   for (i = 0; i < level->array->len; i++)
1528     {
1529       SortTuple tuple;
1530
1531       tuple.elt = &g_array_index (level->array, SortElt, i);
1532       tuple.offset = i;
1533
1534       g_array_append_val (sort_array, tuple);
1535     }
1536
1537     if (tree_model_sort->sort_column_id != GTK_TREE_SORTABLE_DEFAULT_SORT_COLUMN_ID)
1538       {
1539         GtkTreeDataSortHeader *header = NULL;
1540
1541         header = _gtk_tree_data_list_get_header (tree_model_sort->sort_list,
1542                                                  tree_model_sort->sort_column_id);
1543
1544         g_return_if_fail (header != NULL);
1545         g_return_if_fail (header->func != NULL);
1546
1547         data.sort_func = header->func;
1548         data.sort_data = header->data;
1549       }
1550     else
1551       {
1552         /* absolutely SHOULD NOT happen: */
1553         g_return_if_fail (tree_model_sort->default_sort_func != NULL);
1554
1555         data.sort_func = tree_model_sort->default_sort_func;
1556         data.sort_data = tree_model_sort->default_sort_data;
1557       }
1558
1559   if (data.sort_func == NO_SORT_FUNC)
1560     g_array_sort_with_data (sort_array,
1561                             gtk_tree_model_sort_offset_compare_func,
1562                             &data);
1563   else
1564     g_array_sort_with_data (sort_array,
1565                             gtk_tree_model_sort_compare_func,
1566                             &data);
1567
1568   gtk_tree_path_free (data.parent_path);
1569
1570   new_array = g_array_sized_new (FALSE, FALSE, sizeof (SortElt), level->array->len);
1571   new_order = g_new (gint, level->array->len);
1572
1573   for (i = 0; i < level->array->len; i++)
1574     {
1575       SortElt *elt;
1576
1577       elt = g_array_index (sort_array, SortTuple, i).elt;
1578       new_order[i] = g_array_index (sort_array, SortTuple, i).offset;
1579
1580       g_array_append_val (new_array, *elt);
1581       elt = &g_array_index (new_array, SortElt, i);
1582       if (elt->children)
1583         elt->children->parent_elt = elt;
1584     }
1585
1586   g_array_free (level->array, TRUE);
1587   level->array = new_array;
1588   g_array_free (sort_array, TRUE);
1589
1590   if (emit_reordered)
1591     {
1592       gtk_tree_model_sort_increment_stamp (tree_model_sort);
1593       if (level->parent_elt)
1594         {
1595           iter.stamp = tree_model_sort->stamp;
1596           iter.user_data = level->parent_level;
1597           iter.user_data2 = level->parent_elt;
1598
1599           path = gtk_tree_model_get_path (GTK_TREE_MODEL (tree_model_sort),
1600                                           &iter);
1601
1602           gtk_tree_model_rows_reordered (GTK_TREE_MODEL (tree_model_sort), path,
1603                                          &iter, new_order);
1604         }
1605       else
1606         {
1607           /* toplevel list */
1608           path = gtk_tree_path_new ();
1609           gtk_tree_model_rows_reordered (GTK_TREE_MODEL (tree_model_sort), path,
1610                                          NULL, new_order);
1611         }
1612
1613       gtk_tree_path_free (path);
1614     }
1615
1616   /* recurse, if possible */
1617   if (recurse)
1618     {
1619       for (i = 0; i < level->array->len; i++)
1620         {
1621           SortElt *elt = &g_array_index (level->array, SortElt, i);
1622
1623           if (elt->children)
1624             gtk_tree_model_sort_sort_level (tree_model_sort,
1625                                             elt->children,
1626                                             TRUE, emit_reordered);
1627         }
1628     }
1629
1630   g_free (new_order);
1631 }
1632
1633 static void
1634 gtk_tree_model_sort_sort (GtkTreeModelSort *tree_model_sort)
1635 {
1636   g_return_if_fail (GTK_IS_TREE_MODEL_SORT (tree_model_sort));
1637
1638   if (!tree_model_sort->root)
1639     return;
1640
1641   if (tree_model_sort->sort_column_id != GTK_TREE_SORTABLE_DEFAULT_SORT_COLUMN_ID)
1642     {
1643       GtkTreeDataSortHeader *header = NULL;
1644
1645       header = _gtk_tree_data_list_get_header (tree_model_sort->sort_list,
1646                                                tree_model_sort->sort_column_id);
1647
1648       /* we want to make sure that we have a function */
1649       g_return_if_fail (header != NULL);
1650       g_return_if_fail (header->func != NULL);
1651     }
1652   else
1653     g_return_if_fail (tree_model_sort->default_sort_func != NULL);
1654
1655   gtk_tree_model_sort_sort_level (tree_model_sort, tree_model_sort->root,
1656                                   TRUE, TRUE);
1657 }
1658
1659 /* signal helpers */
1660 static gint
1661 gtk_tree_model_sort_level_find_insert (GtkTreeModelSort *tree_model_sort,
1662                                        SortLevel        *level,
1663                                        GtkTreeIter      *iter,
1664                                        gboolean          skip_sort_elt)
1665 {
1666   gint middle;
1667   gint cmp;
1668   SortElt *tmp_elt;
1669   GtkTreeIter tmp_iter;
1670
1671   GtkTreeIterCompareFunc func;
1672   gpointer data;
1673
1674   GtkTreePath *path;
1675
1676   if (tree_model_sort->sort_column_id != GTK_TREE_SORTABLE_DEFAULT_SORT_COLUMN_ID)
1677     {
1678       GtkTreeDataSortHeader *header;
1679
1680       header = _gtk_tree_data_list_get_header (tree_model_sort->sort_list,
1681                                                tree_model_sort->sort_column_id);
1682
1683       g_return_val_if_fail (header != NULL, 0);
1684
1685       func = header->func;
1686       data = header->data;
1687     }
1688   else
1689     {
1690       func = tree_model_sort->default_sort_func;
1691       data = tree_model_sort->default_sort_data;
1692
1693       g_return_val_if_fail (func != NO_SORT_FUNC, 0);
1694     }
1695
1696   g_return_val_if_fail (func != NULL, 0);
1697
1698   for (middle = 0; middle < level->array->len; middle++)
1699     {
1700       tmp_elt = &(g_array_index (level->array, SortElt, middle));
1701
1702       if (!skip_sort_elt && SORT_ELT (iter->user_data2) == tmp_elt)
1703         continue;
1704
1705       path = gtk_tree_model_sort_elt_get_path (level, tmp_elt);
1706       gtk_tree_model_get_iter (tree_model_sort->child_model,
1707                                &tmp_iter, path);
1708       gtk_tree_path_free (path);
1709
1710       if (tree_model_sort->order == GTK_SORT_ASCENDING)
1711         cmp = (* func) (GTK_TREE_MODEL (tree_model_sort->child_model),
1712                         &tmp_iter, iter, data);
1713       else
1714         cmp = (* func) (GTK_TREE_MODEL (tree_model_sort->child_model),
1715                         iter, &tmp_iter, data);
1716
1717       if (cmp > 0)
1718         break;
1719     }
1720
1721   return middle;
1722 }
1723
1724 static gboolean
1725 gtk_tree_model_sort_insert_value (GtkTreeModelSort *tree_model_sort,
1726                                   SortLevel        *level,
1727                                   GtkTreePath      *s_path,
1728                                   GtkTreeIter      *s_iter)
1729 {
1730   gint offset, index, i;
1731
1732   SortElt elt;
1733   SortElt *tmp_elt;
1734
1735   offset = gtk_tree_path_get_indices (s_path)[gtk_tree_path_get_depth (s_path) - 1];
1736
1737   if (GTK_TREE_MODEL_SORT_CACHE_CHILD_ITERS (tree_model_sort))
1738     elt.iter = *s_iter;
1739   elt.offset = offset;
1740   elt.zero_ref_count = 0;
1741   elt.ref_count = 0;
1742   elt.children = NULL;
1743
1744   /* update all larger offsets */
1745   tmp_elt = SORT_ELT (level->array->data);
1746   for (i = 0; i < level->array->len; i++, tmp_elt++)
1747     if (tmp_elt->offset >= offset)
1748       tmp_elt->offset++;
1749
1750   if (tree_model_sort->sort_column_id == GTK_TREE_SORTABLE_DEFAULT_SORT_COLUMN_ID &&
1751       tree_model_sort->default_sort_func == NO_SORT_FUNC)
1752     index = offset;
1753   else
1754     index = gtk_tree_model_sort_level_find_insert (tree_model_sort,
1755                                                    level, s_iter,
1756                                                    FALSE);
1757
1758   g_array_insert_vals (level->array, index, &elt, 1);
1759   tmp_elt = SORT_ELT (level->array->data);
1760   for (i = 0; i < level->array->len; i++, tmp_elt++)
1761     if (tmp_elt->children)
1762       tmp_elt->children->parent_elt = tmp_elt;
1763
1764   return TRUE;
1765 }
1766
1767 /* sort elt stuff */
1768 static GtkTreePath *
1769 gtk_tree_model_sort_elt_get_path (SortLevel *level,
1770                                   SortElt *elt)
1771 {
1772   SortLevel *walker = level;
1773   SortElt *walker2 = elt;
1774   GtkTreePath *path;
1775
1776   g_return_val_if_fail (level != NULL, NULL);
1777   g_return_val_if_fail (elt != NULL, NULL);
1778
1779   path = gtk_tree_path_new ();
1780
1781   while (walker)
1782     {
1783       gtk_tree_path_prepend_index (path, walker2->offset);
1784
1785       walker2 = walker->parent_elt;
1786       walker = walker->parent_level;
1787     }
1788
1789   return path;
1790 }
1791
1792 /**
1793  * gtk_tree_model_sort_set_model:
1794  * @tree_model_sort: The #GtkTreeModelSort.
1795  * @child_model: A #GtkTreeModel, or NULL.
1796  *
1797  * Sets the model of @tree_model_sort to be @model.  If @model is NULL, then the
1798  * old model is unset.  The sort function is unset as a result of this call.
1799  * The model will be in an unsorted state until a sort function is set.
1800  **/
1801 static void
1802 gtk_tree_model_sort_set_model (GtkTreeModelSort *tree_model_sort,
1803                                GtkTreeModel     *child_model)
1804 {
1805   g_return_if_fail (GTK_IS_TREE_MODEL_SORT (tree_model_sort));
1806
1807   if (child_model)
1808     g_object_ref (child_model);
1809
1810   if (tree_model_sort->child_model)
1811     {
1812       g_signal_handler_disconnect (tree_model_sort->child_model,
1813                                    tree_model_sort->changed_id);
1814       g_signal_handler_disconnect (tree_model_sort->child_model,
1815                                    tree_model_sort->inserted_id);
1816       g_signal_handler_disconnect (tree_model_sort->child_model,
1817                                    tree_model_sort->has_child_toggled_id);
1818       g_signal_handler_disconnect (tree_model_sort->child_model,
1819                                    tree_model_sort->deleted_id);
1820       g_signal_handler_disconnect (tree_model_sort->child_model,
1821                                    tree_model_sort->reordered_id);
1822
1823       /* reset our state */
1824       if (tree_model_sort->root)
1825         gtk_tree_model_sort_free_level (tree_model_sort, tree_model_sort->root);
1826       tree_model_sort->root = NULL;
1827       _gtk_tree_data_list_header_free (tree_model_sort->sort_list);
1828       tree_model_sort->sort_list = NULL;
1829       g_object_unref (tree_model_sort->child_model);
1830     }
1831
1832   tree_model_sort->child_model = child_model;
1833
1834   if (child_model)
1835     {
1836       GType *types;
1837       gint i, n_columns;
1838
1839       tree_model_sort->changed_id =
1840         g_signal_connect (child_model, "row_changed",
1841                           G_CALLBACK (gtk_tree_model_sort_row_changed),
1842                           tree_model_sort);
1843       tree_model_sort->inserted_id =
1844         g_signal_connect (child_model, "row_inserted",
1845                           G_CALLBACK (gtk_tree_model_sort_row_inserted),
1846                           tree_model_sort);
1847       tree_model_sort->has_child_toggled_id =
1848         g_signal_connect (child_model, "row_has_child_toggled",
1849                           G_CALLBACK (gtk_tree_model_sort_row_has_child_toggled),
1850                           tree_model_sort);
1851       tree_model_sort->deleted_id =
1852         g_signal_connect (child_model, "row_deleted",
1853                           G_CALLBACK (gtk_tree_model_sort_row_deleted),
1854                           tree_model_sort);
1855       tree_model_sort->reordered_id =
1856         g_signal_connect (child_model, "rows_reordered",
1857                           G_CALLBACK (gtk_tree_model_sort_rows_reordered),
1858                           tree_model_sort);
1859
1860       tree_model_sort->child_flags = gtk_tree_model_get_flags (child_model);
1861       n_columns = gtk_tree_model_get_n_columns (child_model);
1862
1863       types = g_new (GType, n_columns);
1864       for (i = 0; i < n_columns; i++)
1865         types[i] = gtk_tree_model_get_column_type (child_model, i);
1866
1867       tree_model_sort->sort_list = _gtk_tree_data_list_header_new (n_columns, types);
1868       g_free (types);
1869
1870       tree_model_sort->default_sort_func = NO_SORT_FUNC;
1871       tree_model_sort->stamp = g_random_int ();
1872     }
1873 }
1874
1875 /**
1876  * gtk_tree_model_sort_get_model:
1877  * @tree_model: a #GtkTreeModelSort
1878  *
1879  * Returns the model the #GtkTreeModelSort is sorting.
1880  *
1881  * Return value: the "child model" being sorted
1882  **/
1883 GtkTreeModel *
1884 gtk_tree_model_sort_get_model (GtkTreeModelSort  *tree_model)
1885 {
1886   g_return_val_if_fail (GTK_IS_TREE_MODEL_SORT (tree_model), NULL);
1887
1888   return tree_model->child_model;
1889 }
1890
1891
1892 static GtkTreePath *
1893 gtk_real_tree_model_sort_convert_child_path_to_path (GtkTreeModelSort *tree_model_sort,
1894                                                      GtkTreePath      *child_path,
1895                                                      gboolean          build_levels)
1896 {
1897   gint *child_indices;
1898   GtkTreePath *retval;
1899   SortLevel *level;
1900   gint i;
1901
1902   g_return_val_if_fail (GTK_IS_TREE_MODEL_SORT (tree_model_sort), NULL);
1903   g_return_val_if_fail (tree_model_sort->child_model != NULL, NULL);
1904   g_return_val_if_fail (child_path != NULL, NULL);
1905
1906   retval = gtk_tree_path_new ();
1907   child_indices = gtk_tree_path_get_indices (child_path);
1908
1909   if (tree_model_sort->root == NULL && build_levels)
1910     gtk_tree_model_sort_build_level (tree_model_sort, NULL, NULL);
1911   level = SORT_LEVEL (tree_model_sort->root);
1912
1913   for (i = 0; i < gtk_tree_path_get_depth (child_path); i++)
1914     {
1915       gint j;
1916       gboolean found_child = FALSE;
1917
1918       if (!level)
1919         {
1920           gtk_tree_path_free (retval);
1921           return NULL;
1922         }
1923
1924       if (child_indices[i] >= level->array->len)
1925         {
1926           gtk_tree_path_free (retval);
1927           return NULL;
1928         }
1929       for (j = 0; j < level->array->len; j++)
1930         {
1931           if ((g_array_index (level->array, SortElt, j)).offset == child_indices[i])
1932             {
1933               gtk_tree_path_append_index (retval, j);
1934               if (g_array_index (level->array, SortElt, j).children == NULL && build_levels)
1935                 {
1936                   gtk_tree_model_sort_build_level (tree_model_sort, level, &g_array_index (level->array, SortElt, j));
1937                 }
1938               level = g_array_index (level->array, SortElt, j).children;
1939               found_child = TRUE;
1940               break;
1941             }
1942         }
1943       if (! found_child)
1944         {
1945           gtk_tree_path_free (retval);
1946           return NULL;
1947         }
1948     }
1949
1950   return retval;
1951 }
1952
1953
1954 /**
1955  * gtk_tree_model_sort_convert_child_path_to_path:
1956  * @tree_model_sort: A #GtkTreeModelSort
1957  * @child_path: A #GtkTreePath to convert
1958  *
1959  * Converts @child_path to a path relative to @tree_model_sort.  That is,
1960  * @child_path points to a path in the child model.  The returned path will
1961  * point to the same row in the sorted model.  If @child_path isn't a valid path
1962  * on the child model, then %NULL is returned.
1963  *
1964  * Return value: A newly allocated #GtkTreePath, or %NULL
1965  **/
1966 GtkTreePath *
1967 gtk_tree_model_sort_convert_child_path_to_path (GtkTreeModelSort *tree_model_sort,
1968                                                 GtkTreePath      *child_path)
1969 {
1970   g_return_val_if_fail (GTK_IS_TREE_MODEL_SORT (tree_model_sort), NULL);
1971   g_return_val_if_fail (tree_model_sort->child_model != NULL, NULL);
1972   g_return_val_if_fail (child_path != NULL, NULL);
1973
1974   return gtk_real_tree_model_sort_convert_child_path_to_path (tree_model_sort, child_path, TRUE);
1975 }
1976
1977 /**
1978  * gtk_tree_model_sort_convert_child_iter_to_iter:
1979  * @tree_model_sort: A #GtkTreeModelSort
1980  * @sort_iter: An uninitialized #GtkTreeIter.
1981  * @child_iter: A valid #GtkTreeIter pointing to a row on the child model
1982  *
1983  * Sets @sort_iter to point to the row in @tree_model_sort that corresponds to
1984  * the row pointed at by @child_iter.
1985  **/
1986 void
1987 gtk_tree_model_sort_convert_child_iter_to_iter (GtkTreeModelSort *tree_model_sort,
1988                                                 GtkTreeIter      *sort_iter,
1989                                                 GtkTreeIter      *child_iter)
1990 {
1991   GtkTreePath *child_path, *path;
1992
1993   g_return_if_fail (GTK_IS_TREE_MODEL_SORT (tree_model_sort));
1994   g_return_if_fail (tree_model_sort->child_model != NULL);
1995   g_return_if_fail (sort_iter != NULL);
1996   g_return_if_fail (child_iter != NULL);
1997
1998   sort_iter->stamp = 0;
1999
2000   child_path = gtk_tree_model_get_path (tree_model_sort->child_model, child_iter);
2001   g_return_if_fail (child_path != NULL);
2002
2003   path = gtk_tree_model_sort_convert_child_path_to_path (tree_model_sort, child_path);
2004   gtk_tree_path_free (child_path);
2005   g_return_if_fail (path != NULL);
2006
2007   gtk_tree_model_get_iter (GTK_TREE_MODEL (tree_model_sort), sort_iter, path);
2008   gtk_tree_path_free (path);
2009 }
2010
2011 /**
2012  * gtk_tree_model_sort_convert_path_to_child_path:
2013  * @tree_model_sort: A #GtkTreeModelSort
2014  * @sorted_path: A #GtkTreePath to convert
2015  *
2016  * Converts @sorted_path to a path on the child model of @tree_model_sort.  That
2017  * is, @sorted_path points to a location in @tree_model_sort.  The returned path
2018  * will point to the same location in the model not being sorted.  If @sorted_path
2019  * does not point to a location in the child model, %NULL is returned.
2020  *
2021  * Return value: A newly allocated #GtkTreePath, or %NULL
2022  **/
2023 GtkTreePath *
2024 gtk_tree_model_sort_convert_path_to_child_path (GtkTreeModelSort *tree_model_sort,
2025                                                 GtkTreePath      *sorted_path)
2026 {
2027   gint *sorted_indices;
2028   GtkTreePath *retval;
2029   SortLevel *level;
2030   gint i;
2031
2032   g_return_val_if_fail (GTK_IS_TREE_MODEL_SORT (tree_model_sort), NULL);
2033   g_return_val_if_fail (tree_model_sort->child_model != NULL, NULL);
2034   g_return_val_if_fail (sorted_path != NULL, NULL);
2035
2036   retval = gtk_tree_path_new ();
2037   sorted_indices = gtk_tree_path_get_indices (sorted_path);
2038   if (tree_model_sort->root == NULL)
2039     gtk_tree_model_sort_build_level (tree_model_sort, NULL, NULL);
2040   level = SORT_LEVEL (tree_model_sort->root);
2041
2042   for (i = 0; i < gtk_tree_path_get_depth (sorted_path); i++)
2043     {
2044       gint count = sorted_indices[i];
2045
2046       if ((level == NULL) ||
2047           (level->array->len <= count))
2048         {
2049           gtk_tree_path_free (retval);
2050           return NULL;
2051         }
2052
2053       if (g_array_index (level->array, SortElt, count).children == NULL)
2054         gtk_tree_model_sort_build_level (tree_model_sort, level, &g_array_index (level->array, SortElt, count));
2055
2056       if (level == NULL)
2057         {
2058           gtk_tree_path_free (retval);
2059           break;
2060         }
2061
2062       gtk_tree_path_append_index (retval, g_array_index (level->array, SortElt, count).offset);
2063       level = g_array_index (level->array, SortElt, count).children;
2064     }
2065
2066   return retval;
2067 }
2068
2069 /**
2070  * gtk_tree_model_sort_convert_iter_to_child_iter:
2071  * @tree_model_sort: A #GtkTreeModelSort
2072  * @child_iter: An uninitialized #GtkTreeIter
2073  * @sorted_iter: A valid #GtkTreeIter pointing to a row on @tree_model_sort.
2074  *
2075  * Sets @child_iter to point to the row pointed to by @sorted_iter.
2076  **/
2077 void
2078 gtk_tree_model_sort_convert_iter_to_child_iter (GtkTreeModelSort *tree_model_sort,
2079                                                 GtkTreeIter      *child_iter,
2080                                                 GtkTreeIter      *sorted_iter)
2081 {
2082   g_return_if_fail (GTK_IS_TREE_MODEL_SORT (tree_model_sort));
2083   g_return_if_fail (tree_model_sort->child_model != NULL);
2084   g_return_if_fail (child_iter != NULL);
2085   g_return_if_fail (sorted_iter != NULL);
2086   g_return_if_fail (sorted_iter->stamp == tree_model_sort->stamp);
2087
2088   if (GTK_TREE_MODEL_SORT_CACHE_CHILD_ITERS (tree_model_sort))
2089     {
2090       *child_iter = SORT_ELT (sorted_iter->user_data2)->iter;
2091     }
2092   else
2093     {
2094       GtkTreePath *path;
2095
2096       path = gtk_tree_model_sort_elt_get_path (sorted_iter->user_data,
2097                                                sorted_iter->user_data2);
2098       gtk_tree_model_get_iter (tree_model_sort->child_model, child_iter, path);
2099       gtk_tree_path_free (path);
2100     }
2101 }
2102
2103 static void
2104 gtk_tree_model_sort_build_level (GtkTreeModelSort *tree_model_sort,
2105                                  SortLevel        *parent_level,
2106                                  SortElt          *parent_elt)
2107 {
2108   GtkTreeIter iter;
2109   SortLevel *new_level;
2110   gint length = 0;
2111   gint i;
2112
2113   g_assert (tree_model_sort->child_model != NULL);
2114
2115   if (parent_level == NULL)
2116     {
2117       if (gtk_tree_model_get_iter_first (tree_model_sort->child_model, &iter) == FALSE)
2118         return;
2119       length = gtk_tree_model_iter_n_children (tree_model_sort->child_model, NULL);
2120     }
2121   else
2122     {
2123       GtkTreeIter parent_iter;
2124       GtkTreeIter child_parent_iter;
2125
2126       parent_iter.stamp = tree_model_sort->stamp;
2127       parent_iter.user_data = parent_level;
2128       parent_iter.user_data2 = parent_elt;
2129
2130       gtk_tree_model_sort_convert_iter_to_child_iter (tree_model_sort,
2131                                                       &child_parent_iter,
2132                                                       &parent_iter);
2133       if (gtk_tree_model_iter_children (tree_model_sort->child_model,
2134                                         &iter,
2135                                         &child_parent_iter) == FALSE)
2136         return;
2137
2138       /* stamp may have changed */
2139       gtk_tree_model_sort_convert_iter_to_child_iter (tree_model_sort,
2140                                                       &child_parent_iter,
2141                                                       &parent_iter);
2142
2143       length = gtk_tree_model_iter_n_children (tree_model_sort->child_model, &child_parent_iter);
2144     }
2145
2146   g_return_if_fail (length > 0);
2147
2148   new_level = g_new (SortLevel, 1);
2149   new_level->array = g_array_sized_new (FALSE, FALSE, sizeof (SortElt), length);
2150   new_level->ref_count = 0;
2151   new_level->parent_elt = parent_elt;
2152   new_level->parent_level = parent_level;
2153
2154   if (parent_elt)
2155     parent_elt->children = new_level;
2156   else
2157     tree_model_sort->root = new_level;
2158
2159   /* increase the count of zero ref_counts.*/
2160   while (parent_level)
2161     {
2162       parent_elt->zero_ref_count++;
2163
2164       parent_elt = parent_level->parent_elt;
2165       parent_level = parent_level->parent_level;
2166     }
2167   if (new_level != tree_model_sort->root)
2168     tree_model_sort->zero_ref_count++;
2169
2170   for (i = 0; i < length; i++)
2171     {
2172       SortElt sort_elt;
2173       sort_elt.offset = i;
2174       sort_elt.zero_ref_count = 0;
2175       sort_elt.ref_count = 0;
2176       sort_elt.children = NULL;
2177
2178       if (GTK_TREE_MODEL_SORT_CACHE_CHILD_ITERS (tree_model_sort))
2179         {
2180           sort_elt.iter = iter;
2181           if (gtk_tree_model_iter_next (tree_model_sort->child_model, &iter) == FALSE &&
2182               i < length - 1)
2183             {
2184               g_warning ("There is a discrepency between the sort model and the child model.");
2185               return;
2186             }
2187         }
2188       g_array_append_val (new_level->array, sort_elt);
2189     }
2190
2191   /* sort level */
2192   gtk_tree_model_sort_sort_level (tree_model_sort, new_level,
2193                                   FALSE, FALSE);
2194 }
2195
2196 static void
2197 gtk_tree_model_sort_free_level (GtkTreeModelSort *tree_model_sort,
2198                                 SortLevel        *sort_level)
2199 {
2200   gint i;
2201
2202   g_assert (sort_level);
2203
2204   if (sort_level->ref_count == 0)
2205     {
2206       SortLevel *parent_level = sort_level->parent_level;
2207       SortElt *parent_elt = sort_level->parent_elt;
2208
2209       do
2210         {
2211           if (parent_elt)
2212             parent_elt->zero_ref_count--;
2213           else
2214             tree_model_sort->zero_ref_count--;
2215
2216           if (parent_level)
2217             {
2218               parent_elt = parent_level->parent_elt;
2219               parent_level = parent_level->parent_level;
2220             }
2221         }
2222       while (parent_level);
2223     }
2224
2225   for (i = 0; i < sort_level->array->len; i++)
2226     {
2227       if (g_array_index (sort_level->array, SortElt, i).children)
2228         gtk_tree_model_sort_free_level (tree_model_sort,
2229                                         SORT_LEVEL(g_array_index (sort_level->array, SortElt, i).children));
2230     }
2231
2232   if (sort_level->parent_elt)
2233     sort_level->parent_elt->children = NULL;
2234   else
2235     tree_model_sort->root = NULL;
2236
2237   g_array_free (sort_level->array, TRUE);
2238   sort_level->array = NULL;
2239
2240   g_free (sort_level);
2241   sort_level = NULL;
2242 }
2243
2244 static void
2245 gtk_tree_model_sort_increment_stamp (GtkTreeModelSort *tree_model_sort)
2246 {
2247   do
2248     {
2249       tree_model_sort->stamp++;
2250     }
2251   while (tree_model_sort->stamp == 0);
2252
2253   gtk_tree_model_sort_clear_cache (tree_model_sort);
2254 }
2255
2256 static void
2257 gtk_tree_model_sort_clear_cache_helper (GtkTreeModelSort *tree_model_sort,
2258                                         SortLevel        *level)
2259 {
2260   gint i;
2261
2262   g_assert (level != NULL);
2263
2264   for (i = 0; i < level->array->len; i++)
2265     {
2266       if (g_array_index (level->array, SortElt, i).zero_ref_count > 0)
2267         gtk_tree_model_sort_clear_cache_helper (tree_model_sort, g_array_index (level->array, SortElt, i).children);
2268     }
2269
2270   if (level->ref_count == 0 && level != tree_model_sort->root)
2271     gtk_tree_model_sort_free_level (tree_model_sort, level);
2272 }
2273
2274 /**
2275  * gtk_tree_model_sort_reset_default_sort_func:
2276  * @tree_model_sort: A #GtkTreeModelSort
2277  *
2278  * This resets the default sort function to be in the 'unsorted' state.  That
2279  * is, it is in the same order as the child model. It will re-sort the model
2280  * to be in the same order as the child model only if the #GtkTreeModelSort
2281  * is in 'unsorted' state.
2282  **/
2283 void
2284 gtk_tree_model_sort_reset_default_sort_func (GtkTreeModelSort *tree_model_sort)
2285 {
2286   g_return_if_fail (GTK_IS_TREE_MODEL_SORT (tree_model_sort));
2287
2288   if (tree_model_sort->default_sort_destroy)
2289     {
2290       GtkDestroyNotify d = tree_model_sort->default_sort_destroy;
2291
2292       tree_model_sort->default_sort_destroy = NULL;
2293       d (tree_model_sort->default_sort_data);
2294     }
2295
2296   tree_model_sort->default_sort_func = NO_SORT_FUNC;
2297   tree_model_sort->default_sort_data = NULL;
2298   tree_model_sort->default_sort_destroy = NULL;
2299
2300   if (tree_model_sort->sort_column_id == GTK_TREE_SORTABLE_DEFAULT_SORT_COLUMN_ID)
2301     gtk_tree_model_sort_sort (tree_model_sort);
2302   tree_model_sort->sort_column_id = GTK_TREE_SORTABLE_DEFAULT_SORT_COLUMN_ID;
2303 }
2304
2305 /**
2306  * gtk_tree_model_sort_clear_cache:
2307  * @tree_model_sort: A #GtkTreeModelSort
2308  *
2309  * This function should almost never be called.  It clears the @tree_model_sort
2310  * of any cached iterators that haven't been reffed with
2311  * gtk_tree_model_ref_node().  This might be useful if the child model being
2312  * sorted is static (and doesn't change often) and there has been a lot of
2313  * unreffed access to nodes.  As a side effect of this function, all unreffed
2314  * iters will be invalid.
2315  **/
2316 void
2317 gtk_tree_model_sort_clear_cache (GtkTreeModelSort *tree_model_sort)
2318 {
2319   g_return_if_fail (GTK_IS_TREE_MODEL_SORT (tree_model_sort));
2320
2321   if (tree_model_sort->zero_ref_count)
2322     gtk_tree_model_sort_clear_cache_helper (tree_model_sort, (SortLevel *)tree_model_sort->root);
2323 }
2324
2325 static gboolean
2326 gtk_tree_model_sort_iter_is_valid_helper (GtkTreeIter *iter,
2327                                           SortLevel   *level)
2328 {
2329   gint i;
2330
2331   for (i = 0; i < level->array->len; i++)
2332     {
2333       SortElt *elt = &g_array_index (level->array, SortElt, i);
2334
2335       if (iter->user_data == level && iter->user_data2 == elt)
2336         return TRUE;
2337
2338       if (elt->children)
2339         if (gtk_tree_model_sort_iter_is_valid_helper (iter, elt->children))
2340           return TRUE;
2341     }
2342
2343   return FALSE;
2344 }
2345
2346 /**
2347  * gtk_tree_model_sort_iter_is_valid:
2348  * @tree_model_sort: A #GtkTreeModelSort.
2349  * @iter: A #GtkTreeIter.
2350  *
2351  * WARNING: This function is slow. Only use it for debugging and/or testing
2352  * purposes.
2353  *
2354  * Checks if the given iter is a valid iter for this #GtkTreeModelSort.
2355  *
2356  * Return value: %TRUE if the iter is valid, %FALSE if the iter is invalid.
2357  *
2358  * Since: 2.2
2359  **/
2360 gboolean
2361 gtk_tree_model_sort_iter_is_valid (GtkTreeModelSort *tree_model_sort,
2362                                    GtkTreeIter      *iter)
2363 {
2364   g_return_val_if_fail (GTK_IS_TREE_MODEL_SORT (tree_model_sort), FALSE);
2365   g_return_val_if_fail (iter != NULL, FALSE);
2366
2367   if (!VALID_ITER (iter, tree_model_sort))
2368     return FALSE;
2369
2370   return gtk_tree_model_sort_iter_is_valid_helper (iter,
2371                                                    tree_model_sort->root);
2372 }