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));
492 if (GTK_TREE_MODEL_SORT_CACHE_CHILD_ITERS (tree_model_sort))
493 index = gtk_tree_model_sort_level_find_insert (tree_model_sort,
498 index = gtk_tree_model_sort_level_find_insert (tree_model_sort,
503 if (index < old_index)
505 g_memmove (level->array->data + ((index + 1)*sizeof (SortElt)),
506 level->array->data + ((index)*sizeof (SortElt)),
507 (old_index - index)* sizeof(SortElt));
509 else if (index > old_index)
511 g_memmove (level->array->data + ((old_index)*sizeof (SortElt)),
512 level->array->data + ((old_index + 1)*sizeof (SortElt)),
513 (index - old_index)* sizeof(SortElt));
515 memcpy (level->array->data + ((index)*sizeof (SortElt)),
516 &tmp, sizeof (SortElt));
518 for (i = 0; i < level->array->len; i++)
519 if (g_array_index (level->array, SortElt, i).children)
520 g_array_index (level->array, SortElt, i).children->parent_elt = &g_array_index (level->array, SortElt, i);
522 gtk_tree_path_up (path);
523 gtk_tree_path_append_index (path, index);
525 gtk_tree_model_sort_increment_stamp (tree_model_sort);
527 /* if the item moved, then emit rows_reordered */
528 if (old_index != index)
533 GtkTreePath *tmppath;
535 new_order = g_new (gint, level->array->len);
537 for (j = 0; j < level->array->len; j++)
539 if (index > old_index)
542 new_order[j] = old_index;
543 else if (j >= old_index && j < index)
544 new_order[j] = j + 1;
548 else if (index < old_index)
551 new_order[j] = old_index;
552 else if (j > index && j <= old_index)
553 new_order[j] = j - 1;
557 /* else? shouldn't really happen */
560 if (level->parent_elt)
562 iter.stamp = tree_model_sort->stamp;
563 iter.user_data = level->parent_level;
564 iter.user_data2 = level->parent_elt;
566 tmppath = gtk_tree_model_get_path (GTK_TREE_MODEL (tree_model_sort), &iter);
568 gtk_tree_model_rows_reordered (GTK_TREE_MODEL (tree_model_sort),
569 tmppath, &iter, new_order);
574 tmppath = gtk_tree_path_new ();
576 gtk_tree_model_rows_reordered (GTK_TREE_MODEL (tree_model_sort), tmppath,
580 gtk_tree_path_free (tmppath);
584 /* emit row_changed signal (at new location) */
585 gtk_tree_model_get_iter (GTK_TREE_MODEL (data), &iter, path);
586 gtk_tree_model_row_changed (GTK_TREE_MODEL (data), path, &iter);
588 gtk_tree_path_free (path);
590 gtk_tree_path_free (start_s_path);
594 gtk_tree_model_sort_row_inserted (GtkTreeModel *s_model,
599 GtkTreeModelSort *tree_model_sort = GTK_TREE_MODEL_SORT (data);
602 GtkTreeIter real_s_iter;
606 gboolean free_s_path = FALSE;
610 SortLevel *parent_level = NULL;
612 parent_level = level = SORT_LEVEL (tree_model_sort->root);
614 g_return_if_fail (s_path != NULL || s_iter != NULL);
618 s_path = gtk_tree_model_get_path (s_model, s_iter);
623 gtk_tree_model_get_iter (s_model, &real_s_iter, s_path);
625 real_s_iter = *s_iter;
627 if (!tree_model_sort->root)
629 gtk_tree_model_sort_build_level (tree_model_sort, NULL, NULL);
631 /* the build level already put the inserted iter in the level,
632 so no need to handle this signal anymore */
634 goto done_and_submit;
637 /* find the parent level */
638 while (i < gtk_tree_path_get_depth (s_path) - 1)
644 /* level not yet build, we won't cover this signal */
648 if (level->array->len < gtk_tree_path_get_indices (s_path)[i])
650 g_warning ("A node was inserted with a parent that's not in the tree.\n"
651 "This possibly means that a GtkTreeModel inserted a child node\n"
652 "before the parent was inserted.");
657 for (j = 0; j < level->array->len; j++)
658 if (g_array_index (level->array, SortElt, j).offset == gtk_tree_path_get_indices (s_path)[i])
660 elt = &g_array_index (level->array, SortElt, j);
664 g_return_if_fail (elt != NULL);
668 GtkTreePath *tmppath;
671 tmpiter.stamp = tree_model_sort->stamp;
672 tmpiter.user_data = level;
673 tmpiter.user_data2 = elt;
675 tmppath = gtk_tree_model_get_path (GTK_TREE_MODEL (data), &tmpiter);
678 gtk_tree_model_row_has_child_toggled (GTK_TREE_MODEL (data),
681 gtk_tree_path_free (tmppath);
684 /* not covering this signal */
688 level = elt->children;
689 parent_level = level;
696 if (!gtk_tree_model_sort_insert_value (tree_model_sort,
703 path = gtk_real_tree_model_sort_convert_child_path_to_path (tree_model_sort,
710 gtk_tree_model_sort_increment_stamp (tree_model_sort);
712 gtk_tree_model_get_iter (GTK_TREE_MODEL (data), &iter, path);
713 gtk_tree_model_row_inserted (GTK_TREE_MODEL (data), path, &iter);
714 gtk_tree_path_free (path);
718 gtk_tree_path_free (s_path);
724 gtk_tree_model_sort_row_has_child_toggled (GtkTreeModel *s_model,
729 GtkTreeModelSort *tree_model_sort = GTK_TREE_MODEL_SORT (data);
733 g_return_if_fail (s_path != NULL && s_iter != NULL);
735 path = gtk_real_tree_model_sort_convert_child_path_to_path (tree_model_sort, s_path, FALSE);
739 gtk_tree_model_get_iter (GTK_TREE_MODEL (data), &iter, path);
740 gtk_tree_model_row_has_child_toggled (GTK_TREE_MODEL (data), path, &iter);
742 gtk_tree_path_free (path);
745 /* FIXME: I still have doubts if this works */
747 gtk_tree_model_sort_row_deleted (GtkTreeModel *s_model,
751 GtkTreeModelSort *tree_model_sort = GTK_TREE_MODEL_SORT (data);
752 GtkTreePath *path = NULL;
759 g_return_if_fail (s_path != NULL);
761 path = gtk_real_tree_model_sort_convert_child_path_to_path (tree_model_sort, s_path, FALSE);
765 gtk_tree_model_get_iter (GTK_TREE_MODEL (data), &iter, path);
767 level = SORT_LEVEL (iter.user_data);
768 elt = SORT_ELT (iter.user_data2);
769 offset = elt->offset;
771 /* we _need_ to emit ::row_deleted before we start unreffing the node
772 * itself. This is because of the row refs, which start unreffing nodes
773 * when we emit ::row_deleted
775 gtk_tree_model_row_deleted (GTK_TREE_MODEL (data), path);
777 gtk_tree_model_get_iter (GTK_TREE_MODEL (data), &iter, path);
779 while (elt->ref_count > 0)
780 gtk_tree_model_sort_real_unref_node (GTK_TREE_MODEL (data), &iter, FALSE);
782 if (level->ref_count == 0 && level != tree_model_sort->root)
784 /* This will prune the level, so I can just emit the signal and not worry
785 * about cleaning this level up. */
786 gtk_tree_model_sort_increment_stamp (tree_model_sort);
787 gtk_tree_path_free (path);
791 gtk_tree_model_sort_increment_stamp (tree_model_sort);
794 for (i = 0; i < level->array->len; i++)
795 if (elt->offset == g_array_index (level->array, SortElt, i).offset)
798 g_array_remove_index (level->array, i);
800 /* update all offsets */
801 for (i = 0; i < level->array->len; i++)
803 elt = & (g_array_index (level->array, SortElt, i));
804 if (elt->offset > offset)
807 elt->children->parent_elt = elt;
810 gtk_tree_path_free (path);
814 gtk_tree_model_sort_rows_reordered (GtkTreeModel *s_model,
826 GtkTreeModelSort *tree_model_sort = GTK_TREE_MODEL_SORT (data);
828 g_return_if_fail (new_order != NULL);
830 if (s_path == NULL || gtk_tree_path_get_indices (s_path) == NULL)
832 if (tree_model_sort->root == NULL)
834 path = gtk_tree_path_new ();
835 level = SORT_LEVEL (tree_model_sort->root);
839 path = gtk_real_tree_model_sort_convert_child_path_to_path (tree_model_sort, s_path, FALSE);
842 gtk_tree_model_get_iter (GTK_TREE_MODEL (data), &iter, path);
844 level = SORT_LEVEL (iter.user_data);
845 elt = SORT_ELT (iter.user_data2);
849 gtk_tree_path_free (path);
853 level = elt->children;
856 if (level->array->len < 2)
858 gtk_tree_path_free (path);
862 tmp_array = g_new (int, level->array->len);
863 for (i = 0; i < level->array->len; i++)
865 for (j = 0; j < level->array->len; j++)
867 if (g_array_index (level->array, SortElt, i).offset == new_order[j])
872 for (i = 0; i < level->array->len; i++)
873 g_array_index (level->array, SortElt, i).offset = tmp_array[i];
876 if (tree_model_sort->sort_column_id == GTK_TREE_SORTABLE_DEFAULT_SORT_COLUMN_ID &&
877 tree_model_sort->default_sort_func == NO_SORT_FUNC)
880 gtk_tree_model_sort_sort_level (tree_model_sort, level,
882 gtk_tree_model_sort_increment_stamp (tree_model_sort);
884 if (gtk_tree_path_get_depth (path))
886 gtk_tree_model_get_iter (GTK_TREE_MODEL (tree_model_sort),
889 gtk_tree_model_rows_reordered (GTK_TREE_MODEL (tree_model_sort),
890 path, &iter, new_order);
894 gtk_tree_model_rows_reordered (GTK_TREE_MODEL (tree_model_sort),
895 path, NULL, new_order);
899 gtk_tree_path_free (path);
902 /* Fulfill our model requirements */
903 static GtkTreeModelFlags
904 gtk_tree_model_sort_get_flags (GtkTreeModel *tree_model)
906 g_return_val_if_fail (GTK_IS_TREE_MODEL_SORT (tree_model), 0);
912 gtk_tree_model_sort_get_n_columns (GtkTreeModel *tree_model)
914 GtkTreeModelSort *tree_model_sort = (GtkTreeModelSort *) tree_model;
916 g_return_val_if_fail (GTK_IS_TREE_MODEL_SORT (tree_model), 0);
918 if (tree_model_sort->child_model == 0)
921 return gtk_tree_model_get_n_columns (tree_model_sort->child_model);
925 gtk_tree_model_sort_get_column_type (GtkTreeModel *tree_model,
928 g_return_val_if_fail (GTK_IS_TREE_MODEL_SORT (tree_model), G_TYPE_INVALID);
929 g_return_val_if_fail (GTK_TREE_MODEL_SORT (tree_model)->child_model != NULL, G_TYPE_INVALID);
931 return gtk_tree_model_get_column_type (GTK_TREE_MODEL_SORT (tree_model)->child_model, index);
935 gtk_tree_model_sort_get_iter (GtkTreeModel *tree_model,
939 GtkTreeModelSort *tree_model_sort;
944 g_return_val_if_fail (GTK_IS_TREE_MODEL_SORT (tree_model), FALSE);
945 g_return_val_if_fail (GTK_TREE_MODEL_SORT (tree_model)->child_model != NULL, FALSE);
947 tree_model_sort = (GtkTreeModelSort *) tree_model;
948 indices = gtk_tree_path_get_indices (path);
950 if (tree_model_sort->root == NULL)
951 gtk_tree_model_sort_build_level (tree_model_sort, NULL, NULL);
952 level = SORT_LEVEL (tree_model_sort->root);
954 depth = gtk_tree_path_get_depth (path);
958 for (i = 0; i < depth - 1; i++)
960 if ((level == NULL) ||
961 (indices[i] >= level->array->len))
964 if (g_array_index (level->array, SortElt, indices[i]).children == NULL)
965 gtk_tree_model_sort_build_level (tree_model_sort, level, &g_array_index (level->array, SortElt, indices[i]));
966 level = g_array_index (level->array, SortElt, indices[i]).children;
971 iter->stamp = tree_model_sort->stamp;
972 iter->user_data = level;
973 iter->user_data2 = &g_array_index (level->array, SortElt, indices[depth - 1]);
979 gtk_tree_model_sort_get_path (GtkTreeModel *tree_model,
986 g_return_val_if_fail (GTK_IS_TREE_MODEL_SORT (tree_model), NULL);
987 g_return_val_if_fail (GTK_TREE_MODEL_SORT (tree_model)->child_model != NULL, NULL);
988 g_return_val_if_fail (GTK_TREE_MODEL_SORT (tree_model)->stamp == iter->stamp, NULL);
990 retval = gtk_tree_path_new ();
991 level = iter->user_data;
992 elt = iter->user_data2;
993 while (level != NULL)
995 gtk_tree_path_prepend_index (retval, elt - (SortElt *)level->array->data);
997 elt = level->parent_elt;
998 level = level->parent_level;
1005 gtk_tree_model_sort_get_value (GtkTreeModel *tree_model,
1010 GtkTreeIter child_iter;
1012 g_return_if_fail (GTK_IS_TREE_MODEL_SORT (tree_model));
1013 g_return_if_fail (GTK_TREE_MODEL_SORT (tree_model)->child_model != NULL);
1014 g_return_if_fail (GTK_TREE_MODEL_SORT (tree_model)->stamp == iter->stamp);
1016 GET_CHILD_ITER (tree_model, &child_iter, iter);
1017 gtk_tree_model_get_value (GTK_TREE_MODEL_SORT (tree_model)->child_model,
1018 &child_iter, column, value);
1022 gtk_tree_model_sort_iter_next (GtkTreeModel *tree_model,
1028 g_return_val_if_fail (GTK_IS_TREE_MODEL_SORT (tree_model), FALSE);
1029 g_return_val_if_fail (GTK_TREE_MODEL_SORT (tree_model)->child_model != NULL, FALSE);
1030 g_return_val_if_fail (GTK_TREE_MODEL_SORT (tree_model)->stamp == iter->stamp, FALSE);
1032 level = iter->user_data;
1033 elt = iter->user_data2;
1035 if (elt - (SortElt *)level->array->data >= level->array->len - 1)
1040 iter->user_data2 = elt + 1;
1046 gtk_tree_model_sort_iter_children (GtkTreeModel *tree_model,
1048 GtkTreeIter *parent)
1050 GtkTreeModelSort *tree_model_sort = (GtkTreeModelSort *) tree_model;
1054 g_return_val_if_fail (GTK_IS_TREE_MODEL_SORT (tree_model), FALSE);
1055 g_return_val_if_fail (tree_model_sort->child_model != NULL, FALSE);
1056 if (parent) g_return_val_if_fail (tree_model_sort->stamp == parent->stamp, FALSE);
1060 if (tree_model_sort->root == NULL)
1061 gtk_tree_model_sort_build_level (tree_model_sort, NULL, NULL);
1062 if (tree_model_sort->root == NULL)
1065 level = tree_model_sort->root;
1066 iter->stamp = tree_model_sort->stamp;
1067 iter->user_data = level;
1068 iter->user_data2 = level->array->data;
1072 if (((SortElt *)parent->user_data2)->children == NULL)
1073 gtk_tree_model_sort_build_level (tree_model_sort,
1074 (SortLevel *)parent->user_data,
1075 (SortElt *)parent->user_data2);
1076 if (((SortElt *)parent->user_data2)->children == NULL)
1078 iter->stamp = tree_model_sort->stamp;
1079 iter->user_data = ((SortElt *)parent->user_data2)->children;
1080 iter->user_data2 = ((SortLevel *)iter->user_data)->array->data;
1087 gtk_tree_model_sort_iter_has_child (GtkTreeModel *tree_model,
1090 GtkTreeIter child_iter;
1092 g_return_val_if_fail (GTK_IS_TREE_MODEL_SORT (tree_model), FALSE);
1093 g_return_val_if_fail (GTK_TREE_MODEL_SORT (tree_model)->child_model != NULL, FALSE);
1094 g_return_val_if_fail (GTK_TREE_MODEL_SORT (tree_model)->stamp == iter->stamp, FALSE);
1096 GET_CHILD_ITER (tree_model, &child_iter, iter);
1098 return gtk_tree_model_iter_has_child (GTK_TREE_MODEL_SORT (tree_model)->child_model, &child_iter);
1102 gtk_tree_model_sort_iter_n_children (GtkTreeModel *tree_model,
1105 GtkTreeIter child_iter;
1107 g_return_val_if_fail (GTK_IS_TREE_MODEL_SORT (tree_model), 0);
1108 g_return_val_if_fail (GTK_TREE_MODEL_SORT (tree_model)->child_model != NULL, 0);
1109 if (iter) g_return_val_if_fail (GTK_TREE_MODEL_SORT (tree_model)->stamp == iter->stamp, 0);
1112 return gtk_tree_model_iter_n_children (GTK_TREE_MODEL_SORT (tree_model)->child_model, NULL);
1114 GET_CHILD_ITER (tree_model, &child_iter, iter);
1116 return gtk_tree_model_iter_n_children (GTK_TREE_MODEL_SORT (tree_model)->child_model, &child_iter);
1120 gtk_tree_model_sort_iter_nth_child (GtkTreeModel *tree_model,
1122 GtkTreeIter *parent,
1126 /* We have this for the iter == parent case */
1127 GtkTreeIter children;
1129 g_return_val_if_fail (GTK_IS_TREE_MODEL_SORT (tree_model), FALSE);
1130 if (parent) g_return_val_if_fail (GTK_TREE_MODEL_SORT (tree_model)->stamp == parent->stamp, FALSE);
1132 /* Use this instead of has_child to force us to build the level, if needed */
1133 if (gtk_tree_model_sort_iter_children (tree_model, &children, parent) == FALSE)
1139 level = children.user_data;
1140 if (n >= level->array->len)
1146 iter->stamp = GTK_TREE_MODEL_SORT (tree_model)->stamp;
1147 iter->user_data = level;
1148 iter->user_data2 = &g_array_index (level->array, SortElt, n);
1154 gtk_tree_model_sort_iter_parent (GtkTreeModel *tree_model,
1161 g_return_val_if_fail (GTK_IS_TREE_MODEL_SORT (tree_model), FALSE);
1162 g_return_val_if_fail (GTK_TREE_MODEL_SORT (tree_model)->child_model != NULL, FALSE);
1163 g_return_val_if_fail (GTK_TREE_MODEL_SORT (tree_model)->stamp == child->stamp, FALSE);
1165 level = child->user_data;
1167 if (level->parent_level)
1169 iter->stamp = GTK_TREE_MODEL_SORT (tree_model)->stamp;
1170 iter->user_data = level->parent_level;
1171 iter->user_data2 = level->parent_elt;
1179 gtk_tree_model_sort_ref_node (GtkTreeModel *tree_model,
1182 GtkTreeModelSort *tree_model_sort = (GtkTreeModelSort *) tree_model;
1183 GtkTreeIter child_iter;
1187 g_return_if_fail (GTK_IS_TREE_MODEL_SORT (tree_model));
1188 g_return_if_fail (GTK_TREE_MODEL_SORT (tree_model)->child_model != NULL);
1189 g_return_if_fail (GTK_TREE_MODEL_SORT (tree_model)->stamp == iter->stamp);
1191 GET_CHILD_ITER (tree_model, &child_iter, iter);
1193 gtk_tree_model_ref_node (GTK_TREE_MODEL_SORT (tree_model)->child_model, &child_iter);
1195 level = iter->user_data;
1196 elt = iter->user_data2;
1200 if (level->ref_count == 1)
1202 SortLevel *parent_level = level->parent_level;
1203 SortElt *parent_elt = level->parent_elt;
1204 /* We were at zero -- time to decrement the zero_ref_count val */
1208 parent_elt->zero_ref_count--;
1210 tree_model_sort->zero_ref_count--;
1214 parent_elt = parent_level->parent_elt;
1215 parent_level = parent_level->parent_level;
1218 while (parent_level);
1223 gtk_tree_model_sort_real_unref_node (GtkTreeModel *tree_model,
1225 gboolean propagate_unref)
1227 GtkTreeModelSort *tree_model_sort = (GtkTreeModelSort *) tree_model;
1228 GtkTreeIter child_iter;
1232 g_return_if_fail (GTK_IS_TREE_MODEL_SORT (tree_model));
1233 g_return_if_fail (GTK_TREE_MODEL_SORT (tree_model)->child_model != NULL);
1234 g_return_if_fail (GTK_TREE_MODEL_SORT (tree_model)->stamp == iter->stamp);
1236 GET_CHILD_ITER (tree_model, &child_iter, iter);
1238 if (propagate_unref)
1239 gtk_tree_model_unref_node (GTK_TREE_MODEL_SORT (tree_model)->child_model, &child_iter);
1241 level = iter->user_data;
1242 elt = iter->user_data2;
1244 g_return_if_fail (elt->ref_count > 0);
1249 if (level->ref_count == 0)
1251 SortLevel *parent_level = level->parent_level;
1252 SortElt *parent_elt = level->parent_elt;
1254 /* We are at zero -- time to increment the zero_ref_count val */
1255 while (parent_level)
1257 parent_elt->zero_ref_count++;
1259 parent_elt = parent_level->parent_elt;
1260 parent_level = parent_level->parent_level;
1262 tree_model_sort->zero_ref_count++;
1267 gtk_tree_model_sort_unref_node (GtkTreeModel *tree_model,
1270 gtk_tree_model_sort_real_unref_node (tree_model, iter, TRUE);
1273 /* Sortable interface */
1275 gtk_tree_model_sort_get_sort_column_id (GtkTreeSortable *sortable,
1276 gint *sort_column_id,
1279 GtkTreeModelSort *tree_model_sort = (GtkTreeModelSort *)sortable;
1281 g_return_val_if_fail (GTK_IS_TREE_MODEL_SORT (sortable), FALSE);
1283 if (tree_model_sort->sort_column_id == GTK_TREE_SORTABLE_DEFAULT_SORT_COLUMN_ID)
1287 *sort_column_id = tree_model_sort->sort_column_id;
1289 *order = tree_model_sort->order;
1295 gtk_tree_model_sort_set_sort_column_id (GtkTreeSortable *sortable,
1296 gint sort_column_id,
1299 GtkTreeModelSort *tree_model_sort = (GtkTreeModelSort *)sortable;
1301 g_return_if_fail (GTK_IS_TREE_MODEL_SORT (sortable));
1303 if (sort_column_id != GTK_TREE_SORTABLE_DEFAULT_SORT_COLUMN_ID)
1305 GtkTreeDataSortHeader *header = NULL;
1307 header = _gtk_tree_data_list_get_header (tree_model_sort->sort_list,
1310 /* we want to make sure that we have a function */
1311 g_return_if_fail (header != NULL);
1312 g_return_if_fail (header->func != NULL);
1315 g_return_if_fail (tree_model_sort->default_sort_func != NULL);
1317 if (tree_model_sort->sort_column_id == sort_column_id)
1319 if (sort_column_id != GTK_TREE_SORTABLE_DEFAULT_SORT_COLUMN_ID)
1321 if (tree_model_sort->order == order)
1328 tree_model_sort->sort_column_id = sort_column_id;
1329 tree_model_sort->order = order;
1331 gtk_tree_sortable_sort_column_changed (sortable);
1333 gtk_tree_model_sort_sort (tree_model_sort);
1337 gtk_tree_model_sort_set_sort_func (GtkTreeSortable *sortable,
1338 gint sort_column_id,
1339 GtkTreeIterCompareFunc func,
1341 GtkDestroyNotify destroy)
1343 GtkTreeModelSort *tree_model_sort = (GtkTreeModelSort *) sortable;
1344 GtkTreeDataSortHeader *header = NULL;
1347 g_return_if_fail (GTK_IS_TREE_MODEL_SORT (sortable));
1348 g_return_if_fail (func != NULL);
1350 for (list = tree_model_sort->sort_list; list; list = list->next)
1352 GtkTreeDataSortHeader *list_header;
1354 list_header = (GtkTreeDataSortHeader*) list->data;
1355 if (list_header->sort_column_id == sort_column_id)
1357 header = list_header;
1364 header = g_new0 (GtkTreeDataSortHeader, 1);
1365 header->sort_column_id = sort_column_id;
1366 tree_model_sort->sort_list = g_list_append (tree_model_sort->sort_list,
1370 if (header->destroy)
1372 GtkDestroyNotify d = header->destroy;
1374 header->destroy = NULL;
1378 header->func = func;
1379 header->data = data;
1380 header->destroy = destroy;
1382 if (tree_model_sort->sort_column_id == sort_column_id)
1383 gtk_tree_model_sort_sort (tree_model_sort);
1387 gtk_tree_model_sort_set_default_sort_func (GtkTreeSortable *sortable,
1388 GtkTreeIterCompareFunc func,
1390 GtkDestroyNotify destroy)
1392 GtkTreeModelSort *tree_model_sort = (GtkTreeModelSort *)sortable;
1394 g_return_if_fail (GTK_IS_TREE_MODEL_SORT (sortable));
1396 if (tree_model_sort->default_sort_destroy)
1398 GtkDestroyNotify d = tree_model_sort->default_sort_destroy;
1400 tree_model_sort->default_sort_destroy = NULL;
1401 d (tree_model_sort->default_sort_data);
1404 tree_model_sort->default_sort_func = func;
1405 tree_model_sort->default_sort_data = data;
1406 tree_model_sort->default_sort_destroy = destroy;
1408 if (tree_model_sort->sort_column_id == GTK_TREE_SORTABLE_DEFAULT_SORT_COLUMN_ID)
1409 gtk_tree_model_sort_sort (tree_model_sort);
1413 gtk_tree_model_sort_has_default_sort_func (GtkTreeSortable *sortable)
1415 GtkTreeModelSort *tree_model_sort = (GtkTreeModelSort *)sortable;
1417 g_return_val_if_fail (GTK_IS_TREE_MODEL_SORT (sortable), FALSE);
1419 return (tree_model_sort->default_sort_func != NULL);
1422 /* sorting code - private */
1424 gtk_tree_model_sort_compare_func (gconstpointer a,
1428 SortData *data = (SortData *)user_data;
1429 GtkTreeModelSort *tree_model_sort = data->tree_model_sort;
1430 SortTuple *sa = (SortTuple *)a;
1431 SortTuple *sb = (SortTuple *)b;
1433 GtkTreeIter iter_a, iter_b;
1436 /* shortcut, if we've the same offsets here, they should be equal */
1437 if (sa->offset == sb->offset)
1440 if (GTK_TREE_MODEL_SORT_CACHE_CHILD_ITERS (tree_model_sort))
1442 iter_a = sa->elt->iter;
1443 iter_b = sb->elt->iter;
1447 data->parent_path_indices [data->parent_path_depth-1] = sa->elt->offset;
1448 gtk_tree_model_get_iter (GTK_TREE_MODEL (tree_model_sort->child_model), &iter_a, data->parent_path);
1449 data->parent_path_indices [data->parent_path_depth-1] = sb->elt->offset;
1450 gtk_tree_model_get_iter (GTK_TREE_MODEL (tree_model_sort->child_model), &iter_b, data->parent_path);
1453 retval = (* data->sort_func) (GTK_TREE_MODEL (tree_model_sort->child_model),
1457 if (tree_model_sort->order == GTK_SORT_DESCENDING)
1461 else if (retval < 0)
1469 gtk_tree_model_sort_offset_compare_func (gconstpointer a,
1475 SortTuple *sa = (SortTuple *)a;
1476 SortTuple *sb = (SortTuple *)b;
1478 SortData *data = (SortData *)user_data;
1480 if (sa->elt->offset < sb->elt->offset)
1482 else if (sa->elt->offset > sb->elt->offset)
1487 if (data->tree_model_sort->order == GTK_SORT_DESCENDING)
1491 else if (retval < 0)
1499 gtk_tree_model_sort_sort_level (GtkTreeModelSort *tree_model_sort,
1502 gboolean emit_reordered)
1514 g_return_if_fail (GTK_IS_TREE_MODEL_SORT (tree_model_sort));
1515 g_return_if_fail (level != NULL);
1517 if (level->array->len < 1 && !((SortElt *)level->array->data)->children)
1521 data.tree_model_sort = tree_model_sort;
1522 if (level->parent_elt)
1524 data.parent_path = gtk_tree_model_sort_elt_get_path (level->parent_level,
1526 gtk_tree_path_append_index (data.parent_path, 0);
1530 data.parent_path = gtk_tree_path_new_first ();
1532 data.parent_path_depth = gtk_tree_path_get_depth (data.parent_path);
1533 data.parent_path_indices = gtk_tree_path_get_indices (data.parent_path);
1535 /* make the array to be sorted */
1536 sort_array = g_array_sized_new (FALSE, FALSE, sizeof (SortTuple), level->array->len);
1537 for (i = 0; i < level->array->len; i++)
1541 tuple.elt = &g_array_index (level->array, SortElt, i);
1544 g_array_append_val (sort_array, tuple);
1547 if (tree_model_sort->sort_column_id != GTK_TREE_SORTABLE_DEFAULT_SORT_COLUMN_ID)
1549 GtkTreeDataSortHeader *header = NULL;
1551 header = _gtk_tree_data_list_get_header (tree_model_sort->sort_list,
1552 tree_model_sort->sort_column_id);
1554 g_return_if_fail (header != NULL);
1555 g_return_if_fail (header->func != NULL);
1557 data.sort_func = header->func;
1558 data.sort_data = header->data;
1562 /* absolutely SHOULD NOT happen: */
1563 g_return_if_fail (tree_model_sort->default_sort_func != NULL);
1565 data.sort_func = tree_model_sort->default_sort_func;
1566 data.sort_data = tree_model_sort->default_sort_data;
1569 if (data.sort_func == NO_SORT_FUNC)
1570 g_array_sort_with_data (sort_array,
1571 gtk_tree_model_sort_offset_compare_func,
1574 g_array_sort_with_data (sort_array,
1575 gtk_tree_model_sort_compare_func,
1578 gtk_tree_path_free (data.parent_path);
1580 new_array = g_array_sized_new (FALSE, FALSE, sizeof (SortElt), level->array->len);
1581 new_order = g_new (gint, level->array->len);
1583 for (i = 0; i < level->array->len; i++)
1587 elt = g_array_index (sort_array, SortTuple, i).elt;
1588 new_order[i] = g_array_index (sort_array, SortTuple, i).offset;
1590 g_array_append_val (new_array, *elt);
1591 elt = &g_array_index (new_array, SortElt, i);
1593 elt->children->parent_elt = elt;
1596 g_array_free (level->array, TRUE);
1597 level->array = new_array;
1598 g_array_free (sort_array, TRUE);
1602 gtk_tree_model_sort_increment_stamp (tree_model_sort);
1603 if (level->parent_elt)
1605 iter.stamp = tree_model_sort->stamp;
1606 iter.user_data = level->parent_level;
1607 iter.user_data2 = level->parent_elt;
1609 path = gtk_tree_model_get_path (GTK_TREE_MODEL (tree_model_sort),
1612 gtk_tree_model_rows_reordered (GTK_TREE_MODEL (tree_model_sort), path,
1618 path = gtk_tree_path_new ();
1619 gtk_tree_model_rows_reordered (GTK_TREE_MODEL (tree_model_sort), path,
1623 gtk_tree_path_free (path);
1626 /* recurse, if possible */
1629 for (i = 0; i < level->array->len; i++)
1631 SortElt *elt = &g_array_index (level->array, SortElt, i);
1634 gtk_tree_model_sort_sort_level (tree_model_sort,
1636 TRUE, emit_reordered);
1644 gtk_tree_model_sort_sort (GtkTreeModelSort *tree_model_sort)
1646 g_return_if_fail (GTK_IS_TREE_MODEL_SORT (tree_model_sort));
1648 if (!tree_model_sort->root)
1651 if (tree_model_sort->sort_column_id != GTK_TREE_SORTABLE_DEFAULT_SORT_COLUMN_ID)
1653 GtkTreeDataSortHeader *header = NULL;
1655 header = _gtk_tree_data_list_get_header (tree_model_sort->sort_list,
1656 tree_model_sort->sort_column_id);
1658 /* we want to make sure that we have a function */
1659 g_return_if_fail (header != NULL);
1660 g_return_if_fail (header->func != NULL);
1663 g_return_if_fail (tree_model_sort->default_sort_func != NULL);
1665 gtk_tree_model_sort_sort_level (tree_model_sort, tree_model_sort->root,
1669 /* signal helpers */
1671 gtk_tree_model_sort_level_find_insert (GtkTreeModelSort *tree_model_sort,
1674 gboolean skip_sort_elt)
1676 gint start, middle, end;
1680 GtkTreeIter tmp_iter;
1682 GtkTreeIterCompareFunc func;
1685 if (tree_model_sort->sort_column_id != GTK_TREE_SORTABLE_DEFAULT_SORT_COLUMN_ID)
1687 GtkTreeDataSortHeader *header;
1689 header = _gtk_tree_data_list_get_header (tree_model_sort->sort_list,
1690 tree_model_sort->sort_column_id);
1692 g_return_val_if_fail (header != NULL, 0);
1694 func = header->func;
1695 data = header->data;
1699 func = tree_model_sort->default_sort_func;
1700 data = tree_model_sort->default_sort_data;
1702 g_return_val_if_fail (func != NO_SORT_FUNC, 0);
1705 g_return_val_if_fail (func != NULL, 0);
1708 end = level->array->len;
1711 skip_index = SORT_ELT (iter->user_data2) - SORT_ELT (level->array->data);
1720 while (start != end)
1722 middle = (start + end) / 2;
1724 if (middle < skip_index)
1725 tmp_elt = &(g_array_index (level->array, SortElt, middle));
1727 tmp_elt = &(g_array_index (level->array, SortElt, middle + 1));
1729 if (!GTK_TREE_MODEL_SORT_CACHE_CHILD_ITERS (tree_model_sort))
1731 GtkTreePath *path = gtk_tree_model_sort_elt_get_path (level, tmp_elt);
1732 gtk_tree_model_get_iter (tree_model_sort->child_model,
1734 gtk_tree_path_free (path);
1737 tmp_iter = tmp_elt->iter;
1739 if (tree_model_sort->order == GTK_SORT_ASCENDING)
1740 cmp = (* func) (GTK_TREE_MODEL (tree_model_sort->child_model),
1741 &tmp_iter, iter, data);
1743 cmp = (* func) (GTK_TREE_MODEL (tree_model_sort->child_model),
1744 iter, &tmp_iter, data);
1759 gtk_tree_model_sort_insert_value (GtkTreeModelSort *tree_model_sort,
1761 GtkTreePath *s_path,
1762 GtkTreeIter *s_iter)
1764 gint offset, index, i;
1769 offset = gtk_tree_path_get_indices (s_path)[gtk_tree_path_get_depth (s_path) - 1];
1771 if (GTK_TREE_MODEL_SORT_CACHE_CHILD_ITERS (tree_model_sort))
1773 elt.offset = offset;
1774 elt.zero_ref_count = 0;
1776 elt.children = NULL;
1778 /* update all larger offsets */
1779 tmp_elt = SORT_ELT (level->array->data);
1780 for (i = 0; i < level->array->len; i++, tmp_elt++)
1781 if (tmp_elt->offset >= offset)
1784 if (tree_model_sort->sort_column_id == GTK_TREE_SORTABLE_DEFAULT_SORT_COLUMN_ID &&
1785 tree_model_sort->default_sort_func == NO_SORT_FUNC)
1788 index = gtk_tree_model_sort_level_find_insert (tree_model_sort,
1792 g_array_insert_vals (level->array, index, &elt, 1);
1793 tmp_elt = SORT_ELT (level->array->data);
1794 for (i = 0; i < level->array->len; i++, tmp_elt++)
1795 if (tmp_elt->children)
1796 tmp_elt->children->parent_elt = tmp_elt;
1801 /* sort elt stuff */
1802 static GtkTreePath *
1803 gtk_tree_model_sort_elt_get_path (SortLevel *level,
1806 SortLevel *walker = level;
1807 SortElt *walker2 = elt;
1810 g_return_val_if_fail (level != NULL, NULL);
1811 g_return_val_if_fail (elt != NULL, NULL);
1813 path = gtk_tree_path_new ();
1817 gtk_tree_path_prepend_index (path, walker2->offset);
1819 walker2 = walker->parent_elt;
1820 walker = walker->parent_level;
1827 * gtk_tree_model_sort_set_model:
1828 * @tree_model_sort: The #GtkTreeModelSort.
1829 * @child_model: A #GtkTreeModel, or NULL.
1831 * Sets the model of @tree_model_sort to be @model. If @model is NULL, then the
1832 * old model is unset. The sort function is unset as a result of this call.
1833 * The model will be in an unsorted state until a sort function is set.
1836 gtk_tree_model_sort_set_model (GtkTreeModelSort *tree_model_sort,
1837 GtkTreeModel *child_model)
1839 g_return_if_fail (GTK_IS_TREE_MODEL_SORT (tree_model_sort));
1842 g_object_ref (child_model);
1844 if (tree_model_sort->child_model)
1846 g_signal_handler_disconnect (tree_model_sort->child_model,
1847 tree_model_sort->changed_id);
1848 g_signal_handler_disconnect (tree_model_sort->child_model,
1849 tree_model_sort->inserted_id);
1850 g_signal_handler_disconnect (tree_model_sort->child_model,
1851 tree_model_sort->has_child_toggled_id);
1852 g_signal_handler_disconnect (tree_model_sort->child_model,
1853 tree_model_sort->deleted_id);
1854 g_signal_handler_disconnect (tree_model_sort->child_model,
1855 tree_model_sort->reordered_id);
1857 /* reset our state */
1858 if (tree_model_sort->root)
1859 gtk_tree_model_sort_free_level (tree_model_sort, tree_model_sort->root);
1860 tree_model_sort->root = NULL;
1861 _gtk_tree_data_list_header_free (tree_model_sort->sort_list);
1862 tree_model_sort->sort_list = NULL;
1863 g_object_unref (tree_model_sort->child_model);
1866 tree_model_sort->child_model = child_model;
1873 tree_model_sort->changed_id =
1874 g_signal_connect (child_model, "row_changed",
1875 G_CALLBACK (gtk_tree_model_sort_row_changed),
1877 tree_model_sort->inserted_id =
1878 g_signal_connect (child_model, "row_inserted",
1879 G_CALLBACK (gtk_tree_model_sort_row_inserted),
1881 tree_model_sort->has_child_toggled_id =
1882 g_signal_connect (child_model, "row_has_child_toggled",
1883 G_CALLBACK (gtk_tree_model_sort_row_has_child_toggled),
1885 tree_model_sort->deleted_id =
1886 g_signal_connect (child_model, "row_deleted",
1887 G_CALLBACK (gtk_tree_model_sort_row_deleted),
1889 tree_model_sort->reordered_id =
1890 g_signal_connect (child_model, "rows_reordered",
1891 G_CALLBACK (gtk_tree_model_sort_rows_reordered),
1894 tree_model_sort->child_flags = gtk_tree_model_get_flags (child_model);
1895 n_columns = gtk_tree_model_get_n_columns (child_model);
1897 types = g_new (GType, n_columns);
1898 for (i = 0; i < n_columns; i++)
1899 types[i] = gtk_tree_model_get_column_type (child_model, i);
1901 tree_model_sort->sort_list = _gtk_tree_data_list_header_new (n_columns, types);
1904 tree_model_sort->default_sort_func = NO_SORT_FUNC;
1905 tree_model_sort->stamp = g_random_int ();
1910 * gtk_tree_model_sort_get_model:
1911 * @tree_model: a #GtkTreeModelSort
1913 * Returns the model the #GtkTreeModelSort is sorting.
1915 * Return value: the "child model" being sorted
1918 gtk_tree_model_sort_get_model (GtkTreeModelSort *tree_model)
1920 g_return_val_if_fail (GTK_IS_TREE_MODEL_SORT (tree_model), NULL);
1922 return tree_model->child_model;
1926 static GtkTreePath *
1927 gtk_real_tree_model_sort_convert_child_path_to_path (GtkTreeModelSort *tree_model_sort,
1928 GtkTreePath *child_path,
1929 gboolean build_levels)
1931 gint *child_indices;
1932 GtkTreePath *retval;
1936 g_return_val_if_fail (GTK_IS_TREE_MODEL_SORT (tree_model_sort), NULL);
1937 g_return_val_if_fail (tree_model_sort->child_model != NULL, NULL);
1938 g_return_val_if_fail (child_path != NULL, NULL);
1940 retval = gtk_tree_path_new ();
1941 child_indices = gtk_tree_path_get_indices (child_path);
1943 if (tree_model_sort->root == NULL && build_levels)
1944 gtk_tree_model_sort_build_level (tree_model_sort, NULL, NULL);
1945 level = SORT_LEVEL (tree_model_sort->root);
1947 for (i = 0; i < gtk_tree_path_get_depth (child_path); i++)
1950 gboolean found_child = FALSE;
1954 gtk_tree_path_free (retval);
1958 if (child_indices[i] >= level->array->len)
1960 gtk_tree_path_free (retval);
1963 for (j = 0; j < level->array->len; j++)
1965 if ((g_array_index (level->array, SortElt, j)).offset == child_indices[i])
1967 gtk_tree_path_append_index (retval, j);
1968 if (g_array_index (level->array, SortElt, j).children == NULL && build_levels)
1970 gtk_tree_model_sort_build_level (tree_model_sort, level, &g_array_index (level->array, SortElt, j));
1972 level = g_array_index (level->array, SortElt, j).children;
1979 gtk_tree_path_free (retval);
1989 * gtk_tree_model_sort_convert_child_path_to_path:
1990 * @tree_model_sort: A #GtkTreeModelSort
1991 * @child_path: A #GtkTreePath to convert
1993 * Converts @child_path to a path relative to @tree_model_sort. That is,
1994 * @child_path points to a path in the child model. The returned path will
1995 * point to the same row in the sorted model. If @child_path isn't a valid path
1996 * on the child model, then %NULL is returned.
1998 * Return value: A newly allocated #GtkTreePath, or %NULL
2001 gtk_tree_model_sort_convert_child_path_to_path (GtkTreeModelSort *tree_model_sort,
2002 GtkTreePath *child_path)
2004 g_return_val_if_fail (GTK_IS_TREE_MODEL_SORT (tree_model_sort), NULL);
2005 g_return_val_if_fail (tree_model_sort->child_model != NULL, NULL);
2006 g_return_val_if_fail (child_path != NULL, NULL);
2008 return gtk_real_tree_model_sort_convert_child_path_to_path (tree_model_sort, child_path, TRUE);
2012 * gtk_tree_model_sort_convert_child_iter_to_iter:
2013 * @tree_model_sort: A #GtkTreeModelSort
2014 * @sort_iter: An uninitialized #GtkTreeIter.
2015 * @child_iter: A valid #GtkTreeIter pointing to a row on the child model
2017 * Sets @sort_iter to point to the row in @tree_model_sort that corresponds to
2018 * the row pointed at by @child_iter.
2021 gtk_tree_model_sort_convert_child_iter_to_iter (GtkTreeModelSort *tree_model_sort,
2022 GtkTreeIter *sort_iter,
2023 GtkTreeIter *child_iter)
2025 GtkTreePath *child_path, *path;
2027 g_return_if_fail (GTK_IS_TREE_MODEL_SORT (tree_model_sort));
2028 g_return_if_fail (tree_model_sort->child_model != NULL);
2029 g_return_if_fail (sort_iter != NULL);
2030 g_return_if_fail (child_iter != NULL);
2032 sort_iter->stamp = 0;
2034 child_path = gtk_tree_model_get_path (tree_model_sort->child_model, child_iter);
2035 g_return_if_fail (child_path != NULL);
2037 path = gtk_tree_model_sort_convert_child_path_to_path (tree_model_sort, child_path);
2038 gtk_tree_path_free (child_path);
2039 g_return_if_fail (path != NULL);
2041 gtk_tree_model_get_iter (GTK_TREE_MODEL (tree_model_sort), sort_iter, path);
2042 gtk_tree_path_free (path);
2046 * gtk_tree_model_sort_convert_path_to_child_path:
2047 * @tree_model_sort: A #GtkTreeModelSort
2048 * @sorted_path: A #GtkTreePath to convert
2050 * Converts @sorted_path to a path on the child model of @tree_model_sort. That
2051 * is, @sorted_path points to a location in @tree_model_sort. The returned path
2052 * will point to the same location in the model not being sorted. If @sorted_path
2053 * does not point to a location in the child model, %NULL is returned.
2055 * Return value: A newly allocated #GtkTreePath, or %NULL
2058 gtk_tree_model_sort_convert_path_to_child_path (GtkTreeModelSort *tree_model_sort,
2059 GtkTreePath *sorted_path)
2061 gint *sorted_indices;
2062 GtkTreePath *retval;
2066 g_return_val_if_fail (GTK_IS_TREE_MODEL_SORT (tree_model_sort), NULL);
2067 g_return_val_if_fail (tree_model_sort->child_model != NULL, NULL);
2068 g_return_val_if_fail (sorted_path != NULL, NULL);
2070 retval = gtk_tree_path_new ();
2071 sorted_indices = gtk_tree_path_get_indices (sorted_path);
2072 if (tree_model_sort->root == NULL)
2073 gtk_tree_model_sort_build_level (tree_model_sort, NULL, NULL);
2074 level = SORT_LEVEL (tree_model_sort->root);
2076 for (i = 0; i < gtk_tree_path_get_depth (sorted_path); i++)
2078 gint count = sorted_indices[i];
2080 if ((level == NULL) ||
2081 (level->array->len <= count))
2083 gtk_tree_path_free (retval);
2087 if (g_array_index (level->array, SortElt, count).children == NULL)
2088 gtk_tree_model_sort_build_level (tree_model_sort, level, &g_array_index (level->array, SortElt, count));
2092 gtk_tree_path_free (retval);
2096 gtk_tree_path_append_index (retval, g_array_index (level->array, SortElt, count).offset);
2097 level = g_array_index (level->array, SortElt, count).children;
2104 * gtk_tree_model_sort_convert_iter_to_child_iter:
2105 * @tree_model_sort: A #GtkTreeModelSort
2106 * @child_iter: An uninitialized #GtkTreeIter
2107 * @sorted_iter: A valid #GtkTreeIter pointing to a row on @tree_model_sort.
2109 * Sets @child_iter to point to the row pointed to by @sorted_iter.
2112 gtk_tree_model_sort_convert_iter_to_child_iter (GtkTreeModelSort *tree_model_sort,
2113 GtkTreeIter *child_iter,
2114 GtkTreeIter *sorted_iter)
2116 g_return_if_fail (GTK_IS_TREE_MODEL_SORT (tree_model_sort));
2117 g_return_if_fail (tree_model_sort->child_model != NULL);
2118 g_return_if_fail (child_iter != NULL);
2119 g_return_if_fail (sorted_iter != NULL);
2120 g_return_if_fail (sorted_iter->stamp == tree_model_sort->stamp);
2122 if (GTK_TREE_MODEL_SORT_CACHE_CHILD_ITERS (tree_model_sort))
2124 *child_iter = SORT_ELT (sorted_iter->user_data2)->iter;
2130 path = gtk_tree_model_sort_elt_get_path (sorted_iter->user_data,
2131 sorted_iter->user_data2);
2132 gtk_tree_model_get_iter (tree_model_sort->child_model, child_iter, path);
2133 gtk_tree_path_free (path);
2138 gtk_tree_model_sort_build_level (GtkTreeModelSort *tree_model_sort,
2139 SortLevel *parent_level,
2140 SortElt *parent_elt)
2143 SortLevel *new_level;
2147 g_assert (tree_model_sort->child_model != NULL);
2149 if (parent_level == NULL)
2151 if (gtk_tree_model_get_iter_first (tree_model_sort->child_model, &iter) == FALSE)
2153 length = gtk_tree_model_iter_n_children (tree_model_sort->child_model, NULL);
2157 GtkTreeIter parent_iter;
2158 GtkTreeIter child_parent_iter;
2160 parent_iter.stamp = tree_model_sort->stamp;
2161 parent_iter.user_data = parent_level;
2162 parent_iter.user_data2 = parent_elt;
2164 gtk_tree_model_sort_convert_iter_to_child_iter (tree_model_sort,
2167 if (gtk_tree_model_iter_children (tree_model_sort->child_model,
2169 &child_parent_iter) == FALSE)
2172 /* stamp may have changed */
2173 gtk_tree_model_sort_convert_iter_to_child_iter (tree_model_sort,
2177 length = gtk_tree_model_iter_n_children (tree_model_sort->child_model, &child_parent_iter);
2180 g_return_if_fail (length > 0);
2182 new_level = g_new (SortLevel, 1);
2183 new_level->array = g_array_sized_new (FALSE, FALSE, sizeof (SortElt), length);
2184 new_level->ref_count = 0;
2185 new_level->parent_elt = parent_elt;
2186 new_level->parent_level = parent_level;
2189 parent_elt->children = new_level;
2191 tree_model_sort->root = new_level;
2193 /* increase the count of zero ref_counts.*/
2194 while (parent_level)
2196 parent_elt->zero_ref_count++;
2198 parent_elt = parent_level->parent_elt;
2199 parent_level = parent_level->parent_level;
2201 if (new_level != tree_model_sort->root)
2202 tree_model_sort->zero_ref_count++;
2204 for (i = 0; i < length; i++)
2207 sort_elt.offset = i;
2208 sort_elt.zero_ref_count = 0;
2209 sort_elt.ref_count = 0;
2210 sort_elt.children = NULL;
2212 if (GTK_TREE_MODEL_SORT_CACHE_CHILD_ITERS (tree_model_sort))
2214 sort_elt.iter = iter;
2215 if (gtk_tree_model_iter_next (tree_model_sort->child_model, &iter) == FALSE &&
2218 g_warning ("There is a discrepency between the sort model and the child model.");
2222 g_array_append_val (new_level->array, sort_elt);
2226 gtk_tree_model_sort_sort_level (tree_model_sort, new_level,
2231 gtk_tree_model_sort_free_level (GtkTreeModelSort *tree_model_sort,
2232 SortLevel *sort_level)
2236 g_assert (sort_level);
2238 if (sort_level->ref_count == 0)
2240 SortLevel *parent_level = sort_level->parent_level;
2241 SortElt *parent_elt = sort_level->parent_elt;
2246 parent_elt->zero_ref_count--;
2248 tree_model_sort->zero_ref_count--;
2252 parent_elt = parent_level->parent_elt;
2253 parent_level = parent_level->parent_level;
2256 while (parent_level);
2259 for (i = 0; i < sort_level->array->len; i++)
2261 if (g_array_index (sort_level->array, SortElt, i).children)
2262 gtk_tree_model_sort_free_level (tree_model_sort,
2263 SORT_LEVEL(g_array_index (sort_level->array, SortElt, i).children));
2266 if (sort_level->parent_elt)
2267 sort_level->parent_elt->children = NULL;
2269 tree_model_sort->root = NULL;
2271 g_array_free (sort_level->array, TRUE);
2272 sort_level->array = NULL;
2274 g_free (sort_level);
2279 gtk_tree_model_sort_increment_stamp (GtkTreeModelSort *tree_model_sort)
2283 tree_model_sort->stamp++;
2285 while (tree_model_sort->stamp == 0);
2287 gtk_tree_model_sort_clear_cache (tree_model_sort);
2291 gtk_tree_model_sort_clear_cache_helper (GtkTreeModelSort *tree_model_sort,
2296 g_assert (level != NULL);
2298 for (i = 0; i < level->array->len; i++)
2300 if (g_array_index (level->array, SortElt, i).zero_ref_count > 0)
2301 gtk_tree_model_sort_clear_cache_helper (tree_model_sort, g_array_index (level->array, SortElt, i).children);
2304 if (level->ref_count == 0 && level != tree_model_sort->root)
2305 gtk_tree_model_sort_free_level (tree_model_sort, level);
2309 * gtk_tree_model_sort_reset_default_sort_func:
2310 * @tree_model_sort: A #GtkTreeModelSort
2312 * This resets the default sort function to be in the 'unsorted' state. That
2313 * is, it is in the same order as the child model. It will re-sort the model
2314 * to be in the same order as the child model only if the #GtkTreeModelSort
2315 * is in 'unsorted' state.
2318 gtk_tree_model_sort_reset_default_sort_func (GtkTreeModelSort *tree_model_sort)
2320 g_return_if_fail (GTK_IS_TREE_MODEL_SORT (tree_model_sort));
2322 if (tree_model_sort->default_sort_destroy)
2324 GtkDestroyNotify d = tree_model_sort->default_sort_destroy;
2326 tree_model_sort->default_sort_destroy = NULL;
2327 d (tree_model_sort->default_sort_data);
2330 tree_model_sort->default_sort_func = NO_SORT_FUNC;
2331 tree_model_sort->default_sort_data = NULL;
2332 tree_model_sort->default_sort_destroy = NULL;
2334 if (tree_model_sort->sort_column_id == GTK_TREE_SORTABLE_DEFAULT_SORT_COLUMN_ID)
2335 gtk_tree_model_sort_sort (tree_model_sort);
2336 tree_model_sort->sort_column_id = GTK_TREE_SORTABLE_DEFAULT_SORT_COLUMN_ID;
2340 * gtk_tree_model_sort_clear_cache:
2341 * @tree_model_sort: A #GtkTreeModelSort
2343 * This function should almost never be called. It clears the @tree_model_sort
2344 * of any cached iterators that haven't been reffed with
2345 * gtk_tree_model_ref_node(). This might be useful if the child model being
2346 * sorted is static (and doesn't change often) and there has been a lot of
2347 * unreffed access to nodes. As a side effect of this function, all unreffed
2348 * iters will be invalid.
2351 gtk_tree_model_sort_clear_cache (GtkTreeModelSort *tree_model_sort)
2353 g_return_if_fail (GTK_IS_TREE_MODEL_SORT (tree_model_sort));
2355 if (tree_model_sort->zero_ref_count)
2356 gtk_tree_model_sort_clear_cache_helper (tree_model_sort, (SortLevel *)tree_model_sort->root);
2360 gtk_tree_model_sort_iter_is_valid_helper (GtkTreeIter *iter,
2365 for (i = 0; i < level->array->len; i++)
2367 SortElt *elt = &g_array_index (level->array, SortElt, i);
2369 if (iter->user_data == level && iter->user_data2 == elt)
2373 if (gtk_tree_model_sort_iter_is_valid_helper (iter, elt->children))
2381 * gtk_tree_model_sort_iter_is_valid:
2382 * @tree_model_sort: A #GtkTreeModelSort.
2383 * @iter: A #GtkTreeIter.
2385 * WARNING: This function is slow. Only use it for debugging and/or testing
2388 * Checks if the given iter is a valid iter for this #GtkTreeModelSort.
2390 * Return value: %TRUE if the iter is valid, %FALSE if the iter is invalid.
2395 gtk_tree_model_sort_iter_is_valid (GtkTreeModelSort *tree_model_sort,
2398 g_return_val_if_fail (GTK_IS_TREE_MODEL_SORT (tree_model_sort), FALSE);
2399 g_return_val_if_fail (iter != NULL, FALSE);
2401 if (!VALID_ITER (iter, tree_model_sort))
2404 return gtk_tree_model_sort_iter_is_valid_helper (iter,
2405 tree_model_sort->root);