2 * Copyright (C) 2000,2001 Red Hat, Inc., Jonathan Blandford <jrb@redhat.com>
3 * Copyright (C) 2001,2002 Kristian Rietveld <kris@gtk.org>
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.
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.
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.
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);
29 * iter->stamp = tree_model_sort->stamp
30 * iter->user_data = SortLevel
31 * iter->user_data2 = SortElt
34 /* WARNING: this code is dangerous, can cause sleepless nights,
35 * can cause your dog to die among other bad things
37 * we warned you and we're not liable for any head injuries.
40 #include "gtktreemodelsort.h"
41 #include "gtktreesortable.h"
42 #include "gtktreestore.h"
43 #include "gtksignal.h"
44 #include "gtktreedatalist.h"
48 typedef struct _SortElt SortElt;
49 typedef struct _SortLevel SortLevel;
50 typedef struct _SortData SortData;
51 typedef struct _SortTuple SortTuple;
67 SortLevel *parent_level;
72 GtkTreeModelSort *tree_model_sort;
73 GtkTreePath *parent_path;
74 gint parent_path_depth;
75 gint *parent_path_indices;
76 GtkTreeIterCompareFunc sort_func;
95 #define GTK_TREE_MODEL_SORT_CACHE_CHILD_ITERS(tree_model_sort) \
96 (((GtkTreeModelSort *)tree_model_sort)->child_flags>K_TREE_MODEL_ITERS_PERSIST)
97 #define SORT_ELT(sort_elt) ((SortElt *)sort_elt)
98 #define SORT_LEVEL(sort_level) ((SortLevel *)sort_level)
100 #define GET_CHILD_ITER(tree_model_sort,child_iter,sort_iter) gtk_tree_model_sort_convert_iter_to_child_iter(GTK_TREE_MODEL_SORT (tree_model_sort), child_iter, sort_iter);
102 /* general (object/interface init, etc) */
103 static void gtk_tree_model_sort_init (GtkTreeModelSort *tree_model_sort);
104 static void gtk_tree_model_sort_class_init (GtkTreeModelSortClass *tree_model_sort_class);
105 static void gtk_tree_model_sort_tree_model_init (GtkTreeModelIface *iface);
106 static void gtk_tree_model_sort_tree_sortable_init (GtkTreeSortableIface *iface);
107 static void gtk_tree_model_sort_finalize (GObject *object);
108 static void gtk_tree_model_sort_set_property (GObject *object,
112 static void gtk_tree_model_sort_get_property (GObject *object,
117 /* our signal handlers */
118 static void gtk_tree_model_sort_row_changed (GtkTreeModel *model,
119 GtkTreePath *start_path,
120 GtkTreeIter *start_iter,
122 static void gtk_tree_model_sort_row_inserted (GtkTreeModel *model,
126 static void gtk_tree_model_sort_row_has_child_toggled (GtkTreeModel *model,
130 static void gtk_tree_model_sort_row_deleted (GtkTreeModel *model,
133 static void gtk_tree_model_sort_rows_reordered (GtkTreeModel *s_model,
139 /* TreeModel interface */
140 static guint gtk_tree_model_sort_get_flags (GtkTreeModel *tree_model);
141 static gint gtk_tree_model_sort_get_n_columns (GtkTreeModel *tree_model);
142 static GType gtk_tree_model_sort_get_column_type (GtkTreeModel *tree_model,
144 static gboolean gtk_tree_model_sort_get_iter (GtkTreeModel *tree_model,
147 static GtkTreePath *gtk_tree_model_sort_get_path (GtkTreeModel *tree_model,
149 static void gtk_tree_model_sort_get_value (GtkTreeModel *tree_model,
153 static gboolean gtk_tree_model_sort_iter_next (GtkTreeModel *tree_model,
155 static gboolean gtk_tree_model_sort_iter_children (GtkTreeModel *tree_model,
157 GtkTreeIter *parent);
158 static gboolean gtk_tree_model_sort_iter_has_child (GtkTreeModel *tree_model,
160 static gint gtk_tree_model_sort_iter_n_children (GtkTreeModel *tree_model,
162 static gboolean gtk_tree_model_sort_iter_nth_child (GtkTreeModel *tree_model,
166 static gboolean gtk_tree_model_sort_iter_parent (GtkTreeModel *tree_model,
169 static void gtk_tree_model_sort_ref_node (GtkTreeModel *tree_model,
171 static void gtk_tree_model_sort_unref_node (GtkTreeModel *tree_model,
174 /* TreeSortable interface */
175 static gboolean gtk_tree_model_sort_get_sort_column_id (GtkTreeSortable *sortable,
176 gint *sort_column_id,
178 static void gtk_tree_model_sort_set_sort_column_id (GtkTreeSortable *sortable,
181 static void gtk_tree_model_sort_set_sort_func (GtkTreeSortable *sortable,
183 GtkTreeIterCompareFunc func,
185 GtkDestroyNotify destroy);
186 static void gtk_tree_model_sort_set_default_sort_func (GtkTreeSortable *sortable,
187 GtkTreeIterCompareFunc func,
189 GtkDestroyNotify destroy);
190 static gboolean gtk_tree_model_sort_has_default_sort_func (GtkTreeSortable *sortable);
192 /* Private functions (sort funcs, level handling and other utils) */
193 static void gtk_tree_model_sort_build_level (GtkTreeModelSort *tree_model_sort,
194 SortLevel *parent_level,
195 SortElt *parent_elt);
196 static void gtk_tree_model_sort_free_level (GtkTreeModelSort *tree_model_sort,
197 SortLevel *sort_level);
198 static void gtk_tree_model_sort_increment_stamp (GtkTreeModelSort *tree_model_sort);
199 static void gtk_tree_model_sort_sort_level (GtkTreeModelSort *tree_model_sort,
202 gboolean emit_reordered);
203 static void gtk_tree_model_sort_sort (GtkTreeModelSort *tree_model_sort);
204 static gint gtk_tree_model_sort_level_find_insert (GtkTreeModelSort *tree_model_sort,
207 gboolean skip_sort_elt);
208 static gboolean gtk_tree_model_sort_insert_value (GtkTreeModelSort *tree_model_sort,
211 GtkTreeIter *s_iter);
212 static GtkTreePath *gtk_tree_model_sort_elt_get_path (SortLevel *level,
214 static void gtk_tree_model_sort_set_model (GtkTreeModelSort *tree_model_sort,
215 GtkTreeModel *child_model);
216 static GtkTreePath *gtk_real_tree_model_sort_convert_child_path_to_path (GtkTreeModelSort *tree_model_sort,
217 GtkTreePath *child_path,
218 gboolean build_levels);
220 static GObjectClass *parent_class = NULL;
223 gtk_tree_model_sort_get_type (void)
225 static GType tree_model_sort_type = 0;
227 if (!tree_model_sort_type)
229 static const GTypeInfo tree_model_sort_info =
231 sizeof (GtkTreeModelSortClass),
232 NULL, /* base_init */
233 NULL, /* base_finalize */
234 (GClassInitFunc) gtk_tree_model_sort_class_init,
235 NULL, /* class_finalize */
236 NULL, /* class_data */
237 sizeof (GtkTreeModelSort),
239 (GInstanceInitFunc) gtk_tree_model_sort_init
242 static const GInterfaceInfo tree_model_info =
244 (GInterfaceInitFunc) gtk_tree_model_sort_tree_model_init,
249 static const GInterfaceInfo sortable_info =
251 (GInterfaceInitFunc) gtk_tree_model_sort_tree_sortable_init,
256 tree_model_sort_type = g_type_register_static (G_TYPE_OBJECT,
258 &tree_model_sort_info, 0);
259 g_type_add_interface_static (tree_model_sort_type,
263 g_type_add_interface_static (tree_model_sort_type,
264 GTK_TYPE_TREE_SORTABLE,
268 return tree_model_sort_type;
272 gtk_tree_model_sort_init (GtkTreeModelSort *tree_model_sort)
274 tree_model_sort->sort_column_id = GTK_TREE_SORTABLE_DEFAULT_SORT_COLUMN_ID;
275 tree_model_sort->stamp = 0;
276 tree_model_sort->zero_ref_count = 0;
277 tree_model_sort->root = NULL;
278 tree_model_sort->sort_list = NULL;
282 gtk_tree_model_sort_class_init (GtkTreeModelSortClass *class)
284 GObjectClass *object_class;
286 object_class = (GObjectClass *) class;
287 parent_class = g_type_class_peek_parent (class);
289 object_class->set_property = gtk_tree_model_sort_set_property;
290 object_class->get_property = gtk_tree_model_sort_get_property;
292 object_class->finalize = gtk_tree_model_sort_finalize;
295 g_object_class_install_property (object_class,
297 g_param_spec_object ("model",
298 _("TreeModelSort Model"),
299 _("The model for the TreeModelSort to sort"),
301 G_PARAM_READWRITE | G_PARAM_CONSTRUCT_ONLY));
305 gtk_tree_model_sort_tree_model_init (GtkTreeModelIface *iface)
307 iface->get_flags = gtk_tree_model_sort_get_flags;
308 iface->get_n_columns = gtk_tree_model_sort_get_n_columns;
309 iface->get_column_type = gtk_tree_model_sort_get_column_type;
310 iface->get_iter = gtk_tree_model_sort_get_iter;
311 iface->get_path = gtk_tree_model_sort_get_path;
312 iface->get_value = gtk_tree_model_sort_get_value;
313 iface->iter_next = gtk_tree_model_sort_iter_next;
314 iface->iter_children = gtk_tree_model_sort_iter_children;
315 iface->iter_has_child = gtk_tree_model_sort_iter_has_child;
316 iface->iter_n_children = gtk_tree_model_sort_iter_n_children;
317 iface->iter_nth_child = gtk_tree_model_sort_iter_nth_child;
318 iface->iter_parent = gtk_tree_model_sort_iter_parent;
319 iface->ref_node = gtk_tree_model_sort_ref_node;
320 iface->unref_node = gtk_tree_model_sort_unref_node;
324 gtk_tree_model_sort_tree_sortable_init (GtkTreeSortableIface *iface)
326 iface->get_sort_column_id = gtk_tree_model_sort_get_sort_column_id;
327 iface->set_sort_column_id = gtk_tree_model_sort_set_sort_column_id;
328 iface->set_sort_func = gtk_tree_model_sort_set_sort_func;
329 iface->set_default_sort_func = gtk_tree_model_sort_set_default_sort_func;
330 iface->has_default_sort_func = gtk_tree_model_sort_has_default_sort_func;
334 * gtk_tree_model_sort_new_with_model:
335 * @child_model: A #GtkTreeModel
337 * Creates a new #GtkTreeModel, with @child_model as the child_model.
339 * Return value: A new #GtkTreeModel.
342 gtk_tree_model_sort_new_with_model (GtkTreeModel *child_model)
344 GtkTreeModel *retval;
346 g_return_val_if_fail (GTK_IS_TREE_MODEL (child_model), NULL);
348 retval = GTK_TREE_MODEL (g_object_new (gtk_tree_model_sort_get_type (), NULL));
350 gtk_tree_model_sort_set_model (GTK_TREE_MODEL_SORT (retval), child_model);
355 /* GObject callbacks */
357 gtk_tree_model_sort_finalize (GObject *object)
359 GtkTreeModelSort *tree_model_sort = (GtkTreeModelSort *) object;
361 gtk_tree_model_sort_set_model (tree_model_sort, NULL);
363 if (tree_model_sort->root)
364 gtk_tree_model_sort_free_level (tree_model_sort, tree_model_sort->root);
366 if (tree_model_sort->sort_list)
368 _gtk_tree_data_list_header_free (tree_model_sort->sort_list);
369 tree_model_sort->sort_list = NULL;
373 parent_class->finalize (object);
377 gtk_tree_model_sort_set_property (GObject *object,
382 GtkTreeModelSort *tree_model_sort = GTK_TREE_MODEL_SORT (object);
387 gtk_tree_model_sort_set_model (tree_model_sort, g_value_get_object (value));
390 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
396 gtk_tree_model_sort_get_property (GObject *object,
401 GtkTreeModelSort *tree_model_sort = GTK_TREE_MODEL_SORT (object);
406 g_value_set_object (value, gtk_tree_model_sort_get_model(tree_model_sort));
409 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
415 gtk_tree_model_sort_row_changed (GtkTreeModel *s_model,
416 GtkTreePath *start_s_path,
417 GtkTreeIter *start_s_iter,
420 GtkTreeModelSort *tree_model_sort = GTK_TREE_MODEL_SORT (data);
421 GtkTreePath *path = NULL;
429 gboolean free_s_path = FALSE;
431 gint offset, index = 0, i;
433 g_return_if_fail (start_s_path != NULL || start_s_iter != NULL);
436 g_print ("::row_changed run\n");
442 start_s_path = gtk_tree_model_get_path (s_model, start_s_iter);
445 path = gtk_real_tree_model_sort_convert_child_path_to_path (tree_model_sort,
451 gtk_tree_path_free (start_s_path);
455 gtk_tree_model_get_iter (GTK_TREE_MODEL (data), &iter, path);
457 level = iter.user_data;
458 elt = iter.user_data2;
460 if (level->array->len < 2 || tree_model_sort->sort_column_id == -1)
463 gtk_tree_path_free (start_s_path);
465 gtk_tree_model_row_changed (GTK_TREE_MODEL (data), path, &iter);
467 gtk_tree_path_free (path);
472 if (!GTK_TREE_MODEL_SORT_CACHE_CHILD_ITERS (tree_model_sort))
474 gtk_tree_model_get_iter (tree_model_sort->child_model,
475 &tmpiter, start_s_path);
478 offset = elt->offset;
480 for (i = 0; i < level->array->len; i++)
481 if (elt->offset == g_array_index (level->array, SortElt, i).offset)
484 memcpy (&tmp, elt, sizeof (SortElt));
485 g_array_remove_index (level->array, index);
487 if (GTK_TREE_MODEL_SORT_CACHE_CHILD_ITERS (tree_model_sort))
488 index = gtk_tree_model_sort_level_find_insert (tree_model_sort,
493 index = gtk_tree_model_sort_level_find_insert (tree_model_sort,
498 g_array_insert_val (level->array, index, tmp);
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);
504 gtk_tree_path_up (path);
505 gtk_tree_path_append_index (path, index);
507 gtk_tree_model_sort_increment_stamp (tree_model_sort);
508 gtk_tree_model_get_iter (GTK_TREE_MODEL (data), &iter, path);
510 gtk_tree_model_row_changed (GTK_TREE_MODEL (data), path, &iter);
512 gtk_tree_path_free (path);
514 gtk_tree_path_free (start_s_path);
518 gtk_tree_model_sort_row_inserted (GtkTreeModel *s_model,
523 GtkTreeModelSort *tree_model_sort = GTK_TREE_MODEL_SORT (data);
526 GtkTreeIter real_s_iter;
530 gboolean free_s_path = FALSE;
534 SortLevel *parent_level = NULL;
536 parent_level = level = SORT_LEVEL (tree_model_sort->root);
539 g_print ("::row_inserted\n");
542 g_return_if_fail (s_path != NULL || s_iter != NULL);
546 s_path = gtk_tree_model_get_path (s_model, s_iter);
551 gtk_tree_model_get_iter (s_model, &real_s_iter, s_path);
553 real_s_iter = *s_iter;
555 if (!tree_model_sort->root)
557 gtk_tree_model_sort_build_level (tree_model_sort, NULL, NULL);
559 /* the build level already put the inserted iter in the level,
560 so no need to handle this signal anymore */
562 goto done_and_submit;
565 /* find the parent level */
566 while (i < gtk_tree_path_get_depth (s_path) - 1)
572 /* level not yet build, we won't cover this signal */
576 if (level->array->len < gtk_tree_path_get_indices (s_path)[i])
578 g_warning ("A node was inserted with a parent that's not in the tree.\n"
579 "This possibly means that a GtkTreeModel inserted a child node\n"
580 "before the parent was inserted.");
585 for (j = 0; j < level->array->len; j++)
586 if (g_array_index (level->array, SortElt, j).offset == gtk_tree_path_get_indices (s_path)[i])
588 elt = &g_array_index (level->array, SortElt, j);
592 g_return_if_fail (elt != NULL);
596 GtkTreePath *tmppath;
599 tmppath = gtk_tree_model_sort_elt_get_path (level, elt);
602 gtk_tree_model_get_iter (GTK_TREE_MODEL (data), &tmpiter,
604 gtk_tree_model_row_has_child_toggled (GTK_TREE_MODEL (data),
607 gtk_tree_path_free (tmppath);
610 /* not covering this signal */
614 level = elt->children;
615 parent_level = level;
622 if (!gtk_tree_model_sort_insert_value (tree_model_sort,
629 path = gtk_real_tree_model_sort_convert_child_path_to_path (tree_model_sort,
636 gtk_tree_model_sort_increment_stamp (tree_model_sort);
638 gtk_tree_model_get_iter (GTK_TREE_MODEL (data), &iter, path);
639 gtk_tree_model_row_inserted (GTK_TREE_MODEL (data), path, &iter);
640 gtk_tree_path_free (path);
644 gtk_tree_path_free (s_path);
650 gtk_tree_model_sort_row_has_child_toggled (GtkTreeModel *s_model,
655 GtkTreeModelSort *tree_model_sort = GTK_TREE_MODEL_SORT (data);
659 g_return_if_fail (s_path != NULL && s_iter != NULL);
661 path = gtk_real_tree_model_sort_convert_child_path_to_path (tree_model_sort, s_path, FALSE);
665 gtk_tree_model_get_iter (GTK_TREE_MODEL (data), &iter, path);
666 gtk_tree_model_row_has_child_toggled (GTK_TREE_MODEL (data), path, &iter);
668 gtk_tree_path_free (path);
671 /* FIXME: I still have doubts if this works */
673 gtk_tree_model_sort_row_deleted (GtkTreeModel *s_model,
677 GtkTreeModelSort *tree_model_sort = GTK_TREE_MODEL_SORT (data);
678 GtkTreePath *path = NULL;
685 g_return_if_fail (s_path != NULL);
688 g_print ("::row_deleted\n");
691 path = gtk_real_tree_model_sort_convert_child_path_to_path (tree_model_sort, s_path, FALSE);
695 gtk_tree_model_get_iter (GTK_TREE_MODEL (data), &iter, path);
697 level = SORT_LEVEL (iter.user_data);
698 elt = SORT_ELT (iter.user_data2);
699 offset = elt->offset;
701 gtk_tree_model_sort_increment_stamp (tree_model_sort);
702 gtk_tree_model_row_deleted (GTK_TREE_MODEL (data), path);
704 while (elt->ref_count > 0)
705 gtk_tree_model_sort_unref_node (GTK_TREE_MODEL (data), &iter);
707 if (level->ref_count == 0 && level != tree_model_sort->root)
709 /* This will prune the level, so I can just emit the signal and not worry
710 * about cleaning this level up. */
712 g_print ("ref_count == 0, prune level\n");
715 gtk_tree_path_free (path);
720 for (i = 0; i < level->array->len; i++)
721 if (elt->offset == g_array_index (level->array, SortElt, i).offset)
724 g_array_remove_index (level->array, i);
726 /* update all offsets */
727 for (i = 0; i < level->array->len; i++)
729 elt = & (g_array_index (level->array, SortElt, i));
730 if (elt->offset > offset)
733 elt->children->parent_elt = elt;
736 gtk_tree_path_free (path);
740 gtk_tree_model_sort_rows_reordered (GtkTreeModel *s_model,
752 GtkTreeModelSort *tree_model_sort = GTK_TREE_MODEL_SORT (data);
754 g_return_if_fail (new_order != NULL);
756 if (s_path == NULL || gtk_tree_path_get_indices (s_path) == NULL)
758 if (tree_model_sort->root == NULL)
760 path = gtk_tree_path_new ();
761 level = SORT_LEVEL (tree_model_sort->root);
765 path = gtk_real_tree_model_sort_convert_child_path_to_path (tree_model_sort, s_path, FALSE);
768 gtk_tree_model_get_iter (GTK_TREE_MODEL (data), &iter, path);
770 level = SORT_LEVEL (iter.user_data);
771 elt = SORT_ELT (iter.user_data2);
775 gtk_tree_path_free (path);
779 level = elt->children;
782 if (level->array->len < 2)
784 gtk_tree_path_free (path);
788 tmp_array = g_new (int, level->array->len);
789 for (i = 0; i < level->array->len; i++)
791 for (j = 0; j < level->array->len; j++)
793 if (g_array_index (level->array, SortElt, i).offset == new_order[j])
798 for (i = 0; i < level->array->len; i++)
799 g_array_index (level->array, SortElt, i).offset = tmp_array[i];
802 if (tree_model_sort->sort_column_id == -1 &&
803 tree_model_sort->default_sort_func == (GtkTreeIterCompareFunc) 0x1)
806 gtk_tree_model_sort_sort_level (tree_model_sort, level,
808 gtk_tree_model_sort_increment_stamp (tree_model_sort);
810 if (gtk_tree_path_get_depth (path))
812 gtk_tree_model_get_iter (GTK_TREE_MODEL (tree_model_sort),
815 gtk_tree_model_rows_reordered (GTK_TREE_MODEL (tree_model_sort),
816 path, &iter, new_order);
820 gtk_tree_model_rows_reordered (GTK_TREE_MODEL (tree_model_sort),
821 path, NULL, new_order);
825 gtk_tree_path_free (path);
828 /* Fulfill our model requirements */
830 gtk_tree_model_sort_get_flags (GtkTreeModel *tree_model)
832 g_return_val_if_fail (GTK_IS_TREE_MODEL_SORT (tree_model), 0);
838 gtk_tree_model_sort_get_n_columns (GtkTreeModel *tree_model)
840 GtkTreeModelSort *tree_model_sort = (GtkTreeModelSort *) tree_model;
842 g_return_val_if_fail (GTK_IS_TREE_MODEL_SORT (tree_model), 0);
844 if (tree_model_sort->child_model == 0)
847 return gtk_tree_model_get_n_columns (tree_model_sort->child_model);
851 gtk_tree_model_sort_get_column_type (GtkTreeModel *tree_model,
854 g_return_val_if_fail (GTK_IS_TREE_MODEL_SORT (tree_model), G_TYPE_INVALID);
855 g_return_val_if_fail (GTK_TREE_MODEL_SORT (tree_model)->child_model != NULL, G_TYPE_INVALID);
857 return gtk_tree_model_get_column_type (GTK_TREE_MODEL_SORT (tree_model)->child_model, index);
861 gtk_tree_model_sort_get_iter (GtkTreeModel *tree_model,
865 GtkTreeModelSort *tree_model_sort;
870 g_return_val_if_fail (GTK_IS_TREE_MODEL_SORT (tree_model), FALSE);
871 g_return_val_if_fail (GTK_TREE_MODEL_SORT (tree_model)->child_model != NULL, FALSE);
873 tree_model_sort = (GtkTreeModelSort *) tree_model;
874 indices = gtk_tree_path_get_indices (path);
876 if (tree_model_sort->root == NULL)
877 gtk_tree_model_sort_build_level (tree_model_sort, NULL, NULL);
878 level = SORT_LEVEL (tree_model_sort->root);
880 depth = gtk_tree_path_get_depth (path);
884 for (i = 0; i < depth - 1; i++)
886 if ((level == NULL) ||
887 (level->array->len < indices[i]))
890 if (g_array_index (level->array, SortElt, indices[i]).children == NULL)
891 gtk_tree_model_sort_build_level (tree_model_sort, level, &g_array_index (level->array, SortElt, indices[i]));
892 level = g_array_index (level->array, SortElt, indices[i]).children;
897 iter->stamp = tree_model_sort->stamp;
898 iter->user_data = level;
899 iter->user_data2 = &g_array_index (level->array, SortElt, indices[depth - 1]);
905 gtk_tree_model_sort_get_path (GtkTreeModel *tree_model,
912 g_return_val_if_fail (GTK_IS_TREE_MODEL_SORT (tree_model), NULL);
913 g_return_val_if_fail (GTK_TREE_MODEL_SORT (tree_model)->child_model != NULL, NULL);
914 g_return_val_if_fail (GTK_TREE_MODEL_SORT (tree_model)->stamp == iter->stamp, NULL);
916 retval = gtk_tree_path_new ();
917 level = iter->user_data;
918 elt = iter->user_data2;
919 while (level != NULL)
921 gtk_tree_path_prepend_index (retval, elt - (SortElt *)level->array->data);
923 elt = level->parent_elt;
924 level = level->parent_level;
931 gtk_tree_model_sort_get_value (GtkTreeModel *tree_model,
936 GtkTreeIter child_iter;
938 g_return_if_fail (GTK_IS_TREE_MODEL_SORT (tree_model));
939 g_return_if_fail (GTK_TREE_MODEL_SORT (tree_model)->child_model != NULL);
940 g_return_if_fail (GTK_TREE_MODEL_SORT (tree_model)->stamp == iter->stamp);
942 GET_CHILD_ITER (tree_model, &child_iter, iter);
943 gtk_tree_model_get_value (GTK_TREE_MODEL_SORT (tree_model)->child_model,
944 &child_iter, column, value);
948 gtk_tree_model_sort_iter_next (GtkTreeModel *tree_model,
954 g_return_val_if_fail (GTK_IS_TREE_MODEL_SORT (tree_model), FALSE);
955 g_return_val_if_fail (GTK_TREE_MODEL_SORT (tree_model)->child_model != NULL, FALSE);
956 g_return_val_if_fail (GTK_TREE_MODEL_SORT (tree_model)->stamp == iter->stamp, FALSE);
958 level = iter->user_data;
959 elt = iter->user_data2;
961 if (elt - (SortElt *)level->array->data >= level->array->len - 1)
966 iter->user_data2 = elt + 1;
972 gtk_tree_model_sort_iter_children (GtkTreeModel *tree_model,
976 GtkTreeModelSort *tree_model_sort = (GtkTreeModelSort *) tree_model;
980 g_return_val_if_fail (GTK_IS_TREE_MODEL_SORT (tree_model), FALSE);
981 g_return_val_if_fail (tree_model_sort->child_model != NULL, FALSE);
982 if (parent) g_return_val_if_fail (tree_model_sort->stamp == parent->stamp, FALSE);
986 if (tree_model_sort->root == NULL)
987 gtk_tree_model_sort_build_level (tree_model_sort, NULL, NULL);
988 if (tree_model_sort->root == NULL)
991 level = tree_model_sort->root;
992 iter->stamp = tree_model_sort->stamp;
993 iter->user_data = level;
994 iter->user_data2 = level->array->data;
998 if (((SortElt *)parent->user_data2)->children == NULL)
999 gtk_tree_model_sort_build_level (tree_model_sort,
1000 (SortLevel *)parent->user_data,
1001 (SortElt *)parent->user_data2);
1002 if (((SortElt *)parent->user_data2)->children == NULL)
1004 iter->stamp = tree_model_sort->stamp;
1005 iter->user_data = ((SortElt *)parent->user_data2)->children;
1006 iter->user_data2 = ((SortLevel *)iter->user_data)->array->data;
1013 gtk_tree_model_sort_iter_has_child (GtkTreeModel *tree_model,
1016 GtkTreeIter child_iter;
1018 g_return_val_if_fail (GTK_IS_TREE_MODEL_SORT (tree_model), FALSE);
1019 g_return_val_if_fail (GTK_TREE_MODEL_SORT (tree_model)->child_model != NULL, FALSE);
1020 g_return_val_if_fail (GTK_TREE_MODEL_SORT (tree_model)->stamp == iter->stamp, FALSE);
1022 GET_CHILD_ITER (tree_model, &child_iter, iter);
1024 return gtk_tree_model_iter_has_child (GTK_TREE_MODEL_SORT (tree_model)->child_model, &child_iter);
1028 gtk_tree_model_sort_iter_n_children (GtkTreeModel *tree_model,
1031 GtkTreeIter child_iter;
1033 g_return_val_if_fail (GTK_IS_TREE_MODEL_SORT (tree_model), 0);
1034 g_return_val_if_fail (GTK_TREE_MODEL_SORT (tree_model)->child_model != NULL, 0);
1035 if (iter) g_return_val_if_fail (GTK_TREE_MODEL_SORT (tree_model)->stamp == iter->stamp, 0);
1038 return gtk_tree_model_iter_n_children (GTK_TREE_MODEL_SORT (tree_model)->child_model, NULL);
1040 GET_CHILD_ITER (tree_model, &child_iter, iter);
1042 return gtk_tree_model_iter_n_children (GTK_TREE_MODEL_SORT (tree_model)->child_model, &child_iter);
1046 gtk_tree_model_sort_iter_nth_child (GtkTreeModel *tree_model,
1048 GtkTreeIter *parent,
1052 /* We have this for the iter == parent case */
1053 GtkTreeIter children;
1055 g_return_val_if_fail (GTK_IS_TREE_MODEL_SORT (tree_model), FALSE);
1056 if (parent) g_return_val_if_fail (GTK_TREE_MODEL_SORT (tree_model)->stamp == parent->stamp, FALSE);
1058 /* Use this instead of has_child to force us to build the level, if needed */
1059 if (gtk_tree_model_sort_iter_children (tree_model, &children, parent) == FALSE)
1065 level = children.user_data;
1066 if (n >= level->array->len)
1072 iter->stamp = GTK_TREE_MODEL_SORT (tree_model)->stamp;
1073 iter->user_data = level;
1074 iter->user_data2 = &g_array_index (level->array, SortElt, n);
1080 gtk_tree_model_sort_iter_parent (GtkTreeModel *tree_model,
1087 g_return_val_if_fail (GTK_IS_TREE_MODEL_SORT (tree_model), FALSE);
1088 g_return_val_if_fail (GTK_TREE_MODEL_SORT (tree_model)->child_model != NULL, FALSE);
1089 g_return_val_if_fail (GTK_TREE_MODEL_SORT (tree_model)->stamp == child->stamp, FALSE);
1091 level = child->user_data;
1093 if (level->parent_level)
1095 iter->stamp = GTK_TREE_MODEL_SORT (tree_model)->stamp;
1096 iter->user_data = level->parent_level;
1097 iter->user_data2 = level->parent_elt;
1105 gtk_tree_model_sort_ref_node (GtkTreeModel *tree_model,
1108 GtkTreeModelSort *tree_model_sort = (GtkTreeModelSort *) tree_model;
1112 g_return_if_fail (GTK_IS_TREE_MODEL_SORT (tree_model));
1113 g_return_if_fail (GTK_TREE_MODEL_SORT (tree_model)->child_model != NULL);
1114 g_return_if_fail (GTK_TREE_MODEL_SORT (tree_model)->stamp == iter->stamp);
1116 level = iter->user_data;
1117 elt = iter->user_data2;
1121 if (level->ref_count == 1)
1123 SortLevel *parent_level = level->parent_level;
1124 SortElt *parent_elt = level->parent_elt;
1125 /* We were at zero -- time to decrement the zero_ref_count val */
1129 parent_elt->zero_ref_count--;
1131 tree_model_sort->zero_ref_count--;
1135 parent_elt = parent_level->parent_elt;
1136 parent_level = parent_level->parent_level;
1139 while (parent_level);
1144 gtk_tree_model_sort_unref_node (GtkTreeModel *tree_model,
1147 GtkTreeModelSort *tree_model_sort = (GtkTreeModelSort *) tree_model;
1151 g_return_if_fail (GTK_IS_TREE_MODEL_SORT (tree_model));
1152 g_return_if_fail (GTK_TREE_MODEL_SORT (tree_model)->child_model != NULL);
1153 g_return_if_fail (GTK_TREE_MODEL_SORT (tree_model)->stamp == iter->stamp);
1155 level = iter->user_data;
1156 elt = iter->user_data2;
1158 g_return_if_fail (elt->ref_count > 0);
1162 if (level->ref_count == 0)
1164 SortLevel *parent_level = level->parent_level;
1165 SortElt *parent_elt = level->parent_elt;
1167 /* We are at zero -- time to increment the zero_ref_count val */
1168 while (parent_level)
1170 parent_elt->zero_ref_count++;
1172 parent_elt = parent_level->parent_elt;
1173 parent_level = parent_level->parent_level;
1175 tree_model_sort->zero_ref_count++;
1179 /* Sortable interface */
1181 gtk_tree_model_sort_get_sort_column_id (GtkTreeSortable *sortable,
1182 gint *sort_column_id,
1185 GtkTreeModelSort *tree_model_sort = (GtkTreeModelSort *)sortable;
1187 g_return_val_if_fail (GTK_IS_TREE_MODEL_SORT (sortable), FALSE);
1189 if (tree_model_sort->sort_column_id == GTK_TREE_SORTABLE_DEFAULT_SORT_COLUMN_ID)
1193 *sort_column_id = tree_model_sort->sort_column_id;
1195 *order = tree_model_sort->order;
1201 gtk_tree_model_sort_set_sort_column_id (GtkTreeSortable *sortable,
1202 gint sort_column_id,
1205 GtkTreeModelSort *tree_model_sort = (GtkTreeModelSort *)sortable;
1207 g_return_if_fail (GTK_IS_TREE_MODEL_SORT (sortable));
1209 if (sort_column_id != GTK_TREE_SORTABLE_DEFAULT_SORT_COLUMN_ID)
1211 GtkTreeDataSortHeader *header = NULL;
1213 header = _gtk_tree_data_list_get_header (tree_model_sort->sort_list,
1216 /* we want to make sure that we have a function */
1217 g_return_if_fail (header != NULL);
1218 g_return_if_fail (header->func != NULL);
1221 g_return_if_fail (tree_model_sort->default_sort_func != NULL);
1223 if (tree_model_sort->sort_column_id == sort_column_id)
1225 if (sort_column_id != GTK_TREE_SORTABLE_DEFAULT_SORT_COLUMN_ID)
1227 if (tree_model_sort->order == order)
1234 tree_model_sort->sort_column_id = sort_column_id;
1235 tree_model_sort->order = order;
1237 gtk_tree_model_sort_sort (tree_model_sort);
1238 gtk_tree_sortable_sort_column_changed (sortable);
1242 gtk_tree_model_sort_set_sort_func (GtkTreeSortable *sortable,
1243 gint sort_column_id,
1244 GtkTreeIterCompareFunc func,
1246 GtkDestroyNotify destroy)
1248 GtkTreeModelSort *tree_model_sort = (GtkTreeModelSort *) sortable;
1249 GtkTreeDataSortHeader *header = NULL;
1252 g_return_if_fail (GTK_IS_TREE_MODEL_SORT (sortable));
1253 g_return_if_fail (func != NULL);
1255 for (list = tree_model_sort->sort_list; list; list = list->next)
1257 header = (GtkTreeDataSortHeader *) list->data;
1259 if (header->sort_column_id == sort_column_id)
1265 header = g_new0 (GtkTreeDataSortHeader, 1);
1266 header->sort_column_id = sort_column_id;
1267 tree_model_sort->sort_list = g_list_append (tree_model_sort->sort_list,
1271 if (header->destroy)
1272 (* header->destroy) (header->data);
1274 header->func = func;
1275 header->data = data;
1276 header->destroy = destroy;
1280 gtk_tree_model_sort_set_default_sort_func (GtkTreeSortable *sortable,
1281 GtkTreeIterCompareFunc func,
1283 GtkDestroyNotify destroy)
1285 GtkTreeModelSort *tree_model_sort = (GtkTreeModelSort *)sortable;
1287 g_return_if_fail (GTK_IS_TREE_MODEL_SORT (sortable));
1289 if (tree_model_sort->default_sort_destroy)
1290 (* tree_model_sort->default_sort_destroy) (tree_model_sort->default_sort_data);
1292 tree_model_sort->default_sort_func = func;
1293 tree_model_sort->default_sort_data = data;
1294 tree_model_sort->default_sort_destroy = destroy;
1298 gtk_tree_model_sort_has_default_sort_func (GtkTreeSortable *sortable)
1300 GtkTreeModelSort *tree_model_sort = (GtkTreeModelSort *)sortable;
1302 g_return_val_if_fail (GTK_IS_TREE_MODEL_SORT (sortable), FALSE);
1304 return (tree_model_sort->default_sort_func != NULL);
1307 /* sorting code - private */
1309 gtk_tree_model_sort_compare_func (gconstpointer a,
1313 SortData *data = (SortData *)user_data;
1314 GtkTreeModelSort *tree_model_sort = data->tree_model_sort;
1315 SortTuple *sa = (SortTuple *)a;
1316 SortTuple *sb = (SortTuple *)b;
1318 GtkTreeIter iter_a, iter_b;
1321 /* shortcut, if we've the same offsets here, they should be equal */
1322 if (sa->offset == sb->offset)
1325 if (GTK_TREE_MODEL_SORT_CACHE_CHILD_ITERS (tree_model_sort))
1327 iter_a = sa->elt->iter;
1328 iter_b = sb->elt->iter;
1332 data->parent_path_indices [data->parent_path_depth-1] = sa->elt->offset;
1333 gtk_tree_model_get_iter (GTK_TREE_MODEL (tree_model_sort->child_model), &iter_a, data->parent_path);
1334 data->parent_path_indices [data->parent_path_depth-1] = sb->elt->offset;
1335 gtk_tree_model_get_iter (GTK_TREE_MODEL (tree_model_sort->child_model), &iter_b, data->parent_path);
1338 retval = (* data->sort_func) (GTK_TREE_MODEL (tree_model_sort->child_model),
1342 if (tree_model_sort->order == GTK_SORT_DESCENDING)
1346 else if (retval < 0)
1354 gtk_tree_model_sort_offset_compare_func (gconstpointer a,
1360 SortTuple *sa = (SortTuple *)a;
1361 SortTuple *sb = (SortTuple *)b;
1363 SortData *data = (SortData *)user_data;
1365 if (sa->elt->offset < sb->elt->offset)
1367 else if (sa->elt->offset > sb->elt->offset)
1372 if (data->tree_model_sort->order == GTK_SORT_DESCENDING)
1376 else if (retval < 0)
1384 gtk_tree_model_sort_sort_level (GtkTreeModelSort *tree_model_sort,
1387 gboolean emit_reordered)
1399 g_return_if_fail (GTK_IS_TREE_MODEL_SORT (tree_model_sort));
1400 g_return_if_fail (level != NULL);
1402 if (level->array->len < 1 && !((SortElt *)level->array->data)->children)
1406 data.tree_model_sort = tree_model_sort;
1407 if (level->parent_elt)
1409 data.parent_path = gtk_tree_model_sort_elt_get_path (level->parent_level,
1411 gtk_tree_path_append_index (data.parent_path, 0);
1415 data.parent_path = gtk_tree_path_new_root ();
1417 data.parent_path_depth = gtk_tree_path_get_depth (data.parent_path);
1418 data.parent_path_indices = gtk_tree_path_get_indices (data.parent_path);
1420 /* make the array to be sorted */
1421 sort_array = g_array_sized_new (FALSE, FALSE, sizeof (SortTuple), level->array->len);
1422 for (i = 0; i < level->array->len; i++)
1426 tuple.elt = &g_array_index (level->array, SortElt, i);
1429 g_array_append_val (sort_array, tuple);
1432 if (tree_model_sort->sort_column_id != GTK_TREE_SORTABLE_DEFAULT_SORT_COLUMN_ID)
1434 GtkTreeDataSortHeader *header = NULL;
1436 header = _gtk_tree_data_list_get_header (tree_model_sort->sort_list,
1437 tree_model_sort->sort_column_id);
1439 g_return_if_fail (header != NULL);
1440 g_return_if_fail (header->func != NULL);
1442 data.sort_func = header->func;
1443 data.sort_data = header->data;
1447 /* absolutely SHOULD NOT happen: */
1448 g_return_if_fail (tree_model_sort->default_sort_func != NULL);
1450 data.sort_func = tree_model_sort->default_sort_func;
1451 data.sort_data = tree_model_sort->default_sort_data;
1454 if (tree_model_sort->sort_column_id == GTK_TREE_SORTABLE_DEFAULT_SORT_COLUMN_ID &&
1455 tree_model_sort->default_sort_func == (GtkTreeIterCompareFunc) 0x1)
1457 g_array_sort_with_data (sort_array,
1458 gtk_tree_model_sort_offset_compare_func,
1463 g_array_sort_with_data (sort_array,
1464 gtk_tree_model_sort_compare_func,
1468 gtk_tree_path_free (data.parent_path);
1470 new_array = g_array_sized_new (FALSE, FALSE, sizeof (SortElt), level->array->len);
1471 new_order = g_new (gint, level->array->len);
1474 g_print ("---- sort\n");
1476 for (i = 0; i < level->array->len; i++)
1480 elt = g_array_index (sort_array, SortTuple, i).elt;
1481 new_order[i] = g_array_index (sort_array, SortTuple, i).offset;
1483 g_array_append_val (new_array, *elt);
1484 elt = &g_array_index (new_array, SortElt, i);
1486 elt->children->parent_elt = elt;
1489 g_array_free (level->array, TRUE);
1490 level->array = new_array;
1491 g_array_free (sort_array, TRUE);
1495 if (level->parent_elt)
1497 iter.stamp = tree_model_sort->stamp;
1498 iter.user_data = level->parent_level;
1499 iter.user_data2 = level->parent_elt;
1501 path = gtk_tree_model_get_path (GTK_TREE_MODEL (tree_model_sort),
1504 gtk_tree_model_rows_reordered (GTK_TREE_MODEL (tree_model_sort), path,
1510 path = gtk_tree_path_new ();
1511 gtk_tree_model_rows_reordered (GTK_TREE_MODEL (tree_model_sort), path,
1515 gtk_tree_path_free (path);
1518 /* recurse, if possible */
1521 for (i = 0; i < level->array->len; i++)
1523 SortElt *elt = &g_array_index (level->array, SortElt, i);
1526 gtk_tree_model_sort_sort_level (tree_model_sort,
1528 TRUE, emit_reordered);
1536 gtk_tree_model_sort_sort (GtkTreeModelSort *tree_model_sort)
1538 g_return_if_fail (GTK_IS_TREE_MODEL_SORT (tree_model_sort));
1540 if (!tree_model_sort->root)
1543 if (tree_model_sort->sort_column_id != GTK_TREE_SORTABLE_DEFAULT_SORT_COLUMN_ID)
1545 GtkTreeDataSortHeader *header = NULL;
1547 header = _gtk_tree_data_list_get_header (tree_model_sort->sort_list,
1548 tree_model_sort->sort_column_id);
1550 /* we want to make sure that we have a function */
1551 g_return_if_fail (header != NULL);
1552 g_return_if_fail (header->func != NULL);
1555 g_return_if_fail (tree_model_sort->default_sort_func != NULL);
1557 gtk_tree_model_sort_sort_level (tree_model_sort, tree_model_sort->root,
1561 /* signal helpers */
1563 gtk_tree_model_sort_level_find_insert (GtkTreeModelSort *tree_model_sort,
1566 gboolean skip_sort_elt)
1571 GtkTreeIter tmp_iter;
1573 GtkTreeIterCompareFunc func;
1579 GtkTreeDataSortHeader *header;
1581 header = _gtk_tree_data_list_get_header (tree_model_sort->sort_list,
1582 tree_model_sort->sort_column_id);
1584 g_return_val_if_fail (header != NULL, 0);
1585 g_return_val_if_fail (header->func != NULL, 0);
1587 func = header->func;
1588 data = header->data;
1591 for (middle = 0; middle < level->array->len; middle++)
1593 tmp_elt = &(g_array_index (level->array, SortElt, middle));
1595 if (!skip_sort_elt && SORT_ELT (iter->user_data2) == tmp_elt)
1598 path = gtk_tree_model_sort_elt_get_path (level, tmp_elt);
1599 gtk_tree_model_get_iter (tree_model_sort->child_model,
1601 gtk_tree_path_free (path);
1603 if (tree_model_sort->order == GTK_SORT_ASCENDING)
1604 cmp = (* func) (GTK_TREE_MODEL (tree_model_sort->child_model),
1605 &tmp_iter, iter, data);
1607 cmp = (* func) (GTK_TREE_MODEL (tree_model_sort->child_model),
1608 iter, &tmp_iter, data);
1618 gtk_tree_model_sort_insert_value (GtkTreeModelSort *tree_model_sort,
1620 GtkTreePath *s_path,
1621 GtkTreeIter *s_iter)
1623 gint offset, index, i;
1628 offset = gtk_tree_path_get_indices (s_path)[gtk_tree_path_get_depth (s_path) - 1];
1630 if (GTK_TREE_MODEL_SORT_CACHE_CHILD_ITERS (tree_model_sort))
1632 elt.offset = offset;
1633 elt.zero_ref_count = 0;
1635 elt.children = NULL;
1637 /* just insert it here, the ::row_changed signal will put the model
1638 * back in a nice sort order
1641 index = gtk_tree_path_get_indices (s_path)[gtk_tree_path_get_depth (s_path)-1];
1642 g_array_insert_vals (level->array, index, &elt, 1);
1644 /* update all larger offsets */
1645 tmp_elt = SORT_ELT (level->array->data);
1646 for (i = 0; i < level->array->len; i++, tmp_elt++)
1648 if ((tmp_elt->offset >= offset) && i != index)
1650 if (tmp_elt->children)
1651 tmp_elt->children->parent_elt = tmp_elt;
1657 /* sort elt stuff */
1658 static GtkTreePath *
1659 gtk_tree_model_sort_elt_get_path (SortLevel *level,
1662 SortLevel *walker = level;
1663 SortElt *walker2 = elt;
1666 g_return_val_if_fail (level != NULL, NULL);
1667 g_return_val_if_fail (elt != NULL, NULL);
1669 path = gtk_tree_path_new ();
1673 gtk_tree_path_prepend_index (path, walker2->offset);
1675 walker2 = walker->parent_elt;
1676 walker = walker->parent_level;
1683 * gtk_tree_model_sort_set_model:
1684 * @tree_model_sort: The #GtkTreeModelSort.
1685 * @child_model: A #GtkTreeModel, or NULL.
1687 * Sets the model of @tree_model_sort to be @model. If @model is NULL, then the
1688 * old model is unset. The sort function is unset as a result of this call.
1689 * The model will be in an unsorted state until a sort function is set.
1692 gtk_tree_model_sort_set_model (GtkTreeModelSort *tree_model_sort,
1693 GtkTreeModel *child_model)
1695 g_return_if_fail (GTK_IS_TREE_MODEL_SORT (tree_model_sort));
1698 g_object_ref (G_OBJECT (child_model));
1700 if (tree_model_sort->child_model)
1702 g_signal_handler_disconnect (G_OBJECT (tree_model_sort->child_model),
1703 tree_model_sort->changed_id);
1704 g_signal_handler_disconnect (G_OBJECT (tree_model_sort->child_model),
1705 tree_model_sort->inserted_id);
1706 g_signal_handler_disconnect (G_OBJECT (tree_model_sort->child_model),
1707 tree_model_sort->has_child_toggled_id);
1708 g_signal_handler_disconnect (G_OBJECT (tree_model_sort->child_model),
1709 tree_model_sort->deleted_id);
1710 g_signal_handler_disconnect (G_OBJECT (tree_model_sort->child_model),
1711 tree_model_sort->reordered_id);
1713 /* reset our state */
1714 gtk_tree_model_sort_free_level (tree_model_sort, tree_model_sort->root);
1715 tree_model_sort->root = NULL;
1716 _gtk_tree_data_list_header_free (tree_model_sort->sort_list);
1717 tree_model_sort->sort_list = NULL;
1718 g_object_unref (G_OBJECT (tree_model_sort->child_model));
1721 tree_model_sort->child_model = child_model;
1728 g_object_ref (tree_model_sort->child_model);
1729 tree_model_sort->changed_id =
1730 g_signal_connect (child_model, "row_changed",
1731 G_CALLBACK (gtk_tree_model_sort_row_changed),
1733 tree_model_sort->inserted_id =
1734 g_signal_connect (child_model, "row_inserted",
1735 G_CALLBACK (gtk_tree_model_sort_row_inserted),
1737 tree_model_sort->has_child_toggled_id =
1738 g_signal_connect (child_model, "row_has_child_toggled",
1739 G_CALLBACK (gtk_tree_model_sort_row_has_child_toggled),
1741 tree_model_sort->deleted_id =
1742 g_signal_connect (child_model, "row_deleted",
1743 G_CALLBACK (gtk_tree_model_sort_row_deleted),
1745 tree_model_sort->reordered_id =
1746 g_signal_connect (child_model, "rows_reordered",
1747 G_CALLBACK (gtk_tree_model_sort_rows_reordered),
1750 tree_model_sort->child_flags = gtk_tree_model_get_flags (child_model);
1751 n_columns = gtk_tree_model_get_n_columns (child_model);
1753 types = g_new (GType, n_columns);
1754 for (i = 0; i < n_columns; i++)
1755 types[i] = gtk_tree_model_get_column_type (child_model, i);
1757 tree_model_sort->sort_list = _gtk_tree_data_list_header_new (n_columns, types);
1760 tree_model_sort->default_sort_func = (GtkTreeIterCompareFunc)0x1;
1761 tree_model_sort->stamp = g_random_int ();
1766 * gtk_tree_model_sort_get_model:
1767 * @tree_model: a #GtkTreeModelSort
1769 * Returns the model the #GtkTreeModelSort is sorting.
1771 * Return value: the "child model" being sorted
1774 gtk_tree_model_sort_get_model (GtkTreeModelSort *tree_model)
1776 g_return_val_if_fail (GTK_IS_TREE_MODEL_SORT (tree_model), NULL);
1778 return tree_model->child_model;
1782 static GtkTreePath *
1783 gtk_real_tree_model_sort_convert_child_path_to_path (GtkTreeModelSort *tree_model_sort,
1784 GtkTreePath *child_path,
1785 gboolean build_levels)
1787 gint *child_indices;
1788 GtkTreePath *retval;
1792 g_return_val_if_fail (GTK_IS_TREE_MODEL_SORT (tree_model_sort), NULL);
1793 g_return_val_if_fail (tree_model_sort->child_model != NULL, NULL);
1794 g_return_val_if_fail (child_path != NULL, NULL);
1796 retval = gtk_tree_path_new ();
1797 child_indices = gtk_tree_path_get_indices (child_path);
1799 if (tree_model_sort->root == NULL && build_levels)
1800 gtk_tree_model_sort_build_level (tree_model_sort, NULL, NULL);
1801 level = SORT_LEVEL (tree_model_sort->root);
1803 for (i = 0; i < gtk_tree_path_get_depth (child_path); i++)
1806 gboolean found_child = FALSE;
1810 gtk_tree_path_free (retval);
1814 if (child_indices[i] >= level->array->len)
1816 gtk_tree_path_free (retval);
1819 for (j = 0; j < level->array->len; j++)
1821 if ((g_array_index (level->array, SortElt, j)).offset == child_indices[i])
1823 gtk_tree_path_append_index (retval, j);
1824 if (g_array_index (level->array, SortElt, j).children == NULL && build_levels)
1826 gtk_tree_model_sort_build_level (tree_model_sort, level, &g_array_index (level->array, SortElt, j));
1828 level = g_array_index (level->array, SortElt, j).children;
1835 gtk_tree_path_free (retval);
1845 * gtk_tree_model_sort_convert_child_path_to_path:
1846 * @tree_model_sort: A #GtkTreeModelSort
1847 * @child_path: A #GtkTreePath to convert
1849 * Converts @child_path to a path relative to @tree_model_sort. That is,
1850 * @child_path points to a path in the child model. The returned path will
1851 * point to the same row in the sorted model. If @child_path isn't a valid path
1852 * on the child model, then %NULL is returned.
1854 * Return value: A newly allocated #GtkTreePath, or %NULL
1857 gtk_tree_model_sort_convert_child_path_to_path (GtkTreeModelSort *tree_model_sort,
1858 GtkTreePath *child_path)
1860 g_return_val_if_fail (GTK_IS_TREE_MODEL_SORT (tree_model_sort), NULL);
1861 g_return_val_if_fail (tree_model_sort->child_model != NULL, NULL);
1862 g_return_val_if_fail (child_path != NULL, NULL);
1864 return gtk_real_tree_model_sort_convert_child_path_to_path (tree_model_sort, child_path, TRUE);
1868 * gtk_tree_model_sort_convert_child_iter_to_iter:
1869 * @tree_model_sort: A #GtkTreeModelSort
1870 * @sort_iter: An uninitialized #GtkTreeIter.
1871 * @child_iter: A valid #GtkTreeIter pointing to a row on the child model
1873 * Sets @sort_iter to point to the row in @tree_model_sort that corresponds to
1874 * the row pointed at by @child_iter.
1877 gtk_tree_model_sort_convert_child_iter_to_iter (GtkTreeModelSort *tree_model_sort,
1878 GtkTreeIter *sort_iter,
1879 GtkTreeIter *child_iter)
1881 GtkTreePath *child_path, *path;
1883 g_return_if_fail (GTK_IS_TREE_MODEL_SORT (tree_model_sort));
1884 g_return_if_fail (tree_model_sort->child_model != NULL);
1885 g_return_if_fail (sort_iter != NULL);
1886 g_return_if_fail (child_iter != NULL);
1888 sort_iter->stamp = 0;
1890 child_path = gtk_tree_model_get_path (tree_model_sort->child_model, child_iter);
1891 g_return_if_fail (child_path != NULL);
1893 path = gtk_tree_model_sort_convert_child_path_to_path (tree_model_sort, child_path);
1894 gtk_tree_path_free (child_path);
1895 g_return_if_fail (path != NULL);
1897 gtk_tree_model_get_iter (GTK_TREE_MODEL (tree_model_sort), sort_iter, path);
1898 gtk_tree_path_free (path);
1902 * gtk_tree_model_sort_convert_path_to_child_path:
1903 * @tree_model_sort: A #GtkTreeModelSort
1904 * @sorted_path: A #GtkTreePath to convert
1906 * Converts @sort_path to a path on the child model of @tree_model_sort. That
1907 * is, @sort_path points ot a location in @tree_model_sort. The returned path
1908 * will point to the same location in the model not being sorted. If @path does not point to a
1910 * Return value: A newly allocated #GtkTreePath, or %NULL
1913 gtk_tree_model_sort_convert_path_to_child_path (GtkTreeModelSort *tree_model_sort,
1914 GtkTreePath *sorted_path)
1916 gint *sorted_indices;
1917 GtkTreePath *retval;
1921 g_return_val_if_fail (GTK_IS_TREE_MODEL_SORT (tree_model_sort), NULL);
1922 g_return_val_if_fail (tree_model_sort->child_model != NULL, NULL);
1923 g_return_val_if_fail (sorted_path != NULL, NULL);
1925 retval = gtk_tree_path_new ();
1926 sorted_indices = gtk_tree_path_get_indices (sorted_path);
1927 if (tree_model_sort->root == NULL)
1928 gtk_tree_model_sort_build_level (tree_model_sort, NULL, NULL);
1929 level = SORT_LEVEL (tree_model_sort->root);
1931 for (i = 0; i < gtk_tree_path_get_depth (sorted_path); i++)
1933 if ((level == NULL) ||
1934 (level->array->len > sorted_indices[i]))
1936 gtk_tree_path_free (retval);
1939 if (g_array_index (level->array, SortElt, sorted_indices[i]).children == NULL)
1940 gtk_tree_model_sort_build_level (tree_model_sort, level, &g_array_index (level->array, SortElt, sorted_indices[i]));
1943 gtk_tree_path_append_index (retval, g_array_index (level->array, SortElt, i).offset);
1950 * gtk_tree_model_sort_convert_iter_to_child_iter:
1951 * @tree_model_sort: A #GtkTreeModelSort
1952 * @child_iter: An uninitialized #GtkTreeIter
1953 * @sorted_iter: A valid #GtkTreeIter pointing to a row on @tree_model_sort.
1955 * Sets @child_iter to point to the row pointed to by *sorted_iter.
1958 gtk_tree_model_sort_convert_iter_to_child_iter (GtkTreeModelSort *tree_model_sort,
1959 GtkTreeIter *child_iter,
1960 GtkTreeIter *sorted_iter)
1962 g_return_if_fail (GTK_IS_TREE_MODEL_SORT (tree_model_sort));
1963 g_return_if_fail (tree_model_sort->child_model != NULL);
1964 g_return_if_fail (child_iter != NULL);
1965 g_return_if_fail (sorted_iter != NULL);
1966 g_return_if_fail (sorted_iter->stamp == tree_model_sort->stamp);
1968 if (GTK_TREE_MODEL_SORT_CACHE_CHILD_ITERS (tree_model_sort))
1970 *child_iter = SORT_ELT (sorted_iter->user_data2)->iter;
1976 path = gtk_tree_model_sort_elt_get_path (sorted_iter->user_data,
1977 sorted_iter->user_data2);
1978 gtk_tree_model_get_iter (tree_model_sort->child_model, child_iter, path);
1979 gtk_tree_path_free (path);
1984 gtk_tree_model_sort_build_level (GtkTreeModelSort *tree_model_sort,
1985 SortLevel *parent_level,
1986 SortElt *parent_elt)
1989 SortLevel *new_level;
1993 g_assert (tree_model_sort->child_model != NULL);
1995 if (parent_level == NULL)
1997 if (gtk_tree_model_get_iter_root (tree_model_sort->child_model, &iter) == FALSE)
1999 length = gtk_tree_model_iter_n_children (tree_model_sort->child_model, NULL);
2003 GtkTreeIter parent_iter;
2004 GtkTreeIter child_parent_iter;
2006 parent_iter.stamp = tree_model_sort->stamp;
2007 parent_iter.user_data = parent_level;
2008 parent_iter.user_data2 = parent_elt;
2010 gtk_tree_model_sort_convert_iter_to_child_iter (tree_model_sort,
2013 if (gtk_tree_model_iter_children (tree_model_sort->child_model,
2015 &child_parent_iter) == FALSE)
2017 length = gtk_tree_model_iter_n_children (tree_model_sort->child_model, &child_parent_iter);
2020 g_return_if_fail (length > 0);
2022 new_level = g_new (SortLevel, 1);
2023 new_level->array = g_array_sized_new (FALSE, FALSE, sizeof (SortElt), length);
2024 new_level->ref_count = 0;
2025 new_level->parent_elt = parent_elt;
2026 new_level->parent_level = parent_level;
2029 parent_elt->children = new_level;
2031 tree_model_sort->root = new_level;
2033 /* increase the count of zero ref_counts.*/
2034 while (parent_level)
2036 parent_elt->zero_ref_count++;
2038 parent_elt = parent_level->parent_elt;
2039 parent_level = parent_level->parent_level;
2041 if (new_level != tree_model_sort->root)
2042 tree_model_sort->zero_ref_count++;
2044 for (i = 0; i < length; i++)
2047 sort_elt.offset = i;
2048 sort_elt.zero_ref_count = 0;
2049 sort_elt.ref_count = 0;
2050 sort_elt.children = NULL;
2052 if (GTK_TREE_MODEL_SORT_CACHE_CHILD_ITERS (tree_model_sort))
2054 sort_elt.iter = iter;
2055 if (gtk_tree_model_iter_next (tree_model_sort->child_model, &iter) == FALSE &&
2058 g_warning ("There is a discrepency between the sort model and the child model.");
2062 g_array_append_val (new_level->array, sort_elt);
2066 g_print ("-- new level\n");
2070 gtk_tree_model_sort_sort_level (tree_model_sort, new_level,
2075 gtk_tree_model_sort_free_level (GtkTreeModelSort *tree_model_sort,
2076 SortLevel *sort_level)
2081 g_print ("freeing level: %p, %p (ref = %d)\n", sort_level,
2082 sort_level->array, sort_level->ref_count);
2083 g_print ("-- parents - elt: %p, level %p\n",
2084 sort_level->parent_elt, sort_level->parent_level);
2087 g_assert (sort_level);
2090 g_print ("-- freeing current level (ref = %d)\n",sort_level->ref_count);
2093 if (sort_level->ref_count == 0)
2095 SortLevel *parent_level = sort_level->parent_level;
2096 SortElt *parent_elt = sort_level->parent_elt;
2101 parent_elt->zero_ref_count--;
2103 tree_model_sort->zero_ref_count--;
2107 parent_elt = parent_level->parent_elt;
2108 parent_level = parent_level->parent_level;
2111 while (parent_level);
2115 g_print ("-- freeing children\n");
2118 for (i = 0; i < sort_level->array->len; i++)
2120 if (g_array_index (sort_level->array, SortElt, i).children)
2121 gtk_tree_model_sort_free_level (tree_model_sort,
2122 SORT_LEVEL(g_array_index (sort_level->array, SortElt, i).children));
2125 if (sort_level->parent_elt)
2127 sort_level->parent_elt->children = NULL;
2131 tree_model_sort->root = NULL;
2135 g_print ("free %p\n", sort_level->array);
2138 g_array_free (sort_level->array, TRUE);
2139 sort_level->array = NULL;
2142 g_print ("free %p\n", sort_level);
2145 g_free (sort_level);
2149 g_print ("-------- done ---------\n");
2154 gtk_tree_model_sort_increment_stamp (GtkTreeModelSort *tree_model_sort)
2156 while (tree_model_sort->stamp == 0) tree_model_sort->stamp++;
2158 gtk_tree_model_sort_clear_cache (tree_model_sort);
2162 gtk_tree_model_sort_clear_cache_helper (GtkTreeModelSort *tree_model_sort,
2167 g_assert (level != NULL);
2169 for (i = 0; i < level->array->len; i++)
2171 if (g_array_index (level->array, SortElt, i).zero_ref_count > 0)
2172 gtk_tree_model_sort_clear_cache_helper (tree_model_sort, g_array_index (level->array, SortElt, i).children);
2175 if (level->ref_count == 0 && level != tree_model_sort->root)
2177 gtk_tree_model_sort_free_level (tree_model_sort, level);
2183 * gtk_tree_model_sort_reset_default_sort_func:
2184 * @tree_model_sort: A #GtkTreeModelSort
2186 * This resets the default sort function to be in the 'unsorted' state. That
2187 * is, it is in the same order as the child model.
2190 gtk_tree_model_sort_reset_default_sort_func (GtkTreeModelSort *tree_model_sort)
2192 g_return_if_fail (GTK_IS_TREE_MODEL_SORT (tree_model_sort));
2194 if (tree_model_sort->default_sort_destroy)
2195 (* tree_model_sort->default_sort_destroy) (tree_model_sort->default_sort_data);
2197 tree_model_sort->default_sort_func = (GtkTreeIterCompareFunc) 0x1;
2198 tree_model_sort->default_sort_data = NULL;
2199 tree_model_sort->default_sort_destroy = NULL;
2200 tree_model_sort->sort_column_id = GTK_TREE_SORTABLE_DEFAULT_SORT_COLUMN_ID;
2204 * gtk_tree_model_sort_clear_cache:
2205 * @tree_model_sort: A #GtkTreeModelSort
2207 * This function should almost never be called. It clears the @tree_model_sort
2208 * of any cached iterators that haven't been reffed with
2209 * gtk_tree_model_ref_node(). This might be useful if the child model being
2210 * sorted is static (and doesn't change often) and there has been a lot of
2211 * unreffed access to nodes. As a side effect of this function, all unreffed
2212 * iters will be invalid.
2215 gtk_tree_model_sort_clear_cache (GtkTreeModelSort *tree_model_sort)
2217 g_return_if_fail (GTK_IS_TREE_MODEL_SORT (tree_model_sort));
2219 if (tree_model_sort->zero_ref_count)
2220 gtk_tree_model_sort_clear_cache_helper (tree_model_sort, (SortLevel *)tree_model_sort->root);