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.
42 #include "gtktreemodelsort.h"
43 #include "gtktreesortable.h"
44 #include "gtktreestore.h"
45 #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 #define VALID_ITER(iter, tree_model_sort) (iter != NULL && iter->user_data != NULL && iter->user_data2 != NULL && tree_model_sort->stamp == iter->stamp)
106 /* general (object/interface init, etc) */
107 static void gtk_tree_model_sort_init (GtkTreeModelSort *tree_model_sort);
108 static void gtk_tree_model_sort_class_init (GtkTreeModelSortClass *tree_model_sort_class);
109 static void gtk_tree_model_sort_tree_model_init (GtkTreeModelIface *iface);
110 static void gtk_tree_model_sort_tree_sortable_init (GtkTreeSortableIface *iface);
111 static void gtk_tree_model_sort_finalize (GObject *object);
112 static void gtk_tree_model_sort_set_property (GObject *object,
116 static void gtk_tree_model_sort_get_property (GObject *object,
121 /* our signal handlers */
122 static void gtk_tree_model_sort_row_changed (GtkTreeModel *model,
123 GtkTreePath *start_path,
124 GtkTreeIter *start_iter,
126 static void gtk_tree_model_sort_row_inserted (GtkTreeModel *model,
130 static void gtk_tree_model_sort_row_has_child_toggled (GtkTreeModel *model,
134 static void gtk_tree_model_sort_row_deleted (GtkTreeModel *model,
137 static void gtk_tree_model_sort_rows_reordered (GtkTreeModel *s_model,
143 /* TreeModel interface */
144 static GtkTreeModelFlags gtk_tree_model_sort_get_flags (GtkTreeModel *tree_model);
145 static gint gtk_tree_model_sort_get_n_columns (GtkTreeModel *tree_model);
146 static GType gtk_tree_model_sort_get_column_type (GtkTreeModel *tree_model,
148 static gboolean gtk_tree_model_sort_get_iter (GtkTreeModel *tree_model,
151 static GtkTreePath *gtk_tree_model_sort_get_path (GtkTreeModel *tree_model,
153 static void gtk_tree_model_sort_get_value (GtkTreeModel *tree_model,
157 static gboolean gtk_tree_model_sort_iter_next (GtkTreeModel *tree_model,
159 static gboolean gtk_tree_model_sort_iter_children (GtkTreeModel *tree_model,
161 GtkTreeIter *parent);
162 static gboolean gtk_tree_model_sort_iter_has_child (GtkTreeModel *tree_model,
164 static gint gtk_tree_model_sort_iter_n_children (GtkTreeModel *tree_model,
166 static gboolean gtk_tree_model_sort_iter_nth_child (GtkTreeModel *tree_model,
170 static gboolean gtk_tree_model_sort_iter_parent (GtkTreeModel *tree_model,
173 static void gtk_tree_model_sort_ref_node (GtkTreeModel *tree_model,
175 static void gtk_tree_model_sort_real_unref_node (GtkTreeModel *tree_model,
177 gboolean propagate_unref);
178 static void gtk_tree_model_sort_unref_node (GtkTreeModel *tree_model,
181 /* TreeSortable interface */
182 static gboolean gtk_tree_model_sort_get_sort_column_id (GtkTreeSortable *sortable,
183 gint *sort_column_id,
185 static void gtk_tree_model_sort_set_sort_column_id (GtkTreeSortable *sortable,
188 static void gtk_tree_model_sort_set_sort_func (GtkTreeSortable *sortable,
190 GtkTreeIterCompareFunc func,
192 GtkDestroyNotify destroy);
193 static void gtk_tree_model_sort_set_default_sort_func (GtkTreeSortable *sortable,
194 GtkTreeIterCompareFunc func,
196 GtkDestroyNotify destroy);
197 static gboolean gtk_tree_model_sort_has_default_sort_func (GtkTreeSortable *sortable);
199 /* Private functions (sort funcs, level handling and other utils) */
200 static void gtk_tree_model_sort_build_level (GtkTreeModelSort *tree_model_sort,
201 SortLevel *parent_level,
202 SortElt *parent_elt);
203 static void gtk_tree_model_sort_free_level (GtkTreeModelSort *tree_model_sort,
204 SortLevel *sort_level);
205 static void gtk_tree_model_sort_increment_stamp (GtkTreeModelSort *tree_model_sort);
206 static void gtk_tree_model_sort_sort_level (GtkTreeModelSort *tree_model_sort,
209 gboolean emit_reordered);
210 static void gtk_tree_model_sort_sort (GtkTreeModelSort *tree_model_sort);
211 static gint gtk_tree_model_sort_level_find_insert (GtkTreeModelSort *tree_model_sort,
214 gboolean skip_sort_elt);
215 static gboolean gtk_tree_model_sort_insert_value (GtkTreeModelSort *tree_model_sort,
218 GtkTreeIter *s_iter);
219 static GtkTreePath *gtk_tree_model_sort_elt_get_path (SortLevel *level,
221 static void gtk_tree_model_sort_set_model (GtkTreeModelSort *tree_model_sort,
222 GtkTreeModel *child_model);
223 static GtkTreePath *gtk_real_tree_model_sort_convert_child_path_to_path (GtkTreeModelSort *tree_model_sort,
224 GtkTreePath *child_path,
225 gboolean build_levels);
227 static GObjectClass *parent_class = NULL;
230 gtk_tree_model_sort_get_type (void)
232 static GType tree_model_sort_type = 0;
234 if (!tree_model_sort_type)
236 static const GTypeInfo tree_model_sort_info =
238 sizeof (GtkTreeModelSortClass),
239 NULL, /* base_init */
240 NULL, /* base_finalize */
241 (GClassInitFunc) gtk_tree_model_sort_class_init,
242 NULL, /* class_finalize */
243 NULL, /* class_data */
244 sizeof (GtkTreeModelSort),
246 (GInstanceInitFunc) gtk_tree_model_sort_init
249 static const GInterfaceInfo tree_model_info =
251 (GInterfaceInitFunc) gtk_tree_model_sort_tree_model_init,
256 static const GInterfaceInfo sortable_info =
258 (GInterfaceInitFunc) gtk_tree_model_sort_tree_sortable_init,
263 tree_model_sort_type =
264 g_type_register_static (G_TYPE_OBJECT, "GtkTreeModelSort",
265 &tree_model_sort_info, 0);
267 g_type_add_interface_static (tree_model_sort_type,
271 g_type_add_interface_static (tree_model_sort_type,
272 GTK_TYPE_TREE_SORTABLE,
276 return tree_model_sort_type;
280 gtk_tree_model_sort_init (GtkTreeModelSort *tree_model_sort)
282 tree_model_sort->sort_column_id = GTK_TREE_SORTABLE_DEFAULT_SORT_COLUMN_ID;
283 tree_model_sort->stamp = 0;
284 tree_model_sort->zero_ref_count = 0;
285 tree_model_sort->root = NULL;
286 tree_model_sort->sort_list = NULL;
290 gtk_tree_model_sort_class_init (GtkTreeModelSortClass *class)
292 GObjectClass *object_class;
294 object_class = (GObjectClass *) class;
295 parent_class = g_type_class_peek_parent (class);
297 object_class->set_property = gtk_tree_model_sort_set_property;
298 object_class->get_property = gtk_tree_model_sort_get_property;
300 object_class->finalize = gtk_tree_model_sort_finalize;
303 g_object_class_install_property (object_class,
305 g_param_spec_object ("model",
306 _("TreeModelSort Model"),
307 _("The model for the TreeModelSort to sort"),
309 G_PARAM_READWRITE | G_PARAM_CONSTRUCT_ONLY));
313 gtk_tree_model_sort_tree_model_init (GtkTreeModelIface *iface)
315 iface->get_flags = gtk_tree_model_sort_get_flags;
316 iface->get_n_columns = gtk_tree_model_sort_get_n_columns;
317 iface->get_column_type = gtk_tree_model_sort_get_column_type;
318 iface->get_iter = gtk_tree_model_sort_get_iter;
319 iface->get_path = gtk_tree_model_sort_get_path;
320 iface->get_value = gtk_tree_model_sort_get_value;
321 iface->iter_next = gtk_tree_model_sort_iter_next;
322 iface->iter_children = gtk_tree_model_sort_iter_children;
323 iface->iter_has_child = gtk_tree_model_sort_iter_has_child;
324 iface->iter_n_children = gtk_tree_model_sort_iter_n_children;
325 iface->iter_nth_child = gtk_tree_model_sort_iter_nth_child;
326 iface->iter_parent = gtk_tree_model_sort_iter_parent;
327 iface->ref_node = gtk_tree_model_sort_ref_node;
328 iface->unref_node = gtk_tree_model_sort_unref_node;
332 gtk_tree_model_sort_tree_sortable_init (GtkTreeSortableIface *iface)
334 iface->get_sort_column_id = gtk_tree_model_sort_get_sort_column_id;
335 iface->set_sort_column_id = gtk_tree_model_sort_set_sort_column_id;
336 iface->set_sort_func = gtk_tree_model_sort_set_sort_func;
337 iface->set_default_sort_func = gtk_tree_model_sort_set_default_sort_func;
338 iface->has_default_sort_func = gtk_tree_model_sort_has_default_sort_func;
342 * gtk_tree_model_sort_new_with_model:
343 * @child_model: A #GtkTreeModel
345 * Creates a new #GtkTreeModel, with @child_model as the child_model.
347 * Return value: A new #GtkTreeModel.
350 gtk_tree_model_sort_new_with_model (GtkTreeModel *child_model)
352 GtkTreeModel *retval;
354 g_return_val_if_fail (GTK_IS_TREE_MODEL (child_model), NULL);
356 retval = g_object_new (gtk_tree_model_sort_get_type (), NULL);
358 gtk_tree_model_sort_set_model (GTK_TREE_MODEL_SORT (retval), child_model);
363 /* GObject callbacks */
365 gtk_tree_model_sort_finalize (GObject *object)
367 GtkTreeModelSort *tree_model_sort = (GtkTreeModelSort *) object;
369 gtk_tree_model_sort_set_model (tree_model_sort, NULL);
371 if (tree_model_sort->root)
372 gtk_tree_model_sort_free_level (tree_model_sort, tree_model_sort->root);
374 if (tree_model_sort->sort_list)
376 _gtk_tree_data_list_header_free (tree_model_sort->sort_list);
377 tree_model_sort->sort_list = NULL;
381 parent_class->finalize (object);
385 gtk_tree_model_sort_set_property (GObject *object,
390 GtkTreeModelSort *tree_model_sort = GTK_TREE_MODEL_SORT (object);
395 gtk_tree_model_sort_set_model (tree_model_sort, g_value_get_object (value));
398 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
404 gtk_tree_model_sort_get_property (GObject *object,
409 GtkTreeModelSort *tree_model_sort = GTK_TREE_MODEL_SORT (object);
414 g_value_set_object (value, gtk_tree_model_sort_get_model(tree_model_sort));
417 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
423 gtk_tree_model_sort_row_changed (GtkTreeModel *s_model,
424 GtkTreePath *start_s_path,
425 GtkTreeIter *start_s_iter,
428 GtkTreeModelSort *tree_model_sort = GTK_TREE_MODEL_SORT (data);
429 GtkTreePath *path = NULL;
437 gboolean free_s_path = FALSE;
439 gint offset, index = 0, old_index, i;
441 g_return_if_fail (start_s_path != NULL || start_s_iter != NULL);
446 start_s_path = gtk_tree_model_get_path (s_model, start_s_iter);
449 path = gtk_real_tree_model_sort_convert_child_path_to_path (tree_model_sort,
455 gtk_tree_path_free (start_s_path);
459 gtk_tree_model_get_iter (GTK_TREE_MODEL (data), &iter, path);
461 level = iter.user_data;
462 elt = iter.user_data2;
464 if (level->array->len < 2 ||
465 (tree_model_sort->sort_column_id == GTK_TREE_SORTABLE_DEFAULT_SORT_COLUMN_ID &&
466 tree_model_sort->default_sort_func == NO_SORT_FUNC))
469 gtk_tree_path_free (start_s_path);
471 gtk_tree_model_row_changed (GTK_TREE_MODEL (data), path, &iter);
473 gtk_tree_path_free (path);
478 if (!GTK_TREE_MODEL_SORT_CACHE_CHILD_ITERS (tree_model_sort))
480 gtk_tree_model_get_iter (tree_model_sort->child_model,
481 &tmpiter, start_s_path);
484 offset = elt->offset;
486 for (i = 0; i < level->array->len; i++)
487 if (elt->offset == g_array_index (level->array, SortElt, i).offset)
490 memcpy (&tmp, elt, sizeof (SortElt));
491 g_array_remove_index (level->array, index);
495 if (GTK_TREE_MODEL_SORT_CACHE_CHILD_ITERS (tree_model_sort))
496 index = gtk_tree_model_sort_level_find_insert (tree_model_sort,
501 index = gtk_tree_model_sort_level_find_insert (tree_model_sort,
506 g_array_insert_val (level->array, index, tmp);
508 for (i = 0; i < level->array->len; i++)
509 if (g_array_index (level->array, SortElt, i).children)
510 g_array_index (level->array, SortElt, i).children->parent_elt = &g_array_index (level->array, SortElt, i);
512 gtk_tree_path_up (path);
513 gtk_tree_path_append_index (path, index);
515 gtk_tree_model_sort_increment_stamp (tree_model_sort);
517 /* if the item moved, then emit rows_reordered */
518 if (old_index != index)
523 GtkTreePath *tmppath;
525 new_order = g_new (gint, level->array->len);
527 for (j = 0; j < level->array->len; j++)
529 if (index > old_index)
532 new_order[j] = old_index;
533 else if (j >= old_index && j < index)
534 new_order[j] = j + 1;
538 else if (index < old_index)
541 new_order[j] = old_index;
542 else if (j > index && j <= old_index)
543 new_order[j] = j - 1;
547 /* else? shouldn't really happen */
550 if (level->parent_elt)
552 iter.stamp = tree_model_sort->stamp;
553 iter.user_data = level->parent_level;
554 iter.user_data2 = level->parent_elt;
556 tmppath = gtk_tree_model_get_path (GTK_TREE_MODEL (tree_model_sort), &iter);
558 gtk_tree_model_rows_reordered (GTK_TREE_MODEL (tree_model_sort),
559 tmppath, &iter, new_order);
564 tmppath = gtk_tree_path_new ();
566 gtk_tree_model_rows_reordered (GTK_TREE_MODEL (tree_model_sort), tmppath,
570 gtk_tree_path_free (tmppath);
574 /* emit row_changed signal (at new location) */
575 gtk_tree_model_get_iter (GTK_TREE_MODEL (data), &iter, path);
576 gtk_tree_model_row_changed (GTK_TREE_MODEL (data), path, &iter);
578 gtk_tree_path_free (path);
580 gtk_tree_path_free (start_s_path);
584 gtk_tree_model_sort_row_inserted (GtkTreeModel *s_model,
589 GtkTreeModelSort *tree_model_sort = GTK_TREE_MODEL_SORT (data);
592 GtkTreeIter real_s_iter;
596 gboolean free_s_path = FALSE;
600 SortLevel *parent_level = NULL;
602 parent_level = level = SORT_LEVEL (tree_model_sort->root);
604 g_return_if_fail (s_path != NULL || s_iter != NULL);
608 s_path = gtk_tree_model_get_path (s_model, s_iter);
613 gtk_tree_model_get_iter (s_model, &real_s_iter, s_path);
615 real_s_iter = *s_iter;
617 if (!tree_model_sort->root)
619 gtk_tree_model_sort_build_level (tree_model_sort, NULL, NULL);
621 /* the build level already put the inserted iter in the level,
622 so no need to handle this signal anymore */
624 goto done_and_submit;
627 /* find the parent level */
628 while (i < gtk_tree_path_get_depth (s_path) - 1)
634 /* level not yet build, we won't cover this signal */
638 if (level->array->len < gtk_tree_path_get_indices (s_path)[i])
640 g_warning ("A node was inserted with a parent that's not in the tree.\n"
641 "This possibly means that a GtkTreeModel inserted a child node\n"
642 "before the parent was inserted.");
647 for (j = 0; j < level->array->len; j++)
648 if (g_array_index (level->array, SortElt, j).offset == gtk_tree_path_get_indices (s_path)[i])
650 elt = &g_array_index (level->array, SortElt, j);
654 g_return_if_fail (elt != NULL);
658 GtkTreePath *tmppath;
661 tmpiter.stamp = tree_model_sort->stamp;
662 tmpiter.user_data = level;
663 tmpiter.user_data2 = elt;
665 tmppath = gtk_tree_model_get_path (GTK_TREE_MODEL (data), &tmpiter);
668 gtk_tree_model_row_has_child_toggled (GTK_TREE_MODEL (data),
671 gtk_tree_path_free (tmppath);
674 /* not covering this signal */
678 level = elt->children;
679 parent_level = level;
686 if (!gtk_tree_model_sort_insert_value (tree_model_sort,
693 path = gtk_real_tree_model_sort_convert_child_path_to_path (tree_model_sort,
700 gtk_tree_model_sort_increment_stamp (tree_model_sort);
702 gtk_tree_model_get_iter (GTK_TREE_MODEL (data), &iter, path);
703 gtk_tree_model_row_inserted (GTK_TREE_MODEL (data), path, &iter);
704 gtk_tree_path_free (path);
708 gtk_tree_path_free (s_path);
714 gtk_tree_model_sort_row_has_child_toggled (GtkTreeModel *s_model,
719 GtkTreeModelSort *tree_model_sort = GTK_TREE_MODEL_SORT (data);
723 g_return_if_fail (s_path != NULL && s_iter != NULL);
725 path = gtk_real_tree_model_sort_convert_child_path_to_path (tree_model_sort, s_path, FALSE);
729 gtk_tree_model_get_iter (GTK_TREE_MODEL (data), &iter, path);
730 gtk_tree_model_row_has_child_toggled (GTK_TREE_MODEL (data), path, &iter);
732 gtk_tree_path_free (path);
735 /* FIXME: I still have doubts if this works */
737 gtk_tree_model_sort_row_deleted (GtkTreeModel *s_model,
741 GtkTreeModelSort *tree_model_sort = GTK_TREE_MODEL_SORT (data);
742 GtkTreePath *path = NULL;
749 g_return_if_fail (s_path != NULL);
751 path = gtk_real_tree_model_sort_convert_child_path_to_path (tree_model_sort, s_path, FALSE);
755 gtk_tree_model_get_iter (GTK_TREE_MODEL (data), &iter, path);
757 level = SORT_LEVEL (iter.user_data);
758 elt = SORT_ELT (iter.user_data2);
759 offset = elt->offset;
761 /* we _need_ to emit ::row_deleted before we start unreffing the node
762 * itself. This is because of the row refs, which start unreffing nodes
763 * when we emit ::row_deleted
765 gtk_tree_model_row_deleted (GTK_TREE_MODEL (data), path);
767 gtk_tree_model_get_iter (GTK_TREE_MODEL (data), &iter, path);
769 while (elt->ref_count > 0)
770 gtk_tree_model_sort_real_unref_node (GTK_TREE_MODEL (data), &iter, FALSE);
772 if (level->ref_count == 0 && level != tree_model_sort->root)
774 /* This will prune the level, so I can just emit the signal and not worry
775 * about cleaning this level up. */
776 gtk_tree_model_sort_increment_stamp (tree_model_sort);
777 gtk_tree_path_free (path);
781 gtk_tree_model_sort_increment_stamp (tree_model_sort);
784 for (i = 0; i < level->array->len; i++)
785 if (elt->offset == g_array_index (level->array, SortElt, i).offset)
788 g_array_remove_index (level->array, i);
790 /* update all offsets */
791 for (i = 0; i < level->array->len; i++)
793 elt = & (g_array_index (level->array, SortElt, i));
794 if (elt->offset > offset)
797 elt->children->parent_elt = elt;
800 gtk_tree_path_free (path);
804 gtk_tree_model_sort_rows_reordered (GtkTreeModel *s_model,
816 GtkTreeModelSort *tree_model_sort = GTK_TREE_MODEL_SORT (data);
818 g_return_if_fail (new_order != NULL);
820 if (s_path == NULL || gtk_tree_path_get_indices (s_path) == NULL)
822 if (tree_model_sort->root == NULL)
824 path = gtk_tree_path_new ();
825 level = SORT_LEVEL (tree_model_sort->root);
829 path = gtk_real_tree_model_sort_convert_child_path_to_path (tree_model_sort, s_path, FALSE);
832 gtk_tree_model_get_iter (GTK_TREE_MODEL (data), &iter, path);
834 level = SORT_LEVEL (iter.user_data);
835 elt = SORT_ELT (iter.user_data2);
839 gtk_tree_path_free (path);
843 level = elt->children;
846 if (level->array->len < 2)
848 gtk_tree_path_free (path);
852 tmp_array = g_new (int, level->array->len);
853 for (i = 0; i < level->array->len; i++)
855 for (j = 0; j < level->array->len; j++)
857 if (g_array_index (level->array, SortElt, i).offset == new_order[j])
862 for (i = 0; i < level->array->len; i++)
863 g_array_index (level->array, SortElt, i).offset = tmp_array[i];
866 if (tree_model_sort->sort_column_id == GTK_TREE_SORTABLE_DEFAULT_SORT_COLUMN_ID &&
867 tree_model_sort->default_sort_func == NO_SORT_FUNC)
870 gtk_tree_model_sort_sort_level (tree_model_sort, level,
872 gtk_tree_model_sort_increment_stamp (tree_model_sort);
874 if (gtk_tree_path_get_depth (path))
876 gtk_tree_model_get_iter (GTK_TREE_MODEL (tree_model_sort),
879 gtk_tree_model_rows_reordered (GTK_TREE_MODEL (tree_model_sort),
880 path, &iter, new_order);
884 gtk_tree_model_rows_reordered (GTK_TREE_MODEL (tree_model_sort),
885 path, NULL, new_order);
889 gtk_tree_path_free (path);
892 /* Fulfill our model requirements */
893 static GtkTreeModelFlags
894 gtk_tree_model_sort_get_flags (GtkTreeModel *tree_model)
896 g_return_val_if_fail (GTK_IS_TREE_MODEL_SORT (tree_model), 0);
902 gtk_tree_model_sort_get_n_columns (GtkTreeModel *tree_model)
904 GtkTreeModelSort *tree_model_sort = (GtkTreeModelSort *) tree_model;
906 g_return_val_if_fail (GTK_IS_TREE_MODEL_SORT (tree_model), 0);
908 if (tree_model_sort->child_model == 0)
911 return gtk_tree_model_get_n_columns (tree_model_sort->child_model);
915 gtk_tree_model_sort_get_column_type (GtkTreeModel *tree_model,
918 g_return_val_if_fail (GTK_IS_TREE_MODEL_SORT (tree_model), G_TYPE_INVALID);
919 g_return_val_if_fail (GTK_TREE_MODEL_SORT (tree_model)->child_model != NULL, G_TYPE_INVALID);
921 return gtk_tree_model_get_column_type (GTK_TREE_MODEL_SORT (tree_model)->child_model, index);
925 gtk_tree_model_sort_get_iter (GtkTreeModel *tree_model,
929 GtkTreeModelSort *tree_model_sort;
934 g_return_val_if_fail (GTK_IS_TREE_MODEL_SORT (tree_model), FALSE);
935 g_return_val_if_fail (GTK_TREE_MODEL_SORT (tree_model)->child_model != NULL, FALSE);
937 tree_model_sort = (GtkTreeModelSort *) tree_model;
938 indices = gtk_tree_path_get_indices (path);
940 if (tree_model_sort->root == NULL)
941 gtk_tree_model_sort_build_level (tree_model_sort, NULL, NULL);
942 level = SORT_LEVEL (tree_model_sort->root);
944 depth = gtk_tree_path_get_depth (path);
948 for (i = 0; i < depth - 1; i++)
950 if ((level == NULL) ||
951 (indices[i] >= level->array->len))
954 if (g_array_index (level->array, SortElt, indices[i]).children == NULL)
955 gtk_tree_model_sort_build_level (tree_model_sort, level, &g_array_index (level->array, SortElt, indices[i]));
956 level = g_array_index (level->array, SortElt, indices[i]).children;
961 iter->stamp = tree_model_sort->stamp;
962 iter->user_data = level;
963 iter->user_data2 = &g_array_index (level->array, SortElt, indices[depth - 1]);
969 gtk_tree_model_sort_get_path (GtkTreeModel *tree_model,
976 g_return_val_if_fail (GTK_IS_TREE_MODEL_SORT (tree_model), NULL);
977 g_return_val_if_fail (GTK_TREE_MODEL_SORT (tree_model)->child_model != NULL, NULL);
978 g_return_val_if_fail (GTK_TREE_MODEL_SORT (tree_model)->stamp == iter->stamp, NULL);
980 retval = gtk_tree_path_new ();
981 level = iter->user_data;
982 elt = iter->user_data2;
983 while (level != NULL)
985 gtk_tree_path_prepend_index (retval, elt - (SortElt *)level->array->data);
987 elt = level->parent_elt;
988 level = level->parent_level;
995 gtk_tree_model_sort_get_value (GtkTreeModel *tree_model,
1000 GtkTreeIter child_iter;
1002 g_return_if_fail (GTK_IS_TREE_MODEL_SORT (tree_model));
1003 g_return_if_fail (GTK_TREE_MODEL_SORT (tree_model)->child_model != NULL);
1004 g_return_if_fail (GTK_TREE_MODEL_SORT (tree_model)->stamp == iter->stamp);
1006 GET_CHILD_ITER (tree_model, &child_iter, iter);
1007 gtk_tree_model_get_value (GTK_TREE_MODEL_SORT (tree_model)->child_model,
1008 &child_iter, column, value);
1012 gtk_tree_model_sort_iter_next (GtkTreeModel *tree_model,
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 level = iter->user_data;
1023 elt = iter->user_data2;
1025 if (elt - (SortElt *)level->array->data >= level->array->len - 1)
1030 iter->user_data2 = elt + 1;
1036 gtk_tree_model_sort_iter_children (GtkTreeModel *tree_model,
1038 GtkTreeIter *parent)
1040 GtkTreeModelSort *tree_model_sort = (GtkTreeModelSort *) tree_model;
1044 g_return_val_if_fail (GTK_IS_TREE_MODEL_SORT (tree_model), FALSE);
1045 g_return_val_if_fail (tree_model_sort->child_model != NULL, FALSE);
1046 if (parent) g_return_val_if_fail (tree_model_sort->stamp == parent->stamp, FALSE);
1050 if (tree_model_sort->root == NULL)
1051 gtk_tree_model_sort_build_level (tree_model_sort, NULL, NULL);
1052 if (tree_model_sort->root == NULL)
1055 level = tree_model_sort->root;
1056 iter->stamp = tree_model_sort->stamp;
1057 iter->user_data = level;
1058 iter->user_data2 = level->array->data;
1062 if (((SortElt *)parent->user_data2)->children == NULL)
1063 gtk_tree_model_sort_build_level (tree_model_sort,
1064 (SortLevel *)parent->user_data,
1065 (SortElt *)parent->user_data2);
1066 if (((SortElt *)parent->user_data2)->children == NULL)
1068 iter->stamp = tree_model_sort->stamp;
1069 iter->user_data = ((SortElt *)parent->user_data2)->children;
1070 iter->user_data2 = ((SortLevel *)iter->user_data)->array->data;
1077 gtk_tree_model_sort_iter_has_child (GtkTreeModel *tree_model,
1080 GtkTreeIter child_iter;
1082 g_return_val_if_fail (GTK_IS_TREE_MODEL_SORT (tree_model), FALSE);
1083 g_return_val_if_fail (GTK_TREE_MODEL_SORT (tree_model)->child_model != NULL, FALSE);
1084 g_return_val_if_fail (GTK_TREE_MODEL_SORT (tree_model)->stamp == iter->stamp, FALSE);
1086 GET_CHILD_ITER (tree_model, &child_iter, iter);
1088 return gtk_tree_model_iter_has_child (GTK_TREE_MODEL_SORT (tree_model)->child_model, &child_iter);
1092 gtk_tree_model_sort_iter_n_children (GtkTreeModel *tree_model,
1095 GtkTreeIter child_iter;
1097 g_return_val_if_fail (GTK_IS_TREE_MODEL_SORT (tree_model), 0);
1098 g_return_val_if_fail (GTK_TREE_MODEL_SORT (tree_model)->child_model != NULL, 0);
1099 if (iter) g_return_val_if_fail (GTK_TREE_MODEL_SORT (tree_model)->stamp == iter->stamp, 0);
1102 return gtk_tree_model_iter_n_children (GTK_TREE_MODEL_SORT (tree_model)->child_model, NULL);
1104 GET_CHILD_ITER (tree_model, &child_iter, iter);
1106 return gtk_tree_model_iter_n_children (GTK_TREE_MODEL_SORT (tree_model)->child_model, &child_iter);
1110 gtk_tree_model_sort_iter_nth_child (GtkTreeModel *tree_model,
1112 GtkTreeIter *parent,
1116 /* We have this for the iter == parent case */
1117 GtkTreeIter children;
1119 g_return_val_if_fail (GTK_IS_TREE_MODEL_SORT (tree_model), FALSE);
1120 if (parent) g_return_val_if_fail (GTK_TREE_MODEL_SORT (tree_model)->stamp == parent->stamp, FALSE);
1122 /* Use this instead of has_child to force us to build the level, if needed */
1123 if (gtk_tree_model_sort_iter_children (tree_model, &children, parent) == FALSE)
1129 level = children.user_data;
1130 if (n >= level->array->len)
1136 iter->stamp = GTK_TREE_MODEL_SORT (tree_model)->stamp;
1137 iter->user_data = level;
1138 iter->user_data2 = &g_array_index (level->array, SortElt, n);
1144 gtk_tree_model_sort_iter_parent (GtkTreeModel *tree_model,
1151 g_return_val_if_fail (GTK_IS_TREE_MODEL_SORT (tree_model), FALSE);
1152 g_return_val_if_fail (GTK_TREE_MODEL_SORT (tree_model)->child_model != NULL, FALSE);
1153 g_return_val_if_fail (GTK_TREE_MODEL_SORT (tree_model)->stamp == child->stamp, FALSE);
1155 level = child->user_data;
1157 if (level->parent_level)
1159 iter->stamp = GTK_TREE_MODEL_SORT (tree_model)->stamp;
1160 iter->user_data = level->parent_level;
1161 iter->user_data2 = level->parent_elt;
1169 gtk_tree_model_sort_ref_node (GtkTreeModel *tree_model,
1172 GtkTreeModelSort *tree_model_sort = (GtkTreeModelSort *) tree_model;
1173 GtkTreeIter child_iter;
1177 g_return_if_fail (GTK_IS_TREE_MODEL_SORT (tree_model));
1178 g_return_if_fail (GTK_TREE_MODEL_SORT (tree_model)->child_model != NULL);
1179 g_return_if_fail (GTK_TREE_MODEL_SORT (tree_model)->stamp == iter->stamp);
1181 GET_CHILD_ITER (tree_model, &child_iter, iter);
1183 gtk_tree_model_ref_node (GTK_TREE_MODEL_SORT (tree_model)->child_model, &child_iter);
1185 level = iter->user_data;
1186 elt = iter->user_data2;
1190 if (level->ref_count == 1)
1192 SortLevel *parent_level = level->parent_level;
1193 SortElt *parent_elt = level->parent_elt;
1194 /* We were at zero -- time to decrement the zero_ref_count val */
1198 parent_elt->zero_ref_count--;
1200 tree_model_sort->zero_ref_count--;
1204 parent_elt = parent_level->parent_elt;
1205 parent_level = parent_level->parent_level;
1208 while (parent_level);
1213 gtk_tree_model_sort_real_unref_node (GtkTreeModel *tree_model,
1215 gboolean propagate_unref)
1217 GtkTreeModelSort *tree_model_sort = (GtkTreeModelSort *) tree_model;
1218 GtkTreeIter child_iter;
1222 g_return_if_fail (GTK_IS_TREE_MODEL_SORT (tree_model));
1223 g_return_if_fail (GTK_TREE_MODEL_SORT (tree_model)->child_model != NULL);
1224 g_return_if_fail (GTK_TREE_MODEL_SORT (tree_model)->stamp == iter->stamp);
1226 GET_CHILD_ITER (tree_model, &child_iter, iter);
1228 if (propagate_unref)
1229 gtk_tree_model_unref_node (GTK_TREE_MODEL_SORT (tree_model)->child_model, &child_iter);
1231 level = iter->user_data;
1232 elt = iter->user_data2;
1234 g_return_if_fail (elt->ref_count > 0);
1239 if (level->ref_count == 0)
1241 SortLevel *parent_level = level->parent_level;
1242 SortElt *parent_elt = level->parent_elt;
1244 /* We are at zero -- time to increment the zero_ref_count val */
1245 while (parent_level)
1247 parent_elt->zero_ref_count++;
1249 parent_elt = parent_level->parent_elt;
1250 parent_level = parent_level->parent_level;
1252 tree_model_sort->zero_ref_count++;
1257 gtk_tree_model_sort_unref_node (GtkTreeModel *tree_model,
1260 gtk_tree_model_sort_real_unref_node (tree_model, iter, TRUE);
1263 /* Sortable interface */
1265 gtk_tree_model_sort_get_sort_column_id (GtkTreeSortable *sortable,
1266 gint *sort_column_id,
1269 GtkTreeModelSort *tree_model_sort = (GtkTreeModelSort *)sortable;
1271 g_return_val_if_fail (GTK_IS_TREE_MODEL_SORT (sortable), FALSE);
1273 if (tree_model_sort->sort_column_id == GTK_TREE_SORTABLE_DEFAULT_SORT_COLUMN_ID)
1277 *sort_column_id = tree_model_sort->sort_column_id;
1279 *order = tree_model_sort->order;
1285 gtk_tree_model_sort_set_sort_column_id (GtkTreeSortable *sortable,
1286 gint sort_column_id,
1289 GtkTreeModelSort *tree_model_sort = (GtkTreeModelSort *)sortable;
1291 g_return_if_fail (GTK_IS_TREE_MODEL_SORT (sortable));
1293 if (sort_column_id != GTK_TREE_SORTABLE_DEFAULT_SORT_COLUMN_ID)
1295 GtkTreeDataSortHeader *header = NULL;
1297 header = _gtk_tree_data_list_get_header (tree_model_sort->sort_list,
1300 /* we want to make sure that we have a function */
1301 g_return_if_fail (header != NULL);
1302 g_return_if_fail (header->func != NULL);
1305 g_return_if_fail (tree_model_sort->default_sort_func != NULL);
1307 if (tree_model_sort->sort_column_id == sort_column_id)
1309 if (sort_column_id != GTK_TREE_SORTABLE_DEFAULT_SORT_COLUMN_ID)
1311 if (tree_model_sort->order == order)
1318 tree_model_sort->sort_column_id = sort_column_id;
1319 tree_model_sort->order = order;
1321 gtk_tree_model_sort_sort (tree_model_sort);
1323 gtk_tree_sortable_sort_column_changed (sortable);
1327 gtk_tree_model_sort_set_sort_func (GtkTreeSortable *sortable,
1328 gint sort_column_id,
1329 GtkTreeIterCompareFunc func,
1331 GtkDestroyNotify destroy)
1333 GtkTreeModelSort *tree_model_sort = (GtkTreeModelSort *) sortable;
1334 GtkTreeDataSortHeader *header = NULL;
1337 g_return_if_fail (GTK_IS_TREE_MODEL_SORT (sortable));
1338 g_return_if_fail (func != NULL);
1340 for (list = tree_model_sort->sort_list; list; list = list->next)
1342 GtkTreeDataSortHeader *list_header;
1344 list_header = (GtkTreeDataSortHeader*) list->data;
1345 if (list_header->sort_column_id == sort_column_id)
1347 header = list_header;
1354 header = g_new0 (GtkTreeDataSortHeader, 1);
1355 header->sort_column_id = sort_column_id;
1356 tree_model_sort->sort_list = g_list_append (tree_model_sort->sort_list,
1360 if (header->destroy)
1362 GtkDestroyNotify d = header->destroy;
1364 header->destroy = NULL;
1368 header->func = func;
1369 header->data = data;
1370 header->destroy = destroy;
1374 gtk_tree_model_sort_set_default_sort_func (GtkTreeSortable *sortable,
1375 GtkTreeIterCompareFunc func,
1377 GtkDestroyNotify destroy)
1379 GtkTreeModelSort *tree_model_sort = (GtkTreeModelSort *)sortable;
1381 g_return_if_fail (GTK_IS_TREE_MODEL_SORT (sortable));
1383 if (tree_model_sort->default_sort_destroy)
1385 GtkDestroyNotify d = tree_model_sort->default_sort_destroy;
1387 tree_model_sort->default_sort_destroy = NULL;
1388 d (tree_model_sort->default_sort_data);
1391 tree_model_sort->default_sort_func = func;
1392 tree_model_sort->default_sort_data = data;
1393 tree_model_sort->default_sort_destroy = destroy;
1397 gtk_tree_model_sort_has_default_sort_func (GtkTreeSortable *sortable)
1399 GtkTreeModelSort *tree_model_sort = (GtkTreeModelSort *)sortable;
1401 g_return_val_if_fail (GTK_IS_TREE_MODEL_SORT (sortable), FALSE);
1403 return (tree_model_sort->default_sort_func != NULL);
1406 /* sorting code - private */
1408 gtk_tree_model_sort_compare_func (gconstpointer a,
1412 SortData *data = (SortData *)user_data;
1413 GtkTreeModelSort *tree_model_sort = data->tree_model_sort;
1414 SortTuple *sa = (SortTuple *)a;
1415 SortTuple *sb = (SortTuple *)b;
1417 GtkTreeIter iter_a, iter_b;
1420 /* shortcut, if we've the same offsets here, they should be equal */
1421 if (sa->offset == sb->offset)
1424 if (GTK_TREE_MODEL_SORT_CACHE_CHILD_ITERS (tree_model_sort))
1426 iter_a = sa->elt->iter;
1427 iter_b = sb->elt->iter;
1431 data->parent_path_indices [data->parent_path_depth-1] = sa->elt->offset;
1432 gtk_tree_model_get_iter (GTK_TREE_MODEL (tree_model_sort->child_model), &iter_a, data->parent_path);
1433 data->parent_path_indices [data->parent_path_depth-1] = sb->elt->offset;
1434 gtk_tree_model_get_iter (GTK_TREE_MODEL (tree_model_sort->child_model), &iter_b, data->parent_path);
1437 retval = (* data->sort_func) (GTK_TREE_MODEL (tree_model_sort->child_model),
1441 if (tree_model_sort->order == GTK_SORT_DESCENDING)
1445 else if (retval < 0)
1453 gtk_tree_model_sort_offset_compare_func (gconstpointer a,
1459 SortTuple *sa = (SortTuple *)a;
1460 SortTuple *sb = (SortTuple *)b;
1462 SortData *data = (SortData *)user_data;
1464 if (sa->elt->offset < sb->elt->offset)
1466 else if (sa->elt->offset > sb->elt->offset)
1471 if (data->tree_model_sort->order == GTK_SORT_DESCENDING)
1475 else if (retval < 0)
1483 gtk_tree_model_sort_sort_level (GtkTreeModelSort *tree_model_sort,
1486 gboolean emit_reordered)
1498 g_return_if_fail (GTK_IS_TREE_MODEL_SORT (tree_model_sort));
1499 g_return_if_fail (level != NULL);
1501 if (level->array->len < 1 && !((SortElt *)level->array->data)->children)
1505 data.tree_model_sort = tree_model_sort;
1506 if (level->parent_elt)
1508 data.parent_path = gtk_tree_model_sort_elt_get_path (level->parent_level,
1510 gtk_tree_path_append_index (data.parent_path, 0);
1514 data.parent_path = gtk_tree_path_new_first ();
1516 data.parent_path_depth = gtk_tree_path_get_depth (data.parent_path);
1517 data.parent_path_indices = gtk_tree_path_get_indices (data.parent_path);
1519 /* make the array to be sorted */
1520 sort_array = g_array_sized_new (FALSE, FALSE, sizeof (SortTuple), level->array->len);
1521 for (i = 0; i < level->array->len; i++)
1525 tuple.elt = &g_array_index (level->array, SortElt, i);
1528 g_array_append_val (sort_array, tuple);
1531 if (tree_model_sort->sort_column_id != GTK_TREE_SORTABLE_DEFAULT_SORT_COLUMN_ID)
1533 GtkTreeDataSortHeader *header = NULL;
1535 header = _gtk_tree_data_list_get_header (tree_model_sort->sort_list,
1536 tree_model_sort->sort_column_id);
1538 g_return_if_fail (header != NULL);
1539 g_return_if_fail (header->func != NULL);
1541 data.sort_func = header->func;
1542 data.sort_data = header->data;
1546 /* absolutely SHOULD NOT happen: */
1547 g_return_if_fail (tree_model_sort->default_sort_func != NULL);
1549 data.sort_func = tree_model_sort->default_sort_func;
1550 data.sort_data = tree_model_sort->default_sort_data;
1553 if (data.sort_func == NO_SORT_FUNC)
1554 g_array_sort_with_data (sort_array,
1555 gtk_tree_model_sort_offset_compare_func,
1558 g_array_sort_with_data (sort_array,
1559 gtk_tree_model_sort_compare_func,
1562 gtk_tree_path_free (data.parent_path);
1564 new_array = g_array_sized_new (FALSE, FALSE, sizeof (SortElt), level->array->len);
1565 new_order = g_new (gint, level->array->len);
1567 for (i = 0; i < level->array->len; i++)
1571 elt = g_array_index (sort_array, SortTuple, i).elt;
1572 new_order[i] = g_array_index (sort_array, SortTuple, i).offset;
1574 g_array_append_val (new_array, *elt);
1575 elt = &g_array_index (new_array, SortElt, i);
1577 elt->children->parent_elt = elt;
1580 g_array_free (level->array, TRUE);
1581 level->array = new_array;
1582 g_array_free (sort_array, TRUE);
1586 gtk_tree_model_sort_increment_stamp (tree_model_sort);
1587 if (level->parent_elt)
1589 iter.stamp = tree_model_sort->stamp;
1590 iter.user_data = level->parent_level;
1591 iter.user_data2 = level->parent_elt;
1593 path = gtk_tree_model_get_path (GTK_TREE_MODEL (tree_model_sort),
1596 gtk_tree_model_rows_reordered (GTK_TREE_MODEL (tree_model_sort), path,
1602 path = gtk_tree_path_new ();
1603 gtk_tree_model_rows_reordered (GTK_TREE_MODEL (tree_model_sort), path,
1607 gtk_tree_path_free (path);
1610 /* recurse, if possible */
1613 for (i = 0; i < level->array->len; i++)
1615 SortElt *elt = &g_array_index (level->array, SortElt, i);
1618 gtk_tree_model_sort_sort_level (tree_model_sort,
1620 TRUE, emit_reordered);
1628 gtk_tree_model_sort_sort (GtkTreeModelSort *tree_model_sort)
1630 g_return_if_fail (GTK_IS_TREE_MODEL_SORT (tree_model_sort));
1632 if (!tree_model_sort->root)
1635 if (tree_model_sort->sort_column_id != GTK_TREE_SORTABLE_DEFAULT_SORT_COLUMN_ID)
1637 GtkTreeDataSortHeader *header = NULL;
1639 header = _gtk_tree_data_list_get_header (tree_model_sort->sort_list,
1640 tree_model_sort->sort_column_id);
1642 /* we want to make sure that we have a function */
1643 g_return_if_fail (header != NULL);
1644 g_return_if_fail (header->func != NULL);
1647 g_return_if_fail (tree_model_sort->default_sort_func != NULL);
1649 gtk_tree_model_sort_sort_level (tree_model_sort, tree_model_sort->root,
1653 /* signal helpers */
1655 gtk_tree_model_sort_level_find_insert (GtkTreeModelSort *tree_model_sort,
1658 gboolean skip_sort_elt)
1663 GtkTreeIter tmp_iter;
1665 GtkTreeIterCompareFunc func;
1670 if (tree_model_sort->sort_column_id != GTK_TREE_SORTABLE_DEFAULT_SORT_COLUMN_ID)
1672 GtkTreeDataSortHeader *header;
1674 header = _gtk_tree_data_list_get_header (tree_model_sort->sort_list,
1675 tree_model_sort->sort_column_id);
1677 g_return_val_if_fail (header != NULL, 0);
1679 func = header->func;
1680 data = header->data;
1684 func = tree_model_sort->default_sort_func;
1685 data = tree_model_sort->default_sort_data;
1687 g_return_val_if_fail (func != NO_SORT_FUNC, 0);
1690 g_return_val_if_fail (func != NULL, 0);
1692 for (middle = 0; middle < level->array->len; middle++)
1694 tmp_elt = &(g_array_index (level->array, SortElt, middle));
1696 if (!skip_sort_elt && SORT_ELT (iter->user_data2) == tmp_elt)
1699 path = gtk_tree_model_sort_elt_get_path (level, tmp_elt);
1700 gtk_tree_model_get_iter (tree_model_sort->child_model,
1702 gtk_tree_path_free (path);
1704 if (tree_model_sort->order == GTK_SORT_ASCENDING)
1705 cmp = (* func) (GTK_TREE_MODEL (tree_model_sort->child_model),
1706 &tmp_iter, iter, data);
1708 cmp = (* func) (GTK_TREE_MODEL (tree_model_sort->child_model),
1709 iter, &tmp_iter, data);
1719 gtk_tree_model_sort_insert_value (GtkTreeModelSort *tree_model_sort,
1721 GtkTreePath *s_path,
1722 GtkTreeIter *s_iter)
1724 gint offset, index, i;
1729 offset = gtk_tree_path_get_indices (s_path)[gtk_tree_path_get_depth (s_path) - 1];
1731 if (GTK_TREE_MODEL_SORT_CACHE_CHILD_ITERS (tree_model_sort))
1733 elt.offset = offset;
1734 elt.zero_ref_count = 0;
1736 elt.children = NULL;
1738 /* update all larger offsets */
1739 tmp_elt = SORT_ELT (level->array->data);
1740 for (i = 0; i < level->array->len; i++, tmp_elt++)
1741 if (tmp_elt->offset >= offset)
1744 if (tree_model_sort->sort_column_id == GTK_TREE_SORTABLE_DEFAULT_SORT_COLUMN_ID &&
1745 tree_model_sort->default_sort_func == NO_SORT_FUNC)
1748 index = gtk_tree_model_sort_level_find_insert (tree_model_sort,
1752 g_array_insert_vals (level->array, index, &elt, 1);
1753 tmp_elt = SORT_ELT (level->array->data);
1754 for (i = 0; i < level->array->len; i++, tmp_elt++)
1755 if (tmp_elt->children)
1756 tmp_elt->children->parent_elt = tmp_elt;
1761 /* sort elt stuff */
1762 static GtkTreePath *
1763 gtk_tree_model_sort_elt_get_path (SortLevel *level,
1766 SortLevel *walker = level;
1767 SortElt *walker2 = elt;
1770 g_return_val_if_fail (level != NULL, NULL);
1771 g_return_val_if_fail (elt != NULL, NULL);
1773 path = gtk_tree_path_new ();
1777 gtk_tree_path_prepend_index (path, walker2->offset);
1779 walker2 = walker->parent_elt;
1780 walker = walker->parent_level;
1787 * gtk_tree_model_sort_set_model:
1788 * @tree_model_sort: The #GtkTreeModelSort.
1789 * @child_model: A #GtkTreeModel, or NULL.
1791 * Sets the model of @tree_model_sort to be @model. If @model is NULL, then the
1792 * old model is unset. The sort function is unset as a result of this call.
1793 * The model will be in an unsorted state until a sort function is set.
1796 gtk_tree_model_sort_set_model (GtkTreeModelSort *tree_model_sort,
1797 GtkTreeModel *child_model)
1799 g_return_if_fail (GTK_IS_TREE_MODEL_SORT (tree_model_sort));
1802 g_object_ref (child_model);
1804 if (tree_model_sort->child_model)
1806 g_signal_handler_disconnect (tree_model_sort->child_model,
1807 tree_model_sort->changed_id);
1808 g_signal_handler_disconnect (tree_model_sort->child_model,
1809 tree_model_sort->inserted_id);
1810 g_signal_handler_disconnect (tree_model_sort->child_model,
1811 tree_model_sort->has_child_toggled_id);
1812 g_signal_handler_disconnect (tree_model_sort->child_model,
1813 tree_model_sort->deleted_id);
1814 g_signal_handler_disconnect (tree_model_sort->child_model,
1815 tree_model_sort->reordered_id);
1817 /* reset our state */
1818 if (tree_model_sort->root)
1819 gtk_tree_model_sort_free_level (tree_model_sort, tree_model_sort->root);
1820 tree_model_sort->root = NULL;
1821 _gtk_tree_data_list_header_free (tree_model_sort->sort_list);
1822 tree_model_sort->sort_list = NULL;
1823 g_object_unref (tree_model_sort->child_model);
1826 tree_model_sort->child_model = child_model;
1833 tree_model_sort->changed_id =
1834 g_signal_connect (child_model, "row_changed",
1835 G_CALLBACK (gtk_tree_model_sort_row_changed),
1837 tree_model_sort->inserted_id =
1838 g_signal_connect (child_model, "row_inserted",
1839 G_CALLBACK (gtk_tree_model_sort_row_inserted),
1841 tree_model_sort->has_child_toggled_id =
1842 g_signal_connect (child_model, "row_has_child_toggled",
1843 G_CALLBACK (gtk_tree_model_sort_row_has_child_toggled),
1845 tree_model_sort->deleted_id =
1846 g_signal_connect (child_model, "row_deleted",
1847 G_CALLBACK (gtk_tree_model_sort_row_deleted),
1849 tree_model_sort->reordered_id =
1850 g_signal_connect (child_model, "rows_reordered",
1851 G_CALLBACK (gtk_tree_model_sort_rows_reordered),
1854 tree_model_sort->child_flags = gtk_tree_model_get_flags (child_model);
1855 n_columns = gtk_tree_model_get_n_columns (child_model);
1857 types = g_new (GType, n_columns);
1858 for (i = 0; i < n_columns; i++)
1859 types[i] = gtk_tree_model_get_column_type (child_model, i);
1861 tree_model_sort->sort_list = _gtk_tree_data_list_header_new (n_columns, types);
1864 tree_model_sort->default_sort_func = NO_SORT_FUNC;
1865 tree_model_sort->stamp = g_random_int ();
1870 * gtk_tree_model_sort_get_model:
1871 * @tree_model: a #GtkTreeModelSort
1873 * Returns the model the #GtkTreeModelSort is sorting.
1875 * Return value: the "child model" being sorted
1878 gtk_tree_model_sort_get_model (GtkTreeModelSort *tree_model)
1880 g_return_val_if_fail (GTK_IS_TREE_MODEL_SORT (tree_model), NULL);
1882 return tree_model->child_model;
1886 static GtkTreePath *
1887 gtk_real_tree_model_sort_convert_child_path_to_path (GtkTreeModelSort *tree_model_sort,
1888 GtkTreePath *child_path,
1889 gboolean build_levels)
1891 gint *child_indices;
1892 GtkTreePath *retval;
1896 g_return_val_if_fail (GTK_IS_TREE_MODEL_SORT (tree_model_sort), NULL);
1897 g_return_val_if_fail (tree_model_sort->child_model != NULL, NULL);
1898 g_return_val_if_fail (child_path != NULL, NULL);
1900 retval = gtk_tree_path_new ();
1901 child_indices = gtk_tree_path_get_indices (child_path);
1903 if (tree_model_sort->root == NULL && build_levels)
1904 gtk_tree_model_sort_build_level (tree_model_sort, NULL, NULL);
1905 level = SORT_LEVEL (tree_model_sort->root);
1907 for (i = 0; i < gtk_tree_path_get_depth (child_path); i++)
1910 gboolean found_child = FALSE;
1914 gtk_tree_path_free (retval);
1918 if (child_indices[i] >= level->array->len)
1920 gtk_tree_path_free (retval);
1923 for (j = 0; j < level->array->len; j++)
1925 if ((g_array_index (level->array, SortElt, j)).offset == child_indices[i])
1927 gtk_tree_path_append_index (retval, j);
1928 if (g_array_index (level->array, SortElt, j).children == NULL && build_levels)
1930 gtk_tree_model_sort_build_level (tree_model_sort, level, &g_array_index (level->array, SortElt, j));
1932 level = g_array_index (level->array, SortElt, j).children;
1939 gtk_tree_path_free (retval);
1949 * gtk_tree_model_sort_convert_child_path_to_path:
1950 * @tree_model_sort: A #GtkTreeModelSort
1951 * @child_path: A #GtkTreePath to convert
1953 * Converts @child_path to a path relative to @tree_model_sort. That is,
1954 * @child_path points to a path in the child model. The returned path will
1955 * point to the same row in the sorted model. If @child_path isn't a valid path
1956 * on the child model, then %NULL is returned.
1958 * Return value: A newly allocated #GtkTreePath, or %NULL
1961 gtk_tree_model_sort_convert_child_path_to_path (GtkTreeModelSort *tree_model_sort,
1962 GtkTreePath *child_path)
1964 g_return_val_if_fail (GTK_IS_TREE_MODEL_SORT (tree_model_sort), NULL);
1965 g_return_val_if_fail (tree_model_sort->child_model != NULL, NULL);
1966 g_return_val_if_fail (child_path != NULL, NULL);
1968 return gtk_real_tree_model_sort_convert_child_path_to_path (tree_model_sort, child_path, TRUE);
1972 * gtk_tree_model_sort_convert_child_iter_to_iter:
1973 * @tree_model_sort: A #GtkTreeModelSort
1974 * @sort_iter: An uninitialized #GtkTreeIter.
1975 * @child_iter: A valid #GtkTreeIter pointing to a row on the child model
1977 * Sets @sort_iter to point to the row in @tree_model_sort that corresponds to
1978 * the row pointed at by @child_iter.
1981 gtk_tree_model_sort_convert_child_iter_to_iter (GtkTreeModelSort *tree_model_sort,
1982 GtkTreeIter *sort_iter,
1983 GtkTreeIter *child_iter)
1985 GtkTreePath *child_path, *path;
1987 g_return_if_fail (GTK_IS_TREE_MODEL_SORT (tree_model_sort));
1988 g_return_if_fail (tree_model_sort->child_model != NULL);
1989 g_return_if_fail (sort_iter != NULL);
1990 g_return_if_fail (child_iter != NULL);
1992 sort_iter->stamp = 0;
1994 child_path = gtk_tree_model_get_path (tree_model_sort->child_model, child_iter);
1995 g_return_if_fail (child_path != NULL);
1997 path = gtk_tree_model_sort_convert_child_path_to_path (tree_model_sort, child_path);
1998 gtk_tree_path_free (child_path);
1999 g_return_if_fail (path != NULL);
2001 gtk_tree_model_get_iter (GTK_TREE_MODEL (tree_model_sort), sort_iter, path);
2002 gtk_tree_path_free (path);
2006 * gtk_tree_model_sort_convert_path_to_child_path:
2007 * @tree_model_sort: A #GtkTreeModelSort
2008 * @sorted_path: A #GtkTreePath to convert
2010 * Converts @sorted_path to a path on the child model of @tree_model_sort. That
2011 * is, @sorted_path points to a location in @tree_model_sort. The returned path
2012 * will point to the same location in the model not being sorted. If @sorted_path
2013 * does not point to a location in the child model, %NULL is returned.
2015 * Return value: A newly allocated #GtkTreePath, or %NULL
2018 gtk_tree_model_sort_convert_path_to_child_path (GtkTreeModelSort *tree_model_sort,
2019 GtkTreePath *sorted_path)
2021 gint *sorted_indices;
2022 GtkTreePath *retval;
2026 g_return_val_if_fail (GTK_IS_TREE_MODEL_SORT (tree_model_sort), NULL);
2027 g_return_val_if_fail (tree_model_sort->child_model != NULL, NULL);
2028 g_return_val_if_fail (sorted_path != NULL, NULL);
2030 retval = gtk_tree_path_new ();
2031 sorted_indices = gtk_tree_path_get_indices (sorted_path);
2032 if (tree_model_sort->root == NULL)
2033 gtk_tree_model_sort_build_level (tree_model_sort, NULL, NULL);
2034 level = SORT_LEVEL (tree_model_sort->root);
2036 for (i = 0; i < gtk_tree_path_get_depth (sorted_path); i++)
2038 gint count = sorted_indices[i];
2040 if ((level == NULL) ||
2041 (level->array->len <= count))
2043 gtk_tree_path_free (retval);
2047 if (g_array_index (level->array, SortElt, count).children == NULL)
2048 gtk_tree_model_sort_build_level (tree_model_sort, level, &g_array_index (level->array, SortElt, count));
2052 gtk_tree_path_free (retval);
2056 gtk_tree_path_append_index (retval, g_array_index (level->array, SortElt, count).offset);
2057 level = g_array_index (level->array, SortElt, count).children;
2064 * gtk_tree_model_sort_convert_iter_to_child_iter:
2065 * @tree_model_sort: A #GtkTreeModelSort
2066 * @child_iter: An uninitialized #GtkTreeIter
2067 * @sorted_iter: A valid #GtkTreeIter pointing to a row on @tree_model_sort.
2069 * Sets @child_iter to point to the row pointed to by @sorted_iter.
2072 gtk_tree_model_sort_convert_iter_to_child_iter (GtkTreeModelSort *tree_model_sort,
2073 GtkTreeIter *child_iter,
2074 GtkTreeIter *sorted_iter)
2076 g_return_if_fail (GTK_IS_TREE_MODEL_SORT (tree_model_sort));
2077 g_return_if_fail (tree_model_sort->child_model != NULL);
2078 g_return_if_fail (child_iter != NULL);
2079 g_return_if_fail (sorted_iter != NULL);
2080 g_return_if_fail (sorted_iter->stamp == tree_model_sort->stamp);
2082 if (GTK_TREE_MODEL_SORT_CACHE_CHILD_ITERS (tree_model_sort))
2084 *child_iter = SORT_ELT (sorted_iter->user_data2)->iter;
2090 path = gtk_tree_model_sort_elt_get_path (sorted_iter->user_data,
2091 sorted_iter->user_data2);
2092 gtk_tree_model_get_iter (tree_model_sort->child_model, child_iter, path);
2093 gtk_tree_path_free (path);
2098 gtk_tree_model_sort_build_level (GtkTreeModelSort *tree_model_sort,
2099 SortLevel *parent_level,
2100 SortElt *parent_elt)
2103 SortLevel *new_level;
2107 g_assert (tree_model_sort->child_model != NULL);
2109 if (parent_level == NULL)
2111 if (gtk_tree_model_get_iter_first (tree_model_sort->child_model, &iter) == FALSE)
2113 length = gtk_tree_model_iter_n_children (tree_model_sort->child_model, NULL);
2117 GtkTreeIter parent_iter;
2118 GtkTreeIter child_parent_iter;
2120 parent_iter.stamp = tree_model_sort->stamp;
2121 parent_iter.user_data = parent_level;
2122 parent_iter.user_data2 = parent_elt;
2124 gtk_tree_model_sort_convert_iter_to_child_iter (tree_model_sort,
2127 if (gtk_tree_model_iter_children (tree_model_sort->child_model,
2129 &child_parent_iter) == FALSE)
2132 /* stamp may have changed */
2133 gtk_tree_model_sort_convert_iter_to_child_iter (tree_model_sort,
2137 length = gtk_tree_model_iter_n_children (tree_model_sort->child_model, &child_parent_iter);
2140 g_return_if_fail (length > 0);
2142 new_level = g_new (SortLevel, 1);
2143 new_level->array = g_array_sized_new (FALSE, FALSE, sizeof (SortElt), length);
2144 new_level->ref_count = 0;
2145 new_level->parent_elt = parent_elt;
2146 new_level->parent_level = parent_level;
2149 parent_elt->children = new_level;
2151 tree_model_sort->root = new_level;
2153 /* increase the count of zero ref_counts.*/
2154 while (parent_level)
2156 parent_elt->zero_ref_count++;
2158 parent_elt = parent_level->parent_elt;
2159 parent_level = parent_level->parent_level;
2161 if (new_level != tree_model_sort->root)
2162 tree_model_sort->zero_ref_count++;
2164 for (i = 0; i < length; i++)
2167 sort_elt.offset = i;
2168 sort_elt.zero_ref_count = 0;
2169 sort_elt.ref_count = 0;
2170 sort_elt.children = NULL;
2172 if (GTK_TREE_MODEL_SORT_CACHE_CHILD_ITERS (tree_model_sort))
2174 sort_elt.iter = iter;
2175 if (gtk_tree_model_iter_next (tree_model_sort->child_model, &iter) == FALSE &&
2178 g_warning ("There is a discrepency between the sort model and the child model.");
2182 g_array_append_val (new_level->array, sort_elt);
2186 gtk_tree_model_sort_sort_level (tree_model_sort, new_level,
2191 gtk_tree_model_sort_free_level (GtkTreeModelSort *tree_model_sort,
2192 SortLevel *sort_level)
2196 g_assert (sort_level);
2198 if (sort_level->ref_count == 0)
2200 SortLevel *parent_level = sort_level->parent_level;
2201 SortElt *parent_elt = sort_level->parent_elt;
2206 parent_elt->zero_ref_count--;
2208 tree_model_sort->zero_ref_count--;
2212 parent_elt = parent_level->parent_elt;
2213 parent_level = parent_level->parent_level;
2216 while (parent_level);
2219 for (i = 0; i < sort_level->array->len; i++)
2221 if (g_array_index (sort_level->array, SortElt, i).children)
2222 gtk_tree_model_sort_free_level (tree_model_sort,
2223 SORT_LEVEL(g_array_index (sort_level->array, SortElt, i).children));
2226 if (sort_level->parent_elt)
2227 sort_level->parent_elt->children = NULL;
2229 tree_model_sort->root = NULL;
2231 g_array_free (sort_level->array, TRUE);
2232 sort_level->array = NULL;
2234 g_free (sort_level);
2239 gtk_tree_model_sort_increment_stamp (GtkTreeModelSort *tree_model_sort)
2243 tree_model_sort->stamp++;
2245 while (tree_model_sort->stamp == 0);
2247 gtk_tree_model_sort_clear_cache (tree_model_sort);
2251 gtk_tree_model_sort_clear_cache_helper (GtkTreeModelSort *tree_model_sort,
2256 g_assert (level != NULL);
2258 for (i = 0; i < level->array->len; i++)
2260 if (g_array_index (level->array, SortElt, i).zero_ref_count > 0)
2261 gtk_tree_model_sort_clear_cache_helper (tree_model_sort, g_array_index (level->array, SortElt, i).children);
2264 if (level->ref_count == 0 && level != tree_model_sort->root)
2265 gtk_tree_model_sort_free_level (tree_model_sort, level);
2269 * gtk_tree_model_sort_reset_default_sort_func:
2270 * @tree_model_sort: A #GtkTreeModelSort
2272 * This resets the default sort function to be in the 'unsorted' state. That
2273 * is, it is in the same order as the child model. It will re-sort the model
2274 * to be in the same order as the child model only if the #GtkTreeModelSort
2275 * is in 'unsorted' state.
2278 gtk_tree_model_sort_reset_default_sort_func (GtkTreeModelSort *tree_model_sort)
2280 g_return_if_fail (GTK_IS_TREE_MODEL_SORT (tree_model_sort));
2282 if (tree_model_sort->default_sort_destroy)
2284 GtkDestroyNotify d = tree_model_sort->default_sort_destroy;
2286 tree_model_sort->default_sort_destroy = NULL;
2287 d (tree_model_sort->default_sort_data);
2290 tree_model_sort->default_sort_func = NO_SORT_FUNC;
2291 tree_model_sort->default_sort_data = NULL;
2292 tree_model_sort->default_sort_destroy = NULL;
2294 if (tree_model_sort->sort_column_id == GTK_TREE_SORTABLE_DEFAULT_SORT_COLUMN_ID)
2295 gtk_tree_model_sort_sort (tree_model_sort);
2296 tree_model_sort->sort_column_id = GTK_TREE_SORTABLE_DEFAULT_SORT_COLUMN_ID;
2300 * gtk_tree_model_sort_clear_cache:
2301 * @tree_model_sort: A #GtkTreeModelSort
2303 * This function should almost never be called. It clears the @tree_model_sort
2304 * of any cached iterators that haven't been reffed with
2305 * gtk_tree_model_ref_node(). This might be useful if the child model being
2306 * sorted is static (and doesn't change often) and there has been a lot of
2307 * unreffed access to nodes. As a side effect of this function, all unreffed
2308 * iters will be invalid.
2311 gtk_tree_model_sort_clear_cache (GtkTreeModelSort *tree_model_sort)
2313 g_return_if_fail (GTK_IS_TREE_MODEL_SORT (tree_model_sort));
2315 if (tree_model_sort->zero_ref_count)
2316 gtk_tree_model_sort_clear_cache_helper (tree_model_sort, (SortLevel *)tree_model_sort->root);
2320 gtk_tree_model_sort_iter_is_valid_helper (GtkTreeIter *iter,
2325 for (i = 0; i < level->array->len; i++)
2327 SortElt *elt = &g_array_index (level->array, SortElt, i);
2329 if (iter->user_data == level && iter->user_data2 == elt)
2333 if (gtk_tree_model_sort_iter_is_valid_helper (iter, elt->children))
2341 * gtk_tree_model_sort_iter_is_valid:
2342 * @tree_model_sort: A #GtkTreeModelSort.
2343 * @iter: A #GtkTreeIter.
2345 * WARNING: This function is slow. Only use it for debugging and/or testing
2348 * Checks if the given iter is a valid iter for this #GtkTreeModelSort.
2350 * Return value: %TRUE if the iter is valid, %FALSE if the iter is invalid.
2353 gtk_tree_model_sort_iter_is_valid (GtkTreeModelSort *tree_model_sort,
2356 g_return_val_if_fail (GTK_IS_TREE_MODEL_SORT (tree_model_sort), FALSE);
2357 g_return_val_if_fail (iter != NULL, FALSE);
2359 if (!VALID_ITER (iter, tree_model_sort))
2362 return gtk_tree_model_sort_iter_is_valid_helper (iter,
2363 tree_model_sort->root);