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.
43 #include "gtktreemodelsort.h"
44 #include "gtktreesortable.h"
45 #include "gtktreestore.h"
46 #include "gtktreedatalist.h"
48 #include "gtkprivate.h"
49 #include "gtktreednd.h"
52 typedef struct _SortElt SortElt;
53 typedef struct _SortLevel SortLevel;
54 typedef struct _SortData SortData;
55 typedef struct _SortTuple SortTuple;
71 SortLevel *parent_level;
76 GtkTreeModelSort *tree_model_sort;
77 GtkTreePath *parent_path;
78 gint parent_path_depth;
79 gint *parent_path_indices;
80 GtkTreeIterCompareFunc sort_func;
99 #define GTK_TREE_MODEL_SORT_CACHE_CHILD_ITERS(tree_model_sort) \
100 (((GtkTreeModelSort *)tree_model_sort)->child_flags>K_TREE_MODEL_ITERS_PERSIST)
101 #define SORT_ELT(sort_elt) ((SortElt *)sort_elt)
102 #define SORT_LEVEL(sort_level) ((SortLevel *)sort_level)
104 #define GET_CHILD_ITER(tree_model_sort,ch_iter,so_iter) gtk_tree_model_sort_convert_iter_to_child_iter(GTK_TREE_MODEL_SORT (tree_model_sort), ch_iter, so_iter);
106 #define NO_SORT_FUNC ((GtkTreeIterCompareFunc) 0x1)
108 #define VALID_ITER(iter, tree_model_sort) (iter != NULL && iter->user_data != NULL && iter->user_data2 != NULL && tree_model_sort->stamp == iter->stamp)
110 /* general (object/interface init, etc) */
111 static void gtk_tree_model_sort_init (GtkTreeModelSort *tree_model_sort);
112 static void gtk_tree_model_sort_class_init (GtkTreeModelSortClass *tree_model_sort_class);
113 static void gtk_tree_model_sort_tree_model_init (GtkTreeModelIface *iface);
114 static void gtk_tree_model_sort_tree_sortable_init (GtkTreeSortableIface *iface);
115 static void gtk_tree_model_sort_drag_source_init (GtkTreeDragSourceIface*iface);
116 static void gtk_tree_model_sort_finalize (GObject *object);
117 static void gtk_tree_model_sort_set_property (GObject *object,
121 static void gtk_tree_model_sort_get_property (GObject *object,
126 /* our signal handlers */
127 static void gtk_tree_model_sort_row_changed (GtkTreeModel *model,
128 GtkTreePath *start_path,
129 GtkTreeIter *start_iter,
131 static void gtk_tree_model_sort_row_inserted (GtkTreeModel *model,
135 static void gtk_tree_model_sort_row_has_child_toggled (GtkTreeModel *model,
139 static void gtk_tree_model_sort_row_deleted (GtkTreeModel *model,
142 static void gtk_tree_model_sort_rows_reordered (GtkTreeModel *s_model,
148 /* TreeModel interface */
149 static GtkTreeModelFlags gtk_tree_model_sort_get_flags (GtkTreeModel *tree_model);
150 static gint gtk_tree_model_sort_get_n_columns (GtkTreeModel *tree_model);
151 static GType gtk_tree_model_sort_get_column_type (GtkTreeModel *tree_model,
153 static gboolean gtk_tree_model_sort_get_iter (GtkTreeModel *tree_model,
156 static GtkTreePath *gtk_tree_model_sort_get_path (GtkTreeModel *tree_model,
158 static void gtk_tree_model_sort_get_value (GtkTreeModel *tree_model,
162 static gboolean gtk_tree_model_sort_iter_next (GtkTreeModel *tree_model,
164 static gboolean gtk_tree_model_sort_iter_children (GtkTreeModel *tree_model,
166 GtkTreeIter *parent);
167 static gboolean gtk_tree_model_sort_iter_has_child (GtkTreeModel *tree_model,
169 static gint gtk_tree_model_sort_iter_n_children (GtkTreeModel *tree_model,
171 static gboolean gtk_tree_model_sort_iter_nth_child (GtkTreeModel *tree_model,
175 static gboolean gtk_tree_model_sort_iter_parent (GtkTreeModel *tree_model,
178 static void gtk_tree_model_sort_ref_node (GtkTreeModel *tree_model,
180 static void gtk_tree_model_sort_real_unref_node (GtkTreeModel *tree_model,
182 gboolean propagate_unref);
183 static void gtk_tree_model_sort_unref_node (GtkTreeModel *tree_model,
186 /* TreeDragSource interface */
187 static gboolean gtk_tree_model_sort_row_draggable (GtkTreeDragSource *drag_source,
189 static gboolean gtk_tree_model_sort_drag_data_get (GtkTreeDragSource *drag_source,
191 GtkSelectionData *selection_data);
192 static gboolean gtk_tree_model_sort_drag_data_delete (GtkTreeDragSource *drag_source,
195 /* TreeSortable interface */
196 static gboolean gtk_tree_model_sort_get_sort_column_id (GtkTreeSortable *sortable,
197 gint *sort_column_id,
199 static void gtk_tree_model_sort_set_sort_column_id (GtkTreeSortable *sortable,
202 static void gtk_tree_model_sort_set_sort_func (GtkTreeSortable *sortable,
204 GtkTreeIterCompareFunc func,
206 GtkDestroyNotify destroy);
207 static void gtk_tree_model_sort_set_default_sort_func (GtkTreeSortable *sortable,
208 GtkTreeIterCompareFunc func,
210 GtkDestroyNotify destroy);
211 static gboolean gtk_tree_model_sort_has_default_sort_func (GtkTreeSortable *sortable);
213 /* Private functions (sort funcs, level handling and other utils) */
214 static void gtk_tree_model_sort_build_level (GtkTreeModelSort *tree_model_sort,
215 SortLevel *parent_level,
216 SortElt *parent_elt);
217 static void gtk_tree_model_sort_free_level (GtkTreeModelSort *tree_model_sort,
218 SortLevel *sort_level);
219 static void gtk_tree_model_sort_increment_stamp (GtkTreeModelSort *tree_model_sort);
220 static void gtk_tree_model_sort_sort_level (GtkTreeModelSort *tree_model_sort,
223 gboolean emit_reordered);
224 static void gtk_tree_model_sort_sort (GtkTreeModelSort *tree_model_sort);
225 static gint gtk_tree_model_sort_level_find_insert (GtkTreeModelSort *tree_model_sort,
229 static gboolean gtk_tree_model_sort_insert_value (GtkTreeModelSort *tree_model_sort,
232 GtkTreeIter *s_iter);
233 static GtkTreePath *gtk_tree_model_sort_elt_get_path (SortLevel *level,
235 static void gtk_tree_model_sort_set_model (GtkTreeModelSort *tree_model_sort,
236 GtkTreeModel *child_model);
237 static GtkTreePath *gtk_real_tree_model_sort_convert_child_path_to_path (GtkTreeModelSort *tree_model_sort,
238 GtkTreePath *child_path,
239 gboolean build_levels);
241 static GObjectClass *parent_class = NULL;
244 gtk_tree_model_sort_get_type (void)
246 static GType tree_model_sort_type = 0;
248 if (!tree_model_sort_type)
250 static const GTypeInfo tree_model_sort_info =
252 sizeof (GtkTreeModelSortClass),
253 NULL, /* base_init */
254 NULL, /* base_finalize */
255 (GClassInitFunc) gtk_tree_model_sort_class_init,
256 NULL, /* class_finalize */
257 NULL, /* class_data */
258 sizeof (GtkTreeModelSort),
260 (GInstanceInitFunc) gtk_tree_model_sort_init
263 static const GInterfaceInfo tree_model_info =
265 (GInterfaceInitFunc) gtk_tree_model_sort_tree_model_init,
270 static const GInterfaceInfo sortable_info =
272 (GInterfaceInitFunc) gtk_tree_model_sort_tree_sortable_init,
277 static const GInterfaceInfo drag_source_info =
279 (GInterfaceInitFunc) gtk_tree_model_sort_drag_source_init,
284 tree_model_sort_type =
285 g_type_register_static (G_TYPE_OBJECT, I_("GtkTreeModelSort"),
286 &tree_model_sort_info, 0);
288 g_type_add_interface_static (tree_model_sort_type,
292 g_type_add_interface_static (tree_model_sort_type,
293 GTK_TYPE_TREE_SORTABLE,
296 g_type_add_interface_static (tree_model_sort_type,
297 GTK_TYPE_TREE_DRAG_SOURCE,
301 return tree_model_sort_type;
305 gtk_tree_model_sort_init (GtkTreeModelSort *tree_model_sort)
307 tree_model_sort->sort_column_id = GTK_TREE_SORTABLE_DEFAULT_SORT_COLUMN_ID;
308 tree_model_sort->stamp = 0;
309 tree_model_sort->zero_ref_count = 0;
310 tree_model_sort->root = NULL;
311 tree_model_sort->sort_list = NULL;
315 gtk_tree_model_sort_class_init (GtkTreeModelSortClass *class)
317 GObjectClass *object_class;
319 object_class = (GObjectClass *) class;
320 parent_class = g_type_class_peek_parent (class);
322 object_class->set_property = gtk_tree_model_sort_set_property;
323 object_class->get_property = gtk_tree_model_sort_get_property;
325 object_class->finalize = gtk_tree_model_sort_finalize;
328 g_object_class_install_property (object_class,
330 g_param_spec_object ("model",
331 P_("TreeModelSort Model"),
332 P_("The model for the TreeModelSort to sort"),
334 GTK_PARAM_READWRITE | G_PARAM_CONSTRUCT_ONLY));
338 gtk_tree_model_sort_tree_model_init (GtkTreeModelIface *iface)
340 iface->get_flags = gtk_tree_model_sort_get_flags;
341 iface->get_n_columns = gtk_tree_model_sort_get_n_columns;
342 iface->get_column_type = gtk_tree_model_sort_get_column_type;
343 iface->get_iter = gtk_tree_model_sort_get_iter;
344 iface->get_path = gtk_tree_model_sort_get_path;
345 iface->get_value = gtk_tree_model_sort_get_value;
346 iface->iter_next = gtk_tree_model_sort_iter_next;
347 iface->iter_children = gtk_tree_model_sort_iter_children;
348 iface->iter_has_child = gtk_tree_model_sort_iter_has_child;
349 iface->iter_n_children = gtk_tree_model_sort_iter_n_children;
350 iface->iter_nth_child = gtk_tree_model_sort_iter_nth_child;
351 iface->iter_parent = gtk_tree_model_sort_iter_parent;
352 iface->ref_node = gtk_tree_model_sort_ref_node;
353 iface->unref_node = gtk_tree_model_sort_unref_node;
357 gtk_tree_model_sort_tree_sortable_init (GtkTreeSortableIface *iface)
359 iface->get_sort_column_id = gtk_tree_model_sort_get_sort_column_id;
360 iface->set_sort_column_id = gtk_tree_model_sort_set_sort_column_id;
361 iface->set_sort_func = gtk_tree_model_sort_set_sort_func;
362 iface->set_default_sort_func = gtk_tree_model_sort_set_default_sort_func;
363 iface->has_default_sort_func = gtk_tree_model_sort_has_default_sort_func;
367 gtk_tree_model_sort_drag_source_init (GtkTreeDragSourceIface *iface)
369 iface->row_draggable = gtk_tree_model_sort_row_draggable;
370 iface->drag_data_delete = gtk_tree_model_sort_drag_data_delete;
371 iface->drag_data_get = gtk_tree_model_sort_drag_data_get;
375 * gtk_tree_model_sort_new_with_model:
376 * @child_model: A #GtkTreeModel
378 * Creates a new #GtkTreeModel, with @child_model as the child model.
380 * Return value: A new #GtkTreeModel.
383 gtk_tree_model_sort_new_with_model (GtkTreeModel *child_model)
385 GtkTreeModel *retval;
387 g_return_val_if_fail (GTK_IS_TREE_MODEL (child_model), NULL);
389 retval = g_object_new (gtk_tree_model_sort_get_type (), NULL);
391 gtk_tree_model_sort_set_model (GTK_TREE_MODEL_SORT (retval), child_model);
396 /* GObject callbacks */
398 gtk_tree_model_sort_finalize (GObject *object)
400 GtkTreeModelSort *tree_model_sort = (GtkTreeModelSort *) object;
402 gtk_tree_model_sort_set_model (tree_model_sort, NULL);
404 if (tree_model_sort->root)
405 gtk_tree_model_sort_free_level (tree_model_sort, tree_model_sort->root);
407 if (tree_model_sort->sort_list)
409 _gtk_tree_data_list_header_free (tree_model_sort->sort_list);
410 tree_model_sort->sort_list = NULL;
414 parent_class->finalize (object);
418 gtk_tree_model_sort_set_property (GObject *object,
423 GtkTreeModelSort *tree_model_sort = GTK_TREE_MODEL_SORT (object);
428 gtk_tree_model_sort_set_model (tree_model_sort, g_value_get_object (value));
431 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
437 gtk_tree_model_sort_get_property (GObject *object,
442 GtkTreeModelSort *tree_model_sort = GTK_TREE_MODEL_SORT (object);
447 g_value_set_object (value, gtk_tree_model_sort_get_model(tree_model_sort));
450 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
456 gtk_tree_model_sort_row_changed (GtkTreeModel *s_model,
457 GtkTreePath *start_s_path,
458 GtkTreeIter *start_s_iter,
461 GtkTreeModelSort *tree_model_sort = GTK_TREE_MODEL_SORT (data);
462 GtkTreePath *path = NULL;
470 gboolean free_s_path = FALSE;
472 gint index = 0, old_index, i;
474 g_return_if_fail (start_s_path != NULL || start_s_iter != NULL);
479 start_s_path = gtk_tree_model_get_path (s_model, start_s_iter);
482 path = gtk_real_tree_model_sort_convert_child_path_to_path (tree_model_sort,
488 gtk_tree_path_free (start_s_path);
492 gtk_tree_model_get_iter (GTK_TREE_MODEL (data), &iter, path);
494 level = iter.user_data;
495 elt = iter.user_data2;
499 if (level->array->len < 2 ||
500 (tree_model_sort->sort_column_id == GTK_TREE_SORTABLE_DEFAULT_SORT_COLUMN_ID &&
501 tree_model_sort->default_sort_func == NO_SORT_FUNC))
504 gtk_tree_path_free (start_s_path);
506 gtk_tree_model_row_changed (GTK_TREE_MODEL (data), path, &iter);
508 gtk_tree_path_free (path);
515 if (!GTK_TREE_MODEL_SORT_CACHE_CHILD_ITERS (tree_model_sort))
517 gtk_tree_model_get_iter (tree_model_sort->child_model,
518 &tmpiter, start_s_path);
521 old_index = elt - SORT_ELT (level->array->data);
523 memcpy (&tmp, elt, sizeof (SortElt));
525 if (GTK_TREE_MODEL_SORT_CACHE_CHILD_ITERS (tree_model_sort))
526 index = gtk_tree_model_sort_level_find_insert (tree_model_sort,
531 index = gtk_tree_model_sort_level_find_insert (tree_model_sort,
536 if (index < old_index)
538 g_memmove (level->array->data + ((index + 1)*sizeof (SortElt)),
539 level->array->data + ((index)*sizeof (SortElt)),
540 (old_index - index)* sizeof(SortElt));
542 else if (index > old_index)
544 g_memmove (level->array->data + ((old_index)*sizeof (SortElt)),
545 level->array->data + ((old_index + 1)*sizeof (SortElt)),
546 (index - old_index)* sizeof(SortElt));
548 memcpy (level->array->data + ((index)*sizeof (SortElt)),
549 &tmp, sizeof (SortElt));
551 for (i = 0; i < level->array->len; i++)
552 if (g_array_index (level->array, SortElt, i).children)
553 g_array_index (level->array, SortElt, i).children->parent_elt = &g_array_index (level->array, SortElt, i);
555 gtk_tree_path_up (path);
556 gtk_tree_path_append_index (path, index);
558 gtk_tree_model_sort_increment_stamp (tree_model_sort);
560 /* if the item moved, then emit rows_reordered */
561 if (old_index != index)
566 GtkTreePath *tmppath;
568 new_order = g_new (gint, level->array->len);
570 for (j = 0; j < level->array->len; j++)
572 if (index > old_index)
575 new_order[j] = old_index;
576 else if (j >= old_index && j < index)
577 new_order[j] = j + 1;
581 else if (index < old_index)
584 new_order[j] = old_index;
585 else if (j > index && j <= old_index)
586 new_order[j] = j - 1;
590 /* else? shouldn't really happen */
593 if (level->parent_elt)
595 iter.stamp = tree_model_sort->stamp;
596 iter.user_data = level->parent_level;
597 iter.user_data2 = level->parent_elt;
599 tmppath = gtk_tree_model_get_path (GTK_TREE_MODEL (tree_model_sort), &iter);
601 gtk_tree_model_rows_reordered (GTK_TREE_MODEL (tree_model_sort),
602 tmppath, &iter, new_order);
607 tmppath = gtk_tree_path_new ();
609 gtk_tree_model_rows_reordered (GTK_TREE_MODEL (tree_model_sort), tmppath,
613 gtk_tree_path_free (tmppath);
619 /* emit row_changed signal (at new location) */
620 gtk_tree_model_get_iter (GTK_TREE_MODEL (data), &iter, path);
621 gtk_tree_model_row_changed (GTK_TREE_MODEL (data), path, &iter);
623 gtk_tree_path_free (path);
625 gtk_tree_path_free (start_s_path);
629 gtk_tree_model_sort_row_inserted (GtkTreeModel *s_model,
634 GtkTreeModelSort *tree_model_sort = GTK_TREE_MODEL_SORT (data);
637 GtkTreeIter real_s_iter;
641 gboolean free_s_path = FALSE;
645 SortLevel *parent_level = NULL;
647 parent_level = level = SORT_LEVEL (tree_model_sort->root);
649 g_return_if_fail (s_path != NULL || s_iter != NULL);
653 s_path = gtk_tree_model_get_path (s_model, s_iter);
658 gtk_tree_model_get_iter (s_model, &real_s_iter, s_path);
660 real_s_iter = *s_iter;
662 if (!tree_model_sort->root)
664 gtk_tree_model_sort_build_level (tree_model_sort, NULL, NULL);
666 /* the build level already put the inserted iter in the level,
667 so no need to handle this signal anymore */
669 goto done_and_submit;
672 /* find the parent level */
673 while (i < gtk_tree_path_get_depth (s_path) - 1)
679 /* level not yet build, we won't cover this signal */
683 if (level->array->len < gtk_tree_path_get_indices (s_path)[i])
685 g_warning ("A node was inserted with a parent that's not in the tree.\n"
686 "This possibly means that a GtkTreeModel inserted a child node\n"
687 "before the parent was inserted.");
692 for (j = 0; j < level->array->len; j++)
693 if (g_array_index (level->array, SortElt, j).offset == gtk_tree_path_get_indices (s_path)[i])
695 elt = &g_array_index (level->array, SortElt, j);
699 g_return_if_fail (elt != NULL);
703 /* not covering this signal */
707 level = elt->children;
708 parent_level = level;
715 if (level->ref_count == 0 && level != tree_model_sort->root)
717 gtk_tree_model_sort_free_level (tree_model_sort, level);
721 if (!gtk_tree_model_sort_insert_value (tree_model_sort,
728 path = gtk_real_tree_model_sort_convert_child_path_to_path (tree_model_sort,
735 gtk_tree_model_sort_increment_stamp (tree_model_sort);
737 gtk_tree_model_get_iter (GTK_TREE_MODEL (data), &iter, path);
738 gtk_tree_model_row_inserted (GTK_TREE_MODEL (data), path, &iter);
739 gtk_tree_path_free (path);
743 gtk_tree_path_free (s_path);
749 gtk_tree_model_sort_row_has_child_toggled (GtkTreeModel *s_model,
754 GtkTreeModelSort *tree_model_sort = GTK_TREE_MODEL_SORT (data);
758 g_return_if_fail (s_path != NULL && s_iter != NULL);
760 path = gtk_real_tree_model_sort_convert_child_path_to_path (tree_model_sort, s_path, FALSE);
764 gtk_tree_model_get_iter (GTK_TREE_MODEL (data), &iter, path);
765 gtk_tree_model_row_has_child_toggled (GTK_TREE_MODEL (data), path, &iter);
767 gtk_tree_path_free (path);
770 /* FIXME: I still have doubts if this works */
772 gtk_tree_model_sort_row_deleted (GtkTreeModel *s_model,
776 GtkTreeModelSort *tree_model_sort = GTK_TREE_MODEL_SORT (data);
777 GtkTreePath *path = NULL;
784 g_return_if_fail (s_path != NULL);
786 path = gtk_real_tree_model_sort_convert_child_path_to_path (tree_model_sort, s_path, FALSE);
790 gtk_tree_model_get_iter (GTK_TREE_MODEL (data), &iter, path);
792 level = SORT_LEVEL (iter.user_data);
793 elt = SORT_ELT (iter.user_data2);
794 offset = elt->offset;
796 /* we _need_ to emit ::row_deleted before we start unreffing the node
797 * itself. This is because of the row refs, which start unreffing nodes
798 * when we emit ::row_deleted
800 gtk_tree_model_row_deleted (GTK_TREE_MODEL (data), path);
802 gtk_tree_model_get_iter (GTK_TREE_MODEL (data), &iter, path);
804 while (elt->ref_count > 0)
805 gtk_tree_model_sort_real_unref_node (GTK_TREE_MODEL (data), &iter, FALSE);
807 if (level->ref_count == 0)
809 /* This will prune the level, so I can just emit the signal and
810 * not worry about cleaning this level up.
811 * Careful, root level is not cleaned up in increment stamp.
813 gtk_tree_model_sort_increment_stamp (tree_model_sort);
814 gtk_tree_path_free (path);
815 if (level == tree_model_sort->root)
817 gtk_tree_model_sort_free_level (tree_model_sort,
818 tree_model_sort->root);
819 tree_model_sort->root = NULL;
824 gtk_tree_model_sort_increment_stamp (tree_model_sort);
827 for (i = 0; i < level->array->len; i++)
828 if (elt->offset == g_array_index (level->array, SortElt, i).offset)
831 g_array_remove_index (level->array, i);
833 /* update all offsets */
834 for (i = 0; i < level->array->len; i++)
836 elt = & (g_array_index (level->array, SortElt, i));
837 if (elt->offset > offset)
840 elt->children->parent_elt = elt;
843 gtk_tree_path_free (path);
847 gtk_tree_model_sort_rows_reordered (GtkTreeModel *s_model,
859 GtkTreeModelSort *tree_model_sort = GTK_TREE_MODEL_SORT (data);
861 g_return_if_fail (new_order != NULL);
863 if (s_path == NULL || gtk_tree_path_get_indices (s_path) == NULL)
865 if (tree_model_sort->root == NULL)
867 path = gtk_tree_path_new ();
868 level = SORT_LEVEL (tree_model_sort->root);
872 path = gtk_real_tree_model_sort_convert_child_path_to_path (tree_model_sort, s_path, FALSE);
875 gtk_tree_model_get_iter (GTK_TREE_MODEL (data), &iter, path);
877 level = SORT_LEVEL (iter.user_data);
878 elt = SORT_ELT (iter.user_data2);
882 gtk_tree_path_free (path);
886 level = elt->children;
889 if (level->array->len < 2)
891 gtk_tree_path_free (path);
895 tmp_array = g_new (int, level->array->len);
896 for (i = 0; i < level->array->len; i++)
898 for (j = 0; j < level->array->len; j++)
900 if (g_array_index (level->array, SortElt, i).offset == new_order[j])
905 for (i = 0; i < level->array->len; i++)
906 g_array_index (level->array, SortElt, i).offset = tmp_array[i];
909 if (tree_model_sort->sort_column_id == GTK_TREE_SORTABLE_DEFAULT_SORT_COLUMN_ID &&
910 tree_model_sort->default_sort_func == NO_SORT_FUNC)
913 gtk_tree_model_sort_sort_level (tree_model_sort, level,
915 gtk_tree_model_sort_increment_stamp (tree_model_sort);
917 if (gtk_tree_path_get_depth (path))
919 gtk_tree_model_get_iter (GTK_TREE_MODEL (tree_model_sort),
922 gtk_tree_model_rows_reordered (GTK_TREE_MODEL (tree_model_sort),
923 path, &iter, new_order);
927 gtk_tree_model_rows_reordered (GTK_TREE_MODEL (tree_model_sort),
928 path, NULL, new_order);
932 gtk_tree_path_free (path);
935 /* Fulfill our model requirements */
936 static GtkTreeModelFlags
937 gtk_tree_model_sort_get_flags (GtkTreeModel *tree_model)
939 GtkTreeModelFlags flags;
941 g_return_val_if_fail (GTK_IS_TREE_MODEL_SORT (tree_model), 0);
942 g_return_val_if_fail (GTK_TREE_MODEL_SORT (tree_model)->child_model != NULL, 0);
944 flags = gtk_tree_model_get_flags (GTK_TREE_MODEL_SORT (tree_model)->child_model);
946 if ((flags & GTK_TREE_MODEL_LIST_ONLY) == GTK_TREE_MODEL_LIST_ONLY)
947 return GTK_TREE_MODEL_LIST_ONLY;
953 gtk_tree_model_sort_get_n_columns (GtkTreeModel *tree_model)
955 GtkTreeModelSort *tree_model_sort = (GtkTreeModelSort *) tree_model;
957 g_return_val_if_fail (GTK_IS_TREE_MODEL_SORT (tree_model), 0);
959 if (tree_model_sort->child_model == 0)
962 return gtk_tree_model_get_n_columns (tree_model_sort->child_model);
966 gtk_tree_model_sort_get_column_type (GtkTreeModel *tree_model,
969 g_return_val_if_fail (GTK_IS_TREE_MODEL_SORT (tree_model), G_TYPE_INVALID);
970 g_return_val_if_fail (GTK_TREE_MODEL_SORT (tree_model)->child_model != NULL, G_TYPE_INVALID);
972 return gtk_tree_model_get_column_type (GTK_TREE_MODEL_SORT (tree_model)->child_model, index);
976 gtk_tree_model_sort_get_iter (GtkTreeModel *tree_model,
980 GtkTreeModelSort *tree_model_sort;
985 g_return_val_if_fail (GTK_IS_TREE_MODEL_SORT (tree_model), FALSE);
986 g_return_val_if_fail (GTK_TREE_MODEL_SORT (tree_model)->child_model != NULL, FALSE);
988 tree_model_sort = (GtkTreeModelSort *) tree_model;
989 indices = gtk_tree_path_get_indices (path);
991 if (tree_model_sort->root == NULL)
992 gtk_tree_model_sort_build_level (tree_model_sort, NULL, NULL);
993 level = SORT_LEVEL (tree_model_sort->root);
995 depth = gtk_tree_path_get_depth (path);
999 for (i = 0; i < depth - 1; i++)
1001 if ((level == NULL) ||
1002 (indices[i] >= level->array->len))
1005 if (g_array_index (level->array, SortElt, indices[i]).children == NULL)
1006 gtk_tree_model_sort_build_level (tree_model_sort, level, &g_array_index (level->array, SortElt, indices[i]));
1007 level = g_array_index (level->array, SortElt, indices[i]).children;
1010 if (!level || indices[i] >= level->array->len)
1016 iter->stamp = tree_model_sort->stamp;
1017 iter->user_data = level;
1018 iter->user_data2 = &g_array_index (level->array, SortElt, indices[depth - 1]);
1023 static GtkTreePath *
1024 gtk_tree_model_sort_get_path (GtkTreeModel *tree_model,
1027 GtkTreePath *retval;
1031 g_return_val_if_fail (GTK_IS_TREE_MODEL_SORT (tree_model), NULL);
1032 g_return_val_if_fail (GTK_TREE_MODEL_SORT (tree_model)->child_model != NULL, NULL);
1033 g_return_val_if_fail (GTK_TREE_MODEL_SORT (tree_model)->stamp == iter->stamp, NULL);
1035 retval = gtk_tree_path_new ();
1036 level = iter->user_data;
1037 elt = iter->user_data2;
1038 while (level != NULL)
1040 gtk_tree_path_prepend_index (retval, elt - (SortElt *)level->array->data);
1042 elt = level->parent_elt;
1043 level = level->parent_level;
1050 gtk_tree_model_sort_get_value (GtkTreeModel *tree_model,
1055 GtkTreeIter child_iter;
1057 g_return_if_fail (GTK_IS_TREE_MODEL_SORT (tree_model));
1058 g_return_if_fail (GTK_TREE_MODEL_SORT (tree_model)->child_model != NULL);
1059 g_return_if_fail (GTK_TREE_MODEL_SORT (tree_model)->stamp == iter->stamp);
1061 GET_CHILD_ITER (tree_model, &child_iter, iter);
1062 gtk_tree_model_get_value (GTK_TREE_MODEL_SORT (tree_model)->child_model,
1063 &child_iter, column, value);
1067 gtk_tree_model_sort_iter_next (GtkTreeModel *tree_model,
1073 g_return_val_if_fail (GTK_IS_TREE_MODEL_SORT (tree_model), FALSE);
1074 g_return_val_if_fail (GTK_TREE_MODEL_SORT (tree_model)->child_model != NULL, FALSE);
1075 g_return_val_if_fail (GTK_TREE_MODEL_SORT (tree_model)->stamp == iter->stamp, FALSE);
1077 level = iter->user_data;
1078 elt = iter->user_data2;
1080 if (elt - (SortElt *)level->array->data >= level->array->len - 1)
1085 iter->user_data2 = elt + 1;
1091 gtk_tree_model_sort_iter_children (GtkTreeModel *tree_model,
1093 GtkTreeIter *parent)
1095 GtkTreeModelSort *tree_model_sort = (GtkTreeModelSort *) tree_model;
1099 g_return_val_if_fail (GTK_IS_TREE_MODEL_SORT (tree_model), FALSE);
1100 g_return_val_if_fail (tree_model_sort->child_model != NULL, FALSE);
1101 if (parent) g_return_val_if_fail (tree_model_sort->stamp == parent->stamp, FALSE);
1105 if (tree_model_sort->root == NULL)
1106 gtk_tree_model_sort_build_level (tree_model_sort, NULL, NULL);
1107 if (tree_model_sort->root == NULL)
1110 level = tree_model_sort->root;
1111 iter->stamp = tree_model_sort->stamp;
1112 iter->user_data = level;
1113 iter->user_data2 = level->array->data;
1117 if (((SortElt *)parent->user_data2)->children == NULL)
1118 gtk_tree_model_sort_build_level (tree_model_sort,
1119 (SortLevel *)parent->user_data,
1120 (SortElt *)parent->user_data2);
1121 if (((SortElt *)parent->user_data2)->children == NULL)
1123 iter->stamp = tree_model_sort->stamp;
1124 iter->user_data = ((SortElt *)parent->user_data2)->children;
1125 iter->user_data2 = ((SortLevel *)iter->user_data)->array->data;
1132 gtk_tree_model_sort_iter_has_child (GtkTreeModel *tree_model,
1135 GtkTreeIter child_iter;
1137 g_return_val_if_fail (GTK_IS_TREE_MODEL_SORT (tree_model), FALSE);
1138 g_return_val_if_fail (GTK_TREE_MODEL_SORT (tree_model)->child_model != NULL, FALSE);
1139 g_return_val_if_fail (GTK_TREE_MODEL_SORT (tree_model)->stamp == iter->stamp, FALSE);
1141 GET_CHILD_ITER (tree_model, &child_iter, iter);
1143 return gtk_tree_model_iter_has_child (GTK_TREE_MODEL_SORT (tree_model)->child_model, &child_iter);
1147 gtk_tree_model_sort_iter_n_children (GtkTreeModel *tree_model,
1150 GtkTreeIter child_iter;
1152 g_return_val_if_fail (GTK_IS_TREE_MODEL_SORT (tree_model), 0);
1153 g_return_val_if_fail (GTK_TREE_MODEL_SORT (tree_model)->child_model != NULL, 0);
1154 if (iter) g_return_val_if_fail (GTK_TREE_MODEL_SORT (tree_model)->stamp == iter->stamp, 0);
1157 return gtk_tree_model_iter_n_children (GTK_TREE_MODEL_SORT (tree_model)->child_model, NULL);
1159 GET_CHILD_ITER (tree_model, &child_iter, iter);
1161 return gtk_tree_model_iter_n_children (GTK_TREE_MODEL_SORT (tree_model)->child_model, &child_iter);
1165 gtk_tree_model_sort_iter_nth_child (GtkTreeModel *tree_model,
1167 GtkTreeIter *parent,
1171 /* We have this for the iter == parent case */
1172 GtkTreeIter children;
1174 g_return_val_if_fail (GTK_IS_TREE_MODEL_SORT (tree_model), FALSE);
1175 if (parent) g_return_val_if_fail (GTK_TREE_MODEL_SORT (tree_model)->stamp == parent->stamp, FALSE);
1177 /* Use this instead of has_child to force us to build the level, if needed */
1178 if (gtk_tree_model_sort_iter_children (tree_model, &children, parent) == FALSE)
1184 level = children.user_data;
1185 if (n >= level->array->len)
1191 iter->stamp = GTK_TREE_MODEL_SORT (tree_model)->stamp;
1192 iter->user_data = level;
1193 iter->user_data2 = &g_array_index (level->array, SortElt, n);
1199 gtk_tree_model_sort_iter_parent (GtkTreeModel *tree_model,
1206 g_return_val_if_fail (GTK_IS_TREE_MODEL_SORT (tree_model), FALSE);
1207 g_return_val_if_fail (GTK_TREE_MODEL_SORT (tree_model)->child_model != NULL, FALSE);
1208 g_return_val_if_fail (GTK_TREE_MODEL_SORT (tree_model)->stamp == child->stamp, FALSE);
1210 level = child->user_data;
1212 if (level->parent_level)
1214 iter->stamp = GTK_TREE_MODEL_SORT (tree_model)->stamp;
1215 iter->user_data = level->parent_level;
1216 iter->user_data2 = level->parent_elt;
1224 gtk_tree_model_sort_ref_node (GtkTreeModel *tree_model,
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 gtk_tree_model_ref_node (GTK_TREE_MODEL_SORT (tree_model)->child_model, &child_iter);
1240 level = iter->user_data;
1241 elt = iter->user_data2;
1245 if (level->ref_count == 1)
1247 SortLevel *parent_level = level->parent_level;
1248 SortElt *parent_elt = level->parent_elt;
1249 /* We were at zero -- time to decrement the zero_ref_count val */
1253 parent_elt->zero_ref_count--;
1255 tree_model_sort->zero_ref_count--;
1259 parent_elt = parent_level->parent_elt;
1260 parent_level = parent_level->parent_level;
1263 while (parent_level);
1268 gtk_tree_model_sort_real_unref_node (GtkTreeModel *tree_model,
1270 gboolean propagate_unref)
1272 GtkTreeModelSort *tree_model_sort = (GtkTreeModelSort *) tree_model;
1276 g_return_if_fail (GTK_IS_TREE_MODEL_SORT (tree_model));
1277 g_return_if_fail (GTK_TREE_MODEL_SORT (tree_model)->child_model != NULL);
1278 g_return_if_fail (GTK_TREE_MODEL_SORT (tree_model)->stamp == iter->stamp);
1280 if (propagate_unref)
1282 GtkTreeIter child_iter;
1284 GET_CHILD_ITER (tree_model, &child_iter, iter);
1285 gtk_tree_model_unref_node (GTK_TREE_MODEL_SORT (tree_model)->child_model, &child_iter);
1288 level = iter->user_data;
1289 elt = iter->user_data2;
1291 g_return_if_fail (elt->ref_count > 0);
1296 if (level->ref_count == 0)
1298 SortLevel *parent_level = level->parent_level;
1299 SortElt *parent_elt = level->parent_elt;
1301 /* We are at zero -- time to increment the zero_ref_count val */
1302 while (parent_level)
1304 parent_elt->zero_ref_count++;
1306 parent_elt = parent_level->parent_elt;
1307 parent_level = parent_level->parent_level;
1309 tree_model_sort->zero_ref_count++;
1314 gtk_tree_model_sort_unref_node (GtkTreeModel *tree_model,
1317 gtk_tree_model_sort_real_unref_node (tree_model, iter, TRUE);
1320 /* Sortable interface */
1322 gtk_tree_model_sort_get_sort_column_id (GtkTreeSortable *sortable,
1323 gint *sort_column_id,
1326 GtkTreeModelSort *tree_model_sort = (GtkTreeModelSort *)sortable;
1328 g_return_val_if_fail (GTK_IS_TREE_MODEL_SORT (sortable), FALSE);
1331 *sort_column_id = tree_model_sort->sort_column_id;
1333 *order = tree_model_sort->order;
1335 if (tree_model_sort->sort_column_id == GTK_TREE_SORTABLE_DEFAULT_SORT_COLUMN_ID ||
1336 tree_model_sort->sort_column_id == GTK_TREE_SORTABLE_UNSORTED_SORT_COLUMN_ID)
1343 gtk_tree_model_sort_set_sort_column_id (GtkTreeSortable *sortable,
1344 gint sort_column_id,
1347 GtkTreeModelSort *tree_model_sort = (GtkTreeModelSort *)sortable;
1349 g_return_if_fail (GTK_IS_TREE_MODEL_SORT (sortable));
1351 if (sort_column_id != GTK_TREE_SORTABLE_DEFAULT_SORT_COLUMN_ID)
1353 GtkTreeDataSortHeader *header = NULL;
1355 header = _gtk_tree_data_list_get_header (tree_model_sort->sort_list,
1358 /* we want to make sure that we have a function */
1359 g_return_if_fail (header != NULL);
1360 g_return_if_fail (header->func != NULL);
1363 g_return_if_fail (tree_model_sort->default_sort_func != NULL);
1365 if (tree_model_sort->sort_column_id == sort_column_id)
1367 if (sort_column_id != GTK_TREE_SORTABLE_DEFAULT_SORT_COLUMN_ID)
1369 if (tree_model_sort->order == order)
1376 tree_model_sort->sort_column_id = sort_column_id;
1377 tree_model_sort->order = order;
1379 gtk_tree_sortable_sort_column_changed (sortable);
1381 gtk_tree_model_sort_sort (tree_model_sort);
1385 gtk_tree_model_sort_set_sort_func (GtkTreeSortable *sortable,
1386 gint sort_column_id,
1387 GtkTreeIterCompareFunc func,
1389 GtkDestroyNotify destroy)
1391 GtkTreeModelSort *tree_model_sort = (GtkTreeModelSort *) sortable;
1393 g_return_if_fail (GTK_IS_TREE_MODEL_SORT (sortable));
1394 g_return_if_fail (func != NULL);
1396 tree_model_sort->sort_list = _gtk_tree_data_list_set_header (tree_model_sort->sort_list,
1398 func, data, destroy);
1400 if (tree_model_sort->sort_column_id == sort_column_id)
1401 gtk_tree_model_sort_sort (tree_model_sort);
1405 gtk_tree_model_sort_set_default_sort_func (GtkTreeSortable *sortable,
1406 GtkTreeIterCompareFunc func,
1408 GtkDestroyNotify destroy)
1410 GtkTreeModelSort *tree_model_sort = (GtkTreeModelSort *)sortable;
1412 g_return_if_fail (GTK_IS_TREE_MODEL_SORT (sortable));
1414 if (tree_model_sort->default_sort_destroy)
1416 GtkDestroyNotify d = tree_model_sort->default_sort_destroy;
1418 tree_model_sort->default_sort_destroy = NULL;
1419 d (tree_model_sort->default_sort_data);
1422 tree_model_sort->default_sort_func = func;
1423 tree_model_sort->default_sort_data = data;
1424 tree_model_sort->default_sort_destroy = destroy;
1426 if (tree_model_sort->sort_column_id == GTK_TREE_SORTABLE_DEFAULT_SORT_COLUMN_ID)
1427 gtk_tree_model_sort_sort (tree_model_sort);
1431 gtk_tree_model_sort_has_default_sort_func (GtkTreeSortable *sortable)
1433 GtkTreeModelSort *tree_model_sort = (GtkTreeModelSort *)sortable;
1435 g_return_val_if_fail (GTK_IS_TREE_MODEL_SORT (sortable), FALSE);
1437 return (tree_model_sort->default_sort_func != NULL);
1440 /* DragSource interface */
1442 gtk_tree_model_sort_row_draggable (GtkTreeDragSource *drag_source,
1445 GtkTreeModelSort *tree_model_sort = (GtkTreeModelSort *)drag_source;
1446 GtkTreePath *child_path;
1449 g_return_val_if_fail (GTK_IS_TREE_MODEL_SORT (drag_source), FALSE);
1450 g_return_val_if_fail (path != NULL, FALSE);
1452 child_path = gtk_tree_model_sort_convert_path_to_child_path (tree_model_sort,
1454 draggable = gtk_tree_drag_source_row_draggable (GTK_TREE_DRAG_SOURCE (tree_model_sort->child_model), child_path);
1455 gtk_tree_path_free (child_path);
1461 gtk_tree_model_sort_drag_data_get (GtkTreeDragSource *drag_source,
1463 GtkSelectionData *selection_data)
1465 GtkTreeModelSort *tree_model_sort = (GtkTreeModelSort *)drag_source;
1466 GtkTreePath *child_path;
1469 g_return_val_if_fail (GTK_IS_TREE_MODEL_SORT (drag_source), FALSE);
1470 g_return_val_if_fail (path != NULL, FALSE);
1472 child_path = gtk_tree_model_sort_convert_path_to_child_path (tree_model_sort,
1474 gotten = gtk_tree_drag_source_drag_data_get (GTK_TREE_DRAG_SOURCE (tree_model_sort->child_model), child_path, selection_data);
1475 gtk_tree_path_free (child_path);
1481 gtk_tree_model_sort_drag_data_delete (GtkTreeDragSource *drag_source,
1484 GtkTreeModelSort *tree_model_sort = (GtkTreeModelSort *)drag_source;
1485 GtkTreePath *child_path;
1488 g_return_val_if_fail (GTK_IS_TREE_MODEL_SORT (drag_source), FALSE);
1489 g_return_val_if_fail (path != NULL, FALSE);
1491 child_path = gtk_tree_model_sort_convert_path_to_child_path (tree_model_sort,
1493 deleted = gtk_tree_drag_source_drag_data_delete (GTK_TREE_DRAG_SOURCE (tree_model_sort->child_model), child_path);
1494 gtk_tree_path_free (child_path);
1499 /* sorting code - private */
1501 gtk_tree_model_sort_compare_func (gconstpointer a,
1505 SortData *data = (SortData *)user_data;
1506 GtkTreeModelSort *tree_model_sort = data->tree_model_sort;
1507 SortTuple *sa = (SortTuple *)a;
1508 SortTuple *sb = (SortTuple *)b;
1510 GtkTreeIter iter_a, iter_b;
1513 /* shortcut, if we've the same offsets here, they should be equal */
1514 if (sa->offset == sb->offset)
1517 if (GTK_TREE_MODEL_SORT_CACHE_CHILD_ITERS (tree_model_sort))
1519 iter_a = sa->elt->iter;
1520 iter_b = sb->elt->iter;
1524 data->parent_path_indices [data->parent_path_depth-1] = sa->elt->offset;
1525 gtk_tree_model_get_iter (GTK_TREE_MODEL (tree_model_sort->child_model), &iter_a, data->parent_path);
1526 data->parent_path_indices [data->parent_path_depth-1] = sb->elt->offset;
1527 gtk_tree_model_get_iter (GTK_TREE_MODEL (tree_model_sort->child_model), &iter_b, data->parent_path);
1530 retval = (* data->sort_func) (GTK_TREE_MODEL (tree_model_sort->child_model),
1534 if (tree_model_sort->order == GTK_SORT_DESCENDING)
1538 else if (retval < 0)
1546 gtk_tree_model_sort_offset_compare_func (gconstpointer a,
1552 SortTuple *sa = (SortTuple *)a;
1553 SortTuple *sb = (SortTuple *)b;
1555 SortData *data = (SortData *)user_data;
1557 if (sa->elt->offset < sb->elt->offset)
1559 else if (sa->elt->offset > sb->elt->offset)
1564 if (data->tree_model_sort->order == GTK_SORT_DESCENDING)
1568 else if (retval < 0)
1576 gtk_tree_model_sort_sort_level (GtkTreeModelSort *tree_model_sort,
1579 gboolean emit_reordered)
1591 g_return_if_fail (GTK_IS_TREE_MODEL_SORT (tree_model_sort));
1592 g_return_if_fail (level != NULL);
1594 if (level->array->len < 1 && !((SortElt *)level->array->data)->children)
1600 data.tree_model_sort = tree_model_sort;
1601 if (level->parent_elt)
1603 data.parent_path = gtk_tree_model_sort_elt_get_path (level->parent_level,
1605 gtk_tree_path_append_index (data.parent_path, 0);
1609 data.parent_path = gtk_tree_path_new_first ();
1611 data.parent_path_depth = gtk_tree_path_get_depth (data.parent_path);
1612 data.parent_path_indices = gtk_tree_path_get_indices (data.parent_path);
1614 /* make the array to be sorted */
1615 sort_array = g_array_sized_new (FALSE, FALSE, sizeof (SortTuple), level->array->len);
1616 for (i = 0; i < level->array->len; i++)
1620 tuple.elt = &g_array_index (level->array, SortElt, i);
1623 g_array_append_val (sort_array, tuple);
1626 if (tree_model_sort->sort_column_id != GTK_TREE_SORTABLE_DEFAULT_SORT_COLUMN_ID)
1628 GtkTreeDataSortHeader *header = NULL;
1630 header = _gtk_tree_data_list_get_header (tree_model_sort->sort_list,
1631 tree_model_sort->sort_column_id);
1633 g_return_if_fail (header != NULL);
1634 g_return_if_fail (header->func != NULL);
1636 data.sort_func = header->func;
1637 data.sort_data = header->data;
1641 /* absolutely SHOULD NOT happen: */
1642 g_return_if_fail (tree_model_sort->default_sort_func != NULL);
1644 data.sort_func = tree_model_sort->default_sort_func;
1645 data.sort_data = tree_model_sort->default_sort_data;
1648 if (data.sort_func == NO_SORT_FUNC)
1649 g_array_sort_with_data (sort_array,
1650 gtk_tree_model_sort_offset_compare_func,
1653 g_array_sort_with_data (sort_array,
1654 gtk_tree_model_sort_compare_func,
1657 gtk_tree_path_free (data.parent_path);
1659 new_array = g_array_sized_new (FALSE, FALSE, sizeof (SortElt), level->array->len);
1660 new_order = g_new (gint, level->array->len);
1662 for (i = 0; i < level->array->len; i++)
1666 elt = g_array_index (sort_array, SortTuple, i).elt;
1667 new_order[i] = g_array_index (sort_array, SortTuple, i).offset;
1669 g_array_append_val (new_array, *elt);
1670 elt = &g_array_index (new_array, SortElt, i);
1672 elt->children->parent_elt = elt;
1675 g_array_free (level->array, TRUE);
1676 level->array = new_array;
1677 g_array_free (sort_array, TRUE);
1681 gtk_tree_model_sort_increment_stamp (tree_model_sort);
1682 if (level->parent_elt)
1684 iter.stamp = tree_model_sort->stamp;
1685 iter.user_data = level->parent_level;
1686 iter.user_data2 = level->parent_elt;
1688 path = gtk_tree_model_get_path (GTK_TREE_MODEL (tree_model_sort),
1691 gtk_tree_model_rows_reordered (GTK_TREE_MODEL (tree_model_sort), path,
1697 path = gtk_tree_path_new ();
1698 gtk_tree_model_rows_reordered (GTK_TREE_MODEL (tree_model_sort), path,
1702 gtk_tree_path_free (path);
1705 /* recurse, if possible */
1708 for (i = 0; i < level->array->len; i++)
1710 SortElt *elt = &g_array_index (level->array, SortElt, i);
1713 gtk_tree_model_sort_sort_level (tree_model_sort,
1715 TRUE, emit_reordered);
1725 gtk_tree_model_sort_sort (GtkTreeModelSort *tree_model_sort)
1727 g_return_if_fail (GTK_IS_TREE_MODEL_SORT (tree_model_sort));
1729 if (!tree_model_sort->root)
1732 if (tree_model_sort->sort_column_id != GTK_TREE_SORTABLE_DEFAULT_SORT_COLUMN_ID)
1734 GtkTreeDataSortHeader *header = NULL;
1736 header = _gtk_tree_data_list_get_header (tree_model_sort->sort_list,
1737 tree_model_sort->sort_column_id);
1739 /* we want to make sure that we have a function */
1740 g_return_if_fail (header != NULL);
1741 g_return_if_fail (header->func != NULL);
1744 g_return_if_fail (tree_model_sort->default_sort_func != NULL);
1746 gtk_tree_model_sort_sort_level (tree_model_sort, tree_model_sort->root,
1750 /* signal helpers */
1752 gtk_tree_model_sort_level_find_insert (GtkTreeModelSort *tree_model_sort,
1757 gint start, middle, end;
1760 GtkTreeIter tmp_iter;
1762 GtkTreeIterCompareFunc func;
1765 if (tree_model_sort->sort_column_id != GTK_TREE_SORTABLE_DEFAULT_SORT_COLUMN_ID)
1767 GtkTreeDataSortHeader *header;
1769 header = _gtk_tree_data_list_get_header (tree_model_sort->sort_list,
1770 tree_model_sort->sort_column_id);
1772 g_return_val_if_fail (header != NULL, 0);
1774 func = header->func;
1775 data = header->data;
1779 func = tree_model_sort->default_sort_func;
1780 data = tree_model_sort->default_sort_data;
1782 g_return_val_if_fail (func != NO_SORT_FUNC, 0);
1785 g_return_val_if_fail (func != NULL, 0);
1788 end = level->array->len;
1797 while (start != end)
1799 middle = (start + end) / 2;
1801 if (middle < skip_index)
1802 tmp_elt = &(g_array_index (level->array, SortElt, middle));
1804 tmp_elt = &(g_array_index (level->array, SortElt, middle + 1));
1806 if (!GTK_TREE_MODEL_SORT_CACHE_CHILD_ITERS (tree_model_sort))
1808 GtkTreePath *path = gtk_tree_model_sort_elt_get_path (level, tmp_elt);
1809 gtk_tree_model_get_iter (tree_model_sort->child_model,
1811 gtk_tree_path_free (path);
1814 tmp_iter = tmp_elt->iter;
1816 if (tree_model_sort->order == GTK_SORT_ASCENDING)
1817 cmp = (* func) (GTK_TREE_MODEL (tree_model_sort->child_model),
1818 &tmp_iter, iter, data);
1820 cmp = (* func) (GTK_TREE_MODEL (tree_model_sort->child_model),
1821 iter, &tmp_iter, data);
1836 gtk_tree_model_sort_insert_value (GtkTreeModelSort *tree_model_sort,
1838 GtkTreePath *s_path,
1839 GtkTreeIter *s_iter)
1841 gint offset, index, i;
1846 offset = gtk_tree_path_get_indices (s_path)[gtk_tree_path_get_depth (s_path) - 1];
1848 if (GTK_TREE_MODEL_SORT_CACHE_CHILD_ITERS (tree_model_sort))
1850 elt.offset = offset;
1851 elt.zero_ref_count = 0;
1853 elt.children = NULL;
1855 /* update all larger offsets */
1856 tmp_elt = SORT_ELT (level->array->data);
1857 for (i = 0; i < level->array->len; i++, tmp_elt++)
1858 if (tmp_elt->offset >= offset)
1861 if (tree_model_sort->sort_column_id == GTK_TREE_SORTABLE_DEFAULT_SORT_COLUMN_ID &&
1862 tree_model_sort->default_sort_func == NO_SORT_FUNC)
1865 index = gtk_tree_model_sort_level_find_insert (tree_model_sort,
1869 g_array_insert_vals (level->array, index, &elt, 1);
1870 tmp_elt = SORT_ELT (level->array->data);
1871 for (i = 0; i < level->array->len; i++, tmp_elt++)
1872 if (tmp_elt->children)
1873 tmp_elt->children->parent_elt = tmp_elt;
1878 /* sort elt stuff */
1879 static GtkTreePath *
1880 gtk_tree_model_sort_elt_get_path (SortLevel *level,
1883 SortLevel *walker = level;
1884 SortElt *walker2 = elt;
1887 g_return_val_if_fail (level != NULL, NULL);
1888 g_return_val_if_fail (elt != NULL, NULL);
1890 path = gtk_tree_path_new ();
1894 gtk_tree_path_prepend_index (path, walker2->offset);
1896 walker2 = walker->parent_elt;
1897 walker = walker->parent_level;
1904 * gtk_tree_model_sort_set_model:
1905 * @tree_model_sort: The #GtkTreeModelSort.
1906 * @child_model: A #GtkTreeModel, or %NULL.
1908 * Sets the model of @tree_model_sort to be @model. If @model is %NULL,
1909 * then the old model is unset. The sort function is unset as a result
1910 * of this call. The model will be in an unsorted state until a sort
1914 gtk_tree_model_sort_set_model (GtkTreeModelSort *tree_model_sort,
1915 GtkTreeModel *child_model)
1917 g_return_if_fail (GTK_IS_TREE_MODEL_SORT (tree_model_sort));
1920 g_object_ref (child_model);
1922 if (tree_model_sort->child_model)
1924 g_signal_handler_disconnect (tree_model_sort->child_model,
1925 tree_model_sort->changed_id);
1926 g_signal_handler_disconnect (tree_model_sort->child_model,
1927 tree_model_sort->inserted_id);
1928 g_signal_handler_disconnect (tree_model_sort->child_model,
1929 tree_model_sort->has_child_toggled_id);
1930 g_signal_handler_disconnect (tree_model_sort->child_model,
1931 tree_model_sort->deleted_id);
1932 g_signal_handler_disconnect (tree_model_sort->child_model,
1933 tree_model_sort->reordered_id);
1935 /* reset our state */
1936 if (tree_model_sort->root)
1937 gtk_tree_model_sort_free_level (tree_model_sort, tree_model_sort->root);
1938 tree_model_sort->root = NULL;
1939 _gtk_tree_data_list_header_free (tree_model_sort->sort_list);
1940 tree_model_sort->sort_list = NULL;
1941 g_object_unref (tree_model_sort->child_model);
1944 tree_model_sort->child_model = child_model;
1951 tree_model_sort->changed_id =
1952 g_signal_connect (child_model, "row_changed",
1953 G_CALLBACK (gtk_tree_model_sort_row_changed),
1955 tree_model_sort->inserted_id =
1956 g_signal_connect (child_model, "row_inserted",
1957 G_CALLBACK (gtk_tree_model_sort_row_inserted),
1959 tree_model_sort->has_child_toggled_id =
1960 g_signal_connect (child_model, "row_has_child_toggled",
1961 G_CALLBACK (gtk_tree_model_sort_row_has_child_toggled),
1963 tree_model_sort->deleted_id =
1964 g_signal_connect (child_model, "row_deleted",
1965 G_CALLBACK (gtk_tree_model_sort_row_deleted),
1967 tree_model_sort->reordered_id =
1968 g_signal_connect (child_model, "rows_reordered",
1969 G_CALLBACK (gtk_tree_model_sort_rows_reordered),
1972 tree_model_sort->child_flags = gtk_tree_model_get_flags (child_model);
1973 n_columns = gtk_tree_model_get_n_columns (child_model);
1975 types = g_new (GType, n_columns);
1976 for (i = 0; i < n_columns; i++)
1977 types[i] = gtk_tree_model_get_column_type (child_model, i);
1979 tree_model_sort->sort_list = _gtk_tree_data_list_header_new (n_columns, types);
1982 tree_model_sort->default_sort_func = NO_SORT_FUNC;
1983 tree_model_sort->stamp = g_random_int ();
1988 * gtk_tree_model_sort_get_model:
1989 * @tree_model: a #GtkTreeModelSort
1991 * Returns the model the #GtkTreeModelSort is sorting.
1993 * Return value: the "child model" being sorted
1996 gtk_tree_model_sort_get_model (GtkTreeModelSort *tree_model)
1998 g_return_val_if_fail (GTK_IS_TREE_MODEL_SORT (tree_model), NULL);
2000 return tree_model->child_model;
2004 static GtkTreePath *
2005 gtk_real_tree_model_sort_convert_child_path_to_path (GtkTreeModelSort *tree_model_sort,
2006 GtkTreePath *child_path,
2007 gboolean build_levels)
2009 gint *child_indices;
2010 GtkTreePath *retval;
2014 g_return_val_if_fail (GTK_IS_TREE_MODEL_SORT (tree_model_sort), NULL);
2015 g_return_val_if_fail (tree_model_sort->child_model != NULL, NULL);
2016 g_return_val_if_fail (child_path != NULL, NULL);
2018 retval = gtk_tree_path_new ();
2019 child_indices = gtk_tree_path_get_indices (child_path);
2021 if (tree_model_sort->root == NULL && build_levels)
2022 gtk_tree_model_sort_build_level (tree_model_sort, NULL, NULL);
2023 level = SORT_LEVEL (tree_model_sort->root);
2025 for (i = 0; i < gtk_tree_path_get_depth (child_path); i++)
2028 gboolean found_child = FALSE;
2032 gtk_tree_path_free (retval);
2036 if (child_indices[i] >= level->array->len)
2038 gtk_tree_path_free (retval);
2041 for (j = 0; j < level->array->len; j++)
2043 if ((g_array_index (level->array, SortElt, j)).offset == child_indices[i])
2045 gtk_tree_path_append_index (retval, j);
2046 if (g_array_index (level->array, SortElt, j).children == NULL && build_levels)
2048 gtk_tree_model_sort_build_level (tree_model_sort, level, &g_array_index (level->array, SortElt, j));
2050 level = g_array_index (level->array, SortElt, j).children;
2057 gtk_tree_path_free (retval);
2067 * gtk_tree_model_sort_convert_child_path_to_path:
2068 * @tree_model_sort: A #GtkTreeModelSort
2069 * @child_path: A #GtkTreePath to convert
2071 * Converts @child_path to a path relative to @tree_model_sort. That is,
2072 * @child_path points to a path in the child model. The returned path will
2073 * point to the same row in the sorted model. If @child_path isn't a valid
2074 * path on the child model, then %NULL is returned.
2076 * Return value: A newly allocated #GtkTreePath, or %NULL
2079 gtk_tree_model_sort_convert_child_path_to_path (GtkTreeModelSort *tree_model_sort,
2080 GtkTreePath *child_path)
2082 g_return_val_if_fail (GTK_IS_TREE_MODEL_SORT (tree_model_sort), NULL);
2083 g_return_val_if_fail (tree_model_sort->child_model != NULL, NULL);
2084 g_return_val_if_fail (child_path != NULL, NULL);
2086 return gtk_real_tree_model_sort_convert_child_path_to_path (tree_model_sort, child_path, TRUE);
2090 * gtk_tree_model_sort_convert_child_iter_to_iter:
2091 * @tree_model_sort: A #GtkTreeModelSort
2092 * @sort_iter: An uninitialized #GtkTreeIter.
2093 * @child_iter: A valid #GtkTreeIter pointing to a row on the child model
2095 * Sets @sort_iter to point to the row in @tree_model_sort that corresponds to
2096 * the row pointed at by @child_iter.
2099 gtk_tree_model_sort_convert_child_iter_to_iter (GtkTreeModelSort *tree_model_sort,
2100 GtkTreeIter *sort_iter,
2101 GtkTreeIter *child_iter)
2103 GtkTreePath *child_path, *path;
2105 g_return_if_fail (GTK_IS_TREE_MODEL_SORT (tree_model_sort));
2106 g_return_if_fail (tree_model_sort->child_model != NULL);
2107 g_return_if_fail (sort_iter != NULL);
2108 g_return_if_fail (child_iter != NULL);
2110 sort_iter->stamp = 0;
2112 child_path = gtk_tree_model_get_path (tree_model_sort->child_model, child_iter);
2113 g_return_if_fail (child_path != NULL);
2115 path = gtk_tree_model_sort_convert_child_path_to_path (tree_model_sort, child_path);
2116 gtk_tree_path_free (child_path);
2117 g_return_if_fail (path != NULL);
2119 gtk_tree_model_get_iter (GTK_TREE_MODEL (tree_model_sort), sort_iter, path);
2120 gtk_tree_path_free (path);
2124 * gtk_tree_model_sort_convert_path_to_child_path:
2125 * @tree_model_sort: A #GtkTreeModelSort
2126 * @sorted_path: A #GtkTreePath to convert
2128 * Converts @sorted_path to a path on the child model of @tree_model_sort.
2129 * That is, @sorted_path points to a location in @tree_model_sort. The
2130 * returned path will point to the same location in the model not being
2131 * sorted. If @sorted_path does not point to a location in the child model,
2132 * %NULL is returned.
2134 * Return value: A newly allocated #GtkTreePath, or %NULL
2137 gtk_tree_model_sort_convert_path_to_child_path (GtkTreeModelSort *tree_model_sort,
2138 GtkTreePath *sorted_path)
2140 gint *sorted_indices;
2141 GtkTreePath *retval;
2145 g_return_val_if_fail (GTK_IS_TREE_MODEL_SORT (tree_model_sort), NULL);
2146 g_return_val_if_fail (tree_model_sort->child_model != NULL, NULL);
2147 g_return_val_if_fail (sorted_path != NULL, NULL);
2149 retval = gtk_tree_path_new ();
2150 sorted_indices = gtk_tree_path_get_indices (sorted_path);
2151 if (tree_model_sort->root == NULL)
2152 gtk_tree_model_sort_build_level (tree_model_sort, NULL, NULL);
2153 level = SORT_LEVEL (tree_model_sort->root);
2155 for (i = 0; i < gtk_tree_path_get_depth (sorted_path); i++)
2157 gint count = sorted_indices[i];
2159 if ((level == NULL) ||
2160 (level->array->len <= count))
2162 gtk_tree_path_free (retval);
2166 if (g_array_index (level->array, SortElt, count).children == NULL)
2167 gtk_tree_model_sort_build_level (tree_model_sort, level, &g_array_index (level->array, SortElt, count));
2171 gtk_tree_path_free (retval);
2175 gtk_tree_path_append_index (retval, g_array_index (level->array, SortElt, count).offset);
2176 level = g_array_index (level->array, SortElt, count).children;
2183 * gtk_tree_model_sort_convert_iter_to_child_iter:
2184 * @tree_model_sort: A #GtkTreeModelSort
2185 * @child_iter: An uninitialized #GtkTreeIter
2186 * @sorted_iter: A valid #GtkTreeIter pointing to a row on @tree_model_sort.
2188 * Sets @child_iter to point to the row pointed to by @sorted_iter.
2191 gtk_tree_model_sort_convert_iter_to_child_iter (GtkTreeModelSort *tree_model_sort,
2192 GtkTreeIter *child_iter,
2193 GtkTreeIter *sorted_iter)
2195 g_return_if_fail (GTK_IS_TREE_MODEL_SORT (tree_model_sort));
2196 g_return_if_fail (tree_model_sort->child_model != NULL);
2197 g_return_if_fail (child_iter != NULL);
2198 g_return_if_fail (sorted_iter != NULL);
2199 g_return_if_fail (sorted_iter->stamp == tree_model_sort->stamp);
2201 if (GTK_TREE_MODEL_SORT_CACHE_CHILD_ITERS (tree_model_sort))
2203 *child_iter = SORT_ELT (sorted_iter->user_data2)->iter;
2209 path = gtk_tree_model_sort_elt_get_path (sorted_iter->user_data,
2210 sorted_iter->user_data2);
2211 gtk_tree_model_get_iter (tree_model_sort->child_model, child_iter, path);
2212 gtk_tree_path_free (path);
2217 gtk_tree_model_sort_build_level (GtkTreeModelSort *tree_model_sort,
2218 SortLevel *parent_level,
2219 SortElt *parent_elt)
2222 SortLevel *new_level;
2226 g_assert (tree_model_sort->child_model != NULL);
2228 if (parent_level == NULL)
2230 if (gtk_tree_model_get_iter_first (tree_model_sort->child_model, &iter) == FALSE)
2232 length = gtk_tree_model_iter_n_children (tree_model_sort->child_model, NULL);
2236 GtkTreeIter parent_iter;
2237 GtkTreeIter child_parent_iter;
2239 parent_iter.stamp = tree_model_sort->stamp;
2240 parent_iter.user_data = parent_level;
2241 parent_iter.user_data2 = parent_elt;
2243 gtk_tree_model_sort_convert_iter_to_child_iter (tree_model_sort,
2246 if (gtk_tree_model_iter_children (tree_model_sort->child_model,
2248 &child_parent_iter) == FALSE)
2251 /* stamp may have changed */
2252 gtk_tree_model_sort_convert_iter_to_child_iter (tree_model_sort,
2256 length = gtk_tree_model_iter_n_children (tree_model_sort->child_model, &child_parent_iter);
2259 g_return_if_fail (length > 0);
2261 new_level = g_new (SortLevel, 1);
2262 new_level->array = g_array_sized_new (FALSE, FALSE, sizeof (SortElt), length);
2263 new_level->ref_count = 0;
2264 new_level->parent_elt = parent_elt;
2265 new_level->parent_level = parent_level;
2268 parent_elt->children = new_level;
2270 tree_model_sort->root = new_level;
2272 /* increase the count of zero ref_counts.*/
2273 while (parent_level)
2275 parent_elt->zero_ref_count++;
2277 parent_elt = parent_level->parent_elt;
2278 parent_level = parent_level->parent_level;
2280 if (new_level != tree_model_sort->root)
2281 tree_model_sort->zero_ref_count++;
2283 for (i = 0; i < length; i++)
2286 sort_elt.offset = i;
2287 sort_elt.zero_ref_count = 0;
2288 sort_elt.ref_count = 0;
2289 sort_elt.children = NULL;
2291 if (GTK_TREE_MODEL_SORT_CACHE_CHILD_ITERS (tree_model_sort))
2293 sort_elt.iter = iter;
2294 if (gtk_tree_model_iter_next (tree_model_sort->child_model, &iter) == FALSE &&
2297 g_warning ("There is a discrepancy between the sort model and the child model.");
2301 g_array_append_val (new_level->array, sort_elt);
2305 gtk_tree_model_sort_sort_level (tree_model_sort, new_level,
2310 gtk_tree_model_sort_free_level (GtkTreeModelSort *tree_model_sort,
2311 SortLevel *sort_level)
2315 g_assert (sort_level);
2317 if (sort_level->ref_count == 0)
2319 SortLevel *parent_level = sort_level->parent_level;
2320 SortElt *parent_elt = sort_level->parent_elt;
2325 parent_elt->zero_ref_count--;
2327 tree_model_sort->zero_ref_count--;
2331 parent_elt = parent_level->parent_elt;
2332 parent_level = parent_level->parent_level;
2335 while (parent_level);
2338 for (i = 0; i < sort_level->array->len; i++)
2340 if (g_array_index (sort_level->array, SortElt, i).children)
2341 gtk_tree_model_sort_free_level (tree_model_sort,
2342 SORT_LEVEL(g_array_index (sort_level->array, SortElt, i).children));
2345 if (sort_level->parent_elt)
2346 sort_level->parent_elt->children = NULL;
2348 tree_model_sort->root = NULL;
2350 g_array_free (sort_level->array, TRUE);
2351 sort_level->array = NULL;
2353 g_free (sort_level);
2358 gtk_tree_model_sort_increment_stamp (GtkTreeModelSort *tree_model_sort)
2362 tree_model_sort->stamp++;
2364 while (tree_model_sort->stamp == 0);
2366 gtk_tree_model_sort_clear_cache (tree_model_sort);
2370 gtk_tree_model_sort_clear_cache_helper (GtkTreeModelSort *tree_model_sort,
2375 g_assert (level != NULL);
2377 for (i = 0; i < level->array->len; i++)
2379 if (g_array_index (level->array, SortElt, i).zero_ref_count > 0)
2380 gtk_tree_model_sort_clear_cache_helper (tree_model_sort, g_array_index (level->array, SortElt, i).children);
2383 if (level->ref_count == 0 && level != tree_model_sort->root)
2384 gtk_tree_model_sort_free_level (tree_model_sort, level);
2388 * gtk_tree_model_sort_reset_default_sort_func:
2389 * @tree_model_sort: A #GtkTreeModelSort
2391 * This resets the default sort function to be in the 'unsorted' state. That
2392 * is, it is in the same order as the child model. It will re-sort the model
2393 * to be in the same order as the child model only if the #GtkTreeModelSort
2394 * is in 'unsorted' state.
2397 gtk_tree_model_sort_reset_default_sort_func (GtkTreeModelSort *tree_model_sort)
2399 g_return_if_fail (GTK_IS_TREE_MODEL_SORT (tree_model_sort));
2401 if (tree_model_sort->default_sort_destroy)
2403 GtkDestroyNotify d = tree_model_sort->default_sort_destroy;
2405 tree_model_sort->default_sort_destroy = NULL;
2406 d (tree_model_sort->default_sort_data);
2409 tree_model_sort->default_sort_func = NO_SORT_FUNC;
2410 tree_model_sort->default_sort_data = NULL;
2411 tree_model_sort->default_sort_destroy = NULL;
2413 if (tree_model_sort->sort_column_id == GTK_TREE_SORTABLE_DEFAULT_SORT_COLUMN_ID)
2414 gtk_tree_model_sort_sort (tree_model_sort);
2415 tree_model_sort->sort_column_id = GTK_TREE_SORTABLE_DEFAULT_SORT_COLUMN_ID;
2419 * gtk_tree_model_sort_clear_cache:
2420 * @tree_model_sort: A #GtkTreeModelSort
2422 * This function should almost never be called. It clears the @tree_model_sort
2423 * of any cached iterators that haven't been reffed with
2424 * gtk_tree_model_ref_node(). This might be useful if the child model being
2425 * sorted is static (and doesn't change often) and there has been a lot of
2426 * unreffed access to nodes. As a side effect of this function, all unreffed
2427 * iters will be invalid.
2430 gtk_tree_model_sort_clear_cache (GtkTreeModelSort *tree_model_sort)
2432 g_return_if_fail (GTK_IS_TREE_MODEL_SORT (tree_model_sort));
2434 if (tree_model_sort->zero_ref_count)
2435 gtk_tree_model_sort_clear_cache_helper (tree_model_sort, (SortLevel *)tree_model_sort->root);
2439 gtk_tree_model_sort_iter_is_valid_helper (GtkTreeIter *iter,
2444 for (i = 0; i < level->array->len; i++)
2446 SortElt *elt = &g_array_index (level->array, SortElt, i);
2448 if (iter->user_data == level && iter->user_data2 == elt)
2452 if (gtk_tree_model_sort_iter_is_valid_helper (iter, elt->children))
2460 * gtk_tree_model_sort_iter_is_valid:
2461 * @tree_model_sort: A #GtkTreeModelSort.
2462 * @iter: A #GtkTreeIter.
2465 * This function is slow. Only use it for debugging and/or testing purposes.
2468 * Checks if the given iter is a valid iter for this #GtkTreeModelSort.
2470 * Return value: %TRUE if the iter is valid, %FALSE if the iter is invalid.
2475 gtk_tree_model_sort_iter_is_valid (GtkTreeModelSort *tree_model_sort,
2478 g_return_val_if_fail (GTK_IS_TREE_MODEL_SORT (tree_model_sort), FALSE);
2479 g_return_val_if_fail (iter != NULL, FALSE);
2481 if (!VALID_ITER (iter, tree_model_sort))
2484 return gtk_tree_model_sort_iter_is_valid_helper (iter,
2485 tree_model_sort->root);
2488 #define __GTK_TREE_MODEL_SORT_C__
2489 #include "gtkaliasdef.c"