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

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