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((GtkTreeModelSort*)(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_tree_model_init (GtkTreeModelIface *iface);
112 static void gtk_tree_model_sort_tree_sortable_init (GtkTreeSortableIface *iface);
113 static void gtk_tree_model_sort_drag_source_init (GtkTreeDragSourceIface*iface);
114 static void gtk_tree_model_sort_finalize (GObject *object);
115 static void gtk_tree_model_sort_set_property (GObject *object,
119 static void gtk_tree_model_sort_get_property (GObject *object,
124 /* our signal handlers */
125 static void gtk_tree_model_sort_row_changed (GtkTreeModel *model,
126 GtkTreePath *start_path,
127 GtkTreeIter *start_iter,
129 static void gtk_tree_model_sort_row_inserted (GtkTreeModel *model,
133 static void gtk_tree_model_sort_row_has_child_toggled (GtkTreeModel *model,
137 static void gtk_tree_model_sort_row_deleted (GtkTreeModel *model,
140 static void gtk_tree_model_sort_rows_reordered (GtkTreeModel *s_model,
146 /* TreeModel interface */
147 static GtkTreeModelFlags gtk_tree_model_sort_get_flags (GtkTreeModel *tree_model);
148 static gint gtk_tree_model_sort_get_n_columns (GtkTreeModel *tree_model);
149 static GType gtk_tree_model_sort_get_column_type (GtkTreeModel *tree_model,
151 static gboolean gtk_tree_model_sort_get_iter (GtkTreeModel *tree_model,
154 static GtkTreePath *gtk_tree_model_sort_get_path (GtkTreeModel *tree_model,
156 static void gtk_tree_model_sort_get_value (GtkTreeModel *tree_model,
160 static gboolean gtk_tree_model_sort_iter_next (GtkTreeModel *tree_model,
162 static gboolean gtk_tree_model_sort_iter_children (GtkTreeModel *tree_model,
164 GtkTreeIter *parent);
165 static gboolean gtk_tree_model_sort_iter_has_child (GtkTreeModel *tree_model,
167 static gint gtk_tree_model_sort_iter_n_children (GtkTreeModel *tree_model,
169 static gboolean gtk_tree_model_sort_iter_nth_child (GtkTreeModel *tree_model,
173 static gboolean gtk_tree_model_sort_iter_parent (GtkTreeModel *tree_model,
176 static void gtk_tree_model_sort_ref_node (GtkTreeModel *tree_model,
178 static void gtk_tree_model_sort_real_unref_node (GtkTreeModel *tree_model,
180 gboolean propagate_unref);
181 static void gtk_tree_model_sort_unref_node (GtkTreeModel *tree_model,
184 /* TreeDragSource interface */
185 static gboolean gtk_tree_model_sort_row_draggable (GtkTreeDragSource *drag_source,
187 static gboolean gtk_tree_model_sort_drag_data_get (GtkTreeDragSource *drag_source,
189 GtkSelectionData *selection_data);
190 static gboolean gtk_tree_model_sort_drag_data_delete (GtkTreeDragSource *drag_source,
193 /* TreeSortable interface */
194 static gboolean gtk_tree_model_sort_get_sort_column_id (GtkTreeSortable *sortable,
195 gint *sort_column_id,
197 static void gtk_tree_model_sort_set_sort_column_id (GtkTreeSortable *sortable,
200 static void gtk_tree_model_sort_set_sort_func (GtkTreeSortable *sortable,
202 GtkTreeIterCompareFunc func,
204 GDestroyNotify destroy);
205 static void gtk_tree_model_sort_set_default_sort_func (GtkTreeSortable *sortable,
206 GtkTreeIterCompareFunc func,
208 GDestroyNotify destroy);
209 static gboolean gtk_tree_model_sort_has_default_sort_func (GtkTreeSortable *sortable);
211 /* Private functions (sort funcs, level handling and other utils) */
212 static void gtk_tree_model_sort_build_level (GtkTreeModelSort *tree_model_sort,
213 SortLevel *parent_level,
214 SortElt *parent_elt);
215 static void gtk_tree_model_sort_free_level (GtkTreeModelSort *tree_model_sort,
216 SortLevel *sort_level);
217 static void gtk_tree_model_sort_increment_stamp (GtkTreeModelSort *tree_model_sort);
218 static void gtk_tree_model_sort_sort_level (GtkTreeModelSort *tree_model_sort,
221 gboolean emit_reordered);
222 static void gtk_tree_model_sort_sort (GtkTreeModelSort *tree_model_sort);
223 static gint gtk_tree_model_sort_level_find_insert (GtkTreeModelSort *tree_model_sort,
227 static gboolean gtk_tree_model_sort_insert_value (GtkTreeModelSort *tree_model_sort,
230 GtkTreeIter *s_iter);
231 static GtkTreePath *gtk_tree_model_sort_elt_get_path (SortLevel *level,
233 static void gtk_tree_model_sort_set_model (GtkTreeModelSort *tree_model_sort,
234 GtkTreeModel *child_model);
235 static GtkTreePath *gtk_real_tree_model_sort_convert_child_path_to_path (GtkTreeModelSort *tree_model_sort,
236 GtkTreePath *child_path,
237 gboolean build_levels);
240 G_DEFINE_TYPE_WITH_CODE (GtkTreeModelSort, gtk_tree_model_sort, G_TYPE_OBJECT,
241 G_IMPLEMENT_INTERFACE (GTK_TYPE_TREE_MODEL,
242 gtk_tree_model_sort_tree_model_init)
243 G_IMPLEMENT_INTERFACE (GTK_TYPE_TREE_SORTABLE,
244 gtk_tree_model_sort_tree_sortable_init)
245 G_IMPLEMENT_INTERFACE (GTK_TYPE_TREE_DRAG_SOURCE,
246 gtk_tree_model_sort_drag_source_init))
249 gtk_tree_model_sort_init (GtkTreeModelSort *tree_model_sort)
251 tree_model_sort->sort_column_id = GTK_TREE_SORTABLE_DEFAULT_SORT_COLUMN_ID;
252 tree_model_sort->stamp = 0;
253 tree_model_sort->zero_ref_count = 0;
254 tree_model_sort->root = NULL;
255 tree_model_sort->sort_list = NULL;
259 gtk_tree_model_sort_class_init (GtkTreeModelSortClass *class)
261 GObjectClass *object_class;
263 object_class = (GObjectClass *) class;
265 object_class->set_property = gtk_tree_model_sort_set_property;
266 object_class->get_property = gtk_tree_model_sort_get_property;
268 object_class->finalize = gtk_tree_model_sort_finalize;
271 g_object_class_install_property (object_class,
273 g_param_spec_object ("model",
274 P_("TreeModelSort Model"),
275 P_("The model for the TreeModelSort to sort"),
277 GTK_PARAM_READWRITE | G_PARAM_CONSTRUCT_ONLY));
281 gtk_tree_model_sort_tree_model_init (GtkTreeModelIface *iface)
283 iface->get_flags = gtk_tree_model_sort_get_flags;
284 iface->get_n_columns = gtk_tree_model_sort_get_n_columns;
285 iface->get_column_type = gtk_tree_model_sort_get_column_type;
286 iface->get_iter = gtk_tree_model_sort_get_iter;
287 iface->get_path = gtk_tree_model_sort_get_path;
288 iface->get_value = gtk_tree_model_sort_get_value;
289 iface->iter_next = gtk_tree_model_sort_iter_next;
290 iface->iter_children = gtk_tree_model_sort_iter_children;
291 iface->iter_has_child = gtk_tree_model_sort_iter_has_child;
292 iface->iter_n_children = gtk_tree_model_sort_iter_n_children;
293 iface->iter_nth_child = gtk_tree_model_sort_iter_nth_child;
294 iface->iter_parent = gtk_tree_model_sort_iter_parent;
295 iface->ref_node = gtk_tree_model_sort_ref_node;
296 iface->unref_node = gtk_tree_model_sort_unref_node;
300 gtk_tree_model_sort_tree_sortable_init (GtkTreeSortableIface *iface)
302 iface->get_sort_column_id = gtk_tree_model_sort_get_sort_column_id;
303 iface->set_sort_column_id = gtk_tree_model_sort_set_sort_column_id;
304 iface->set_sort_func = gtk_tree_model_sort_set_sort_func;
305 iface->set_default_sort_func = gtk_tree_model_sort_set_default_sort_func;
306 iface->has_default_sort_func = gtk_tree_model_sort_has_default_sort_func;
310 gtk_tree_model_sort_drag_source_init (GtkTreeDragSourceIface *iface)
312 iface->row_draggable = gtk_tree_model_sort_row_draggable;
313 iface->drag_data_delete = gtk_tree_model_sort_drag_data_delete;
314 iface->drag_data_get = gtk_tree_model_sort_drag_data_get;
318 * gtk_tree_model_sort_new_with_model:
319 * @child_model: A #GtkTreeModel
321 * Creates a new #GtkTreeModel, with @child_model as the child model.
323 * Return value: A new #GtkTreeModel.
326 gtk_tree_model_sort_new_with_model (GtkTreeModel *child_model)
328 GtkTreeModel *retval;
330 g_return_val_if_fail (GTK_IS_TREE_MODEL (child_model), NULL);
332 retval = g_object_new (gtk_tree_model_sort_get_type (), NULL);
334 gtk_tree_model_sort_set_model (GTK_TREE_MODEL_SORT (retval), child_model);
339 /* GObject callbacks */
341 gtk_tree_model_sort_finalize (GObject *object)
343 GtkTreeModelSort *tree_model_sort = (GtkTreeModelSort *) object;
345 gtk_tree_model_sort_set_model (tree_model_sort, NULL);
347 if (tree_model_sort->root)
348 gtk_tree_model_sort_free_level (tree_model_sort, tree_model_sort->root);
350 if (tree_model_sort->sort_list)
352 _gtk_tree_data_list_header_free (tree_model_sort->sort_list);
353 tree_model_sort->sort_list = NULL;
356 if (tree_model_sort->default_sort_destroy)
358 tree_model_sort->default_sort_destroy (tree_model_sort->default_sort_data);
359 tree_model_sort->default_sort_destroy = NULL;
360 tree_model_sort->default_sort_data = NULL;
365 G_OBJECT_CLASS (gtk_tree_model_sort_parent_class)->finalize (object);
369 gtk_tree_model_sort_set_property (GObject *object,
374 GtkTreeModelSort *tree_model_sort = GTK_TREE_MODEL_SORT (object);
379 gtk_tree_model_sort_set_model (tree_model_sort, g_value_get_object (value));
382 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
388 gtk_tree_model_sort_get_property (GObject *object,
393 GtkTreeModelSort *tree_model_sort = GTK_TREE_MODEL_SORT (object);
398 g_value_set_object (value, gtk_tree_model_sort_get_model(tree_model_sort));
401 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
407 gtk_tree_model_sort_row_changed (GtkTreeModel *s_model,
408 GtkTreePath *start_s_path,
409 GtkTreeIter *start_s_iter,
412 GtkTreeModelSort *tree_model_sort = GTK_TREE_MODEL_SORT (data);
413 GtkTreePath *path = NULL;
421 gboolean free_s_path = FALSE;
423 gint index = 0, old_index, i;
425 g_return_if_fail (start_s_path != NULL || start_s_iter != NULL);
430 start_s_path = gtk_tree_model_get_path (s_model, start_s_iter);
433 path = gtk_real_tree_model_sort_convert_child_path_to_path (tree_model_sort,
439 gtk_tree_path_free (start_s_path);
443 gtk_tree_model_get_iter (GTK_TREE_MODEL (data), &iter, path);
444 gtk_tree_model_sort_ref_node (GTK_TREE_MODEL (data), &iter);
446 level = iter.user_data;
447 elt = iter.user_data2;
449 if (level->array->len < 2 ||
450 (tree_model_sort->sort_column_id == GTK_TREE_SORTABLE_DEFAULT_SORT_COLUMN_ID &&
451 tree_model_sort->default_sort_func == NO_SORT_FUNC))
454 gtk_tree_path_free (start_s_path);
456 gtk_tree_model_row_changed (GTK_TREE_MODEL (data), path, &iter);
457 gtk_tree_model_sort_unref_node (GTK_TREE_MODEL (data), &iter);
459 gtk_tree_path_free (path);
464 if (!GTK_TREE_MODEL_SORT_CACHE_CHILD_ITERS (tree_model_sort))
466 gtk_tree_model_get_iter (tree_model_sort->child_model,
467 &tmpiter, start_s_path);
470 old_index = elt - SORT_ELT (level->array->data);
472 memcpy (&tmp, elt, sizeof (SortElt));
474 if (GTK_TREE_MODEL_SORT_CACHE_CHILD_ITERS (tree_model_sort))
475 index = gtk_tree_model_sort_level_find_insert (tree_model_sort,
480 index = gtk_tree_model_sort_level_find_insert (tree_model_sort,
485 if (index < old_index)
487 g_memmove (level->array->data + ((index + 1)*sizeof (SortElt)),
488 level->array->data + ((index)*sizeof (SortElt)),
489 (old_index - index)* sizeof(SortElt));
491 else if (index > old_index)
493 g_memmove (level->array->data + ((old_index)*sizeof (SortElt)),
494 level->array->data + ((old_index + 1)*sizeof (SortElt)),
495 (index - old_index)* sizeof(SortElt));
497 memcpy (level->array->data + ((index)*sizeof (SortElt)),
498 &tmp, sizeof (SortElt));
500 for (i = 0; i < level->array->len; i++)
501 if (g_array_index (level->array, SortElt, i).children)
502 g_array_index (level->array, SortElt, i).children->parent_elt = &g_array_index (level->array, SortElt, i);
504 gtk_tree_path_up (path);
505 gtk_tree_path_append_index (path, index);
507 gtk_tree_model_sort_increment_stamp (tree_model_sort);
509 /* if the item moved, then emit rows_reordered */
510 if (old_index != index)
515 GtkTreePath *tmppath;
517 new_order = g_new (gint, level->array->len);
519 for (j = 0; j < level->array->len; j++)
521 if (index > old_index)
524 new_order[j] = old_index;
525 else if (j >= old_index && j < index)
526 new_order[j] = j + 1;
530 else if (index < old_index)
533 new_order[j] = old_index;
534 else if (j > index && j <= old_index)
535 new_order[j] = j - 1;
539 /* else? shouldn't really happen */
542 if (level->parent_elt)
544 iter.stamp = tree_model_sort->stamp;
545 iter.user_data = level->parent_level;
546 iter.user_data2 = level->parent_elt;
548 tmppath = gtk_tree_model_get_path (GTK_TREE_MODEL (tree_model_sort), &iter);
550 gtk_tree_model_rows_reordered (GTK_TREE_MODEL (tree_model_sort),
551 tmppath, &iter, new_order);
556 tmppath = gtk_tree_path_new ();
558 gtk_tree_model_rows_reordered (GTK_TREE_MODEL (tree_model_sort), tmppath,
562 gtk_tree_path_free (tmppath);
566 /* emit row_changed signal (at new location) */
567 gtk_tree_model_get_iter (GTK_TREE_MODEL (data), &iter, path);
568 gtk_tree_model_row_changed (GTK_TREE_MODEL (data), path, &iter);
569 gtk_tree_model_sort_unref_node (GTK_TREE_MODEL (data), &iter);
571 gtk_tree_path_free (path);
573 gtk_tree_path_free (start_s_path);
577 gtk_tree_model_sort_row_inserted (GtkTreeModel *s_model,
582 GtkTreeModelSort *tree_model_sort = GTK_TREE_MODEL_SORT (data);
585 GtkTreeIter real_s_iter;
589 gboolean free_s_path = FALSE;
593 SortLevel *parent_level = NULL;
595 parent_level = level = SORT_LEVEL (tree_model_sort->root);
597 g_return_if_fail (s_path != NULL || s_iter != NULL);
601 s_path = gtk_tree_model_get_path (s_model, s_iter);
606 gtk_tree_model_get_iter (s_model, &real_s_iter, s_path);
608 real_s_iter = *s_iter;
610 if (!tree_model_sort->root)
612 gtk_tree_model_sort_build_level (tree_model_sort, NULL, NULL);
614 /* the build level already put the inserted iter in the level,
615 so no need to handle this signal anymore */
617 goto done_and_submit;
620 /* find the parent level */
621 while (i < gtk_tree_path_get_depth (s_path) - 1)
627 /* level not yet build, we won't cover this signal */
631 if (level->array->len < gtk_tree_path_get_indices (s_path)[i])
633 g_warning ("%s: A node was inserted with a parent that's not in the tree.\n"
634 "This possibly means that a GtkTreeModel inserted a child node\n"
635 "before the parent was inserted.",
641 for (j = 0; j < level->array->len; j++)
642 if (g_array_index (level->array, SortElt, j).offset == gtk_tree_path_get_indices (s_path)[i])
644 elt = &g_array_index (level->array, SortElt, j);
648 g_return_if_fail (elt != NULL);
652 /* not covering this signal */
656 level = elt->children;
657 parent_level = level;
664 if (level->ref_count == 0 && level != tree_model_sort->root)
666 gtk_tree_model_sort_free_level (tree_model_sort, level);
670 if (!gtk_tree_model_sort_insert_value (tree_model_sort,
677 path = gtk_real_tree_model_sort_convert_child_path_to_path (tree_model_sort,
684 gtk_tree_model_sort_increment_stamp (tree_model_sort);
686 gtk_tree_model_get_iter (GTK_TREE_MODEL (data), &iter, path);
687 gtk_tree_model_row_inserted (GTK_TREE_MODEL (data), path, &iter);
688 gtk_tree_path_free (path);
692 gtk_tree_path_free (s_path);
698 gtk_tree_model_sort_row_has_child_toggled (GtkTreeModel *s_model,
703 GtkTreeModelSort *tree_model_sort = GTK_TREE_MODEL_SORT (data);
707 g_return_if_fail (s_path != NULL && s_iter != NULL);
709 path = gtk_real_tree_model_sort_convert_child_path_to_path (tree_model_sort, s_path, FALSE);
713 gtk_tree_model_get_iter (GTK_TREE_MODEL (data), &iter, path);
714 gtk_tree_model_row_has_child_toggled (GTK_TREE_MODEL (data), path, &iter);
716 gtk_tree_path_free (path);
720 gtk_tree_model_sort_row_deleted (GtkTreeModel *s_model,
724 GtkTreeModelSort *tree_model_sort = GTK_TREE_MODEL_SORT (data);
725 GtkTreePath *path = NULL;
732 g_return_if_fail (s_path != NULL);
734 path = gtk_real_tree_model_sort_convert_child_path_to_path (tree_model_sort, s_path, FALSE);
738 gtk_tree_model_get_iter (GTK_TREE_MODEL (data), &iter, path);
740 level = SORT_LEVEL (iter.user_data);
741 elt = SORT_ELT (iter.user_data2);
742 offset = elt->offset;
744 /* we _need_ to emit ::row_deleted before we start unreffing the node
745 * itself. This is because of the row refs, which start unreffing nodes
746 * when we emit ::row_deleted
748 gtk_tree_model_row_deleted (GTK_TREE_MODEL (data), path);
750 gtk_tree_model_get_iter (GTK_TREE_MODEL (data), &iter, path);
752 while (elt->ref_count > 0)
753 gtk_tree_model_sort_real_unref_node (GTK_TREE_MODEL (data), &iter, FALSE);
755 if (level->ref_count == 0)
757 /* This will prune the level, so I can just emit the signal and
758 * not worry about cleaning this level up.
759 * Careful, root level is not cleaned up in increment stamp.
761 gtk_tree_model_sort_increment_stamp (tree_model_sort);
762 gtk_tree_path_free (path);
763 if (level == tree_model_sort->root)
765 gtk_tree_model_sort_free_level (tree_model_sort,
766 tree_model_sort->root);
767 tree_model_sort->root = NULL;
772 gtk_tree_model_sort_increment_stamp (tree_model_sort);
775 for (i = 0; i < level->array->len; i++)
776 if (elt->offset == g_array_index (level->array, SortElt, i).offset)
779 g_array_remove_index (level->array, i);
781 /* update all offsets */
782 for (i = 0; i < level->array->len; i++)
784 elt = & (g_array_index (level->array, SortElt, i));
785 if (elt->offset > offset)
788 elt->children->parent_elt = elt;
791 gtk_tree_path_free (path);
795 gtk_tree_model_sort_rows_reordered (GtkTreeModel *s_model,
807 GtkTreeModelSort *tree_model_sort = GTK_TREE_MODEL_SORT (data);
809 g_return_if_fail (new_order != NULL);
811 if (s_path == NULL || gtk_tree_path_get_depth (s_path) == 0)
813 if (tree_model_sort->root == NULL)
815 path = gtk_tree_path_new ();
816 level = SORT_LEVEL (tree_model_sort->root);
820 path = gtk_real_tree_model_sort_convert_child_path_to_path (tree_model_sort, s_path, FALSE);
823 gtk_tree_model_get_iter (GTK_TREE_MODEL (data), &iter, path);
825 level = SORT_LEVEL (iter.user_data);
826 elt = SORT_ELT (iter.user_data2);
830 gtk_tree_path_free (path);
834 level = elt->children;
837 if (level->array->len < 2)
839 gtk_tree_path_free (path);
843 tmp_array = g_new (int, level->array->len);
844 for (i = 0; i < level->array->len; i++)
846 for (j = 0; j < level->array->len; j++)
848 if (g_array_index (level->array, SortElt, i).offset == new_order[j])
853 for (i = 0; i < level->array->len; i++)
854 g_array_index (level->array, SortElt, i).offset = tmp_array[i];
857 if (tree_model_sort->sort_column_id == GTK_TREE_SORTABLE_DEFAULT_SORT_COLUMN_ID &&
858 tree_model_sort->default_sort_func == NO_SORT_FUNC)
861 gtk_tree_model_sort_sort_level (tree_model_sort, level,
863 gtk_tree_model_sort_increment_stamp (tree_model_sort);
865 if (gtk_tree_path_get_depth (path))
867 gtk_tree_model_get_iter (GTK_TREE_MODEL (tree_model_sort),
870 gtk_tree_model_rows_reordered (GTK_TREE_MODEL (tree_model_sort),
871 path, &iter, new_order);
875 gtk_tree_model_rows_reordered (GTK_TREE_MODEL (tree_model_sort),
876 path, NULL, new_order);
880 gtk_tree_path_free (path);
883 /* Fulfill our model requirements */
884 static GtkTreeModelFlags
885 gtk_tree_model_sort_get_flags (GtkTreeModel *tree_model)
887 GtkTreeModelSort *tree_model_sort = (GtkTreeModelSort *) tree_model;
888 GtkTreeModelFlags flags;
890 g_return_val_if_fail (tree_model_sort->child_model != NULL, 0);
892 flags = gtk_tree_model_get_flags (tree_model_sort->child_model);
894 if ((flags & GTK_TREE_MODEL_LIST_ONLY) == GTK_TREE_MODEL_LIST_ONLY)
895 return GTK_TREE_MODEL_LIST_ONLY;
901 gtk_tree_model_sort_get_n_columns (GtkTreeModel *tree_model)
903 GtkTreeModelSort *tree_model_sort = (GtkTreeModelSort *) tree_model;
905 if (tree_model_sort->child_model == 0)
908 return gtk_tree_model_get_n_columns (tree_model_sort->child_model);
912 gtk_tree_model_sort_get_column_type (GtkTreeModel *tree_model,
915 GtkTreeModelSort *tree_model_sort = (GtkTreeModelSort *) tree_model;
917 g_return_val_if_fail (tree_model_sort->child_model != NULL, G_TYPE_INVALID);
919 return gtk_tree_model_get_column_type (tree_model_sort->child_model, index);
923 gtk_tree_model_sort_get_iter (GtkTreeModel *tree_model,
927 GtkTreeModelSort *tree_model_sort = (GtkTreeModelSort *) tree_model;
932 g_return_val_if_fail (tree_model_sort->child_model != NULL, FALSE);
934 indices = gtk_tree_path_get_indices (path);
936 if (tree_model_sort->root == NULL)
937 gtk_tree_model_sort_build_level (tree_model_sort, NULL, NULL);
938 level = SORT_LEVEL (tree_model_sort->root);
940 depth = gtk_tree_path_get_depth (path);
944 for (i = 0; i < depth - 1; i++)
946 if ((level == NULL) ||
947 (indices[i] >= level->array->len))
950 if (g_array_index (level->array, SortElt, indices[i]).children == NULL)
951 gtk_tree_model_sort_build_level (tree_model_sort, level, &g_array_index (level->array, SortElt, indices[i]));
952 level = g_array_index (level->array, SortElt, indices[i]).children;
955 if (!level || indices[i] >= level->array->len)
961 iter->stamp = tree_model_sort->stamp;
962 iter->user_data = level;
963 iter->user_data2 = &g_array_index (level->array, SortElt, indices[depth - 1]);
969 gtk_tree_model_sort_get_path (GtkTreeModel *tree_model,
972 GtkTreeModelSort *tree_model_sort = (GtkTreeModelSort *) tree_model;
977 g_return_val_if_fail (tree_model_sort->child_model != NULL, NULL);
978 g_return_val_if_fail (tree_model_sort->stamp == iter->stamp, NULL);
980 retval = gtk_tree_path_new ();
981 level = iter->user_data;
982 elt = iter->user_data2;
983 while (level != NULL)
985 gtk_tree_path_prepend_index (retval, elt - (SortElt *)level->array->data);
987 elt = level->parent_elt;
988 level = level->parent_level;
995 gtk_tree_model_sort_get_value (GtkTreeModel *tree_model,
1000 GtkTreeModelSort *tree_model_sort = (GtkTreeModelSort *) tree_model;
1001 GtkTreeIter child_iter;
1003 g_return_if_fail (tree_model_sort->child_model != NULL);
1004 g_return_if_fail (VALID_ITER (iter, tree_model_sort));
1006 GET_CHILD_ITER (tree_model_sort, &child_iter, iter);
1007 gtk_tree_model_get_value (tree_model_sort->child_model,
1008 &child_iter, column, value);
1012 gtk_tree_model_sort_iter_next (GtkTreeModel *tree_model,
1015 GtkTreeModelSort *tree_model_sort = (GtkTreeModelSort *) tree_model;
1019 g_return_val_if_fail (tree_model_sort->child_model != NULL, FALSE);
1020 g_return_val_if_fail (tree_model_sort->stamp == iter->stamp, FALSE);
1022 level = iter->user_data;
1023 elt = iter->user_data2;
1025 if (elt - (SortElt *)level->array->data >= level->array->len - 1)
1030 iter->user_data2 = elt + 1;
1036 gtk_tree_model_sort_iter_children (GtkTreeModel *tree_model,
1038 GtkTreeIter *parent)
1040 GtkTreeModelSort *tree_model_sort = (GtkTreeModelSort *) tree_model;
1044 g_return_val_if_fail (tree_model_sort->child_model != NULL, FALSE);
1046 g_return_val_if_fail (VALID_ITER (parent, tree_model_sort), FALSE);
1050 if (tree_model_sort->root == NULL)
1051 gtk_tree_model_sort_build_level (tree_model_sort, NULL, NULL);
1052 if (tree_model_sort->root == NULL)
1055 level = tree_model_sort->root;
1056 iter->stamp = tree_model_sort->stamp;
1057 iter->user_data = level;
1058 iter->user_data2 = level->array->data;
1062 if (((SortElt *)parent->user_data2)->children == NULL)
1063 gtk_tree_model_sort_build_level (tree_model_sort,
1064 (SortLevel *)parent->user_data,
1065 (SortElt *)parent->user_data2);
1066 if (((SortElt *)parent->user_data2)->children == NULL)
1068 iter->stamp = tree_model_sort->stamp;
1069 iter->user_data = ((SortElt *)parent->user_data2)->children;
1070 iter->user_data2 = ((SortLevel *)iter->user_data)->array->data;
1077 gtk_tree_model_sort_iter_has_child (GtkTreeModel *tree_model,
1080 GtkTreeModelSort *tree_model_sort = (GtkTreeModelSort *) tree_model;
1081 GtkTreeIter child_iter;
1083 g_return_val_if_fail (tree_model_sort->child_model != NULL, FALSE);
1084 g_return_val_if_fail (VALID_ITER (iter, tree_model_sort), FALSE);
1086 GET_CHILD_ITER (tree_model_sort, &child_iter, iter);
1088 return gtk_tree_model_iter_has_child (tree_model_sort->child_model, &child_iter);
1092 gtk_tree_model_sort_iter_n_children (GtkTreeModel *tree_model,
1095 GtkTreeModelSort *tree_model_sort = (GtkTreeModelSort *) tree_model;
1096 GtkTreeIter child_iter;
1098 g_return_val_if_fail (tree_model_sort->child_model != NULL, 0);
1100 g_return_val_if_fail (VALID_ITER (iter, tree_model_sort), 0);
1103 return gtk_tree_model_iter_n_children (tree_model_sort->child_model, NULL);
1105 GET_CHILD_ITER (tree_model_sort, &child_iter, iter);
1107 return gtk_tree_model_iter_n_children (tree_model_sort->child_model, &child_iter);
1111 gtk_tree_model_sort_iter_nth_child (GtkTreeModel *tree_model,
1113 GtkTreeIter *parent,
1116 GtkTreeModelSort *tree_model_sort = (GtkTreeModelSort *) tree_model;
1118 /* We have this for the iter == parent case */
1119 GtkTreeIter children;
1122 g_return_val_if_fail (VALID_ITER (parent, tree_model_sort), FALSE);
1124 /* Use this instead of has_child to force us to build the level, if needed */
1125 if (gtk_tree_model_sort_iter_children (tree_model, &children, parent) == FALSE)
1131 level = children.user_data;
1132 if (n >= level->array->len)
1138 iter->stamp = tree_model_sort->stamp;
1139 iter->user_data = level;
1140 iter->user_data2 = &g_array_index (level->array, SortElt, n);
1146 gtk_tree_model_sort_iter_parent (GtkTreeModel *tree_model,
1150 GtkTreeModelSort *tree_model_sort = (GtkTreeModelSort *) tree_model;
1154 g_return_val_if_fail (tree_model_sort->child_model != NULL, FALSE);
1155 g_return_val_if_fail (VALID_ITER (child, tree_model_sort), FALSE);
1157 level = child->user_data;
1159 if (level->parent_level)
1161 iter->stamp = tree_model_sort->stamp;
1162 iter->user_data = level->parent_level;
1163 iter->user_data2 = level->parent_elt;
1171 gtk_tree_model_sort_ref_node (GtkTreeModel *tree_model,
1174 GtkTreeModelSort *tree_model_sort = (GtkTreeModelSort *) tree_model;
1175 GtkTreeIter child_iter;
1176 GtkTreeIter tmp_iter;
1180 g_return_if_fail (tree_model_sort->child_model != NULL);
1181 g_return_if_fail (VALID_ITER (iter, tree_model_sort));
1183 GET_CHILD_ITER (tree_model_sort, &child_iter, iter);
1185 /* Reference the node in the child model */
1186 gtk_tree_model_ref_node (tree_model_sort->child_model, &child_iter);
1188 /* Increase the reference count of this element and its level */
1189 level = iter->user_data;
1190 elt = iter->user_data2;
1195 /* Increase the reference count of all parent elements */
1196 tmp_iter.stamp = tree_model_sort->stamp;
1197 tmp_iter.user_data = level->parent_level;
1198 tmp_iter.user_data2 = level->parent_elt;;
1200 while (tmp_iter.user_data2)
1202 gtk_tree_model_sort_ref_node (tree_model, &tmp_iter);
1204 tmp_iter.user_data2 = SORT_LEVEL (tmp_iter.user_data)->parent_elt;
1205 tmp_iter.user_data = SORT_LEVEL (tmp_iter.user_data)->parent_level;
1208 if (level->ref_count == 1)
1210 SortLevel *parent_level = level->parent_level;
1211 SortElt *parent_elt = level->parent_elt;
1212 /* We were at zero -- time to decrement the zero_ref_count val */
1213 while (parent_level)
1215 parent_elt->zero_ref_count--;
1217 parent_elt = parent_level->parent_elt;
1218 parent_level = parent_level->parent_level;
1221 if (tree_model_sort->root != level)
1222 tree_model_sort->zero_ref_count--;
1227 gtk_tree_model_sort_real_unref_node (GtkTreeModel *tree_model,
1229 gboolean propagate_unref)
1231 GtkTreeModelSort *tree_model_sort = (GtkTreeModelSort *) tree_model;
1232 GtkTreeIter tmp_iter;
1236 g_return_if_fail (tree_model_sort->child_model != NULL);
1237 g_return_if_fail (VALID_ITER (iter, tree_model_sort));
1239 if (propagate_unref)
1241 GtkTreeIter child_iter;
1243 GET_CHILD_ITER (tree_model_sort, &child_iter, iter);
1244 gtk_tree_model_unref_node (tree_model_sort->child_model, &child_iter);
1247 level = iter->user_data;
1248 elt = iter->user_data2;
1250 g_return_if_fail (elt->ref_count > 0);
1255 /* Decrease the reference count of all parent elements */
1256 tmp_iter.stamp = tree_model_sort->stamp;
1257 tmp_iter.user_data = level->parent_level;
1258 tmp_iter.user_data2 = level->parent_elt;;
1260 while (tmp_iter.user_data2)
1262 gtk_tree_model_sort_real_unref_node (tree_model, &tmp_iter, FALSE);
1264 tmp_iter.user_data2 = SORT_LEVEL (tmp_iter.user_data)->parent_elt;
1265 tmp_iter.user_data = SORT_LEVEL (tmp_iter.user_data)->parent_level;
1268 if (level->ref_count == 0)
1270 SortLevel *parent_level = level->parent_level;
1271 SortElt *parent_elt = level->parent_elt;
1273 /* We are at zero -- time to increment the zero_ref_count val */
1274 while (parent_level)
1276 parent_elt->zero_ref_count++;
1278 parent_elt = parent_level->parent_elt;
1279 parent_level = parent_level->parent_level;
1282 if (tree_model_sort->root != level)
1283 tree_model_sort->zero_ref_count++;
1288 gtk_tree_model_sort_unref_node (GtkTreeModel *tree_model,
1291 gtk_tree_model_sort_real_unref_node (tree_model, iter, TRUE);
1294 /* Sortable interface */
1296 gtk_tree_model_sort_get_sort_column_id (GtkTreeSortable *sortable,
1297 gint *sort_column_id,
1300 GtkTreeModelSort *tree_model_sort = (GtkTreeModelSort *)sortable;
1303 *sort_column_id = tree_model_sort->sort_column_id;
1305 *order = tree_model_sort->order;
1307 if (tree_model_sort->sort_column_id == GTK_TREE_SORTABLE_DEFAULT_SORT_COLUMN_ID ||
1308 tree_model_sort->sort_column_id == GTK_TREE_SORTABLE_UNSORTED_SORT_COLUMN_ID)
1315 gtk_tree_model_sort_set_sort_column_id (GtkTreeSortable *sortable,
1316 gint sort_column_id,
1319 GtkTreeModelSort *tree_model_sort = (GtkTreeModelSort *)sortable;
1321 if (sort_column_id != GTK_TREE_SORTABLE_UNSORTED_SORT_COLUMN_ID)
1323 if (sort_column_id != GTK_TREE_SORTABLE_DEFAULT_SORT_COLUMN_ID)
1325 GtkTreeDataSortHeader *header = NULL;
1327 header = _gtk_tree_data_list_get_header (tree_model_sort->sort_list,
1330 /* we want to make sure that we have a function */
1331 g_return_if_fail (header != NULL);
1332 g_return_if_fail (header->func != NULL);
1335 g_return_if_fail (tree_model_sort->default_sort_func != NULL);
1337 if (tree_model_sort->sort_column_id == sort_column_id)
1339 if (sort_column_id != GTK_TREE_SORTABLE_DEFAULT_SORT_COLUMN_ID)
1341 if (tree_model_sort->order == order)
1349 tree_model_sort->sort_column_id = sort_column_id;
1350 tree_model_sort->order = order;
1352 gtk_tree_sortable_sort_column_changed (sortable);
1354 gtk_tree_model_sort_sort (tree_model_sort);
1358 gtk_tree_model_sort_set_sort_func (GtkTreeSortable *sortable,
1359 gint sort_column_id,
1360 GtkTreeIterCompareFunc func,
1362 GDestroyNotify destroy)
1364 GtkTreeModelSort *tree_model_sort = (GtkTreeModelSort *) sortable;
1366 tree_model_sort->sort_list = _gtk_tree_data_list_set_header (tree_model_sort->sort_list,
1368 func, data, destroy);
1370 if (tree_model_sort->sort_column_id == sort_column_id)
1371 gtk_tree_model_sort_sort (tree_model_sort);
1375 gtk_tree_model_sort_set_default_sort_func (GtkTreeSortable *sortable,
1376 GtkTreeIterCompareFunc func,
1378 GDestroyNotify destroy)
1380 GtkTreeModelSort *tree_model_sort = (GtkTreeModelSort *)sortable;
1382 if (tree_model_sort->default_sort_destroy)
1384 GDestroyNotify d = tree_model_sort->default_sort_destroy;
1386 tree_model_sort->default_sort_destroy = NULL;
1387 d (tree_model_sort->default_sort_data);
1390 tree_model_sort->default_sort_func = func;
1391 tree_model_sort->default_sort_data = data;
1392 tree_model_sort->default_sort_destroy = destroy;
1394 if (tree_model_sort->sort_column_id == GTK_TREE_SORTABLE_DEFAULT_SORT_COLUMN_ID)
1395 gtk_tree_model_sort_sort (tree_model_sort);
1399 gtk_tree_model_sort_has_default_sort_func (GtkTreeSortable *sortable)
1401 GtkTreeModelSort *tree_model_sort = (GtkTreeModelSort *)sortable;
1403 return (tree_model_sort->default_sort_func != NULL);
1406 /* DragSource interface */
1408 gtk_tree_model_sort_row_draggable (GtkTreeDragSource *drag_source,
1411 GtkTreeModelSort *tree_model_sort = (GtkTreeModelSort *)drag_source;
1412 GtkTreePath *child_path;
1415 child_path = gtk_tree_model_sort_convert_path_to_child_path (tree_model_sort,
1417 draggable = gtk_tree_drag_source_row_draggable (GTK_TREE_DRAG_SOURCE (tree_model_sort->child_model), child_path);
1418 gtk_tree_path_free (child_path);
1424 gtk_tree_model_sort_drag_data_get (GtkTreeDragSource *drag_source,
1426 GtkSelectionData *selection_data)
1428 GtkTreeModelSort *tree_model_sort = (GtkTreeModelSort *)drag_source;
1429 GtkTreePath *child_path;
1432 child_path = gtk_tree_model_sort_convert_path_to_child_path (tree_model_sort, path);
1433 gotten = gtk_tree_drag_source_drag_data_get (GTK_TREE_DRAG_SOURCE (tree_model_sort->child_model), child_path, selection_data);
1434 gtk_tree_path_free (child_path);
1440 gtk_tree_model_sort_drag_data_delete (GtkTreeDragSource *drag_source,
1443 GtkTreeModelSort *tree_model_sort = (GtkTreeModelSort *)drag_source;
1444 GtkTreePath *child_path;
1447 child_path = gtk_tree_model_sort_convert_path_to_child_path (tree_model_sort, path);
1448 deleted = gtk_tree_drag_source_drag_data_delete (GTK_TREE_DRAG_SOURCE (tree_model_sort->child_model), child_path);
1449 gtk_tree_path_free (child_path);
1454 /* sorting code - private */
1456 gtk_tree_model_sort_compare_func (gconstpointer a,
1460 SortData *data = (SortData *)user_data;
1461 GtkTreeModelSort *tree_model_sort = data->tree_model_sort;
1462 SortTuple *sa = (SortTuple *)a;
1463 SortTuple *sb = (SortTuple *)b;
1465 GtkTreeIter iter_a, iter_b;
1468 /* shortcut, if we've the same offsets here, they should be equal */
1469 if (sa->offset == sb->offset)
1472 if (GTK_TREE_MODEL_SORT_CACHE_CHILD_ITERS (tree_model_sort))
1474 iter_a = sa->elt->iter;
1475 iter_b = sb->elt->iter;
1479 data->parent_path_indices [data->parent_path_depth-1] = sa->elt->offset;
1480 gtk_tree_model_get_iter (GTK_TREE_MODEL (tree_model_sort->child_model), &iter_a, data->parent_path);
1481 data->parent_path_indices [data->parent_path_depth-1] = sb->elt->offset;
1482 gtk_tree_model_get_iter (GTK_TREE_MODEL (tree_model_sort->child_model), &iter_b, data->parent_path);
1485 retval = (* data->sort_func) (GTK_TREE_MODEL (tree_model_sort->child_model),
1489 if (tree_model_sort->order == GTK_SORT_DESCENDING)
1493 else if (retval < 0)
1501 gtk_tree_model_sort_offset_compare_func (gconstpointer a,
1507 SortTuple *sa = (SortTuple *)a;
1508 SortTuple *sb = (SortTuple *)b;
1510 SortData *data = (SortData *)user_data;
1512 if (sa->elt->offset < sb->elt->offset)
1514 else if (sa->elt->offset > sb->elt->offset)
1519 if (data->tree_model_sort->order == GTK_SORT_DESCENDING)
1523 else if (retval < 0)
1531 gtk_tree_model_sort_sort_level (GtkTreeModelSort *tree_model_sort,
1534 gboolean emit_reordered)
1547 g_return_if_fail (level != NULL);
1549 if (level->array->len < 1 && !((SortElt *)level->array->data)->children)
1552 iter.stamp = tree_model_sort->stamp;
1553 iter.user_data = level;
1554 iter.user_data2 = &g_array_index (level->array, SortElt, 0);
1556 gtk_tree_model_sort_ref_node (GTK_TREE_MODEL (tree_model_sort), &iter);
1557 ref_offset = g_array_index (level->array, SortElt, 0).offset;
1560 data.tree_model_sort = tree_model_sort;
1561 if (level->parent_elt)
1563 data.parent_path = gtk_tree_model_sort_elt_get_path (level->parent_level,
1565 gtk_tree_path_append_index (data.parent_path, 0);
1569 data.parent_path = gtk_tree_path_new_first ();
1571 data.parent_path_depth = gtk_tree_path_get_depth (data.parent_path);
1572 data.parent_path_indices = gtk_tree_path_get_indices (data.parent_path);
1574 /* make the array to be sorted */
1575 sort_array = g_array_sized_new (FALSE, FALSE, sizeof (SortTuple), level->array->len);
1576 for (i = 0; i < level->array->len; i++)
1580 tuple.elt = &g_array_index (level->array, SortElt, i);
1583 g_array_append_val (sort_array, tuple);
1586 if (tree_model_sort->sort_column_id != GTK_TREE_SORTABLE_DEFAULT_SORT_COLUMN_ID)
1588 GtkTreeDataSortHeader *header = NULL;
1590 header = _gtk_tree_data_list_get_header (tree_model_sort->sort_list,
1591 tree_model_sort->sort_column_id);
1593 g_return_if_fail (header != NULL);
1594 g_return_if_fail (header->func != NULL);
1596 data.sort_func = header->func;
1597 data.sort_data = header->data;
1601 /* absolutely SHOULD NOT happen: */
1602 g_return_if_fail (tree_model_sort->default_sort_func != NULL);
1604 data.sort_func = tree_model_sort->default_sort_func;
1605 data.sort_data = tree_model_sort->default_sort_data;
1608 if (data.sort_func == NO_SORT_FUNC)
1609 g_array_sort_with_data (sort_array,
1610 gtk_tree_model_sort_offset_compare_func,
1613 g_array_sort_with_data (sort_array,
1614 gtk_tree_model_sort_compare_func,
1617 gtk_tree_path_free (data.parent_path);
1619 new_array = g_array_sized_new (FALSE, FALSE, sizeof (SortElt), level->array->len);
1620 new_order = g_new (gint, level->array->len);
1622 for (i = 0; i < level->array->len; i++)
1626 elt = g_array_index (sort_array, SortTuple, i).elt;
1627 new_order[i] = g_array_index (sort_array, SortTuple, i).offset;
1629 g_array_append_val (new_array, *elt);
1630 elt = &g_array_index (new_array, SortElt, i);
1632 elt->children->parent_elt = elt;
1635 g_array_free (level->array, TRUE);
1636 level->array = new_array;
1637 g_array_free (sort_array, TRUE);
1641 gtk_tree_model_sort_increment_stamp (tree_model_sort);
1642 if (level->parent_elt)
1644 iter.stamp = tree_model_sort->stamp;
1645 iter.user_data = level->parent_level;
1646 iter.user_data2 = level->parent_elt;
1648 path = gtk_tree_model_get_path (GTK_TREE_MODEL (tree_model_sort),
1651 gtk_tree_model_rows_reordered (GTK_TREE_MODEL (tree_model_sort), path,
1657 path = gtk_tree_path_new ();
1658 gtk_tree_model_rows_reordered (GTK_TREE_MODEL (tree_model_sort), path,
1662 gtk_tree_path_free (path);
1665 /* recurse, if possible */
1668 for (i = 0; i < level->array->len; i++)
1670 SortElt *elt = &g_array_index (level->array, SortElt, i);
1673 gtk_tree_model_sort_sort_level (tree_model_sort,
1675 TRUE, emit_reordered);
1681 /* get the iter we referenced at the beginning of this function and
1684 iter.stamp = tree_model_sort->stamp;
1685 iter.user_data = level;
1687 for (i = 0; i < level->array->len; i++)
1689 if (g_array_index (level->array, SortElt, i).offset == ref_offset)
1691 iter.user_data2 = &g_array_index (level->array, SortElt, i);
1696 gtk_tree_model_sort_unref_node (GTK_TREE_MODEL (tree_model_sort), &iter);
1700 gtk_tree_model_sort_sort (GtkTreeModelSort *tree_model_sort)
1702 if (tree_model_sort->sort_column_id == GTK_TREE_SORTABLE_UNSORTED_SORT_COLUMN_ID)
1705 if (!tree_model_sort->root)
1708 if (tree_model_sort->sort_column_id != GTK_TREE_SORTABLE_DEFAULT_SORT_COLUMN_ID)
1710 GtkTreeDataSortHeader *header = NULL;
1712 header = _gtk_tree_data_list_get_header (tree_model_sort->sort_list,
1713 tree_model_sort->sort_column_id);
1715 /* we want to make sure that we have a function */
1716 g_return_if_fail (header != NULL);
1717 g_return_if_fail (header->func != NULL);
1720 g_return_if_fail (tree_model_sort->default_sort_func != NULL);
1722 gtk_tree_model_sort_sort_level (tree_model_sort, tree_model_sort->root,
1726 /* signal helpers */
1728 gtk_tree_model_sort_level_find_insert (GtkTreeModelSort *tree_model_sort,
1733 gint start, middle, end;
1736 GtkTreeIter tmp_iter;
1738 GtkTreeIterCompareFunc func;
1741 if (tree_model_sort->sort_column_id != GTK_TREE_SORTABLE_DEFAULT_SORT_COLUMN_ID)
1743 GtkTreeDataSortHeader *header;
1745 header = _gtk_tree_data_list_get_header (tree_model_sort->sort_list,
1746 tree_model_sort->sort_column_id);
1748 g_return_val_if_fail (header != NULL, 0);
1750 func = header->func;
1751 data = header->data;
1755 func = tree_model_sort->default_sort_func;
1756 data = tree_model_sort->default_sort_data;
1758 g_return_val_if_fail (func != NO_SORT_FUNC, 0);
1761 g_return_val_if_fail (func != NULL, 0);
1764 end = level->array->len;
1773 while (start != end)
1775 middle = (start + end) / 2;
1777 if (middle < skip_index)
1778 tmp_elt = &(g_array_index (level->array, SortElt, middle));
1780 tmp_elt = &(g_array_index (level->array, SortElt, middle + 1));
1782 if (!GTK_TREE_MODEL_SORT_CACHE_CHILD_ITERS (tree_model_sort))
1784 GtkTreePath *path = gtk_tree_model_sort_elt_get_path (level, tmp_elt);
1785 gtk_tree_model_get_iter (tree_model_sort->child_model,
1787 gtk_tree_path_free (path);
1790 tmp_iter = tmp_elt->iter;
1792 if (tree_model_sort->order == GTK_SORT_ASCENDING)
1793 cmp = (* func) (GTK_TREE_MODEL (tree_model_sort->child_model),
1794 &tmp_iter, iter, data);
1796 cmp = (* func) (GTK_TREE_MODEL (tree_model_sort->child_model),
1797 iter, &tmp_iter, data);
1812 gtk_tree_model_sort_insert_value (GtkTreeModelSort *tree_model_sort,
1814 GtkTreePath *s_path,
1815 GtkTreeIter *s_iter)
1817 gint offset, index, i;
1822 offset = gtk_tree_path_get_indices (s_path)[gtk_tree_path_get_depth (s_path) - 1];
1824 if (GTK_TREE_MODEL_SORT_CACHE_CHILD_ITERS (tree_model_sort))
1826 elt.offset = offset;
1827 elt.zero_ref_count = 0;
1829 elt.children = NULL;
1831 /* update all larger offsets */
1832 tmp_elt = SORT_ELT (level->array->data);
1833 for (i = 0; i < level->array->len; i++, tmp_elt++)
1834 if (tmp_elt->offset >= offset)
1837 if (tree_model_sort->sort_column_id == GTK_TREE_SORTABLE_DEFAULT_SORT_COLUMN_ID &&
1838 tree_model_sort->default_sort_func == NO_SORT_FUNC)
1841 index = gtk_tree_model_sort_level_find_insert (tree_model_sort,
1845 g_array_insert_vals (level->array, index, &elt, 1);
1846 tmp_elt = SORT_ELT (level->array->data);
1847 for (i = 0; i < level->array->len; i++, tmp_elt++)
1848 if (tmp_elt->children)
1849 tmp_elt->children->parent_elt = tmp_elt;
1854 /* sort elt stuff */
1855 static GtkTreePath *
1856 gtk_tree_model_sort_elt_get_path (SortLevel *level,
1859 SortLevel *walker = level;
1860 SortElt *walker2 = elt;
1863 g_return_val_if_fail (level != NULL, NULL);
1864 g_return_val_if_fail (elt != NULL, NULL);
1866 path = gtk_tree_path_new ();
1870 gtk_tree_path_prepend_index (path, walker2->offset);
1872 walker2 = walker->parent_elt;
1873 walker = walker->parent_level;
1880 * gtk_tree_model_sort_set_model:
1881 * @tree_model_sort: The #GtkTreeModelSort.
1882 * @child_model: A #GtkTreeModel, or %NULL.
1884 * Sets the model of @tree_model_sort to be @model. If @model is %NULL,
1885 * then the old model is unset. The sort function is unset as a result
1886 * of this call. The model will be in an unsorted state until a sort
1890 gtk_tree_model_sort_set_model (GtkTreeModelSort *tree_model_sort,
1891 GtkTreeModel *child_model)
1894 g_object_ref (child_model);
1896 if (tree_model_sort->child_model)
1898 g_signal_handler_disconnect (tree_model_sort->child_model,
1899 tree_model_sort->changed_id);
1900 g_signal_handler_disconnect (tree_model_sort->child_model,
1901 tree_model_sort->inserted_id);
1902 g_signal_handler_disconnect (tree_model_sort->child_model,
1903 tree_model_sort->has_child_toggled_id);
1904 g_signal_handler_disconnect (tree_model_sort->child_model,
1905 tree_model_sort->deleted_id);
1906 g_signal_handler_disconnect (tree_model_sort->child_model,
1907 tree_model_sort->reordered_id);
1909 /* reset our state */
1910 if (tree_model_sort->root)
1911 gtk_tree_model_sort_free_level (tree_model_sort, tree_model_sort->root);
1912 tree_model_sort->root = NULL;
1913 _gtk_tree_data_list_header_free (tree_model_sort->sort_list);
1914 tree_model_sort->sort_list = NULL;
1915 g_object_unref (tree_model_sort->child_model);
1918 tree_model_sort->child_model = child_model;
1925 tree_model_sort->changed_id =
1926 g_signal_connect (child_model, "row-changed",
1927 G_CALLBACK (gtk_tree_model_sort_row_changed),
1929 tree_model_sort->inserted_id =
1930 g_signal_connect (child_model, "row-inserted",
1931 G_CALLBACK (gtk_tree_model_sort_row_inserted),
1933 tree_model_sort->has_child_toggled_id =
1934 g_signal_connect (child_model, "row-has-child-toggled",
1935 G_CALLBACK (gtk_tree_model_sort_row_has_child_toggled),
1937 tree_model_sort->deleted_id =
1938 g_signal_connect (child_model, "row-deleted",
1939 G_CALLBACK (gtk_tree_model_sort_row_deleted),
1941 tree_model_sort->reordered_id =
1942 g_signal_connect (child_model, "rows-reordered",
1943 G_CALLBACK (gtk_tree_model_sort_rows_reordered),
1946 tree_model_sort->child_flags = gtk_tree_model_get_flags (child_model);
1947 n_columns = gtk_tree_model_get_n_columns (child_model);
1949 types = g_new (GType, n_columns);
1950 for (i = 0; i < n_columns; i++)
1951 types[i] = gtk_tree_model_get_column_type (child_model, i);
1953 tree_model_sort->sort_list = _gtk_tree_data_list_header_new (n_columns, types);
1956 tree_model_sort->default_sort_func = NO_SORT_FUNC;
1957 tree_model_sort->stamp = g_random_int ();
1962 * gtk_tree_model_sort_get_model:
1963 * @tree_model: a #GtkTreeModelSort
1965 * Returns the model the #GtkTreeModelSort is sorting.
1967 * Return value: the "child model" being sorted
1970 gtk_tree_model_sort_get_model (GtkTreeModelSort *tree_model)
1972 g_return_val_if_fail (GTK_IS_TREE_MODEL_SORT (tree_model), NULL);
1974 return tree_model->child_model;
1978 static GtkTreePath *
1979 gtk_real_tree_model_sort_convert_child_path_to_path (GtkTreeModelSort *tree_model_sort,
1980 GtkTreePath *child_path,
1981 gboolean build_levels)
1983 gint *child_indices;
1984 GtkTreePath *retval;
1988 g_return_val_if_fail (tree_model_sort->child_model != NULL, NULL);
1989 g_return_val_if_fail (child_path != NULL, NULL);
1991 retval = gtk_tree_path_new ();
1992 child_indices = gtk_tree_path_get_indices (child_path);
1994 if (tree_model_sort->root == NULL && build_levels)
1995 gtk_tree_model_sort_build_level (tree_model_sort, NULL, NULL);
1996 level = SORT_LEVEL (tree_model_sort->root);
1998 for (i = 0; i < gtk_tree_path_get_depth (child_path); i++)
2001 gboolean found_child = FALSE;
2005 gtk_tree_path_free (retval);
2009 if (child_indices[i] >= level->array->len)
2011 gtk_tree_path_free (retval);
2014 for (j = 0; j < level->array->len; j++)
2016 if ((g_array_index (level->array, SortElt, j)).offset == child_indices[i])
2018 gtk_tree_path_append_index (retval, j);
2019 if (g_array_index (level->array, SortElt, j).children == NULL && build_levels)
2021 gtk_tree_model_sort_build_level (tree_model_sort, level, &g_array_index (level->array, SortElt, j));
2023 level = g_array_index (level->array, SortElt, j).children;
2030 gtk_tree_path_free (retval);
2040 * gtk_tree_model_sort_convert_child_path_to_path:
2041 * @tree_model_sort: A #GtkTreeModelSort
2042 * @child_path: A #GtkTreePath to convert
2044 * Converts @child_path to a path relative to @tree_model_sort. That is,
2045 * @child_path points to a path in the child model. The returned path will
2046 * point to the same row in the sorted model. If @child_path isn't a valid
2047 * path on the child model, then %NULL is returned.
2049 * Return value: A newly allocated #GtkTreePath, or %NULL
2052 gtk_tree_model_sort_convert_child_path_to_path (GtkTreeModelSort *tree_model_sort,
2053 GtkTreePath *child_path)
2055 g_return_val_if_fail (GTK_IS_TREE_MODEL_SORT (tree_model_sort), NULL);
2056 g_return_val_if_fail (tree_model_sort->child_model != NULL, NULL);
2057 g_return_val_if_fail (child_path != NULL, NULL);
2059 return gtk_real_tree_model_sort_convert_child_path_to_path (tree_model_sort, child_path, TRUE);
2063 * gtk_tree_model_sort_convert_child_iter_to_iter:
2064 * @tree_model_sort: A #GtkTreeModelSort
2065 * @sort_iter: An uninitialized #GtkTreeIter.
2066 * @child_iter: A valid #GtkTreeIter pointing to a row on the child model
2068 * Sets @sort_iter to point to the row in @tree_model_sort that corresponds to
2069 * the row pointed at by @child_iter. If @sort_iter was not set, %FALSE
2070 * is returned. Note: a boolean is only returned since 2.14.
2072 * Return value: %TRUE, if @sort_iter was set, i.e. if @sort_iter is a
2073 * valid iterator pointer to a visible row in the child model.
2076 gtk_tree_model_sort_convert_child_iter_to_iter (GtkTreeModelSort *tree_model_sort,
2077 GtkTreeIter *sort_iter,
2078 GtkTreeIter *child_iter)
2081 GtkTreePath *child_path, *path;
2083 g_return_val_if_fail (GTK_IS_TREE_MODEL_SORT (tree_model_sort), FALSE);
2084 g_return_val_if_fail (tree_model_sort->child_model != NULL, FALSE);
2085 g_return_val_if_fail (sort_iter != NULL, FALSE);
2086 g_return_val_if_fail (child_iter != NULL, FALSE);
2088 sort_iter->stamp = 0;
2090 child_path = gtk_tree_model_get_path (tree_model_sort->child_model, child_iter);
2091 g_return_val_if_fail (child_path != NULL, FALSE);
2093 path = gtk_tree_model_sort_convert_child_path_to_path (tree_model_sort, child_path);
2094 gtk_tree_path_free (child_path);
2098 g_warning ("%s: The conversion of the child path to a GtkTreeModel sort path failed", G_STRLOC);
2102 ret = gtk_tree_model_get_iter (GTK_TREE_MODEL (tree_model_sort),
2104 gtk_tree_path_free (path);
2110 * gtk_tree_model_sort_convert_path_to_child_path:
2111 * @tree_model_sort: A #GtkTreeModelSort
2112 * @sorted_path: A #GtkTreePath to convert
2114 * Converts @sorted_path to a path on the child model of @tree_model_sort.
2115 * That is, @sorted_path points to a location in @tree_model_sort. The
2116 * returned path will point to the same location in the model not being
2117 * sorted. If @sorted_path does not point to a location in the child model,
2118 * %NULL is returned.
2120 * Return value: A newly allocated #GtkTreePath, or %NULL
2123 gtk_tree_model_sort_convert_path_to_child_path (GtkTreeModelSort *tree_model_sort,
2124 GtkTreePath *sorted_path)
2126 gint *sorted_indices;
2127 GtkTreePath *retval;
2131 g_return_val_if_fail (GTK_IS_TREE_MODEL_SORT (tree_model_sort), NULL);
2132 g_return_val_if_fail (tree_model_sort->child_model != NULL, NULL);
2133 g_return_val_if_fail (sorted_path != NULL, NULL);
2135 retval = gtk_tree_path_new ();
2136 sorted_indices = gtk_tree_path_get_indices (sorted_path);
2137 if (tree_model_sort->root == NULL)
2138 gtk_tree_model_sort_build_level (tree_model_sort, NULL, NULL);
2139 level = SORT_LEVEL (tree_model_sort->root);
2141 for (i = 0; i < gtk_tree_path_get_depth (sorted_path); i++)
2143 gint count = sorted_indices[i];
2145 if ((level == NULL) ||
2146 (level->array->len <= count))
2148 gtk_tree_path_free (retval);
2152 if (g_array_index (level->array, SortElt, count).children == NULL)
2153 gtk_tree_model_sort_build_level (tree_model_sort, level, &g_array_index (level->array, SortElt, count));
2157 gtk_tree_path_free (retval);
2161 gtk_tree_path_append_index (retval, g_array_index (level->array, SortElt, count).offset);
2162 level = g_array_index (level->array, SortElt, count).children;
2169 * gtk_tree_model_sort_convert_iter_to_child_iter:
2170 * @tree_model_sort: A #GtkTreeModelSort
2171 * @child_iter: An uninitialized #GtkTreeIter
2172 * @sorted_iter: A valid #GtkTreeIter pointing to a row on @tree_model_sort.
2174 * Sets @child_iter to point to the row pointed to by @sorted_iter.
2177 gtk_tree_model_sort_convert_iter_to_child_iter (GtkTreeModelSort *tree_model_sort,
2178 GtkTreeIter *child_iter,
2179 GtkTreeIter *sorted_iter)
2181 g_return_if_fail (GTK_IS_TREE_MODEL_SORT (tree_model_sort));
2182 g_return_if_fail (tree_model_sort->child_model != NULL);
2183 g_return_if_fail (child_iter != NULL);
2184 g_return_if_fail (VALID_ITER (sorted_iter, tree_model_sort));
2186 if (GTK_TREE_MODEL_SORT_CACHE_CHILD_ITERS (tree_model_sort))
2188 *child_iter = SORT_ELT (sorted_iter->user_data2)->iter;
2194 path = gtk_tree_model_sort_elt_get_path (sorted_iter->user_data,
2195 sorted_iter->user_data2);
2196 gtk_tree_model_get_iter (tree_model_sort->child_model, child_iter, path);
2197 gtk_tree_path_free (path);
2202 gtk_tree_model_sort_build_level (GtkTreeModelSort *tree_model_sort,
2203 SortLevel *parent_level,
2204 SortElt *parent_elt)
2207 SortLevel *new_level;
2211 g_assert (tree_model_sort->child_model != NULL);
2213 if (parent_level == NULL)
2215 if (gtk_tree_model_get_iter_first (tree_model_sort->child_model, &iter) == FALSE)
2217 length = gtk_tree_model_iter_n_children (tree_model_sort->child_model, NULL);
2221 GtkTreeIter parent_iter;
2222 GtkTreeIter child_parent_iter;
2224 parent_iter.stamp = tree_model_sort->stamp;
2225 parent_iter.user_data = parent_level;
2226 parent_iter.user_data2 = parent_elt;
2228 gtk_tree_model_sort_convert_iter_to_child_iter (tree_model_sort,
2231 if (gtk_tree_model_iter_children (tree_model_sort->child_model,
2233 &child_parent_iter) == FALSE)
2236 /* stamp may have changed */
2237 gtk_tree_model_sort_convert_iter_to_child_iter (tree_model_sort,
2241 length = gtk_tree_model_iter_n_children (tree_model_sort->child_model, &child_parent_iter);
2244 g_return_if_fail (length > 0);
2246 new_level = g_new (SortLevel, 1);
2247 new_level->array = g_array_sized_new (FALSE, FALSE, sizeof (SortElt), length);
2248 new_level->ref_count = 0;
2249 new_level->parent_elt = parent_elt;
2250 new_level->parent_level = parent_level;
2253 parent_elt->children = new_level;
2255 tree_model_sort->root = new_level;
2257 /* increase the count of zero ref_counts.*/
2258 while (parent_level)
2260 parent_elt->zero_ref_count++;
2262 parent_elt = parent_level->parent_elt;
2263 parent_level = parent_level->parent_level;
2265 if (new_level != tree_model_sort->root)
2266 tree_model_sort->zero_ref_count++;
2268 for (i = 0; i < length; i++)
2271 sort_elt.offset = i;
2272 sort_elt.zero_ref_count = 0;
2273 sort_elt.ref_count = 0;
2274 sort_elt.children = NULL;
2276 if (GTK_TREE_MODEL_SORT_CACHE_CHILD_ITERS (tree_model_sort))
2278 sort_elt.iter = iter;
2279 if (gtk_tree_model_iter_next (tree_model_sort->child_model, &iter) == FALSE &&
2287 level = gtk_tree_model_sort_elt_get_path (parent_level,
2289 str = gtk_tree_path_to_string (level);
2290 gtk_tree_path_free (level);
2292 g_warning ("%s: There is a discrepancy between the sort model "
2293 "and the child model. The child model is "
2294 "advertising a wrong length for level %s:.",
2300 g_warning ("%s: There is a discrepancy between the sort model "
2301 "and the child model. The child model is "
2302 "advertising a wrong length for the root level.",
2309 g_array_append_val (new_level->array, sort_elt);
2313 gtk_tree_model_sort_sort_level (tree_model_sort, new_level,
2318 gtk_tree_model_sort_free_level (GtkTreeModelSort *tree_model_sort,
2319 SortLevel *sort_level)
2323 g_assert (sort_level);
2325 for (i = 0; i < sort_level->array->len; i++)
2327 if (g_array_index (sort_level->array, SortElt, i).children)
2328 gtk_tree_model_sort_free_level (tree_model_sort,
2329 SORT_LEVEL (g_array_index (sort_level->array, SortElt, i).children));
2332 if (sort_level->ref_count == 0)
2334 SortLevel *parent_level = sort_level->parent_level;
2335 SortElt *parent_elt = sort_level->parent_elt;
2337 while (parent_level)
2339 parent_elt->zero_ref_count--;
2341 parent_elt = parent_level->parent_elt;
2342 parent_level = parent_level->parent_level;
2345 if (sort_level != tree_model_sort->root)
2346 tree_model_sort->zero_ref_count--;
2349 if (sort_level->parent_elt)
2350 sort_level->parent_elt->children = NULL;
2352 tree_model_sort->root = NULL;
2354 g_array_free (sort_level->array, TRUE);
2355 sort_level->array = NULL;
2357 g_free (sort_level);
2362 gtk_tree_model_sort_increment_stamp (GtkTreeModelSort *tree_model_sort)
2366 tree_model_sort->stamp++;
2368 while (tree_model_sort->stamp == 0);
2370 gtk_tree_model_sort_clear_cache (tree_model_sort);
2374 gtk_tree_model_sort_clear_cache_helper (GtkTreeModelSort *tree_model_sort,
2379 g_assert (level != NULL);
2381 for (i = 0; i < level->array->len; i++)
2383 if (g_array_index (level->array, SortElt, i).zero_ref_count > 0)
2384 gtk_tree_model_sort_clear_cache_helper (tree_model_sort, g_array_index (level->array, SortElt, i).children);
2387 if (level->ref_count == 0 && level != tree_model_sort->root)
2388 gtk_tree_model_sort_free_level (tree_model_sort, level);
2392 * gtk_tree_model_sort_reset_default_sort_func:
2393 * @tree_model_sort: A #GtkTreeModelSort
2395 * This resets the default sort function to be in the 'unsorted' state. That
2396 * is, it is in the same order as the child model. It will re-sort the model
2397 * to be in the same order as the child model only if the #GtkTreeModelSort
2398 * is in 'unsorted' state.
2401 gtk_tree_model_sort_reset_default_sort_func (GtkTreeModelSort *tree_model_sort)
2403 g_return_if_fail (GTK_IS_TREE_MODEL_SORT (tree_model_sort));
2405 if (tree_model_sort->default_sort_destroy)
2407 GDestroyNotify d = tree_model_sort->default_sort_destroy;
2409 tree_model_sort->default_sort_destroy = NULL;
2410 d (tree_model_sort->default_sort_data);
2413 tree_model_sort->default_sort_func = NO_SORT_FUNC;
2414 tree_model_sort->default_sort_data = NULL;
2415 tree_model_sort->default_sort_destroy = NULL;
2417 if (tree_model_sort->sort_column_id == GTK_TREE_SORTABLE_DEFAULT_SORT_COLUMN_ID)
2418 gtk_tree_model_sort_sort (tree_model_sort);
2419 tree_model_sort->sort_column_id = GTK_TREE_SORTABLE_DEFAULT_SORT_COLUMN_ID;
2423 * gtk_tree_model_sort_clear_cache:
2424 * @tree_model_sort: A #GtkTreeModelSort
2426 * This function should almost never be called. It clears the @tree_model_sort
2427 * of any cached iterators that haven't been reffed with
2428 * gtk_tree_model_ref_node(). This might be useful if the child model being
2429 * sorted is static (and doesn't change often) and there has been a lot of
2430 * unreffed access to nodes. As a side effect of this function, all unreffed
2431 * iters will be invalid.
2434 gtk_tree_model_sort_clear_cache (GtkTreeModelSort *tree_model_sort)
2436 g_return_if_fail (GTK_IS_TREE_MODEL_SORT (tree_model_sort));
2438 if (tree_model_sort->zero_ref_count > 0)
2439 gtk_tree_model_sort_clear_cache_helper (tree_model_sort, (SortLevel *)tree_model_sort->root);
2443 gtk_tree_model_sort_iter_is_valid_helper (GtkTreeIter *iter,
2448 for (i = 0; i < level->array->len; i++)
2450 SortElt *elt = &g_array_index (level->array, SortElt, i);
2452 if (iter->user_data == level && iter->user_data2 == elt)
2456 if (gtk_tree_model_sort_iter_is_valid_helper (iter, elt->children))
2464 * gtk_tree_model_sort_iter_is_valid:
2465 * @tree_model_sort: A #GtkTreeModelSort.
2466 * @iter: A #GtkTreeIter.
2469 * This function is slow. Only use it for debugging and/or testing purposes.
2472 * Checks if the given iter is a valid iter for this #GtkTreeModelSort.
2474 * Return value: %TRUE if the iter is valid, %FALSE if the iter is invalid.
2479 gtk_tree_model_sort_iter_is_valid (GtkTreeModelSort *tree_model_sort,
2482 g_return_val_if_fail (GTK_IS_TREE_MODEL_SORT (tree_model_sort), FALSE);
2483 g_return_val_if_fail (iter != NULL, FALSE);
2485 if (!VALID_ITER (iter, tree_model_sort))
2488 return gtk_tree_model_sort_iter_is_valid_helper (iter,
2489 tree_model_sort->root);
2492 #define __GTK_TREE_MODEL_SORT_C__
2493 #include "gtkaliasdef.c"