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