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_DEFAULT_SORT_COLUMN_ID)
1322     {
1323       GtkTreeDataSortHeader *header = NULL;
1324
1325       header = _gtk_tree_data_list_get_header (tree_model_sort->sort_list,
1326                                                sort_column_id);
1327
1328       /* we want to make sure that we have a function */
1329       g_return_if_fail (header != NULL);
1330       g_return_if_fail (header->func != NULL);
1331     }
1332   else
1333     g_return_if_fail (tree_model_sort->default_sort_func != NULL);
1334
1335   if (tree_model_sort->sort_column_id == sort_column_id)
1336     {
1337       if (sort_column_id != GTK_TREE_SORTABLE_DEFAULT_SORT_COLUMN_ID)
1338         {
1339           if (tree_model_sort->order == order)
1340             return;
1341         }
1342       else
1343         return;
1344     }
1345
1346   tree_model_sort->sort_column_id = sort_column_id;
1347   tree_model_sort->order = order;
1348
1349   gtk_tree_sortable_sort_column_changed (sortable);
1350
1351   gtk_tree_model_sort_sort (tree_model_sort);
1352 }
1353
1354 static void
1355 gtk_tree_model_sort_set_sort_func (GtkTreeSortable        *sortable,
1356                                    gint                    sort_column_id,
1357                                    GtkTreeIterCompareFunc  func,
1358                                    gpointer                data,
1359                                    GDestroyNotify          destroy)
1360 {
1361   GtkTreeModelSort *tree_model_sort = (GtkTreeModelSort *) sortable;
1362
1363   tree_model_sort->sort_list = _gtk_tree_data_list_set_header (tree_model_sort->sort_list,
1364                                                                sort_column_id,
1365                                                                func, data, destroy);
1366
1367   if (tree_model_sort->sort_column_id == sort_column_id)
1368     gtk_tree_model_sort_sort (tree_model_sort);
1369 }
1370
1371 static void
1372 gtk_tree_model_sort_set_default_sort_func (GtkTreeSortable        *sortable,
1373                                            GtkTreeIterCompareFunc  func,
1374                                            gpointer                data,
1375                                            GDestroyNotify          destroy)
1376 {
1377   GtkTreeModelSort *tree_model_sort = (GtkTreeModelSort *)sortable;
1378
1379   if (tree_model_sort->default_sort_destroy)
1380     {
1381       GDestroyNotify d = tree_model_sort->default_sort_destroy;
1382
1383       tree_model_sort->default_sort_destroy = NULL;
1384       d (tree_model_sort->default_sort_data);
1385     }
1386
1387   tree_model_sort->default_sort_func = func;
1388   tree_model_sort->default_sort_data = data;
1389   tree_model_sort->default_sort_destroy = destroy;
1390
1391   if (tree_model_sort->sort_column_id == GTK_TREE_SORTABLE_DEFAULT_SORT_COLUMN_ID)
1392     gtk_tree_model_sort_sort (tree_model_sort);
1393 }
1394
1395 static gboolean
1396 gtk_tree_model_sort_has_default_sort_func (GtkTreeSortable *sortable)
1397 {
1398   GtkTreeModelSort *tree_model_sort = (GtkTreeModelSort *)sortable;
1399
1400   return (tree_model_sort->default_sort_func != NULL);
1401 }
1402
1403 /* DragSource interface */
1404 static gboolean
1405 gtk_tree_model_sort_row_draggable (GtkTreeDragSource *drag_source,
1406                                    GtkTreePath       *path)
1407 {
1408   GtkTreeModelSort *tree_model_sort = (GtkTreeModelSort *)drag_source;
1409   GtkTreePath *child_path;
1410   gboolean draggable;
1411
1412   child_path = gtk_tree_model_sort_convert_path_to_child_path (tree_model_sort,
1413                                                                path);
1414   draggable = gtk_tree_drag_source_row_draggable (GTK_TREE_DRAG_SOURCE (tree_model_sort->child_model), child_path);
1415   gtk_tree_path_free (child_path);
1416
1417   return draggable;
1418 }
1419
1420 static gboolean
1421 gtk_tree_model_sort_drag_data_get (GtkTreeDragSource *drag_source,
1422                                    GtkTreePath       *path,
1423                                    GtkSelectionData  *selection_data)
1424 {
1425   GtkTreeModelSort *tree_model_sort = (GtkTreeModelSort *)drag_source;
1426   GtkTreePath *child_path;
1427   gboolean gotten;
1428
1429   child_path = gtk_tree_model_sort_convert_path_to_child_path (tree_model_sort, path);
1430   gotten = gtk_tree_drag_source_drag_data_get (GTK_TREE_DRAG_SOURCE (tree_model_sort->child_model), child_path, selection_data);
1431   gtk_tree_path_free (child_path);
1432
1433   return gotten;
1434 }
1435
1436 static gboolean
1437 gtk_tree_model_sort_drag_data_delete (GtkTreeDragSource *drag_source,
1438                                       GtkTreePath       *path)
1439 {
1440   GtkTreeModelSort *tree_model_sort = (GtkTreeModelSort *)drag_source;
1441   GtkTreePath *child_path;
1442   gboolean deleted;
1443
1444   child_path = gtk_tree_model_sort_convert_path_to_child_path (tree_model_sort, path);
1445   deleted = gtk_tree_drag_source_drag_data_delete (GTK_TREE_DRAG_SOURCE (tree_model_sort->child_model), child_path);
1446   gtk_tree_path_free (child_path);
1447
1448   return deleted;
1449 }
1450
1451 /* sorting code - private */
1452 static gint
1453 gtk_tree_model_sort_compare_func (gconstpointer a,
1454                                   gconstpointer b,
1455                                   gpointer      user_data)
1456 {
1457   SortData *data = (SortData *)user_data;
1458   GtkTreeModelSort *tree_model_sort = data->tree_model_sort;
1459   SortTuple *sa = (SortTuple *)a;
1460   SortTuple *sb = (SortTuple *)b;
1461
1462   GtkTreeIter iter_a, iter_b;
1463   gint retval;
1464
1465   /* shortcut, if we've the same offsets here, they should be equal */
1466   if (sa->offset == sb->offset)
1467     return 0;
1468
1469   if (GTK_TREE_MODEL_SORT_CACHE_CHILD_ITERS (tree_model_sort))
1470     {
1471       iter_a = sa->elt->iter;
1472       iter_b = sb->elt->iter;
1473     }
1474   else
1475     {
1476       data->parent_path_indices [data->parent_path_depth-1] = sa->elt->offset;
1477       gtk_tree_model_get_iter (GTK_TREE_MODEL (tree_model_sort->child_model), &iter_a, data->parent_path);
1478       data->parent_path_indices [data->parent_path_depth-1] = sb->elt->offset;
1479       gtk_tree_model_get_iter (GTK_TREE_MODEL (tree_model_sort->child_model), &iter_b, data->parent_path);
1480     }
1481
1482   retval = (* data->sort_func) (GTK_TREE_MODEL (tree_model_sort->child_model),
1483                                 &iter_a, &iter_b,
1484                                 data->sort_data);
1485
1486   if (tree_model_sort->order == GTK_SORT_DESCENDING)
1487     {
1488       if (retval > 0)
1489         retval = -1;
1490       else if (retval < 0)
1491         retval = 1;
1492     }
1493
1494   return retval;
1495 }
1496
1497 static gint
1498 gtk_tree_model_sort_offset_compare_func (gconstpointer a,
1499                                          gconstpointer b,
1500                                          gpointer      user_data)
1501 {
1502   gint retval;
1503
1504   SortTuple *sa = (SortTuple *)a;
1505   SortTuple *sb = (SortTuple *)b;
1506
1507   SortData *data = (SortData *)user_data;
1508
1509   if (sa->elt->offset < sb->elt->offset)
1510     retval = -1;
1511   else if (sa->elt->offset > sb->elt->offset)
1512     retval = 1;
1513   else
1514     retval = 0;
1515
1516   if (data->tree_model_sort->order == GTK_SORT_DESCENDING)
1517     {
1518       if (retval > 0)
1519         retval = -1;
1520       else if (retval < 0)
1521         retval = 1;
1522     }
1523
1524   return retval;
1525 }
1526
1527 static void
1528 gtk_tree_model_sort_sort_level (GtkTreeModelSort *tree_model_sort,
1529                                 SortLevel        *level,
1530                                 gboolean          recurse,
1531                                 gboolean          emit_reordered)
1532 {
1533   gint i;
1534   gint ref_offset;
1535   GArray *sort_array;
1536   GArray *new_array;
1537   gint *new_order;
1538
1539   GtkTreeIter iter;
1540   GtkTreePath *path;
1541
1542   SortData data;
1543
1544   g_return_if_fail (level != NULL);
1545
1546   if (level->array->len < 1 && !((SortElt *)level->array->data)->children)
1547     return;
1548
1549   iter.stamp = tree_model_sort->stamp;
1550   iter.user_data = level;
1551   iter.user_data2 = &g_array_index (level->array, SortElt, 0);
1552
1553   gtk_tree_model_sort_ref_node (GTK_TREE_MODEL (tree_model_sort), &iter);
1554   ref_offset = g_array_index (level->array, SortElt, 0).offset;
1555
1556   /* Set up data */
1557   data.tree_model_sort = tree_model_sort;
1558   if (level->parent_elt)
1559     {
1560       data.parent_path = gtk_tree_model_sort_elt_get_path (level->parent_level,
1561                                                            level->parent_elt);
1562       gtk_tree_path_append_index (data.parent_path, 0);
1563     }
1564   else
1565     {
1566       data.parent_path = gtk_tree_path_new_first ();
1567     }
1568   data.parent_path_depth = gtk_tree_path_get_depth (data.parent_path);
1569   data.parent_path_indices = gtk_tree_path_get_indices (data.parent_path);
1570
1571   /* make the array to be sorted */
1572   sort_array = g_array_sized_new (FALSE, FALSE, sizeof (SortTuple), level->array->len);
1573   for (i = 0; i < level->array->len; i++)
1574     {
1575       SortTuple tuple;
1576
1577       tuple.elt = &g_array_index (level->array, SortElt, i);
1578       tuple.offset = i;
1579
1580       g_array_append_val (sort_array, tuple);
1581     }
1582
1583     if (tree_model_sort->sort_column_id != GTK_TREE_SORTABLE_DEFAULT_SORT_COLUMN_ID)
1584       {
1585         GtkTreeDataSortHeader *header = NULL;
1586
1587         header = _gtk_tree_data_list_get_header (tree_model_sort->sort_list,
1588                                                  tree_model_sort->sort_column_id);
1589
1590         g_return_if_fail (header != NULL);
1591         g_return_if_fail (header->func != NULL);
1592
1593         data.sort_func = header->func;
1594         data.sort_data = header->data;
1595       }
1596     else
1597       {
1598         /* absolutely SHOULD NOT happen: */
1599         g_return_if_fail (tree_model_sort->default_sort_func != NULL);
1600
1601         data.sort_func = tree_model_sort->default_sort_func;
1602         data.sort_data = tree_model_sort->default_sort_data;
1603       }
1604
1605   if (data.sort_func == NO_SORT_FUNC)
1606     g_array_sort_with_data (sort_array,
1607                             gtk_tree_model_sort_offset_compare_func,
1608                             &data);
1609   else
1610     g_array_sort_with_data (sort_array,
1611                             gtk_tree_model_sort_compare_func,
1612                             &data);
1613
1614   gtk_tree_path_free (data.parent_path);
1615
1616   new_array = g_array_sized_new (FALSE, FALSE, sizeof (SortElt), level->array->len);
1617   new_order = g_new (gint, level->array->len);
1618
1619   for (i = 0; i < level->array->len; i++)
1620     {
1621       SortElt *elt;
1622
1623       elt = g_array_index (sort_array, SortTuple, i).elt;
1624       new_order[i] = g_array_index (sort_array, SortTuple, i).offset;
1625
1626       g_array_append_val (new_array, *elt);
1627       elt = &g_array_index (new_array, SortElt, i);
1628       if (elt->children)
1629         elt->children->parent_elt = elt;
1630     }
1631
1632   g_array_free (level->array, TRUE);
1633   level->array = new_array;
1634   g_array_free (sort_array, TRUE);
1635
1636   if (emit_reordered)
1637     {
1638       gtk_tree_model_sort_increment_stamp (tree_model_sort);
1639       if (level->parent_elt)
1640         {
1641           iter.stamp = tree_model_sort->stamp;
1642           iter.user_data = level->parent_level;
1643           iter.user_data2 = level->parent_elt;
1644
1645           path = gtk_tree_model_get_path (GTK_TREE_MODEL (tree_model_sort),
1646                                           &iter);
1647
1648           gtk_tree_model_rows_reordered (GTK_TREE_MODEL (tree_model_sort), path,
1649                                          &iter, new_order);
1650         }
1651       else
1652         {
1653           /* toplevel list */
1654           path = gtk_tree_path_new ();
1655           gtk_tree_model_rows_reordered (GTK_TREE_MODEL (tree_model_sort), path,
1656                                          NULL, new_order);
1657         }
1658
1659       gtk_tree_path_free (path);
1660     }
1661
1662   /* recurse, if possible */
1663   if (recurse)
1664     {
1665       for (i = 0; i < level->array->len; i++)
1666         {
1667           SortElt *elt = &g_array_index (level->array, SortElt, i);
1668
1669           if (elt->children)
1670             gtk_tree_model_sort_sort_level (tree_model_sort,
1671                                             elt->children,
1672                                             TRUE, emit_reordered);
1673         }
1674     }
1675
1676   g_free (new_order);
1677
1678   /* get the iter we referenced at the beginning of this function and
1679    * unref it again
1680    */
1681   iter.stamp = tree_model_sort->stamp;
1682   iter.user_data = level;
1683
1684   for (i = 0; i < level->array->len; i++)
1685     {
1686       if (g_array_index (level->array, SortElt, i).offset == ref_offset)
1687         {
1688           iter.user_data2 = &g_array_index (level->array, SortElt, i);
1689           break;
1690         }
1691     }
1692
1693   gtk_tree_model_sort_unref_node (GTK_TREE_MODEL (tree_model_sort), &iter);
1694 }
1695
1696 static void
1697 gtk_tree_model_sort_sort (GtkTreeModelSort *tree_model_sort)
1698 {
1699   if (!tree_model_sort->root)
1700     return;
1701
1702   if (tree_model_sort->sort_column_id != GTK_TREE_SORTABLE_DEFAULT_SORT_COLUMN_ID)
1703     {
1704       GtkTreeDataSortHeader *header = NULL;
1705
1706       header = _gtk_tree_data_list_get_header (tree_model_sort->sort_list,
1707                                                tree_model_sort->sort_column_id);
1708
1709       /* we want to make sure that we have a function */
1710       g_return_if_fail (header != NULL);
1711       g_return_if_fail (header->func != NULL);
1712     }
1713   else
1714     g_return_if_fail (tree_model_sort->default_sort_func != NULL);
1715
1716   gtk_tree_model_sort_sort_level (tree_model_sort, tree_model_sort->root,
1717                                   TRUE, TRUE);
1718 }
1719
1720 /* signal helpers */
1721 static gint
1722 gtk_tree_model_sort_level_find_insert (GtkTreeModelSort *tree_model_sort,
1723                                        SortLevel        *level,
1724                                        GtkTreeIter      *iter,
1725                                        gint             skip_index)
1726 {
1727   gint start, middle, end;
1728   gint cmp;
1729   SortElt *tmp_elt;
1730   GtkTreeIter tmp_iter;
1731
1732   GtkTreeIterCompareFunc func;
1733   gpointer data;
1734
1735   if (tree_model_sort->sort_column_id != GTK_TREE_SORTABLE_DEFAULT_SORT_COLUMN_ID)
1736     {
1737       GtkTreeDataSortHeader *header;
1738
1739       header = _gtk_tree_data_list_get_header (tree_model_sort->sort_list,
1740                                                tree_model_sort->sort_column_id);
1741
1742       g_return_val_if_fail (header != NULL, 0);
1743
1744       func = header->func;
1745       data = header->data;
1746     }
1747   else
1748     {
1749       func = tree_model_sort->default_sort_func;
1750       data = tree_model_sort->default_sort_data;
1751
1752       g_return_val_if_fail (func != NO_SORT_FUNC, 0);
1753     }
1754
1755   g_return_val_if_fail (func != NULL, 0);
1756
1757   start = 0;
1758   end = level->array->len;
1759   if (skip_index < 0)
1760     skip_index = end;
1761   else
1762     end--;
1763
1764   if (start == end)
1765     return 0;
1766
1767   while (start != end)
1768     {
1769       middle = (start + end) / 2;
1770
1771       if (middle < skip_index)
1772         tmp_elt = &(g_array_index (level->array, SortElt, middle));
1773       else
1774         tmp_elt = &(g_array_index (level->array, SortElt, middle + 1));
1775
1776       if (!GTK_TREE_MODEL_SORT_CACHE_CHILD_ITERS (tree_model_sort))
1777         {
1778           GtkTreePath *path = gtk_tree_model_sort_elt_get_path (level, tmp_elt);
1779           gtk_tree_model_get_iter (tree_model_sort->child_model,
1780                                    &tmp_iter, path);
1781           gtk_tree_path_free (path);
1782         }
1783       else
1784         tmp_iter = tmp_elt->iter;
1785
1786       if (tree_model_sort->order == GTK_SORT_ASCENDING)
1787         cmp = (* func) (GTK_TREE_MODEL (tree_model_sort->child_model),
1788                         &tmp_iter, iter, data);
1789       else
1790         cmp = (* func) (GTK_TREE_MODEL (tree_model_sort->child_model),
1791                         iter, &tmp_iter, data);
1792
1793       if (cmp <= 0)
1794         start = middle + 1;
1795       else
1796         end = middle;
1797     }
1798
1799   if (cmp <= 0)
1800     return middle + 1;
1801   else
1802     return middle;
1803 }
1804
1805 static gboolean
1806 gtk_tree_model_sort_insert_value (GtkTreeModelSort *tree_model_sort,
1807                                   SortLevel        *level,
1808                                   GtkTreePath      *s_path,
1809                                   GtkTreeIter      *s_iter)
1810 {
1811   gint offset, index, i;
1812
1813   SortElt elt;
1814   SortElt *tmp_elt;
1815
1816   offset = gtk_tree_path_get_indices (s_path)[gtk_tree_path_get_depth (s_path) - 1];
1817
1818   if (GTK_TREE_MODEL_SORT_CACHE_CHILD_ITERS (tree_model_sort))
1819     elt.iter = *s_iter;
1820   elt.offset = offset;
1821   elt.zero_ref_count = 0;
1822   elt.ref_count = 0;
1823   elt.children = NULL;
1824
1825   /* update all larger offsets */
1826   tmp_elt = SORT_ELT (level->array->data);
1827   for (i = 0; i < level->array->len; i++, tmp_elt++)
1828     if (tmp_elt->offset >= offset)
1829       tmp_elt->offset++;
1830
1831   if (tree_model_sort->sort_column_id == GTK_TREE_SORTABLE_DEFAULT_SORT_COLUMN_ID &&
1832       tree_model_sort->default_sort_func == NO_SORT_FUNC)
1833     index = offset;
1834   else
1835     index = gtk_tree_model_sort_level_find_insert (tree_model_sort,
1836                                                    level, s_iter,
1837                                                    -1);
1838
1839   g_array_insert_vals (level->array, index, &elt, 1);
1840   tmp_elt = SORT_ELT (level->array->data);
1841   for (i = 0; i < level->array->len; i++, tmp_elt++)
1842     if (tmp_elt->children)
1843       tmp_elt->children->parent_elt = tmp_elt;
1844
1845   return TRUE;
1846 }
1847
1848 /* sort elt stuff */
1849 static GtkTreePath *
1850 gtk_tree_model_sort_elt_get_path (SortLevel *level,
1851                                   SortElt *elt)
1852 {
1853   SortLevel *walker = level;
1854   SortElt *walker2 = elt;
1855   GtkTreePath *path;
1856
1857   g_return_val_if_fail (level != NULL, NULL);
1858   g_return_val_if_fail (elt != NULL, NULL);
1859
1860   path = gtk_tree_path_new ();
1861
1862   while (walker)
1863     {
1864       gtk_tree_path_prepend_index (path, walker2->offset);
1865
1866       walker2 = walker->parent_elt;
1867       walker = walker->parent_level;
1868     }
1869
1870   return path;
1871 }
1872
1873 /**
1874  * gtk_tree_model_sort_set_model:
1875  * @tree_model_sort: The #GtkTreeModelSort.
1876  * @child_model: A #GtkTreeModel, or %NULL.
1877  *
1878  * Sets the model of @tree_model_sort to be @model.  If @model is %NULL,
1879  * then the old model is unset.  The sort function is unset as a result
1880  * of this call. The model will be in an unsorted state until a sort
1881  * function is set.
1882  **/
1883 static void
1884 gtk_tree_model_sort_set_model (GtkTreeModelSort *tree_model_sort,
1885                                GtkTreeModel     *child_model)
1886 {
1887   if (child_model)
1888     g_object_ref (child_model);
1889
1890   if (tree_model_sort->child_model)
1891     {
1892       g_signal_handler_disconnect (tree_model_sort->child_model,
1893                                    tree_model_sort->changed_id);
1894       g_signal_handler_disconnect (tree_model_sort->child_model,
1895                                    tree_model_sort->inserted_id);
1896       g_signal_handler_disconnect (tree_model_sort->child_model,
1897                                    tree_model_sort->has_child_toggled_id);
1898       g_signal_handler_disconnect (tree_model_sort->child_model,
1899                                    tree_model_sort->deleted_id);
1900       g_signal_handler_disconnect (tree_model_sort->child_model,
1901                                    tree_model_sort->reordered_id);
1902
1903       /* reset our state */
1904       if (tree_model_sort->root)
1905         gtk_tree_model_sort_free_level (tree_model_sort, tree_model_sort->root);
1906       tree_model_sort->root = NULL;
1907       _gtk_tree_data_list_header_free (tree_model_sort->sort_list);
1908       tree_model_sort->sort_list = NULL;
1909       g_object_unref (tree_model_sort->child_model);
1910     }
1911
1912   tree_model_sort->child_model = child_model;
1913
1914   if (child_model)
1915     {
1916       GType *types;
1917       gint i, n_columns;
1918
1919       tree_model_sort->changed_id =
1920         g_signal_connect (child_model, "row_changed",
1921                           G_CALLBACK (gtk_tree_model_sort_row_changed),
1922                           tree_model_sort);
1923       tree_model_sort->inserted_id =
1924         g_signal_connect (child_model, "row_inserted",
1925                           G_CALLBACK (gtk_tree_model_sort_row_inserted),
1926                           tree_model_sort);
1927       tree_model_sort->has_child_toggled_id =
1928         g_signal_connect (child_model, "row_has_child_toggled",
1929                           G_CALLBACK (gtk_tree_model_sort_row_has_child_toggled),
1930                           tree_model_sort);
1931       tree_model_sort->deleted_id =
1932         g_signal_connect (child_model, "row_deleted",
1933                           G_CALLBACK (gtk_tree_model_sort_row_deleted),
1934                           tree_model_sort);
1935       tree_model_sort->reordered_id =
1936         g_signal_connect (child_model, "rows_reordered",
1937                           G_CALLBACK (gtk_tree_model_sort_rows_reordered),
1938                           tree_model_sort);
1939
1940       tree_model_sort->child_flags = gtk_tree_model_get_flags (child_model);
1941       n_columns = gtk_tree_model_get_n_columns (child_model);
1942
1943       types = g_new (GType, n_columns);
1944       for (i = 0; i < n_columns; i++)
1945         types[i] = gtk_tree_model_get_column_type (child_model, i);
1946
1947       tree_model_sort->sort_list = _gtk_tree_data_list_header_new (n_columns, types);
1948       g_free (types);
1949
1950       tree_model_sort->default_sort_func = NO_SORT_FUNC;
1951       tree_model_sort->stamp = g_random_int ();
1952     }
1953 }
1954
1955 /**
1956  * gtk_tree_model_sort_get_model:
1957  * @tree_model: a #GtkTreeModelSort
1958  *
1959  * Returns the model the #GtkTreeModelSort is sorting.
1960  *
1961  * Return value: the "child model" being sorted
1962  **/
1963 GtkTreeModel *
1964 gtk_tree_model_sort_get_model (GtkTreeModelSort *tree_model)
1965 {
1966   g_return_val_if_fail (GTK_IS_TREE_MODEL_SORT (tree_model), NULL);
1967
1968   return tree_model->child_model;
1969 }
1970
1971
1972 static GtkTreePath *
1973 gtk_real_tree_model_sort_convert_child_path_to_path (GtkTreeModelSort *tree_model_sort,
1974                                                      GtkTreePath      *child_path,
1975                                                      gboolean          build_levels)
1976 {
1977   gint *child_indices;
1978   GtkTreePath *retval;
1979   SortLevel *level;
1980   gint i;
1981
1982   g_return_val_if_fail (tree_model_sort->child_model != NULL, NULL);
1983   g_return_val_if_fail (child_path != NULL, NULL);
1984
1985   retval = gtk_tree_path_new ();
1986   child_indices = gtk_tree_path_get_indices (child_path);
1987
1988   if (tree_model_sort->root == NULL && build_levels)
1989     gtk_tree_model_sort_build_level (tree_model_sort, NULL, NULL);
1990   level = SORT_LEVEL (tree_model_sort->root);
1991
1992   for (i = 0; i < gtk_tree_path_get_depth (child_path); i++)
1993     {
1994       gint j;
1995       gboolean found_child = FALSE;
1996
1997       if (!level)
1998         {
1999           gtk_tree_path_free (retval);
2000           return NULL;
2001         }
2002
2003       if (child_indices[i] >= level->array->len)
2004         {
2005           gtk_tree_path_free (retval);
2006           return NULL;
2007         }
2008       for (j = 0; j < level->array->len; j++)
2009         {
2010           if ((g_array_index (level->array, SortElt, j)).offset == child_indices[i])
2011             {
2012               gtk_tree_path_append_index (retval, j);
2013               if (g_array_index (level->array, SortElt, j).children == NULL && build_levels)
2014                 {
2015                   gtk_tree_model_sort_build_level (tree_model_sort, level, &g_array_index (level->array, SortElt, j));
2016                 }
2017               level = g_array_index (level->array, SortElt, j).children;
2018               found_child = TRUE;
2019               break;
2020             }
2021         }
2022       if (! found_child)
2023         {
2024           gtk_tree_path_free (retval);
2025           return NULL;
2026         }
2027     }
2028
2029   return retval;
2030 }
2031
2032
2033 /**
2034  * gtk_tree_model_sort_convert_child_path_to_path:
2035  * @tree_model_sort: A #GtkTreeModelSort
2036  * @child_path: A #GtkTreePath to convert
2037  *
2038  * Converts @child_path to a path relative to @tree_model_sort.  That is,
2039  * @child_path points to a path in the child model.  The returned path will
2040  * point to the same row in the sorted model.  If @child_path isn't a valid
2041  * path on the child model, then %NULL is returned.
2042  *
2043  * Return value: A newly allocated #GtkTreePath, or %NULL
2044  **/
2045 GtkTreePath *
2046 gtk_tree_model_sort_convert_child_path_to_path (GtkTreeModelSort *tree_model_sort,
2047                                                 GtkTreePath      *child_path)
2048 {
2049   g_return_val_if_fail (GTK_IS_TREE_MODEL_SORT (tree_model_sort), NULL);
2050   g_return_val_if_fail (tree_model_sort->child_model != NULL, NULL);
2051   g_return_val_if_fail (child_path != NULL, NULL);
2052
2053   return gtk_real_tree_model_sort_convert_child_path_to_path (tree_model_sort, child_path, TRUE);
2054 }
2055
2056 /**
2057  * gtk_tree_model_sort_convert_child_iter_to_iter:
2058  * @tree_model_sort: A #GtkTreeModelSort
2059  * @sort_iter: An uninitialized #GtkTreeIter.
2060  * @child_iter: A valid #GtkTreeIter pointing to a row on the child model
2061  *
2062  * Sets @sort_iter to point to the row in @tree_model_sort that corresponds to
2063  * the row pointed at by @child_iter.  If @sort_iter was not set, %FALSE
2064  * is returned.  Note: a boolean is only returned since 2.14.
2065  *
2066  * Return value: %TRUE, if @sort_iter was set, i.e. if @sort_iter is a
2067  * valid iterator pointer to a visible row in the child model.
2068  **/
2069 gboolean
2070 gtk_tree_model_sort_convert_child_iter_to_iter (GtkTreeModelSort *tree_model_sort,
2071                                                 GtkTreeIter      *sort_iter,
2072                                                 GtkTreeIter      *child_iter)
2073 {
2074   gboolean ret;
2075   GtkTreePath *child_path, *path;
2076
2077   g_return_val_if_fail (GTK_IS_TREE_MODEL_SORT (tree_model_sort), FALSE);
2078   g_return_val_if_fail (tree_model_sort->child_model != NULL, FALSE);
2079   g_return_val_if_fail (sort_iter != NULL, FALSE);
2080   g_return_val_if_fail (child_iter != NULL, FALSE);
2081
2082   sort_iter->stamp = 0;
2083
2084   child_path = gtk_tree_model_get_path (tree_model_sort->child_model, child_iter);
2085   g_return_val_if_fail (child_path != NULL, FALSE);
2086
2087   path = gtk_tree_model_sort_convert_child_path_to_path (tree_model_sort, child_path);
2088   gtk_tree_path_free (child_path);
2089
2090   if (!path)
2091     {
2092       g_warning ("%s: The conversion of the child path to a GtkTreeModel sort path failed", G_STRLOC);
2093       return FALSE;
2094     }
2095
2096   ret = gtk_tree_model_get_iter (GTK_TREE_MODEL (tree_model_sort),
2097                                  sort_iter, path);
2098   gtk_tree_path_free (path);
2099
2100   return ret;
2101 }
2102
2103 /**
2104  * gtk_tree_model_sort_convert_path_to_child_path:
2105  * @tree_model_sort: A #GtkTreeModelSort
2106  * @sorted_path: A #GtkTreePath to convert
2107  *
2108  * Converts @sorted_path to a path on the child model of @tree_model_sort.
2109  * That is, @sorted_path points to a location in @tree_model_sort.  The
2110  * returned path will point to the same location in the model not being
2111  * sorted.  If @sorted_path does not point to a location in the child model,
2112  * %NULL is returned.
2113  *
2114  * Return value: A newly allocated #GtkTreePath, or %NULL
2115  **/
2116 GtkTreePath *
2117 gtk_tree_model_sort_convert_path_to_child_path (GtkTreeModelSort *tree_model_sort,
2118                                                 GtkTreePath      *sorted_path)
2119 {
2120   gint *sorted_indices;
2121   GtkTreePath *retval;
2122   SortLevel *level;
2123   gint i;
2124
2125   g_return_val_if_fail (GTK_IS_TREE_MODEL_SORT (tree_model_sort), NULL);
2126   g_return_val_if_fail (tree_model_sort->child_model != NULL, NULL);
2127   g_return_val_if_fail (sorted_path != NULL, NULL);
2128
2129   retval = gtk_tree_path_new ();
2130   sorted_indices = gtk_tree_path_get_indices (sorted_path);
2131   if (tree_model_sort->root == NULL)
2132     gtk_tree_model_sort_build_level (tree_model_sort, NULL, NULL);
2133   level = SORT_LEVEL (tree_model_sort->root);
2134
2135   for (i = 0; i < gtk_tree_path_get_depth (sorted_path); i++)
2136     {
2137       gint count = sorted_indices[i];
2138
2139       if ((level == NULL) ||
2140           (level->array->len <= count))
2141         {
2142           gtk_tree_path_free (retval);
2143           return NULL;
2144         }
2145
2146       if (g_array_index (level->array, SortElt, count).children == NULL)
2147         gtk_tree_model_sort_build_level (tree_model_sort, level, &g_array_index (level->array, SortElt, count));
2148
2149       if (level == NULL)
2150         {
2151           gtk_tree_path_free (retval);
2152           break;
2153         }
2154
2155       gtk_tree_path_append_index (retval, g_array_index (level->array, SortElt, count).offset);
2156       level = g_array_index (level->array, SortElt, count).children;
2157     }
2158
2159   return retval;
2160 }
2161
2162 /**
2163  * gtk_tree_model_sort_convert_iter_to_child_iter:
2164  * @tree_model_sort: A #GtkTreeModelSort
2165  * @child_iter: An uninitialized #GtkTreeIter
2166  * @sorted_iter: A valid #GtkTreeIter pointing to a row on @tree_model_sort.
2167  *
2168  * Sets @child_iter to point to the row pointed to by @sorted_iter.
2169  **/
2170 void
2171 gtk_tree_model_sort_convert_iter_to_child_iter (GtkTreeModelSort *tree_model_sort,
2172                                                 GtkTreeIter      *child_iter,
2173                                                 GtkTreeIter      *sorted_iter)
2174 {
2175   g_return_if_fail (GTK_IS_TREE_MODEL_SORT (tree_model_sort));
2176   g_return_if_fail (tree_model_sort->child_model != NULL);
2177   g_return_if_fail (child_iter != NULL);
2178   g_return_if_fail (VALID_ITER (sorted_iter, tree_model_sort));
2179
2180   if (GTK_TREE_MODEL_SORT_CACHE_CHILD_ITERS (tree_model_sort))
2181     {
2182       *child_iter = SORT_ELT (sorted_iter->user_data2)->iter;
2183     }
2184   else
2185     {
2186       GtkTreePath *path;
2187
2188       path = gtk_tree_model_sort_elt_get_path (sorted_iter->user_data,
2189                                                sorted_iter->user_data2);
2190       gtk_tree_model_get_iter (tree_model_sort->child_model, child_iter, path);
2191       gtk_tree_path_free (path);
2192     }
2193 }
2194
2195 static void
2196 gtk_tree_model_sort_build_level (GtkTreeModelSort *tree_model_sort,
2197                                  SortLevel        *parent_level,
2198                                  SortElt          *parent_elt)
2199 {
2200   GtkTreeIter iter;
2201   SortLevel *new_level;
2202   gint length = 0;
2203   gint i;
2204
2205   g_assert (tree_model_sort->child_model != NULL);
2206
2207   if (parent_level == NULL)
2208     {
2209       if (gtk_tree_model_get_iter_first (tree_model_sort->child_model, &iter) == FALSE)
2210         return;
2211       length = gtk_tree_model_iter_n_children (tree_model_sort->child_model, NULL);
2212     }
2213   else
2214     {
2215       GtkTreeIter parent_iter;
2216       GtkTreeIter child_parent_iter;
2217
2218       parent_iter.stamp = tree_model_sort->stamp;
2219       parent_iter.user_data = parent_level;
2220       parent_iter.user_data2 = parent_elt;
2221
2222       gtk_tree_model_sort_convert_iter_to_child_iter (tree_model_sort,
2223                                                       &child_parent_iter,
2224                                                       &parent_iter);
2225       if (gtk_tree_model_iter_children (tree_model_sort->child_model,
2226                                         &iter,
2227                                         &child_parent_iter) == FALSE)
2228         return;
2229
2230       /* stamp may have changed */
2231       gtk_tree_model_sort_convert_iter_to_child_iter (tree_model_sort,
2232                                                       &child_parent_iter,
2233                                                       &parent_iter);
2234
2235       length = gtk_tree_model_iter_n_children (tree_model_sort->child_model, &child_parent_iter);
2236     }
2237
2238   g_return_if_fail (length > 0);
2239
2240   new_level = g_new (SortLevel, 1);
2241   new_level->array = g_array_sized_new (FALSE, FALSE, sizeof (SortElt), length);
2242   new_level->ref_count = 0;
2243   new_level->parent_elt = parent_elt;
2244   new_level->parent_level = parent_level;
2245
2246   if (parent_elt)
2247     parent_elt->children = new_level;
2248   else
2249     tree_model_sort->root = new_level;
2250
2251   /* increase the count of zero ref_counts.*/
2252   while (parent_level)
2253     {
2254       parent_elt->zero_ref_count++;
2255
2256       parent_elt = parent_level->parent_elt;
2257       parent_level = parent_level->parent_level;
2258     }
2259   if (new_level != tree_model_sort->root)
2260     tree_model_sort->zero_ref_count++;
2261
2262   for (i = 0; i < length; i++)
2263     {
2264       SortElt sort_elt;
2265       sort_elt.offset = i;
2266       sort_elt.zero_ref_count = 0;
2267       sort_elt.ref_count = 0;
2268       sort_elt.children = NULL;
2269
2270       if (GTK_TREE_MODEL_SORT_CACHE_CHILD_ITERS (tree_model_sort))
2271         {
2272           sort_elt.iter = iter;
2273           if (gtk_tree_model_iter_next (tree_model_sort->child_model, &iter) == FALSE &&
2274               i < length - 1)
2275             {
2276               if (parent_level)
2277                 {
2278                   GtkTreePath *level;
2279                   gchar *str;
2280
2281                   level = gtk_tree_model_sort_elt_get_path (parent_level,
2282                                                             parent_elt);
2283                   str = gtk_tree_path_to_string (level);
2284                   gtk_tree_path_free (level);
2285
2286                   g_warning ("%s: There is a discrepancy between the sort model "
2287                              "and the child model.  The child model is "
2288                              "advertising a wrong length for level %s:.",
2289                              G_STRLOC, str);
2290                   g_free (str);
2291                 }
2292               else
2293                 {
2294                   g_warning ("%s: There is a discrepancy between the sort model "
2295                              "and the child model.  The child model is "
2296                              "advertising a wrong length for the root level.",
2297                              G_STRLOC);
2298                 }
2299
2300               return;
2301             }
2302         }
2303       g_array_append_val (new_level->array, sort_elt);
2304     }
2305
2306   /* sort level */
2307   gtk_tree_model_sort_sort_level (tree_model_sort, new_level,
2308                                   FALSE, FALSE);
2309 }
2310
2311 static void
2312 gtk_tree_model_sort_free_level (GtkTreeModelSort *tree_model_sort,
2313                                 SortLevel        *sort_level)
2314 {
2315   gint i;
2316
2317   g_assert (sort_level);
2318
2319   for (i = 0; i < sort_level->array->len; i++)
2320     {
2321       if (g_array_index (sort_level->array, SortElt, i).children)
2322         gtk_tree_model_sort_free_level (tree_model_sort,
2323                                         SORT_LEVEL (g_array_index (sort_level->array, SortElt, i).children));
2324     }
2325
2326   if (sort_level->ref_count == 0)
2327     {
2328       SortLevel *parent_level = sort_level->parent_level;
2329       SortElt *parent_elt = sort_level->parent_elt;
2330
2331       while (parent_level)
2332         {
2333           parent_elt->zero_ref_count--;
2334
2335           parent_elt = parent_level->parent_elt;
2336           parent_level = parent_level->parent_level;
2337         }
2338
2339       if (sort_level != tree_model_sort->root)
2340         tree_model_sort->zero_ref_count--;
2341     }
2342
2343   if (sort_level->parent_elt)
2344     sort_level->parent_elt->children = NULL;
2345   else
2346     tree_model_sort->root = NULL;
2347
2348   g_array_free (sort_level->array, TRUE);
2349   sort_level->array = NULL;
2350
2351   g_free (sort_level);
2352   sort_level = NULL;
2353 }
2354
2355 static void
2356 gtk_tree_model_sort_increment_stamp (GtkTreeModelSort *tree_model_sort)
2357 {
2358   do
2359     {
2360       tree_model_sort->stamp++;
2361     }
2362   while (tree_model_sort->stamp == 0);
2363
2364   gtk_tree_model_sort_clear_cache (tree_model_sort);
2365 }
2366
2367 static void
2368 gtk_tree_model_sort_clear_cache_helper (GtkTreeModelSort *tree_model_sort,
2369                                         SortLevel        *level)
2370 {
2371   gint i;
2372
2373   g_assert (level != NULL);
2374
2375   for (i = 0; i < level->array->len; i++)
2376     {
2377       if (g_array_index (level->array, SortElt, i).zero_ref_count > 0)
2378         gtk_tree_model_sort_clear_cache_helper (tree_model_sort, g_array_index (level->array, SortElt, i).children);
2379     }
2380
2381   if (level->ref_count == 0 && level != tree_model_sort->root)
2382     gtk_tree_model_sort_free_level (tree_model_sort, level);
2383 }
2384
2385 /**
2386  * gtk_tree_model_sort_reset_default_sort_func:
2387  * @tree_model_sort: A #GtkTreeModelSort
2388  *
2389  * This resets the default sort function to be in the 'unsorted' state.  That
2390  * is, it is in the same order as the child model. It will re-sort the model
2391  * to be in the same order as the child model only if the #GtkTreeModelSort
2392  * is in 'unsorted' state.
2393  **/
2394 void
2395 gtk_tree_model_sort_reset_default_sort_func (GtkTreeModelSort *tree_model_sort)
2396 {
2397   g_return_if_fail (GTK_IS_TREE_MODEL_SORT (tree_model_sort));
2398
2399   if (tree_model_sort->default_sort_destroy)
2400     {
2401       GDestroyNotify d = tree_model_sort->default_sort_destroy;
2402
2403       tree_model_sort->default_sort_destroy = NULL;
2404       d (tree_model_sort->default_sort_data);
2405     }
2406
2407   tree_model_sort->default_sort_func = NO_SORT_FUNC;
2408   tree_model_sort->default_sort_data = NULL;
2409   tree_model_sort->default_sort_destroy = NULL;
2410
2411   if (tree_model_sort->sort_column_id == GTK_TREE_SORTABLE_DEFAULT_SORT_COLUMN_ID)
2412     gtk_tree_model_sort_sort (tree_model_sort);
2413   tree_model_sort->sort_column_id = GTK_TREE_SORTABLE_DEFAULT_SORT_COLUMN_ID;
2414 }
2415
2416 /**
2417  * gtk_tree_model_sort_clear_cache:
2418  * @tree_model_sort: A #GtkTreeModelSort
2419  *
2420  * This function should almost never be called.  It clears the @tree_model_sort
2421  * of any cached iterators that haven't been reffed with
2422  * gtk_tree_model_ref_node().  This might be useful if the child model being
2423  * sorted is static (and doesn't change often) and there has been a lot of
2424  * unreffed access to nodes.  As a side effect of this function, all unreffed
2425  * iters will be invalid.
2426  **/
2427 void
2428 gtk_tree_model_sort_clear_cache (GtkTreeModelSort *tree_model_sort)
2429 {
2430   g_return_if_fail (GTK_IS_TREE_MODEL_SORT (tree_model_sort));
2431
2432   if (tree_model_sort->zero_ref_count > 0)
2433     gtk_tree_model_sort_clear_cache_helper (tree_model_sort, (SortLevel *)tree_model_sort->root);
2434 }
2435
2436 static gboolean
2437 gtk_tree_model_sort_iter_is_valid_helper (GtkTreeIter *iter,
2438                                           SortLevel   *level)
2439 {
2440   gint i;
2441
2442   for (i = 0; i < level->array->len; i++)
2443     {
2444       SortElt *elt = &g_array_index (level->array, SortElt, i);
2445
2446       if (iter->user_data == level && iter->user_data2 == elt)
2447         return TRUE;
2448
2449       if (elt->children)
2450         if (gtk_tree_model_sort_iter_is_valid_helper (iter, elt->children))
2451           return TRUE;
2452     }
2453
2454   return FALSE;
2455 }
2456
2457 /**
2458  * gtk_tree_model_sort_iter_is_valid:
2459  * @tree_model_sort: A #GtkTreeModelSort.
2460  * @iter: A #GtkTreeIter.
2461  *
2462  * <warning><para>
2463  * This function is slow. Only use it for debugging and/or testing purposes.
2464  * </para></warning>
2465  *
2466  * Checks if the given iter is a valid iter for this #GtkTreeModelSort.
2467  *
2468  * Return value: %TRUE if the iter is valid, %FALSE if the iter is invalid.
2469  *
2470  * Since: 2.2
2471  **/
2472 gboolean
2473 gtk_tree_model_sort_iter_is_valid (GtkTreeModelSort *tree_model_sort,
2474                                    GtkTreeIter      *iter)
2475 {
2476   g_return_val_if_fail (GTK_IS_TREE_MODEL_SORT (tree_model_sort), FALSE);
2477   g_return_val_if_fail (iter != NULL, FALSE);
2478
2479   if (!VALID_ITER (iter, tree_model_sort))
2480     return FALSE;
2481
2482   return gtk_tree_model_sort_iter_is_valid_helper (iter,
2483                                                    tree_model_sort->root);
2484 }
2485
2486 #define __GTK_TREE_MODEL_SORT_C__
2487 #include "gtkaliasdef.c"