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 #define NO_SORT_FUNC ((GtkTreeIterCompareFunc) 0x1)
104 /* general (object/interface init, etc) */
105 static void gtk_tree_model_sort_init (GtkTreeModelSort *tree_model_sort);
106 static void gtk_tree_model_sort_class_init (GtkTreeModelSortClass *tree_model_sort_class);
107 static void gtk_tree_model_sort_tree_model_init (GtkTreeModelIface *iface);
108 static void gtk_tree_model_sort_tree_sortable_init (GtkTreeSortableIface *iface);
109 static void gtk_tree_model_sort_finalize (GObject *object);
110 static void gtk_tree_model_sort_set_property (GObject *object,
114 static void gtk_tree_model_sort_get_property (GObject *object,
119 /* our signal handlers */
120 static void gtk_tree_model_sort_row_changed (GtkTreeModel *model,
121 GtkTreePath *start_path,
122 GtkTreeIter *start_iter,
124 static void gtk_tree_model_sort_row_inserted (GtkTreeModel *model,
128 static void gtk_tree_model_sort_row_has_child_toggled (GtkTreeModel *model,
132 static void gtk_tree_model_sort_row_deleted (GtkTreeModel *model,
135 static void gtk_tree_model_sort_rows_reordered (GtkTreeModel *s_model,
141 /* TreeModel interface */
142 static guint gtk_tree_model_sort_get_flags (GtkTreeModel *tree_model);
143 static gint gtk_tree_model_sort_get_n_columns (GtkTreeModel *tree_model);
144 static GType gtk_tree_model_sort_get_column_type (GtkTreeModel *tree_model,
146 static gboolean gtk_tree_model_sort_get_iter (GtkTreeModel *tree_model,
149 static GtkTreePath *gtk_tree_model_sort_get_path (GtkTreeModel *tree_model,
151 static void gtk_tree_model_sort_get_value (GtkTreeModel *tree_model,
155 static gboolean gtk_tree_model_sort_iter_next (GtkTreeModel *tree_model,
157 static gboolean gtk_tree_model_sort_iter_children (GtkTreeModel *tree_model,
159 GtkTreeIter *parent);
160 static gboolean gtk_tree_model_sort_iter_has_child (GtkTreeModel *tree_model,
162 static gint gtk_tree_model_sort_iter_n_children (GtkTreeModel *tree_model,
164 static gboolean gtk_tree_model_sort_iter_nth_child (GtkTreeModel *tree_model,
168 static gboolean gtk_tree_model_sort_iter_parent (GtkTreeModel *tree_model,
171 static void gtk_tree_model_sort_ref_node (GtkTreeModel *tree_model,
173 static void gtk_tree_model_sort_real_unref_node (GtkTreeModel *tree_model,
175 gboolean propagate_unref);
176 static void gtk_tree_model_sort_unref_node (GtkTreeModel *tree_model,
179 /* TreeSortable interface */
180 static gboolean gtk_tree_model_sort_get_sort_column_id (GtkTreeSortable *sortable,
181 gint *sort_column_id,
183 static void gtk_tree_model_sort_set_sort_column_id (GtkTreeSortable *sortable,
186 static void gtk_tree_model_sort_set_sort_func (GtkTreeSortable *sortable,
188 GtkTreeIterCompareFunc func,
190 GtkDestroyNotify destroy);
191 static void gtk_tree_model_sort_set_default_sort_func (GtkTreeSortable *sortable,
192 GtkTreeIterCompareFunc func,
194 GtkDestroyNotify destroy);
195 static gboolean gtk_tree_model_sort_has_default_sort_func (GtkTreeSortable *sortable);
197 /* Private functions (sort funcs, level handling and other utils) */
198 static void gtk_tree_model_sort_build_level (GtkTreeModelSort *tree_model_sort,
199 SortLevel *parent_level,
200 SortElt *parent_elt);
201 static void gtk_tree_model_sort_free_level (GtkTreeModelSort *tree_model_sort,
202 SortLevel *sort_level);
203 static void gtk_tree_model_sort_increment_stamp (GtkTreeModelSort *tree_model_sort);
204 static void gtk_tree_model_sort_sort_level (GtkTreeModelSort *tree_model_sort,
207 gboolean emit_reordered);
208 static void gtk_tree_model_sort_sort (GtkTreeModelSort *tree_model_sort);
209 static gint gtk_tree_model_sort_level_find_insert (GtkTreeModelSort *tree_model_sort,
212 gboolean skip_sort_elt);
213 static gboolean gtk_tree_model_sort_insert_value (GtkTreeModelSort *tree_model_sort,
216 GtkTreeIter *s_iter);
217 static GtkTreePath *gtk_tree_model_sort_elt_get_path (SortLevel *level,
219 static void gtk_tree_model_sort_set_model (GtkTreeModelSort *tree_model_sort,
220 GtkTreeModel *child_model);
221 static GtkTreePath *gtk_real_tree_model_sort_convert_child_path_to_path (GtkTreeModelSort *tree_model_sort,
222 GtkTreePath *child_path,
223 gboolean build_levels);
225 static GObjectClass *parent_class = NULL;
228 gtk_tree_model_sort_get_type (void)
230 static GType tree_model_sort_type = 0;
232 if (!tree_model_sort_type)
234 static const GTypeInfo tree_model_sort_info =
236 sizeof (GtkTreeModelSortClass),
237 NULL, /* base_init */
238 NULL, /* base_finalize */
239 (GClassInitFunc) gtk_tree_model_sort_class_init,
240 NULL, /* class_finalize */
241 NULL, /* class_data */
242 sizeof (GtkTreeModelSort),
244 (GInstanceInitFunc) gtk_tree_model_sort_init
247 static const GInterfaceInfo tree_model_info =
249 (GInterfaceInitFunc) gtk_tree_model_sort_tree_model_init,
254 static const GInterfaceInfo sortable_info =
256 (GInterfaceInitFunc) gtk_tree_model_sort_tree_sortable_init,
261 tree_model_sort_type = g_type_register_static (G_TYPE_OBJECT,
263 &tree_model_sort_info, 0);
264 g_type_add_interface_static (tree_model_sort_type,
268 g_type_add_interface_static (tree_model_sort_type,
269 GTK_TYPE_TREE_SORTABLE,
273 return tree_model_sort_type;
277 gtk_tree_model_sort_init (GtkTreeModelSort *tree_model_sort)
279 tree_model_sort->sort_column_id = GTK_TREE_SORTABLE_DEFAULT_SORT_COLUMN_ID;
280 tree_model_sort->stamp = 0;
281 tree_model_sort->zero_ref_count = 0;
282 tree_model_sort->root = NULL;
283 tree_model_sort->sort_list = NULL;
287 gtk_tree_model_sort_class_init (GtkTreeModelSortClass *class)
289 GObjectClass *object_class;
291 object_class = (GObjectClass *) class;
292 parent_class = g_type_class_peek_parent (class);
294 object_class->set_property = gtk_tree_model_sort_set_property;
295 object_class->get_property = gtk_tree_model_sort_get_property;
297 object_class->finalize = gtk_tree_model_sort_finalize;
300 g_object_class_install_property (object_class,
302 g_param_spec_object ("model",
303 _("TreeModelSort Model"),
304 _("The model for the TreeModelSort to sort"),
306 G_PARAM_READWRITE | G_PARAM_CONSTRUCT_ONLY));
310 gtk_tree_model_sort_tree_model_init (GtkTreeModelIface *iface)
312 iface->get_flags = gtk_tree_model_sort_get_flags;
313 iface->get_n_columns = gtk_tree_model_sort_get_n_columns;
314 iface->get_column_type = gtk_tree_model_sort_get_column_type;
315 iface->get_iter = gtk_tree_model_sort_get_iter;
316 iface->get_path = gtk_tree_model_sort_get_path;
317 iface->get_value = gtk_tree_model_sort_get_value;
318 iface->iter_next = gtk_tree_model_sort_iter_next;
319 iface->iter_children = gtk_tree_model_sort_iter_children;
320 iface->iter_has_child = gtk_tree_model_sort_iter_has_child;
321 iface->iter_n_children = gtk_tree_model_sort_iter_n_children;
322 iface->iter_nth_child = gtk_tree_model_sort_iter_nth_child;
323 iface->iter_parent = gtk_tree_model_sort_iter_parent;
324 iface->ref_node = gtk_tree_model_sort_ref_node;
325 iface->unref_node = gtk_tree_model_sort_unref_node;
329 gtk_tree_model_sort_tree_sortable_init (GtkTreeSortableIface *iface)
331 iface->get_sort_column_id = gtk_tree_model_sort_get_sort_column_id;
332 iface->set_sort_column_id = gtk_tree_model_sort_set_sort_column_id;
333 iface->set_sort_func = gtk_tree_model_sort_set_sort_func;
334 iface->set_default_sort_func = gtk_tree_model_sort_set_default_sort_func;
335 iface->has_default_sort_func = gtk_tree_model_sort_has_default_sort_func;
339 * gtk_tree_model_sort_new_with_model:
340 * @child_model: A #GtkTreeModel
342 * Creates a new #GtkTreeModel, with @child_model as the child_model.
344 * Return value: A new #GtkTreeModel.
347 gtk_tree_model_sort_new_with_model (GtkTreeModel *child_model)
349 GtkTreeModel *retval;
351 g_return_val_if_fail (GTK_IS_TREE_MODEL (child_model), NULL);
353 retval = GTK_TREE_MODEL (g_object_new (gtk_tree_model_sort_get_type (), NULL));
355 gtk_tree_model_sort_set_model (GTK_TREE_MODEL_SORT (retval), child_model);
360 /* GObject callbacks */
362 gtk_tree_model_sort_finalize (GObject *object)
364 GtkTreeModelSort *tree_model_sort = (GtkTreeModelSort *) object;
366 gtk_tree_model_sort_set_model (tree_model_sort, NULL);
368 if (tree_model_sort->root)
369 gtk_tree_model_sort_free_level (tree_model_sort, tree_model_sort->root);
371 if (tree_model_sort->sort_list)
373 _gtk_tree_data_list_header_free (tree_model_sort->sort_list);
374 tree_model_sort->sort_list = NULL;
378 parent_class->finalize (object);
382 gtk_tree_model_sort_set_property (GObject *object,
387 GtkTreeModelSort *tree_model_sort = GTK_TREE_MODEL_SORT (object);
392 gtk_tree_model_sort_set_model (tree_model_sort, g_value_get_object (value));
395 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
401 gtk_tree_model_sort_get_property (GObject *object,
406 GtkTreeModelSort *tree_model_sort = GTK_TREE_MODEL_SORT (object);
411 g_value_set_object (value, gtk_tree_model_sort_get_model(tree_model_sort));
414 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
420 gtk_tree_model_sort_row_changed (GtkTreeModel *s_model,
421 GtkTreePath *start_s_path,
422 GtkTreeIter *start_s_iter,
425 GtkTreeModelSort *tree_model_sort = GTK_TREE_MODEL_SORT (data);
426 GtkTreePath *path = NULL;
434 gboolean free_s_path = FALSE;
436 gint offset, index = 0, i;
438 g_return_if_fail (start_s_path != NULL || start_s_iter != NULL);
443 start_s_path = gtk_tree_model_get_path (s_model, start_s_iter);
446 path = gtk_real_tree_model_sort_convert_child_path_to_path (tree_model_sort,
452 gtk_tree_path_free (start_s_path);
456 gtk_tree_model_get_iter (GTK_TREE_MODEL (data), &iter, path);
458 level = iter.user_data;
459 elt = iter.user_data2;
461 if (level->array->len < 2 ||
462 (tree_model_sort->sort_column_id == GTK_TREE_SORTABLE_DEFAULT_SORT_COLUMN_ID &&
463 tree_model_sort->default_sort_func == NO_SORT_FUNC))
466 gtk_tree_path_free (start_s_path);
468 gtk_tree_model_row_changed (GTK_TREE_MODEL (data), path, &iter);
470 gtk_tree_path_free (path);
475 if (!GTK_TREE_MODEL_SORT_CACHE_CHILD_ITERS (tree_model_sort))
477 gtk_tree_model_get_iter (tree_model_sort->child_model,
478 &tmpiter, start_s_path);
481 offset = elt->offset;
483 for (i = 0; i < level->array->len; i++)
484 if (elt->offset == g_array_index (level->array, SortElt, i).offset)
487 memcpy (&tmp, elt, sizeof (SortElt));
488 g_array_remove_index (level->array, index);
490 if (GTK_TREE_MODEL_SORT_CACHE_CHILD_ITERS (tree_model_sort))
491 index = gtk_tree_model_sort_level_find_insert (tree_model_sort,
496 index = gtk_tree_model_sort_level_find_insert (tree_model_sort,
501 g_array_insert_val (level->array, index, tmp);
503 for (i = 0; i < level->array->len; i++)
504 if (g_array_index (level->array, SortElt, i).children)
505 g_array_index (level->array, SortElt, i).children->parent_elt = &g_array_index (level->array, SortElt, i);
507 gtk_tree_path_up (path);
508 gtk_tree_path_append_index (path, index);
510 gtk_tree_model_sort_increment_stamp (tree_model_sort);
511 gtk_tree_model_get_iter (GTK_TREE_MODEL (data), &iter, path);
513 gtk_tree_model_row_changed (GTK_TREE_MODEL (data), path, &iter);
515 gtk_tree_path_free (path);
517 gtk_tree_path_free (start_s_path);
521 gtk_tree_model_sort_row_inserted (GtkTreeModel *s_model,
526 GtkTreeModelSort *tree_model_sort = GTK_TREE_MODEL_SORT (data);
529 GtkTreeIter real_s_iter;
533 gboolean free_s_path = FALSE;
537 SortLevel *parent_level = NULL;
539 parent_level = level = SORT_LEVEL (tree_model_sort->root);
541 g_return_if_fail (s_path != NULL || s_iter != NULL);
545 s_path = gtk_tree_model_get_path (s_model, s_iter);
550 gtk_tree_model_get_iter (s_model, &real_s_iter, s_path);
552 real_s_iter = *s_iter;
554 if (!tree_model_sort->root)
556 gtk_tree_model_sort_build_level (tree_model_sort, NULL, NULL);
558 /* the build level already put the inserted iter in the level,
559 so no need to handle this signal anymore */
561 goto done_and_submit;
564 /* find the parent level */
565 while (i < gtk_tree_path_get_depth (s_path) - 1)
571 /* level not yet build, we won't cover this signal */
575 if (level->array->len < gtk_tree_path_get_indices (s_path)[i])
577 g_warning ("A node was inserted with a parent that's not in the tree.\n"
578 "This possibly means that a GtkTreeModel inserted a child node\n"
579 "before the parent was inserted.");
584 for (j = 0; j < level->array->len; j++)
585 if (g_array_index (level->array, SortElt, j).offset == gtk_tree_path_get_indices (s_path)[i])
587 elt = &g_array_index (level->array, SortElt, j);
591 g_return_if_fail (elt != NULL);
595 GtkTreePath *tmppath;
598 tmppath = gtk_tree_model_sort_elt_get_path (level, elt);
601 gtk_tree_model_get_iter (GTK_TREE_MODEL (data), &tmpiter,
603 gtk_tree_model_row_has_child_toggled (GTK_TREE_MODEL (data),
606 gtk_tree_path_free (tmppath);
609 /* not covering this signal */
613 level = elt->children;
614 parent_level = level;
621 if (!gtk_tree_model_sort_insert_value (tree_model_sort,
628 path = gtk_real_tree_model_sort_convert_child_path_to_path (tree_model_sort,
635 gtk_tree_model_sort_increment_stamp (tree_model_sort);
637 gtk_tree_model_get_iter (GTK_TREE_MODEL (data), &iter, path);
638 gtk_tree_model_row_inserted (GTK_TREE_MODEL (data), path, &iter);
639 gtk_tree_path_free (path);
643 gtk_tree_path_free (s_path);
649 gtk_tree_model_sort_row_has_child_toggled (GtkTreeModel *s_model,
654 GtkTreeModelSort *tree_model_sort = GTK_TREE_MODEL_SORT (data);
658 g_return_if_fail (s_path != NULL && s_iter != NULL);
660 path = gtk_real_tree_model_sort_convert_child_path_to_path (tree_model_sort, s_path, FALSE);
664 gtk_tree_model_get_iter (GTK_TREE_MODEL (data), &iter, path);
665 gtk_tree_model_row_has_child_toggled (GTK_TREE_MODEL (data), path, &iter);
667 gtk_tree_path_free (path);
670 /* FIXME: I still have doubts if this works */
672 gtk_tree_model_sort_row_deleted (GtkTreeModel *s_model,
676 GtkTreeModelSort *tree_model_sort = GTK_TREE_MODEL_SORT (data);
677 GtkTreePath *path = NULL;
684 g_return_if_fail (s_path != NULL);
686 path = gtk_real_tree_model_sort_convert_child_path_to_path (tree_model_sort, s_path, FALSE);
690 gtk_tree_model_get_iter (GTK_TREE_MODEL (data), &iter, path);
692 level = SORT_LEVEL (iter.user_data);
693 elt = SORT_ELT (iter.user_data2);
694 offset = elt->offset;
696 /* we _need_ to emit ::row_deleted before we start unreffing the node
697 * itself. This is because of the row refs, which start unreffing nodes
698 * when we emit ::row_deleted
700 gtk_tree_model_row_deleted (GTK_TREE_MODEL (data), path);
702 gtk_tree_model_get_iter (GTK_TREE_MODEL (data), &iter, path);
704 while (elt->ref_count > 0)
705 gtk_tree_model_sort_real_unref_node (GTK_TREE_MODEL (data), &iter, FALSE);
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. */
711 gtk_tree_model_sort_increment_stamp (tree_model_sort);
712 gtk_tree_path_free (path);
716 gtk_tree_model_sort_increment_stamp (tree_model_sort);
719 for (i = 0; i < level->array->len; i++)
720 if (elt->offset == g_array_index (level->array, SortElt, i).offset)
723 g_array_remove_index (level->array, i);
725 /* update all offsets */
726 for (i = 0; i < level->array->len; i++)
728 elt = & (g_array_index (level->array, SortElt, i));
729 if (elt->offset > offset)
732 elt->children->parent_elt = elt;
735 gtk_tree_path_free (path);
739 gtk_tree_model_sort_rows_reordered (GtkTreeModel *s_model,
751 GtkTreeModelSort *tree_model_sort = GTK_TREE_MODEL_SORT (data);
753 g_return_if_fail (new_order != NULL);
755 if (s_path == NULL || gtk_tree_path_get_indices (s_path) == NULL)
757 if (tree_model_sort->root == NULL)
759 path = gtk_tree_path_new ();
760 level = SORT_LEVEL (tree_model_sort->root);
764 path = gtk_real_tree_model_sort_convert_child_path_to_path (tree_model_sort, s_path, FALSE);
767 gtk_tree_model_get_iter (GTK_TREE_MODEL (data), &iter, path);
769 level = SORT_LEVEL (iter.user_data);
770 elt = SORT_ELT (iter.user_data2);
774 gtk_tree_path_free (path);
778 level = elt->children;
781 if (level->array->len < 2)
783 gtk_tree_path_free (path);
787 tmp_array = g_new (int, level->array->len);
788 for (i = 0; i < level->array->len; i++)
790 for (j = 0; j < level->array->len; j++)
792 if (g_array_index (level->array, SortElt, i).offset == new_order[j])
797 for (i = 0; i < level->array->len; i++)
798 g_array_index (level->array, SortElt, i).offset = tmp_array[i];
801 if (tree_model_sort->sort_column_id == GTK_TREE_SORTABLE_DEFAULT_SORT_COLUMN_ID &&
802 tree_model_sort->default_sort_func == NO_SORT_FUNC)
805 gtk_tree_model_sort_sort_level (tree_model_sort, level,
807 gtk_tree_model_sort_increment_stamp (tree_model_sort);
809 if (gtk_tree_path_get_depth (path))
811 gtk_tree_model_get_iter (GTK_TREE_MODEL (tree_model_sort),
814 gtk_tree_model_rows_reordered (GTK_TREE_MODEL (tree_model_sort),
815 path, &iter, new_order);
819 gtk_tree_model_rows_reordered (GTK_TREE_MODEL (tree_model_sort),
820 path, NULL, new_order);
824 gtk_tree_path_free (path);
827 /* Fulfill our model requirements */
829 gtk_tree_model_sort_get_flags (GtkTreeModel *tree_model)
831 g_return_val_if_fail (GTK_IS_TREE_MODEL_SORT (tree_model), 0);
837 gtk_tree_model_sort_get_n_columns (GtkTreeModel *tree_model)
839 GtkTreeModelSort *tree_model_sort = (GtkTreeModelSort *) tree_model;
841 g_return_val_if_fail (GTK_IS_TREE_MODEL_SORT (tree_model), 0);
843 if (tree_model_sort->child_model == 0)
846 return gtk_tree_model_get_n_columns (tree_model_sort->child_model);
850 gtk_tree_model_sort_get_column_type (GtkTreeModel *tree_model,
853 g_return_val_if_fail (GTK_IS_TREE_MODEL_SORT (tree_model), G_TYPE_INVALID);
854 g_return_val_if_fail (GTK_TREE_MODEL_SORT (tree_model)->child_model != NULL, G_TYPE_INVALID);
856 return gtk_tree_model_get_column_type (GTK_TREE_MODEL_SORT (tree_model)->child_model, index);
860 gtk_tree_model_sort_get_iter (GtkTreeModel *tree_model,
864 GtkTreeModelSort *tree_model_sort;
869 g_return_val_if_fail (GTK_IS_TREE_MODEL_SORT (tree_model), FALSE);
870 g_return_val_if_fail (GTK_TREE_MODEL_SORT (tree_model)->child_model != NULL, FALSE);
872 tree_model_sort = (GtkTreeModelSort *) tree_model;
873 indices = gtk_tree_path_get_indices (path);
875 if (tree_model_sort->root == NULL)
876 gtk_tree_model_sort_build_level (tree_model_sort, NULL, NULL);
877 level = SORT_LEVEL (tree_model_sort->root);
879 depth = gtk_tree_path_get_depth (path);
883 for (i = 0; i < depth - 1; i++)
885 if ((level == NULL) ||
886 (level->array->len < indices[i]))
889 if (g_array_index (level->array, SortElt, indices[i]).children == NULL)
890 gtk_tree_model_sort_build_level (tree_model_sort, level, &g_array_index (level->array, SortElt, indices[i]));
891 level = g_array_index (level->array, SortElt, indices[i]).children;
896 iter->stamp = tree_model_sort->stamp;
897 iter->user_data = level;
898 iter->user_data2 = &g_array_index (level->array, SortElt, indices[depth - 1]);
904 gtk_tree_model_sort_get_path (GtkTreeModel *tree_model,
911 g_return_val_if_fail (GTK_IS_TREE_MODEL_SORT (tree_model), NULL);
912 g_return_val_if_fail (GTK_TREE_MODEL_SORT (tree_model)->child_model != NULL, NULL);
913 g_return_val_if_fail (GTK_TREE_MODEL_SORT (tree_model)->stamp == iter->stamp, NULL);
915 retval = gtk_tree_path_new ();
916 level = iter->user_data;
917 elt = iter->user_data2;
918 while (level != NULL)
920 gtk_tree_path_prepend_index (retval, elt - (SortElt *)level->array->data);
922 elt = level->parent_elt;
923 level = level->parent_level;
930 gtk_tree_model_sort_get_value (GtkTreeModel *tree_model,
935 GtkTreeIter child_iter;
937 g_return_if_fail (GTK_IS_TREE_MODEL_SORT (tree_model));
938 g_return_if_fail (GTK_TREE_MODEL_SORT (tree_model)->child_model != NULL);
939 g_return_if_fail (GTK_TREE_MODEL_SORT (tree_model)->stamp == iter->stamp);
941 GET_CHILD_ITER (tree_model, &child_iter, iter);
942 gtk_tree_model_get_value (GTK_TREE_MODEL_SORT (tree_model)->child_model,
943 &child_iter, column, value);
947 gtk_tree_model_sort_iter_next (GtkTreeModel *tree_model,
953 g_return_val_if_fail (GTK_IS_TREE_MODEL_SORT (tree_model), FALSE);
954 g_return_val_if_fail (GTK_TREE_MODEL_SORT (tree_model)->child_model != NULL, FALSE);
955 g_return_val_if_fail (GTK_TREE_MODEL_SORT (tree_model)->stamp == iter->stamp, FALSE);
957 level = iter->user_data;
958 elt = iter->user_data2;
960 if (elt - (SortElt *)level->array->data >= level->array->len - 1)
965 iter->user_data2 = elt + 1;
971 gtk_tree_model_sort_iter_children (GtkTreeModel *tree_model,
975 GtkTreeModelSort *tree_model_sort = (GtkTreeModelSort *) tree_model;
979 g_return_val_if_fail (GTK_IS_TREE_MODEL_SORT (tree_model), FALSE);
980 g_return_val_if_fail (tree_model_sort->child_model != NULL, FALSE);
981 if (parent) g_return_val_if_fail (tree_model_sort->stamp == parent->stamp, FALSE);
985 if (tree_model_sort->root == NULL)
986 gtk_tree_model_sort_build_level (tree_model_sort, NULL, NULL);
987 if (tree_model_sort->root == NULL)
990 level = tree_model_sort->root;
991 iter->stamp = tree_model_sort->stamp;
992 iter->user_data = level;
993 iter->user_data2 = level->array->data;
997 if (((SortElt *)parent->user_data2)->children == NULL)
998 gtk_tree_model_sort_build_level (tree_model_sort,
999 (SortLevel *)parent->user_data,
1000 (SortElt *)parent->user_data2);
1001 if (((SortElt *)parent->user_data2)->children == NULL)
1003 iter->stamp = tree_model_sort->stamp;
1004 iter->user_data = ((SortElt *)parent->user_data2)->children;
1005 iter->user_data2 = ((SortLevel *)iter->user_data)->array->data;
1012 gtk_tree_model_sort_iter_has_child (GtkTreeModel *tree_model,
1015 GtkTreeIter child_iter;
1017 g_return_val_if_fail (GTK_IS_TREE_MODEL_SORT (tree_model), FALSE);
1018 g_return_val_if_fail (GTK_TREE_MODEL_SORT (tree_model)->child_model != NULL, FALSE);
1019 g_return_val_if_fail (GTK_TREE_MODEL_SORT (tree_model)->stamp == iter->stamp, FALSE);
1021 GET_CHILD_ITER (tree_model, &child_iter, iter);
1023 return gtk_tree_model_iter_has_child (GTK_TREE_MODEL_SORT (tree_model)->child_model, &child_iter);
1027 gtk_tree_model_sort_iter_n_children (GtkTreeModel *tree_model,
1030 GtkTreeIter child_iter;
1032 g_return_val_if_fail (GTK_IS_TREE_MODEL_SORT (tree_model), 0);
1033 g_return_val_if_fail (GTK_TREE_MODEL_SORT (tree_model)->child_model != NULL, 0);
1034 if (iter) g_return_val_if_fail (GTK_TREE_MODEL_SORT (tree_model)->stamp == iter->stamp, 0);
1037 return gtk_tree_model_iter_n_children (GTK_TREE_MODEL_SORT (tree_model)->child_model, NULL);
1039 GET_CHILD_ITER (tree_model, &child_iter, iter);
1041 return gtk_tree_model_iter_n_children (GTK_TREE_MODEL_SORT (tree_model)->child_model, &child_iter);
1045 gtk_tree_model_sort_iter_nth_child (GtkTreeModel *tree_model,
1047 GtkTreeIter *parent,
1051 /* We have this for the iter == parent case */
1052 GtkTreeIter children;
1054 g_return_val_if_fail (GTK_IS_TREE_MODEL_SORT (tree_model), FALSE);
1055 if (parent) g_return_val_if_fail (GTK_TREE_MODEL_SORT (tree_model)->stamp == parent->stamp, FALSE);
1057 /* Use this instead of has_child to force us to build the level, if needed */
1058 if (gtk_tree_model_sort_iter_children (tree_model, &children, parent) == FALSE)
1064 level = children.user_data;
1065 if (n >= level->array->len)
1071 iter->stamp = GTK_TREE_MODEL_SORT (tree_model)->stamp;
1072 iter->user_data = level;
1073 iter->user_data2 = &g_array_index (level->array, SortElt, n);
1079 gtk_tree_model_sort_iter_parent (GtkTreeModel *tree_model,
1086 g_return_val_if_fail (GTK_IS_TREE_MODEL_SORT (tree_model), FALSE);
1087 g_return_val_if_fail (GTK_TREE_MODEL_SORT (tree_model)->child_model != NULL, FALSE);
1088 g_return_val_if_fail (GTK_TREE_MODEL_SORT (tree_model)->stamp == child->stamp, FALSE);
1090 level = child->user_data;
1092 if (level->parent_level)
1094 iter->stamp = GTK_TREE_MODEL_SORT (tree_model)->stamp;
1095 iter->user_data = level->parent_level;
1096 iter->user_data2 = level->parent_elt;
1104 gtk_tree_model_sort_ref_node (GtkTreeModel *tree_model,
1107 GtkTreeModelSort *tree_model_sort = (GtkTreeModelSort *) tree_model;
1108 GtkTreeIter child_iter;
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 GET_CHILD_ITER (tree_model, &child_iter, iter);
1118 gtk_tree_model_ref_node (GTK_TREE_MODEL_SORT (tree_model)->child_model, &child_iter);
1120 level = iter->user_data;
1121 elt = iter->user_data2;
1125 if (level->ref_count == 1)
1127 SortLevel *parent_level = level->parent_level;
1128 SortElt *parent_elt = level->parent_elt;
1129 /* We were at zero -- time to decrement the zero_ref_count val */
1133 parent_elt->zero_ref_count--;
1135 tree_model_sort->zero_ref_count--;
1139 parent_elt = parent_level->parent_elt;
1140 parent_level = parent_level->parent_level;
1143 while (parent_level);
1148 gtk_tree_model_sort_real_unref_node (GtkTreeModel *tree_model,
1150 gboolean propagate_unref)
1152 GtkTreeModelSort *tree_model_sort = (GtkTreeModelSort *) tree_model;
1153 GtkTreeIter child_iter;
1157 g_return_if_fail (GTK_IS_TREE_MODEL_SORT (tree_model));
1158 g_return_if_fail (GTK_TREE_MODEL_SORT (tree_model)->child_model != NULL);
1159 g_return_if_fail (GTK_TREE_MODEL_SORT (tree_model)->stamp == iter->stamp);
1161 GET_CHILD_ITER (tree_model, &child_iter, iter);
1163 if (propagate_unref)
1164 gtk_tree_model_unref_node (GTK_TREE_MODEL_SORT (tree_model)->child_model, &child_iter);
1166 level = iter->user_data;
1167 elt = iter->user_data2;
1169 g_return_if_fail (elt->ref_count > 0);
1173 if (level->ref_count == 0)
1175 SortLevel *parent_level = level->parent_level;
1176 SortElt *parent_elt = level->parent_elt;
1178 /* We are at zero -- time to increment the zero_ref_count val */
1179 while (parent_level)
1181 parent_elt->zero_ref_count++;
1183 parent_elt = parent_level->parent_elt;
1184 parent_level = parent_level->parent_level;
1186 tree_model_sort->zero_ref_count++;
1191 gtk_tree_model_sort_unref_node (GtkTreeModel *tree_model,
1194 gtk_tree_model_sort_real_unref_node (tree_model, iter, TRUE);
1197 /* Sortable interface */
1199 gtk_tree_model_sort_get_sort_column_id (GtkTreeSortable *sortable,
1200 gint *sort_column_id,
1203 GtkTreeModelSort *tree_model_sort = (GtkTreeModelSort *)sortable;
1205 g_return_val_if_fail (GTK_IS_TREE_MODEL_SORT (sortable), FALSE);
1207 if (tree_model_sort->sort_column_id == GTK_TREE_SORTABLE_DEFAULT_SORT_COLUMN_ID)
1211 *sort_column_id = tree_model_sort->sort_column_id;
1213 *order = tree_model_sort->order;
1219 gtk_tree_model_sort_set_sort_column_id (GtkTreeSortable *sortable,
1220 gint sort_column_id,
1223 GtkTreeModelSort *tree_model_sort = (GtkTreeModelSort *)sortable;
1225 g_return_if_fail (GTK_IS_TREE_MODEL_SORT (sortable));
1227 if (sort_column_id != GTK_TREE_SORTABLE_DEFAULT_SORT_COLUMN_ID)
1229 GtkTreeDataSortHeader *header = NULL;
1231 header = _gtk_tree_data_list_get_header (tree_model_sort->sort_list,
1234 /* we want to make sure that we have a function */
1235 g_return_if_fail (header != NULL);
1236 g_return_if_fail (header->func != NULL);
1239 g_return_if_fail (tree_model_sort->default_sort_func != NULL);
1241 if (tree_model_sort->sort_column_id == sort_column_id)
1243 if (sort_column_id != GTK_TREE_SORTABLE_DEFAULT_SORT_COLUMN_ID)
1245 if (tree_model_sort->order == order)
1252 tree_model_sort->sort_column_id = sort_column_id;
1253 tree_model_sort->order = order;
1255 gtk_tree_model_sort_sort (tree_model_sort);
1256 gtk_tree_sortable_sort_column_changed (sortable);
1260 gtk_tree_model_sort_set_sort_func (GtkTreeSortable *sortable,
1261 gint sort_column_id,
1262 GtkTreeIterCompareFunc func,
1264 GtkDestroyNotify destroy)
1266 GtkTreeModelSort *tree_model_sort = (GtkTreeModelSort *) sortable;
1267 GtkTreeDataSortHeader *header = NULL;
1270 g_return_if_fail (GTK_IS_TREE_MODEL_SORT (sortable));
1271 g_return_if_fail (func != NULL);
1273 for (list = tree_model_sort->sort_list; list; list = list->next)
1275 header = (GtkTreeDataSortHeader *) list->data;
1277 if (header->sort_column_id == sort_column_id)
1283 header = g_new0 (GtkTreeDataSortHeader, 1);
1284 header->sort_column_id = sort_column_id;
1285 tree_model_sort->sort_list = g_list_append (tree_model_sort->sort_list,
1289 if (header->destroy)
1290 (* header->destroy) (header->data);
1292 header->func = func;
1293 header->data = data;
1294 header->destroy = destroy;
1298 gtk_tree_model_sort_set_default_sort_func (GtkTreeSortable *sortable,
1299 GtkTreeIterCompareFunc func,
1301 GtkDestroyNotify destroy)
1303 GtkTreeModelSort *tree_model_sort = (GtkTreeModelSort *)sortable;
1305 g_return_if_fail (GTK_IS_TREE_MODEL_SORT (sortable));
1307 if (tree_model_sort->default_sort_destroy)
1308 (* tree_model_sort->default_sort_destroy) (tree_model_sort->default_sort_data);
1310 tree_model_sort->default_sort_func = func;
1311 tree_model_sort->default_sort_data = data;
1312 tree_model_sort->default_sort_destroy = destroy;
1316 gtk_tree_model_sort_has_default_sort_func (GtkTreeSortable *sortable)
1318 GtkTreeModelSort *tree_model_sort = (GtkTreeModelSort *)sortable;
1320 g_return_val_if_fail (GTK_IS_TREE_MODEL_SORT (sortable), FALSE);
1322 return (tree_model_sort->default_sort_func != NULL);
1325 /* sorting code - private */
1327 gtk_tree_model_sort_compare_func (gconstpointer a,
1331 SortData *data = (SortData *)user_data;
1332 GtkTreeModelSort *tree_model_sort = data->tree_model_sort;
1333 SortTuple *sa = (SortTuple *)a;
1334 SortTuple *sb = (SortTuple *)b;
1336 GtkTreeIter iter_a, iter_b;
1339 /* shortcut, if we've the same offsets here, they should be equal */
1340 if (sa->offset == sb->offset)
1343 if (GTK_TREE_MODEL_SORT_CACHE_CHILD_ITERS (tree_model_sort))
1345 iter_a = sa->elt->iter;
1346 iter_b = sb->elt->iter;
1350 data->parent_path_indices [data->parent_path_depth-1] = sa->elt->offset;
1351 gtk_tree_model_get_iter (GTK_TREE_MODEL (tree_model_sort->child_model), &iter_a, data->parent_path);
1352 data->parent_path_indices [data->parent_path_depth-1] = sb->elt->offset;
1353 gtk_tree_model_get_iter (GTK_TREE_MODEL (tree_model_sort->child_model), &iter_b, data->parent_path);
1356 retval = (* data->sort_func) (GTK_TREE_MODEL (tree_model_sort->child_model),
1360 if (tree_model_sort->order == GTK_SORT_DESCENDING)
1364 else if (retval < 0)
1372 gtk_tree_model_sort_offset_compare_func (gconstpointer a,
1378 SortTuple *sa = (SortTuple *)a;
1379 SortTuple *sb = (SortTuple *)b;
1381 SortData *data = (SortData *)user_data;
1383 if (sa->elt->offset < sb->elt->offset)
1385 else if (sa->elt->offset > sb->elt->offset)
1390 if (data->tree_model_sort->order == GTK_SORT_DESCENDING)
1394 else if (retval < 0)
1402 gtk_tree_model_sort_sort_level (GtkTreeModelSort *tree_model_sort,
1405 gboolean emit_reordered)
1417 g_return_if_fail (GTK_IS_TREE_MODEL_SORT (tree_model_sort));
1418 g_return_if_fail (level != NULL);
1420 if (level->array->len < 1 && !((SortElt *)level->array->data)->children)
1424 data.tree_model_sort = tree_model_sort;
1425 if (level->parent_elt)
1427 data.parent_path = gtk_tree_model_sort_elt_get_path (level->parent_level,
1429 gtk_tree_path_append_index (data.parent_path, 0);
1433 data.parent_path = gtk_tree_path_new_root ();
1435 data.parent_path_depth = gtk_tree_path_get_depth (data.parent_path);
1436 data.parent_path_indices = gtk_tree_path_get_indices (data.parent_path);
1438 /* make the array to be sorted */
1439 sort_array = g_array_sized_new (FALSE, FALSE, sizeof (SortTuple), level->array->len);
1440 for (i = 0; i < level->array->len; i++)
1444 tuple.elt = &g_array_index (level->array, SortElt, i);
1447 g_array_append_val (sort_array, tuple);
1450 if (tree_model_sort->sort_column_id != GTK_TREE_SORTABLE_DEFAULT_SORT_COLUMN_ID)
1452 GtkTreeDataSortHeader *header = NULL;
1454 header = _gtk_tree_data_list_get_header (tree_model_sort->sort_list,
1455 tree_model_sort->sort_column_id);
1457 g_return_if_fail (header != NULL);
1458 g_return_if_fail (header->func != NULL);
1460 data.sort_func = header->func;
1461 data.sort_data = header->data;
1465 /* absolutely SHOULD NOT happen: */
1466 g_return_if_fail (tree_model_sort->default_sort_func != NULL);
1468 data.sort_func = tree_model_sort->default_sort_func;
1469 data.sort_data = tree_model_sort->default_sort_data;
1472 if (data.sort_func == NO_SORT_FUNC)
1473 g_array_sort_with_data (sort_array,
1474 gtk_tree_model_sort_offset_compare_func,
1477 g_array_sort_with_data (sort_array,
1478 gtk_tree_model_sort_compare_func,
1481 gtk_tree_path_free (data.parent_path);
1483 new_array = g_array_sized_new (FALSE, FALSE, sizeof (SortElt), level->array->len);
1484 new_order = g_new (gint, level->array->len);
1486 for (i = 0; i < level->array->len; i++)
1490 elt = g_array_index (sort_array, SortTuple, i).elt;
1491 new_order[i] = g_array_index (sort_array, SortTuple, i).offset;
1493 g_array_append_val (new_array, *elt);
1494 elt = &g_array_index (new_array, SortElt, i);
1496 elt->children->parent_elt = elt;
1499 g_array_free (level->array, TRUE);
1500 level->array = new_array;
1501 g_array_free (sort_array, TRUE);
1505 if (level->parent_elt)
1507 iter.stamp = tree_model_sort->stamp;
1508 iter.user_data = level->parent_level;
1509 iter.user_data2 = level->parent_elt;
1511 path = gtk_tree_model_get_path (GTK_TREE_MODEL (tree_model_sort),
1514 gtk_tree_model_rows_reordered (GTK_TREE_MODEL (tree_model_sort), path,
1520 path = gtk_tree_path_new ();
1521 gtk_tree_model_rows_reordered (GTK_TREE_MODEL (tree_model_sort), path,
1525 gtk_tree_path_free (path);
1528 /* recurse, if possible */
1531 for (i = 0; i < level->array->len; i++)
1533 SortElt *elt = &g_array_index (level->array, SortElt, i);
1536 gtk_tree_model_sort_sort_level (tree_model_sort,
1538 TRUE, emit_reordered);
1546 gtk_tree_model_sort_sort (GtkTreeModelSort *tree_model_sort)
1548 g_return_if_fail (GTK_IS_TREE_MODEL_SORT (tree_model_sort));
1550 if (!tree_model_sort->root)
1553 if (tree_model_sort->sort_column_id != GTK_TREE_SORTABLE_DEFAULT_SORT_COLUMN_ID)
1555 GtkTreeDataSortHeader *header = NULL;
1557 header = _gtk_tree_data_list_get_header (tree_model_sort->sort_list,
1558 tree_model_sort->sort_column_id);
1560 /* we want to make sure that we have a function */
1561 g_return_if_fail (header != NULL);
1562 g_return_if_fail (header->func != NULL);
1565 g_return_if_fail (tree_model_sort->default_sort_func != NULL);
1567 gtk_tree_model_sort_sort_level (tree_model_sort, tree_model_sort->root,
1571 /* signal helpers */
1573 gtk_tree_model_sort_level_find_insert (GtkTreeModelSort *tree_model_sort,
1576 gboolean skip_sort_elt)
1581 GtkTreeIter tmp_iter;
1583 GtkTreeIterCompareFunc func;
1588 if (tree_model_sort->sort_column_id != GTK_TREE_SORTABLE_DEFAULT_SORT_COLUMN_ID)
1590 GtkTreeDataSortHeader *header;
1592 header = _gtk_tree_data_list_get_header (tree_model_sort->sort_list,
1593 tree_model_sort->sort_column_id);
1595 g_return_val_if_fail (header != NULL, 0);
1597 func = header->func;
1598 data = header->data;
1602 func = tree_model_sort->default_sort_func;
1603 data = tree_model_sort->default_sort_data;
1605 g_return_val_if_fail (func != NO_SORT_FUNC, 0);
1608 g_return_val_if_fail (func != NULL, 0);
1610 for (middle = 0; middle < level->array->len; middle++)
1612 tmp_elt = &(g_array_index (level->array, SortElt, middle));
1614 if (!skip_sort_elt && SORT_ELT (iter->user_data2) == tmp_elt)
1617 path = gtk_tree_model_sort_elt_get_path (level, tmp_elt);
1618 gtk_tree_model_get_iter (tree_model_sort->child_model,
1620 gtk_tree_path_free (path);
1622 if (tree_model_sort->order == GTK_SORT_ASCENDING)
1623 cmp = (* func) (GTK_TREE_MODEL (tree_model_sort->child_model),
1624 &tmp_iter, iter, data);
1626 cmp = (* func) (GTK_TREE_MODEL (tree_model_sort->child_model),
1627 iter, &tmp_iter, data);
1637 gtk_tree_model_sort_insert_value (GtkTreeModelSort *tree_model_sort,
1639 GtkTreePath *s_path,
1640 GtkTreeIter *s_iter)
1642 gint offset, index, i;
1647 offset = gtk_tree_path_get_indices (s_path)[gtk_tree_path_get_depth (s_path) - 1];
1649 if (GTK_TREE_MODEL_SORT_CACHE_CHILD_ITERS (tree_model_sort))
1651 elt.offset = offset;
1652 elt.zero_ref_count = 0;
1654 elt.children = NULL;
1656 if (tree_model_sort->sort_column_id == GTK_TREE_SORTABLE_DEFAULT_SORT_COLUMN_ID &&
1657 tree_model_sort->default_sort_func == NO_SORT_FUNC)
1660 index = gtk_tree_model_sort_level_find_insert (tree_model_sort,
1664 g_array_insert_vals (level->array, index, &elt, 1);
1666 /* update all larger offsets */
1667 tmp_elt = SORT_ELT (level->array->data);
1668 for (i = 0; i < level->array->len; i++, tmp_elt++)
1670 if ((tmp_elt->offset >= offset) && i != index)
1672 if (tmp_elt->children)
1673 tmp_elt->children->parent_elt = tmp_elt;
1679 /* sort elt stuff */
1680 static GtkTreePath *
1681 gtk_tree_model_sort_elt_get_path (SortLevel *level,
1684 SortLevel *walker = level;
1685 SortElt *walker2 = elt;
1688 g_return_val_if_fail (level != NULL, NULL);
1689 g_return_val_if_fail (elt != NULL, NULL);
1691 path = gtk_tree_path_new ();
1695 gtk_tree_path_prepend_index (path, walker2->offset);
1697 walker2 = walker->parent_elt;
1698 walker = walker->parent_level;
1705 * gtk_tree_model_sort_set_model:
1706 * @tree_model_sort: The #GtkTreeModelSort.
1707 * @child_model: A #GtkTreeModel, or NULL.
1709 * Sets the model of @tree_model_sort to be @model. If @model is NULL, then the
1710 * old model is unset. The sort function is unset as a result of this call.
1711 * The model will be in an unsorted state until a sort function is set.
1714 gtk_tree_model_sort_set_model (GtkTreeModelSort *tree_model_sort,
1715 GtkTreeModel *child_model)
1717 g_return_if_fail (GTK_IS_TREE_MODEL_SORT (tree_model_sort));
1720 g_object_ref (G_OBJECT (child_model));
1722 if (tree_model_sort->child_model)
1724 g_signal_handler_disconnect (G_OBJECT (tree_model_sort->child_model),
1725 tree_model_sort->changed_id);
1726 g_signal_handler_disconnect (G_OBJECT (tree_model_sort->child_model),
1727 tree_model_sort->inserted_id);
1728 g_signal_handler_disconnect (G_OBJECT (tree_model_sort->child_model),
1729 tree_model_sort->has_child_toggled_id);
1730 g_signal_handler_disconnect (G_OBJECT (tree_model_sort->child_model),
1731 tree_model_sort->deleted_id);
1732 g_signal_handler_disconnect (G_OBJECT (tree_model_sort->child_model),
1733 tree_model_sort->reordered_id);
1735 /* reset our state */
1736 if (tree_model_sort->root)
1737 gtk_tree_model_sort_free_level (tree_model_sort, tree_model_sort->root);
1738 tree_model_sort->root = NULL;
1739 _gtk_tree_data_list_header_free (tree_model_sort->sort_list);
1740 tree_model_sort->sort_list = NULL;
1741 g_object_unref (G_OBJECT (tree_model_sort->child_model));
1744 tree_model_sort->child_model = child_model;
1751 g_object_ref (tree_model_sort->child_model);
1752 tree_model_sort->changed_id =
1753 g_signal_connect (child_model, "row_changed",
1754 G_CALLBACK (gtk_tree_model_sort_row_changed),
1756 tree_model_sort->inserted_id =
1757 g_signal_connect (child_model, "row_inserted",
1758 G_CALLBACK (gtk_tree_model_sort_row_inserted),
1760 tree_model_sort->has_child_toggled_id =
1761 g_signal_connect (child_model, "row_has_child_toggled",
1762 G_CALLBACK (gtk_tree_model_sort_row_has_child_toggled),
1764 tree_model_sort->deleted_id =
1765 g_signal_connect (child_model, "row_deleted",
1766 G_CALLBACK (gtk_tree_model_sort_row_deleted),
1768 tree_model_sort->reordered_id =
1769 g_signal_connect (child_model, "rows_reordered",
1770 G_CALLBACK (gtk_tree_model_sort_rows_reordered),
1773 tree_model_sort->child_flags = gtk_tree_model_get_flags (child_model);
1774 n_columns = gtk_tree_model_get_n_columns (child_model);
1776 types = g_new (GType, n_columns);
1777 for (i = 0; i < n_columns; i++)
1778 types[i] = gtk_tree_model_get_column_type (child_model, i);
1780 tree_model_sort->sort_list = _gtk_tree_data_list_header_new (n_columns, types);
1783 tree_model_sort->default_sort_func = NO_SORT_FUNC;
1784 tree_model_sort->stamp = g_random_int ();
1789 * gtk_tree_model_sort_get_model:
1790 * @tree_model: a #GtkTreeModelSort
1792 * Returns the model the #GtkTreeModelSort is sorting.
1794 * Return value: the "child model" being sorted
1797 gtk_tree_model_sort_get_model (GtkTreeModelSort *tree_model)
1799 g_return_val_if_fail (GTK_IS_TREE_MODEL_SORT (tree_model), NULL);
1801 return tree_model->child_model;
1805 static GtkTreePath *
1806 gtk_real_tree_model_sort_convert_child_path_to_path (GtkTreeModelSort *tree_model_sort,
1807 GtkTreePath *child_path,
1808 gboolean build_levels)
1810 gint *child_indices;
1811 GtkTreePath *retval;
1815 g_return_val_if_fail (GTK_IS_TREE_MODEL_SORT (tree_model_sort), NULL);
1816 g_return_val_if_fail (tree_model_sort->child_model != NULL, NULL);
1817 g_return_val_if_fail (child_path != NULL, NULL);
1819 retval = gtk_tree_path_new ();
1820 child_indices = gtk_tree_path_get_indices (child_path);
1822 if (tree_model_sort->root == NULL && build_levels)
1823 gtk_tree_model_sort_build_level (tree_model_sort, NULL, NULL);
1824 level = SORT_LEVEL (tree_model_sort->root);
1826 for (i = 0; i < gtk_tree_path_get_depth (child_path); i++)
1829 gboolean found_child = FALSE;
1833 gtk_tree_path_free (retval);
1837 if (child_indices[i] >= level->array->len)
1839 gtk_tree_path_free (retval);
1842 for (j = 0; j < level->array->len; j++)
1844 if ((g_array_index (level->array, SortElt, j)).offset == child_indices[i])
1846 gtk_tree_path_append_index (retval, j);
1847 if (g_array_index (level->array, SortElt, j).children == NULL && build_levels)
1849 gtk_tree_model_sort_build_level (tree_model_sort, level, &g_array_index (level->array, SortElt, j));
1851 level = g_array_index (level->array, SortElt, j).children;
1858 gtk_tree_path_free (retval);
1868 * gtk_tree_model_sort_convert_child_path_to_path:
1869 * @tree_model_sort: A #GtkTreeModelSort
1870 * @child_path: A #GtkTreePath to convert
1872 * Converts @child_path to a path relative to @tree_model_sort. That is,
1873 * @child_path points to a path in the child model. The returned path will
1874 * point to the same row in the sorted model. If @child_path isn't a valid path
1875 * on the child model, then %NULL is returned.
1877 * Return value: A newly allocated #GtkTreePath, or %NULL
1880 gtk_tree_model_sort_convert_child_path_to_path (GtkTreeModelSort *tree_model_sort,
1881 GtkTreePath *child_path)
1883 g_return_val_if_fail (GTK_IS_TREE_MODEL_SORT (tree_model_sort), NULL);
1884 g_return_val_if_fail (tree_model_sort->child_model != NULL, NULL);
1885 g_return_val_if_fail (child_path != NULL, NULL);
1887 return gtk_real_tree_model_sort_convert_child_path_to_path (tree_model_sort, child_path, TRUE);
1891 * gtk_tree_model_sort_convert_child_iter_to_iter:
1892 * @tree_model_sort: A #GtkTreeModelSort
1893 * @sort_iter: An uninitialized #GtkTreeIter.
1894 * @child_iter: A valid #GtkTreeIter pointing to a row on the child model
1896 * Sets @sort_iter to point to the row in @tree_model_sort that corresponds to
1897 * the row pointed at by @child_iter.
1900 gtk_tree_model_sort_convert_child_iter_to_iter (GtkTreeModelSort *tree_model_sort,
1901 GtkTreeIter *sort_iter,
1902 GtkTreeIter *child_iter)
1904 GtkTreePath *child_path, *path;
1906 g_return_if_fail (GTK_IS_TREE_MODEL_SORT (tree_model_sort));
1907 g_return_if_fail (tree_model_sort->child_model != NULL);
1908 g_return_if_fail (sort_iter != NULL);
1909 g_return_if_fail (child_iter != NULL);
1911 sort_iter->stamp = 0;
1913 child_path = gtk_tree_model_get_path (tree_model_sort->child_model, child_iter);
1914 g_return_if_fail (child_path != NULL);
1916 path = gtk_tree_model_sort_convert_child_path_to_path (tree_model_sort, child_path);
1917 gtk_tree_path_free (child_path);
1918 g_return_if_fail (path != NULL);
1920 gtk_tree_model_get_iter (GTK_TREE_MODEL (tree_model_sort), sort_iter, path);
1921 gtk_tree_path_free (path);
1925 * gtk_tree_model_sort_convert_path_to_child_path:
1926 * @tree_model_sort: A #GtkTreeModelSort
1927 * @sorted_path: A #GtkTreePath to convert
1929 * Converts @sort_path to a path on the child model of @tree_model_sort. That
1930 * is, @sort_path points ot a location in @tree_model_sort. The returned path
1931 * will point to the same location in the model not being sorted. If @path does not point to a
1933 * Return value: A newly allocated #GtkTreePath, or %NULL
1936 gtk_tree_model_sort_convert_path_to_child_path (GtkTreeModelSort *tree_model_sort,
1937 GtkTreePath *sorted_path)
1939 gint *sorted_indices;
1940 GtkTreePath *retval;
1944 g_return_val_if_fail (GTK_IS_TREE_MODEL_SORT (tree_model_sort), NULL);
1945 g_return_val_if_fail (tree_model_sort->child_model != NULL, NULL);
1946 g_return_val_if_fail (sorted_path != NULL, NULL);
1948 retval = gtk_tree_path_new ();
1949 sorted_indices = gtk_tree_path_get_indices (sorted_path);
1950 if (tree_model_sort->root == NULL)
1951 gtk_tree_model_sort_build_level (tree_model_sort, NULL, NULL);
1952 level = SORT_LEVEL (tree_model_sort->root);
1954 for (i = 0; i < gtk_tree_path_get_depth (sorted_path); i++)
1956 if ((level == NULL) ||
1957 (level->array->len > sorted_indices[i]))
1959 gtk_tree_path_free (retval);
1962 if (g_array_index (level->array, SortElt, sorted_indices[i]).children == NULL)
1963 gtk_tree_model_sort_build_level (tree_model_sort, level, &g_array_index (level->array, SortElt, sorted_indices[i]));
1966 gtk_tree_path_append_index (retval, g_array_index (level->array, SortElt, i).offset);
1973 * gtk_tree_model_sort_convert_iter_to_child_iter:
1974 * @tree_model_sort: A #GtkTreeModelSort
1975 * @child_iter: An uninitialized #GtkTreeIter
1976 * @sorted_iter: A valid #GtkTreeIter pointing to a row on @tree_model_sort.
1978 * Sets @child_iter to point to the row pointed to by *sorted_iter.
1981 gtk_tree_model_sort_convert_iter_to_child_iter (GtkTreeModelSort *tree_model_sort,
1982 GtkTreeIter *child_iter,
1983 GtkTreeIter *sorted_iter)
1985 g_return_if_fail (GTK_IS_TREE_MODEL_SORT (tree_model_sort));
1986 g_return_if_fail (tree_model_sort->child_model != NULL);
1987 g_return_if_fail (child_iter != NULL);
1988 g_return_if_fail (sorted_iter != NULL);
1989 g_return_if_fail (sorted_iter->stamp == tree_model_sort->stamp);
1991 if (GTK_TREE_MODEL_SORT_CACHE_CHILD_ITERS (tree_model_sort))
1993 *child_iter = SORT_ELT (sorted_iter->user_data2)->iter;
1999 path = gtk_tree_model_sort_elt_get_path (sorted_iter->user_data,
2000 sorted_iter->user_data2);
2001 gtk_tree_model_get_iter (tree_model_sort->child_model, child_iter, path);
2002 gtk_tree_path_free (path);
2007 gtk_tree_model_sort_build_level (GtkTreeModelSort *tree_model_sort,
2008 SortLevel *parent_level,
2009 SortElt *parent_elt)
2012 SortLevel *new_level;
2016 g_assert (tree_model_sort->child_model != NULL);
2018 if (parent_level == NULL)
2020 if (gtk_tree_model_get_iter_root (tree_model_sort->child_model, &iter) == FALSE)
2022 length = gtk_tree_model_iter_n_children (tree_model_sort->child_model, NULL);
2026 GtkTreeIter parent_iter;
2027 GtkTreeIter child_parent_iter;
2029 parent_iter.stamp = tree_model_sort->stamp;
2030 parent_iter.user_data = parent_level;
2031 parent_iter.user_data2 = parent_elt;
2033 gtk_tree_model_sort_convert_iter_to_child_iter (tree_model_sort,
2036 if (gtk_tree_model_iter_children (tree_model_sort->child_model,
2038 &child_parent_iter) == FALSE)
2041 /* stamp may have changed */
2042 gtk_tree_model_sort_convert_iter_to_child_iter (tree_model_sort,
2046 length = gtk_tree_model_iter_n_children (tree_model_sort->child_model, &child_parent_iter);
2049 g_return_if_fail (length > 0);
2051 new_level = g_new (SortLevel, 1);
2052 new_level->array = g_array_sized_new (FALSE, FALSE, sizeof (SortElt), length);
2053 new_level->ref_count = 0;
2054 new_level->parent_elt = parent_elt;
2055 new_level->parent_level = parent_level;
2058 parent_elt->children = new_level;
2060 tree_model_sort->root = new_level;
2062 /* increase the count of zero ref_counts.*/
2063 while (parent_level)
2065 parent_elt->zero_ref_count++;
2067 parent_elt = parent_level->parent_elt;
2068 parent_level = parent_level->parent_level;
2070 if (new_level != tree_model_sort->root)
2071 tree_model_sort->zero_ref_count++;
2073 for (i = 0; i < length; i++)
2076 sort_elt.offset = i;
2077 sort_elt.zero_ref_count = 0;
2078 sort_elt.ref_count = 0;
2079 sort_elt.children = NULL;
2081 if (GTK_TREE_MODEL_SORT_CACHE_CHILD_ITERS (tree_model_sort))
2083 sort_elt.iter = iter;
2084 if (gtk_tree_model_iter_next (tree_model_sort->child_model, &iter) == FALSE &&
2087 g_warning ("There is a discrepency between the sort model and the child model.");
2091 g_array_append_val (new_level->array, sort_elt);
2095 gtk_tree_model_sort_sort_level (tree_model_sort, new_level,
2100 gtk_tree_model_sort_free_level (GtkTreeModelSort *tree_model_sort,
2101 SortLevel *sort_level)
2105 g_assert (sort_level);
2107 if (sort_level->ref_count == 0)
2109 SortLevel *parent_level = sort_level->parent_level;
2110 SortElt *parent_elt = sort_level->parent_elt;
2115 parent_elt->zero_ref_count--;
2117 tree_model_sort->zero_ref_count--;
2121 parent_elt = parent_level->parent_elt;
2122 parent_level = parent_level->parent_level;
2125 while (parent_level);
2128 for (i = 0; i < sort_level->array->len; i++)
2130 if (g_array_index (sort_level->array, SortElt, i).children)
2131 gtk_tree_model_sort_free_level (tree_model_sort,
2132 SORT_LEVEL(g_array_index (sort_level->array, SortElt, i).children));
2135 if (sort_level->parent_elt)
2136 sort_level->parent_elt->children = NULL;
2138 tree_model_sort->root = NULL;
2140 g_array_free (sort_level->array, TRUE);
2141 sort_level->array = NULL;
2143 g_free (sort_level);
2148 gtk_tree_model_sort_increment_stamp (GtkTreeModelSort *tree_model_sort)
2152 tree_model_sort->stamp++;
2154 while (tree_model_sort->stamp == 0);
2156 gtk_tree_model_sort_clear_cache (tree_model_sort);
2160 gtk_tree_model_sort_clear_cache_helper (GtkTreeModelSort *tree_model_sort,
2165 g_assert (level != NULL);
2167 for (i = 0; i < level->array->len; i++)
2169 if (g_array_index (level->array, SortElt, i).zero_ref_count > 0)
2170 gtk_tree_model_sort_clear_cache_helper (tree_model_sort, g_array_index (level->array, SortElt, i).children);
2173 if (level->ref_count == 0 && level != tree_model_sort->root)
2174 gtk_tree_model_sort_free_level (tree_model_sort, level);
2178 * gtk_tree_model_sort_reset_default_sort_func:
2179 * @tree_model_sort: A #GtkTreeModelSort
2181 * This resets the default sort function to be in the 'unsorted' state. That
2182 * is, it is in the same order as the child model.
2185 gtk_tree_model_sort_reset_default_sort_func (GtkTreeModelSort *tree_model_sort)
2187 g_return_if_fail (GTK_IS_TREE_MODEL_SORT (tree_model_sort));
2189 if (tree_model_sort->default_sort_destroy)
2190 (* tree_model_sort->default_sort_destroy) (tree_model_sort->default_sort_data);
2192 tree_model_sort->default_sort_func = NO_SORT_FUNC;
2193 tree_model_sort->default_sort_data = NULL;
2194 tree_model_sort->default_sort_destroy = NULL;
2195 tree_model_sort->sort_column_id = GTK_TREE_SORTABLE_DEFAULT_SORT_COLUMN_ID;
2199 * gtk_tree_model_sort_clear_cache:
2200 * @tree_model_sort: A #GtkTreeModelSort
2202 * This function should almost never be called. It clears the @tree_model_sort
2203 * of any cached iterators that haven't been reffed with
2204 * gtk_tree_model_ref_node(). This might be useful if the child model being
2205 * sorted is static (and doesn't change often) and there has been a lot of
2206 * unreffed access to nodes. As a side effect of this function, all unreffed
2207 * iters will be invalid.
2210 gtk_tree_model_sort_clear_cache (GtkTreeModelSort *tree_model_sort)
2212 g_return_if_fail (GTK_IS_TREE_MODEL_SORT (tree_model_sort));
2214 if (tree_model_sort->zero_ref_count)
2215 gtk_tree_model_sort_clear_cache_helper (tree_model_sort, (SortLevel *)tree_model_sort->root);