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