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