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, see <http://www.gnu.org/licenses/>.
22 #include "gtktreemodelsort.h"
23 #include "gtktreesortable.h"
24 #include "gtktreestore.h"
25 #include "gtktreedatalist.h"
27 #include "gtkprivate.h"
28 #include "gtktreednd.h"
32 * SECTION:gtktreemodelsort
33 * @Short_description: A GtkTreeModel which makes an underlying tree model sortable
34 * @Title: GtkTreeModelSort
35 * @See_also: #GtkTreeModel, #GtkListStore, #GtkTreeStore, #GtkTreeSortable, #GtkTreeModelFilter
37 * The #GtkTreeModelSort is a model which implements the #GtkTreeSortable
38 * interface. It does not hold any data itself, but rather is created with
39 * a child model and proxies its data. It has identical column types to
40 * this child model, and the changes in the child are propagated. The
41 * primary purpose of this model is to provide a way to sort a different
42 * model without modifying it. Note that the sort function used by
43 * #GtkTreeModelSort is not guaranteed to be stable.
45 * The use of this is best demonstrated through an example. In the
46 * following sample code we create two #GtkTreeView widgets each with a
47 * view of the same data. As the model is wrapped here by a
48 * #GtkTreeModelSort, the two #GtkTreeView<!-- -->s can each sort their
49 * view of the data without affecting the other. By contrast, if we
50 * simply put the same model in each widget, then sorting the first would
54 * <title>Using a <structname>GtkTreeModelSort</structname></title>
57 * GtkTreeView *tree_view1;
58 * GtkTreeView *tree_view2;
59 * GtkTreeModel *sort_model1;
60 * GtkTreeModel *sort_model2;
61 * GtkTreeModel *child_model;
63 * // get the child model
64 * child_model = get_my_model ();
66 * // Create the first tree
67 * sort_model1 = gtk_tree_model_sort_new_with_model (child_model);
68 * tree_view1 = gtk_tree_view_new_with_model (sort_model1);
70 * // Create the second tree
71 * sort_model2 = gtk_tree_model_sort_new_with_model (child_model);
72 * tree_view2 = gtk_tree_view_new_with_model (sort_model2);
74 * // Now we can sort the two models independently
75 * gtk_tree_sortable_set_sort_column_id (GTK_TREE_SORTABLE (sort_model1),
76 * COLUMN_1, GTK_SORT_ASCENDING);
77 * gtk_tree_sortable_set_sort_column_id (GTK_TREE_SORTABLE (sort_model2),
78 * COLUMN_1, GTK_SORT_DESCENDING);
83 * To demonstrate how to access the underlying child model from the sort
84 * model, the next example will be a callback for the #GtkTreeSelection
85 * #GtkTreeSelection::changed signal. In this callback, we get a string
86 * from COLUMN_1 of the model. We then modify the string, find the same
87 * selected row on the child model, and change the row there.
90 * <title>Accessing the child model of in a selection changed callback</title>
93 * selection_changed (GtkTreeSelection *selection, gpointer data)
95 * GtkTreeModel *sort_model = NULL;
96 * GtkTreeModel *child_model;
97 * GtkTreeIter sort_iter;
98 * GtkTreeIter child_iter;
99 * char *some_data = NULL;
100 * char *modified_data;
102 * // Get the current selected row and the model.
103 * if (! gtk_tree_selection_get_selected (selection,
108 * /<!---->* Look up the current value on the selected row and get a new value
111 * gtk_tree_model_get (GTK_TREE_MODEL (sort_model), &sort_iter,
112 * COLUMN_1, &some_data,
115 * modified_data = change_the_data (some_data);
116 * g_free (some_data);
118 * // Get an iterator on the child model, instead of the sort model.
119 * gtk_tree_model_sort_convert_iter_to_child_iter (GTK_TREE_MODEL_SORT (sort_model),
123 * /<!---->* Get the child model and change the value of the row. In this
124 * * example, the child model is a GtkListStore. It could be any other
125 * * type of model, though.
127 * child_model = gtk_tree_model_sort_get_model (GTK_TREE_MODEL_SORT (sort_model));
128 * gtk_list_store_set (GTK_LIST_STORE (child_model), &child_iter,
129 * COLUMN_1, &modified_data,
131 * g_free (modified_data);
138 /* Notes on this implementation of GtkTreeModelSort
139 * ================================================
144 * In this code there is a potential for confusion as to whether an iter,
145 * path or value refers to the GtkTreeModelSort model, or to the child model
146 * that has been set. As a convention, variables referencing the child model
147 * will have an s_ prefix before them (ie. s_iter, s_value, s_path);
148 * Conversion of iterators and paths between GtkTreeModelSort and the child
149 * model is done through the various gtk_tree_model_sort_convert_* functions.
154 * The iterator format of iterators handed out by GtkTreeModelSort is as
157 * iter->stamp = tree_model_sort->stamp
158 * iter->user_data = SortLevel
159 * iter->user_data2 = SortElt
161 * Internal data structure
162 * -----------------------
164 * Using SortLevel and SortElt, GtkTreeModelSort maintains a "cache" of
165 * the mapping from GtkTreeModelSort nodes to nodes in the child model.
166 * This is to avoid sorting a level each time an operation is requested
167 * on GtkTreeModelSort, such as get iter, get path, get value.
169 * A SortElt corresponds to a single node. A node and its siblings are
170 * stored in a SortLevel. The SortLevel keeps a reference to the parent
171 * SortElt and its SortLevel (if any). The SortElt can have a "children"
172 * pointer set, which points at a child level (a sub level).
174 * In a SortLevel, nodes are stored in a GSequence. The GSequence
175 * allows for fast additions and removals, and supports sorting
176 * the level of SortElt nodes.
178 * It is important to recognize the two different mappings that play
179 * a part in this code:
180 * I. The mapping from the client to this model. The order in which
181 * nodes are stored in the GSequence is the order in which the
182 * nodes are exposed to clients of the GtkTreeModelSort.
183 * II. The mapping from this model to its child model. Each SortElt
184 * contains an "offset" field which is the offset of the
185 * corresponding node in the child model.
190 * GtkTreeModelSort forwards all reference and unreference operations
191 * to the corresponding node in the child model. The reference count
192 * of each node is also maintained internally, in the "ref_count"
193 * fields in SortElt and SortLevel. For each ref and unref operation on
194 * a SortElt, the "ref_count" of the SortLevel is updated accordingly.
195 * In addition, if a SortLevel has a parent, a reference is taken on
196 * this parent. This happens in gtk_tree_model_sort_build_level() and
197 * the reference is released again in gtk_tree_model_sort_free_level().
198 * This ensures that when GtkTreeModelSort takes a reference on a node
199 * (for example during sorting), all parent nodes are referenced
200 * according to reference counting rule 1, see the GtkTreeModel
203 * When a level has a reference count of zero, which means that
204 * none of the nodes in the level is referenced, the level has
205 * a "zero ref count" on all its parents. As soon as the level
206 * reaches a reference count of zero, the zero ref count value is
207 * incremented by one on all parents of this level. Similarly, as
208 * soon as the reference count of a level changes from zero, the
209 * zero ref count value is decremented by one on all parents.
211 * The zero ref count value is used to clear unused portions of
212 * the cache. If a SortElt has a zero ref count of one, then
213 * its child level is unused and can be removed from the cache.
214 * If the zero ref count value is higher than one, then the
215 * child level contains sublevels which are unused as well.
216 * gtk_tree_model_sort_clear_cache() uses this to not recurse
217 * into levels which have a zero ref count of zero.
220 typedef struct _SortElt SortElt;
221 typedef struct _SortLevel SortLevel;
222 typedef struct _SortData SortData;
231 GSequenceIter *siter; /* iter into seq */
232 gint old_index; /* used while sorting */
240 SortLevel *parent_level;
245 GtkTreeModelSort *tree_model_sort;
246 GtkTreeIterCompareFunc sort_func;
249 GtkTreePath *parent_path;
250 gint parent_path_depth;
251 gint *parent_path_indices;
262 struct _GtkTreeModelSortPrivate
267 GtkTreeModel *child_model;
270 /* sort information */
276 GtkTreeIterCompareFunc default_sort_func;
277 gpointer default_sort_data;
278 GDestroyNotify default_sort_destroy;
283 gulong has_child_toggled_id;
288 /* Set this to 0 to disable caching of child iterators. This
289 * allows for more stringent testing. It is recommended to set this
290 * to one when refactoring this code and running the unit tests to
294 # define GTK_TREE_MODEL_SORT_CACHE_CHILD_ITERS(tree_model_sort) \
295 (((GtkTreeModelSort *)tree_model_sort)->priv->child_flags>K_TREE_MODEL_ITERS_PERSIST)
297 # define GTK_TREE_MODEL_SORT_CACHE_CHILD_ITERS(tree_model_sort) (FALSE)
300 #define SORT_ELT(sort_elt) ((SortElt *)sort_elt)
301 #define SORT_LEVEL(sort_level) ((SortLevel *)sort_level)
302 #define GET_ELT(siter) ((SortElt *) (siter ? g_sequence_get (siter) : NULL))
305 #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));
307 #define NO_SORT_FUNC ((GtkTreeIterCompareFunc) 0x1)
309 #define VALID_ITER(iter, tree_model_sort) ((iter) != NULL && (iter)->user_data != NULL && (iter)->user_data2 != NULL && (tree_model_sort)->priv->stamp == (iter)->stamp)
311 /* general (object/interface init, etc) */
312 static void gtk_tree_model_sort_tree_model_init (GtkTreeModelIface *iface);
313 static void gtk_tree_model_sort_tree_sortable_init (GtkTreeSortableIface *iface);
314 static void gtk_tree_model_sort_drag_source_init (GtkTreeDragSourceIface*iface);
315 static void gtk_tree_model_sort_finalize (GObject *object);
316 static void gtk_tree_model_sort_set_property (GObject *object,
320 static void gtk_tree_model_sort_get_property (GObject *object,
325 /* our signal handlers */
326 static void gtk_tree_model_sort_row_changed (GtkTreeModel *model,
327 GtkTreePath *start_path,
328 GtkTreeIter *start_iter,
330 static void gtk_tree_model_sort_row_inserted (GtkTreeModel *model,
334 static void gtk_tree_model_sort_row_has_child_toggled (GtkTreeModel *model,
338 static void gtk_tree_model_sort_row_deleted (GtkTreeModel *model,
341 static void gtk_tree_model_sort_rows_reordered (GtkTreeModel *s_model,
347 /* TreeModel interface */
348 static GtkTreeModelFlags gtk_tree_model_sort_get_flags (GtkTreeModel *tree_model);
349 static gint gtk_tree_model_sort_get_n_columns (GtkTreeModel *tree_model);
350 static GType gtk_tree_model_sort_get_column_type (GtkTreeModel *tree_model,
352 static gboolean gtk_tree_model_sort_get_iter (GtkTreeModel *tree_model,
355 static GtkTreePath *gtk_tree_model_sort_get_path (GtkTreeModel *tree_model,
357 static void gtk_tree_model_sort_get_value (GtkTreeModel *tree_model,
361 static gboolean gtk_tree_model_sort_iter_next (GtkTreeModel *tree_model,
363 static gboolean gtk_tree_model_sort_iter_previous (GtkTreeModel *tree_model,
365 static gboolean gtk_tree_model_sort_iter_children (GtkTreeModel *tree_model,
367 GtkTreeIter *parent);
368 static gboolean gtk_tree_model_sort_iter_has_child (GtkTreeModel *tree_model,
370 static gint gtk_tree_model_sort_iter_n_children (GtkTreeModel *tree_model,
372 static gboolean gtk_tree_model_sort_iter_nth_child (GtkTreeModel *tree_model,
376 static gboolean gtk_tree_model_sort_iter_parent (GtkTreeModel *tree_model,
379 static void gtk_tree_model_sort_ref_node (GtkTreeModel *tree_model,
381 static void gtk_tree_model_sort_real_unref_node (GtkTreeModel *tree_model,
383 gboolean propagate_unref);
384 static void gtk_tree_model_sort_unref_node (GtkTreeModel *tree_model,
387 /* TreeDragSource interface */
388 static gboolean gtk_tree_model_sort_row_draggable (GtkTreeDragSource *drag_source,
390 static gboolean gtk_tree_model_sort_drag_data_get (GtkTreeDragSource *drag_source,
392 GtkSelectionData *selection_data);
393 static gboolean gtk_tree_model_sort_drag_data_delete (GtkTreeDragSource *drag_source,
396 /* TreeSortable interface */
397 static gboolean gtk_tree_model_sort_get_sort_column_id (GtkTreeSortable *sortable,
398 gint *sort_column_id,
400 static void gtk_tree_model_sort_set_sort_column_id (GtkTreeSortable *sortable,
403 static void gtk_tree_model_sort_set_sort_func (GtkTreeSortable *sortable,
405 GtkTreeIterCompareFunc func,
407 GDestroyNotify destroy);
408 static void gtk_tree_model_sort_set_default_sort_func (GtkTreeSortable *sortable,
409 GtkTreeIterCompareFunc func,
411 GDestroyNotify destroy);
412 static gboolean gtk_tree_model_sort_has_default_sort_func (GtkTreeSortable *sortable);
414 /* Private functions (sort funcs, level handling and other utils) */
415 static void gtk_tree_model_sort_build_level (GtkTreeModelSort *tree_model_sort,
416 SortLevel *parent_level,
417 SortElt *parent_elt);
418 static void gtk_tree_model_sort_free_level (GtkTreeModelSort *tree_model_sort,
419 SortLevel *sort_level,
421 static void gtk_tree_model_sort_increment_stamp (GtkTreeModelSort *tree_model_sort);
422 static void gtk_tree_model_sort_sort_level (GtkTreeModelSort *tree_model_sort,
425 gboolean emit_reordered);
426 static void gtk_tree_model_sort_sort (GtkTreeModelSort *tree_model_sort);
427 static gboolean gtk_tree_model_sort_insert_value (GtkTreeModelSort *tree_model_sort,
430 GtkTreeIter *s_iter);
431 static GtkTreePath *gtk_tree_model_sort_elt_get_path (SortLevel *level,
433 static void gtk_tree_model_sort_set_model (GtkTreeModelSort *tree_model_sort,
434 GtkTreeModel *child_model);
435 static GtkTreePath *gtk_real_tree_model_sort_convert_child_path_to_path (GtkTreeModelSort *tree_model_sort,
436 GtkTreePath *child_path,
437 gboolean build_levels);
439 static gint gtk_tree_model_sort_compare_func (gconstpointer a,
442 static gint gtk_tree_model_sort_offset_compare_func (gconstpointer a,
445 static void gtk_tree_model_sort_clear_cache_helper (GtkTreeModelSort *tree_model_sort,
449 G_DEFINE_TYPE_WITH_CODE (GtkTreeModelSort, gtk_tree_model_sort, G_TYPE_OBJECT,
450 G_IMPLEMENT_INTERFACE (GTK_TYPE_TREE_MODEL,
451 gtk_tree_model_sort_tree_model_init)
452 G_IMPLEMENT_INTERFACE (GTK_TYPE_TREE_SORTABLE,
453 gtk_tree_model_sort_tree_sortable_init)
454 G_IMPLEMENT_INTERFACE (GTK_TYPE_TREE_DRAG_SOURCE,
455 gtk_tree_model_sort_drag_source_init))
458 gtk_tree_model_sort_init (GtkTreeModelSort *tree_model_sort)
460 GtkTreeModelSortPrivate *priv;
462 priv = G_TYPE_INSTANCE_GET_PRIVATE (tree_model_sort,
463 GTK_TYPE_TREE_MODEL_SORT,
464 GtkTreeModelSortPrivate);
465 tree_model_sort->priv = priv;
466 priv->sort_column_id = GTK_TREE_SORTABLE_DEFAULT_SORT_COLUMN_ID;
468 priv->zero_ref_count = 0;
470 priv->sort_list = NULL;
474 gtk_tree_model_sort_class_init (GtkTreeModelSortClass *class)
476 GObjectClass *object_class;
478 object_class = (GObjectClass *) class;
480 object_class->set_property = gtk_tree_model_sort_set_property;
481 object_class->get_property = gtk_tree_model_sort_get_property;
483 object_class->finalize = gtk_tree_model_sort_finalize;
486 g_object_class_install_property (object_class,
488 g_param_spec_object ("model",
489 P_("TreeModelSort Model"),
490 P_("The model for the TreeModelSort to sort"),
492 GTK_PARAM_READWRITE | G_PARAM_CONSTRUCT_ONLY));
494 g_type_class_add_private (class, sizeof (GtkTreeModelSortPrivate));
498 gtk_tree_model_sort_tree_model_init (GtkTreeModelIface *iface)
500 iface->get_flags = gtk_tree_model_sort_get_flags;
501 iface->get_n_columns = gtk_tree_model_sort_get_n_columns;
502 iface->get_column_type = gtk_tree_model_sort_get_column_type;
503 iface->get_iter = gtk_tree_model_sort_get_iter;
504 iface->get_path = gtk_tree_model_sort_get_path;
505 iface->get_value = gtk_tree_model_sort_get_value;
506 iface->iter_next = gtk_tree_model_sort_iter_next;
507 iface->iter_previous = gtk_tree_model_sort_iter_previous;
508 iface->iter_children = gtk_tree_model_sort_iter_children;
509 iface->iter_has_child = gtk_tree_model_sort_iter_has_child;
510 iface->iter_n_children = gtk_tree_model_sort_iter_n_children;
511 iface->iter_nth_child = gtk_tree_model_sort_iter_nth_child;
512 iface->iter_parent = gtk_tree_model_sort_iter_parent;
513 iface->ref_node = gtk_tree_model_sort_ref_node;
514 iface->unref_node = gtk_tree_model_sort_unref_node;
518 gtk_tree_model_sort_tree_sortable_init (GtkTreeSortableIface *iface)
520 iface->get_sort_column_id = gtk_tree_model_sort_get_sort_column_id;
521 iface->set_sort_column_id = gtk_tree_model_sort_set_sort_column_id;
522 iface->set_sort_func = gtk_tree_model_sort_set_sort_func;
523 iface->set_default_sort_func = gtk_tree_model_sort_set_default_sort_func;
524 iface->has_default_sort_func = gtk_tree_model_sort_has_default_sort_func;
528 gtk_tree_model_sort_drag_source_init (GtkTreeDragSourceIface *iface)
530 iface->row_draggable = gtk_tree_model_sort_row_draggable;
531 iface->drag_data_delete = gtk_tree_model_sort_drag_data_delete;
532 iface->drag_data_get = gtk_tree_model_sort_drag_data_get;
536 * gtk_tree_model_sort_new_with_model:
537 * @child_model: A #GtkTreeModel
539 * Creates a new #GtkTreeModel, with @child_model as the child model.
541 * Return value: (transfer full): A new #GtkTreeModel.
544 gtk_tree_model_sort_new_with_model (GtkTreeModel *child_model)
546 GtkTreeModel *retval;
548 g_return_val_if_fail (GTK_IS_TREE_MODEL (child_model), NULL);
550 retval = g_object_new (gtk_tree_model_sort_get_type (), NULL);
552 gtk_tree_model_sort_set_model (GTK_TREE_MODEL_SORT (retval), child_model);
557 /* GObject callbacks */
559 gtk_tree_model_sort_finalize (GObject *object)
561 GtkTreeModelSort *tree_model_sort = (GtkTreeModelSort *) object;
562 GtkTreeModelSortPrivate *priv = tree_model_sort->priv;
564 gtk_tree_model_sort_set_model (tree_model_sort, NULL);
567 gtk_tree_model_sort_free_level (tree_model_sort, priv->root, TRUE);
571 _gtk_tree_data_list_header_free (priv->sort_list);
572 priv->sort_list = NULL;
575 if (priv->default_sort_destroy)
577 priv->default_sort_destroy (priv->default_sort_data);
578 priv->default_sort_destroy = NULL;
579 priv->default_sort_data = NULL;
584 G_OBJECT_CLASS (gtk_tree_model_sort_parent_class)->finalize (object);
588 gtk_tree_model_sort_set_property (GObject *object,
593 GtkTreeModelSort *tree_model_sort = GTK_TREE_MODEL_SORT (object);
598 gtk_tree_model_sort_set_model (tree_model_sort, g_value_get_object (value));
601 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
607 gtk_tree_model_sort_get_property (GObject *object,
612 GtkTreeModelSort *tree_model_sort = GTK_TREE_MODEL_SORT (object);
617 g_value_set_object (value, gtk_tree_model_sort_get_model (tree_model_sort));
620 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
629 return g_slice_new (SortElt);
633 sort_elt_free (gpointer elt)
635 g_slice_free (SortElt, elt);
639 increase_offset_iter (gpointer data,
643 gint offset = GPOINTER_TO_INT (user_data);
645 if (elt->offset >= offset)
650 decrease_offset_iter (gpointer data,
654 gint offset = GPOINTER_TO_INT (user_data);
656 if (elt->offset > offset)
661 fill_sort_data (SortData *data,
662 GtkTreeModelSort *tree_model_sort,
665 GtkTreeModelSortPrivate *priv = tree_model_sort->priv;
667 data->tree_model_sort = tree_model_sort;
669 if (priv->sort_column_id != GTK_TREE_SORTABLE_DEFAULT_SORT_COLUMN_ID)
671 GtkTreeDataSortHeader *header;
673 header = _gtk_tree_data_list_get_header (priv->sort_list,
674 priv->sort_column_id);
676 g_return_if_fail (header != NULL);
677 g_return_if_fail (header->func != NULL);
679 data->sort_func = header->func;
680 data->sort_data = header->data;
684 /* absolutely SHOULD NOT happen: */
685 g_return_if_fail (priv->default_sort_func != NULL);
687 data->sort_func = priv->default_sort_func;
688 data->sort_data = priv->default_sort_data;
691 if (level->parent_elt)
693 data->parent_path = gtk_tree_model_sort_elt_get_path (level->parent_level,
695 gtk_tree_path_append_index (data->parent_path, 0);
699 data->parent_path = gtk_tree_path_new_first ();
701 data->parent_path_depth = gtk_tree_path_get_depth (data->parent_path);
702 data->parent_path_indices = gtk_tree_path_get_indices (data->parent_path);
706 free_sort_data (SortData *data)
708 gtk_tree_path_free (data->parent_path);
712 lookup_elt_with_offset (GtkTreeModelSort *tree_model_sort,
715 GSequenceIter **ret_siter)
717 GSequenceIter *siter, *end_siter;
719 /* FIXME: We have to do a search like this, because the sequence is not
720 * (always) sorted on offset order. Perhaps we should introduce a
721 * second sequence which is sorted on offset order.
723 end_siter = g_sequence_get_end_iter (level->seq);
724 for (siter = g_sequence_get_begin_iter (level->seq);
726 siter = g_sequence_iter_next (siter))
728 SortElt *elt = g_sequence_get (siter);
730 if (elt->offset == offset)
737 return GET_ELT (siter);
742 gtk_tree_model_sort_row_changed (GtkTreeModel *s_model,
743 GtkTreePath *start_s_path,
744 GtkTreeIter *start_s_iter,
747 GtkTreeModelSort *tree_model_sort = GTK_TREE_MODEL_SORT (data);
748 GtkTreeModelSortPrivate *priv = tree_model_sort->priv;
749 GtkTreePath *path = NULL;
757 gboolean free_s_path = FALSE;
759 gint index = 0, old_index;
761 g_return_if_fail (start_s_path != NULL || start_s_iter != NULL);
766 start_s_path = gtk_tree_model_get_path (s_model, start_s_iter);
769 path = gtk_real_tree_model_sort_convert_child_path_to_path (tree_model_sort,
775 gtk_tree_path_free (start_s_path);
779 gtk_tree_model_get_iter (GTK_TREE_MODEL (data), &iter, path);
780 gtk_tree_model_sort_ref_node (GTK_TREE_MODEL (data), &iter);
782 level = iter.user_data;
783 elt = iter.user_data2;
785 if (g_sequence_get_length (level->seq) < 2 ||
786 (priv->sort_column_id == GTK_TREE_SORTABLE_DEFAULT_SORT_COLUMN_ID &&
787 priv->default_sort_func == NO_SORT_FUNC))
790 gtk_tree_path_free (start_s_path);
792 gtk_tree_model_row_changed (GTK_TREE_MODEL (data), path, &iter);
793 gtk_tree_model_sort_unref_node (GTK_TREE_MODEL (data), &iter);
795 gtk_tree_path_free (path);
800 if (GTK_TREE_MODEL_SORT_CACHE_CHILD_ITERS (tree_model_sort))
803 gtk_tree_model_get_iter (priv->child_model,
804 &tmpiter, start_s_path);
806 old_index = g_sequence_iter_get_position (elt->siter);
808 fill_sort_data (&sort_data, tree_model_sort, level);
809 g_sequence_sort_changed (elt->siter,
810 gtk_tree_model_sort_compare_func,
812 free_sort_data (&sort_data);
814 index = g_sequence_iter_get_position (elt->siter);
816 /* Prepare the path for signal emission */
817 gtk_tree_path_up (path);
818 gtk_tree_path_append_index (path, index);
820 gtk_tree_model_sort_increment_stamp (tree_model_sort);
822 /* if the item moved, then emit rows_reordered */
823 if (old_index != index)
828 GtkTreePath *tmppath;
830 new_order = g_new (gint, g_sequence_get_length (level->seq));
832 for (j = 0; j < g_sequence_get_length (level->seq); j++)
834 if (index > old_index)
837 new_order[j] = old_index;
838 else if (j >= old_index && j < index)
839 new_order[j] = j + 1;
843 else if (index < old_index)
846 new_order[j] = old_index;
847 else if (j > index && j <= old_index)
848 new_order[j] = j - 1;
852 /* else? shouldn't really happen */
855 if (level->parent_elt)
857 iter.stamp = priv->stamp;
858 iter.user_data = level->parent_level;
859 iter.user_data2 = level->parent_elt;
861 tmppath = gtk_tree_model_get_path (GTK_TREE_MODEL (tree_model_sort), &iter);
863 gtk_tree_model_rows_reordered (GTK_TREE_MODEL (tree_model_sort),
864 tmppath, &iter, new_order);
869 tmppath = gtk_tree_path_new ();
871 gtk_tree_model_rows_reordered (GTK_TREE_MODEL (tree_model_sort), tmppath,
875 gtk_tree_path_free (tmppath);
879 /* emit row_changed signal (at new location) */
880 gtk_tree_model_get_iter (GTK_TREE_MODEL (data), &iter, path);
881 gtk_tree_model_row_changed (GTK_TREE_MODEL (data), path, &iter);
882 gtk_tree_model_sort_unref_node (GTK_TREE_MODEL (data), &iter);
884 gtk_tree_path_free (path);
886 gtk_tree_path_free (start_s_path);
890 gtk_tree_model_sort_row_inserted (GtkTreeModel *s_model,
895 GtkTreeModelSort *tree_model_sort = GTK_TREE_MODEL_SORT (data);
896 GtkTreeModelSortPrivate *priv = tree_model_sort->priv;
899 GtkTreeIter real_s_iter;
903 gboolean free_s_path = FALSE;
907 SortLevel *parent_level = NULL;
909 parent_level = level = SORT_LEVEL (priv->root);
911 g_return_if_fail (s_path != NULL || s_iter != NULL);
915 s_path = gtk_tree_model_get_path (s_model, s_iter);
920 gtk_tree_model_get_iter (s_model, &real_s_iter, s_path);
922 real_s_iter = *s_iter;
926 gtk_tree_model_sort_build_level (tree_model_sort, NULL, NULL);
928 /* the build level already put the inserted iter in the level,
929 so no need to handle this signal anymore */
931 goto done_and_submit;
934 /* find the parent level */
935 while (i < gtk_tree_path_get_depth (s_path) - 1)
939 /* level not yet build, we won't cover this signal */
943 if (g_sequence_get_length (level->seq) < gtk_tree_path_get_indices (s_path)[i])
945 g_warning ("%s: A node was inserted with a parent that's not in the tree.\n"
946 "This possibly means that a GtkTreeModel inserted a child node\n"
947 "before the parent was inserted.",
952 elt = lookup_elt_with_offset (tree_model_sort, level,
953 gtk_tree_path_get_indices (s_path)[i],
956 g_return_if_fail (elt != NULL);
960 /* not covering this signal */
964 level = elt->children;
965 parent_level = level;
972 if (level->ref_count == 0 && level != priv->root)
974 gtk_tree_model_sort_free_level (tree_model_sort, level, TRUE);
978 if (!gtk_tree_model_sort_insert_value (tree_model_sort,
985 path = gtk_real_tree_model_sort_convert_child_path_to_path (tree_model_sort,
992 gtk_tree_model_sort_increment_stamp (tree_model_sort);
994 gtk_tree_model_get_iter (GTK_TREE_MODEL (data), &iter, path);
995 gtk_tree_model_row_inserted (GTK_TREE_MODEL (data), path, &iter);
996 gtk_tree_path_free (path);
1000 gtk_tree_path_free (s_path);
1006 gtk_tree_model_sort_row_has_child_toggled (GtkTreeModel *s_model,
1007 GtkTreePath *s_path,
1008 GtkTreeIter *s_iter,
1011 GtkTreeModelSort *tree_model_sort = GTK_TREE_MODEL_SORT (data);
1015 g_return_if_fail (s_path != NULL && s_iter != NULL);
1017 path = gtk_real_tree_model_sort_convert_child_path_to_path (tree_model_sort, s_path, FALSE);
1021 gtk_tree_model_get_iter (GTK_TREE_MODEL (data), &iter, path);
1022 gtk_tree_model_row_has_child_toggled (GTK_TREE_MODEL (data), path, &iter);
1024 gtk_tree_path_free (path);
1028 gtk_tree_model_sort_row_deleted (GtkTreeModel *s_model,
1029 GtkTreePath *s_path,
1032 GtkTreeModelSort *tree_model_sort = GTK_TREE_MODEL_SORT (data);
1033 GtkTreePath *path = NULL;
1039 g_return_if_fail (s_path != NULL);
1041 path = gtk_real_tree_model_sort_convert_child_path_to_path (tree_model_sort, s_path, FALSE);
1045 gtk_tree_model_get_iter (GTK_TREE_MODEL (data), &iter, path);
1047 level = SORT_LEVEL (iter.user_data);
1048 elt = SORT_ELT (iter.user_data2);
1049 offset = elt->offset;
1051 gtk_tree_model_get_iter (GTK_TREE_MODEL (data), &iter, path);
1053 while (elt->ref_count > 0)
1054 gtk_tree_model_sort_real_unref_node (GTK_TREE_MODEL (data), &iter, FALSE);
1056 /* If this node has children, we free the level (recursively) here
1057 * and specify that unref may not be used, because parent and its
1058 * children have been removed by now.
1061 gtk_tree_model_sort_free_level (tree_model_sort,
1062 elt->children, FALSE);
1064 if (level->ref_count == 0)
1066 gtk_tree_model_sort_increment_stamp (tree_model_sort);
1067 gtk_tree_model_row_deleted (GTK_TREE_MODEL (data), path);
1068 gtk_tree_path_free (path);
1070 if (level == tree_model_sort->priv->root)
1072 gtk_tree_model_sort_free_level (tree_model_sort,
1073 tree_model_sort->priv->root,
1075 tree_model_sort->priv->root = NULL;
1080 g_sequence_remove (elt->siter);
1083 /* The sequence is not ordered on offset, so we traverse the entire
1086 g_sequence_foreach (level->seq, decrease_offset_iter,
1087 GINT_TO_POINTER (offset));
1089 gtk_tree_model_sort_increment_stamp (tree_model_sort);
1090 gtk_tree_model_row_deleted (GTK_TREE_MODEL (data), path);
1092 gtk_tree_path_free (path);
1096 gtk_tree_model_sort_rows_reordered (GtkTreeModel *s_model,
1097 GtkTreePath *s_path,
1098 GtkTreeIter *s_iter,
1108 GSequenceIter *siter, *end_siter;
1109 GtkTreeModelSort *tree_model_sort = GTK_TREE_MODEL_SORT (data);
1110 GtkTreeModelSortPrivate *priv = tree_model_sort->priv;
1112 g_return_if_fail (new_order != NULL);
1114 if (s_path == NULL || gtk_tree_path_get_depth (s_path) == 0)
1116 if (priv->root == NULL)
1118 path = gtk_tree_path_new ();
1119 level = SORT_LEVEL (priv->root);
1123 path = gtk_real_tree_model_sort_convert_child_path_to_path (tree_model_sort, s_path, FALSE);
1126 gtk_tree_model_get_iter (GTK_TREE_MODEL (data), &iter, path);
1128 elt = SORT_ELT (iter.user_data2);
1132 gtk_tree_path_free (path);
1136 level = elt->children;
1139 length = g_sequence_get_length (level->seq);
1142 gtk_tree_path_free (path);
1146 tmp_array = g_new (int, length);
1148 /* FIXME: I need to think about whether this can be done in a more
1152 end_siter = g_sequence_get_end_iter (level->seq);
1153 for (siter = g_sequence_get_begin_iter (level->seq);
1155 siter = g_sequence_iter_next (siter))
1158 SortElt *elt = g_sequence_get (siter);
1160 for (j = 0; j < length; j++)
1162 if (elt->offset == new_order[j])
1169 /* This loop cannot be merged with the above loop nest, because that
1170 * would introduce duplicate offsets.
1173 end_siter = g_sequence_get_end_iter (level->seq);
1174 for (siter = g_sequence_get_begin_iter (level->seq);
1176 siter = g_sequence_iter_next (siter))
1178 SortElt *elt = g_sequence_get (siter);
1180 elt->offset = tmp_array[i];
1185 if (priv->sort_column_id == GTK_TREE_SORTABLE_DEFAULT_SORT_COLUMN_ID &&
1186 priv->default_sort_func == NO_SORT_FUNC)
1188 gtk_tree_model_sort_sort_level (tree_model_sort, level,
1190 gtk_tree_model_sort_increment_stamp (tree_model_sort);
1192 if (gtk_tree_path_get_depth (path))
1194 gtk_tree_model_get_iter (GTK_TREE_MODEL (tree_model_sort),
1197 gtk_tree_model_rows_reordered (GTK_TREE_MODEL (tree_model_sort),
1198 path, &iter, new_order);
1202 gtk_tree_model_rows_reordered (GTK_TREE_MODEL (tree_model_sort),
1203 path, NULL, new_order);
1207 gtk_tree_path_free (path);
1210 /* Fulfill our model requirements */
1211 static GtkTreeModelFlags
1212 gtk_tree_model_sort_get_flags (GtkTreeModel *tree_model)
1214 GtkTreeModelSort *tree_model_sort = (GtkTreeModelSort *) tree_model;
1215 GtkTreeModelFlags flags;
1217 g_return_val_if_fail (tree_model_sort->priv->child_model != NULL, 0);
1219 flags = gtk_tree_model_get_flags (tree_model_sort->priv->child_model);
1221 if ((flags & GTK_TREE_MODEL_LIST_ONLY) == GTK_TREE_MODEL_LIST_ONLY)
1222 return GTK_TREE_MODEL_LIST_ONLY;
1228 gtk_tree_model_sort_get_n_columns (GtkTreeModel *tree_model)
1230 GtkTreeModelSort *tree_model_sort = (GtkTreeModelSort *) tree_model;
1232 if (tree_model_sort->priv->child_model == 0)
1235 return gtk_tree_model_get_n_columns (tree_model_sort->priv->child_model);
1239 gtk_tree_model_sort_get_column_type (GtkTreeModel *tree_model,
1242 GtkTreeModelSort *tree_model_sort = (GtkTreeModelSort *) tree_model;
1244 g_return_val_if_fail (tree_model_sort->priv->child_model != NULL, G_TYPE_INVALID);
1246 return gtk_tree_model_get_column_type (tree_model_sort->priv->child_model, index);
1250 gtk_tree_model_sort_get_iter (GtkTreeModel *tree_model,
1254 GtkTreeModelSort *tree_model_sort = (GtkTreeModelSort *) tree_model;
1255 GtkTreeModelSortPrivate *priv = tree_model_sort->priv;
1260 GSequenceIter *siter;
1262 g_return_val_if_fail (priv->child_model != NULL, FALSE);
1264 indices = gtk_tree_path_get_indices (path);
1266 if (priv->root == NULL)
1267 gtk_tree_model_sort_build_level (tree_model_sort, NULL, NULL);
1268 level = SORT_LEVEL (priv->root);
1270 depth = gtk_tree_path_get_depth (path);
1277 for (i = 0; i < depth - 1; i++)
1279 if ((level == NULL) ||
1280 (indices[i] >= g_sequence_get_length (level->seq)))
1286 siter = g_sequence_get_iter_at_pos (level->seq, indices[i]);
1287 if (g_sequence_iter_is_end (siter))
1293 elt = GET_ELT (siter);
1294 if (elt->children == NULL)
1295 gtk_tree_model_sort_build_level (tree_model_sort, level, elt);
1297 level = elt->children;
1300 if (!level || indices[i] >= g_sequence_get_length (level->seq))
1306 iter->stamp = priv->stamp;
1307 iter->user_data = level;
1309 siter = g_sequence_get_iter_at_pos (level->seq, indices[depth - 1]);
1310 if (g_sequence_iter_is_end (siter))
1315 iter->user_data2 = GET_ELT (siter);
1320 static GtkTreePath *
1321 gtk_tree_model_sort_get_path (GtkTreeModel *tree_model,
1324 GtkTreeModelSort *tree_model_sort = (GtkTreeModelSort *) tree_model;
1325 GtkTreeModelSortPrivate *priv = tree_model_sort->priv;
1326 GtkTreePath *retval;
1330 g_return_val_if_fail (priv->child_model != NULL, NULL);
1331 g_return_val_if_fail (priv->stamp == iter->stamp, NULL);
1333 retval = gtk_tree_path_new ();
1335 level = SORT_LEVEL (iter->user_data);
1336 elt = SORT_ELT (iter->user_data2);
1342 index = g_sequence_iter_get_position (elt->siter);
1343 gtk_tree_path_prepend_index (retval, index);
1345 elt = level->parent_elt;
1346 level = level->parent_level;
1353 gtk_tree_model_sort_get_value (GtkTreeModel *tree_model,
1358 GtkTreeModelSort *tree_model_sort = (GtkTreeModelSort *) tree_model;
1359 GtkTreeModelSortPrivate *priv = tree_model_sort->priv;
1360 GtkTreeIter child_iter;
1362 g_return_if_fail (priv->child_model != NULL);
1363 g_return_if_fail (VALID_ITER (iter, tree_model_sort));
1365 GET_CHILD_ITER (tree_model_sort, &child_iter, iter);
1366 gtk_tree_model_get_value (priv->child_model,
1367 &child_iter, column, value);
1371 gtk_tree_model_sort_iter_next (GtkTreeModel *tree_model,
1374 GtkTreeModelSort *tree_model_sort = (GtkTreeModelSort *) tree_model;
1375 GtkTreeModelSortPrivate *priv = tree_model_sort->priv;
1377 GSequenceIter *siter;
1379 g_return_val_if_fail (priv->child_model != NULL, FALSE);
1380 g_return_val_if_fail (priv->stamp == iter->stamp, FALSE);
1382 elt = iter->user_data2;
1384 siter = g_sequence_iter_next (elt->siter);
1385 if (g_sequence_iter_is_end (siter))
1390 iter->user_data2 = GET_ELT (siter);
1396 gtk_tree_model_sort_iter_previous (GtkTreeModel *tree_model,
1399 GtkTreeModelSort *tree_model_sort = (GtkTreeModelSort *) tree_model;
1400 GtkTreeModelSortPrivate *priv = tree_model_sort->priv;
1402 GSequenceIter *siter;
1404 g_return_val_if_fail (priv->child_model != NULL, FALSE);
1405 g_return_val_if_fail (priv->stamp == iter->stamp, FALSE);
1407 elt = iter->user_data2;
1409 if (g_sequence_iter_is_begin (elt->siter))
1415 siter = g_sequence_iter_prev (elt->siter);
1416 iter->user_data2 = GET_ELT (siter);
1422 gtk_tree_model_sort_iter_children (GtkTreeModel *tree_model,
1424 GtkTreeIter *parent)
1426 GtkTreeModelSort *tree_model_sort = (GtkTreeModelSort *) tree_model;
1427 GtkTreeModelSortPrivate *priv = tree_model_sort->priv;
1431 g_return_val_if_fail (priv->child_model != NULL, FALSE);
1433 g_return_val_if_fail (VALID_ITER (parent, tree_model_sort), FALSE);
1437 if (priv->root == NULL)
1438 gtk_tree_model_sort_build_level (tree_model_sort, NULL, NULL);
1439 if (priv->root == NULL)
1443 iter->stamp = priv->stamp;
1444 iter->user_data = level;
1445 iter->user_data2 = g_sequence_get (g_sequence_get_begin_iter (level->seq));
1451 level = SORT_LEVEL (parent->user_data);
1452 elt = SORT_ELT (parent->user_data2);
1454 if (elt->children == NULL)
1455 gtk_tree_model_sort_build_level (tree_model_sort, level, elt);
1457 if (elt->children == NULL)
1460 iter->stamp = priv->stamp;
1461 iter->user_data = elt->children;
1462 iter->user_data2 = g_sequence_get (g_sequence_get_begin_iter (elt->children->seq));
1469 gtk_tree_model_sort_iter_has_child (GtkTreeModel *tree_model,
1472 GtkTreeModelSort *tree_model_sort = (GtkTreeModelSort *) tree_model;
1473 GtkTreeModelSortPrivate *priv = tree_model_sort->priv;
1474 GtkTreeIter child_iter;
1476 g_return_val_if_fail (priv->child_model != NULL, FALSE);
1477 g_return_val_if_fail (VALID_ITER (iter, tree_model_sort), FALSE);
1479 GET_CHILD_ITER (tree_model_sort, &child_iter, iter);
1481 return gtk_tree_model_iter_has_child (priv->child_model, &child_iter);
1485 gtk_tree_model_sort_iter_n_children (GtkTreeModel *tree_model,
1488 GtkTreeModelSort *tree_model_sort = (GtkTreeModelSort *) tree_model;
1489 GtkTreeModelSortPrivate *priv = tree_model_sort->priv;
1490 GtkTreeIter child_iter;
1492 g_return_val_if_fail (priv->child_model != NULL, 0);
1494 g_return_val_if_fail (VALID_ITER (iter, tree_model_sort), 0);
1497 return gtk_tree_model_iter_n_children (priv->child_model, NULL);
1499 GET_CHILD_ITER (tree_model_sort, &child_iter, iter);
1501 return gtk_tree_model_iter_n_children (priv->child_model, &child_iter);
1505 gtk_tree_model_sort_iter_nth_child (GtkTreeModel *tree_model,
1507 GtkTreeIter *parent,
1510 GtkTreeModelSort *tree_model_sort = (GtkTreeModelSort *) tree_model;
1512 /* We have this for the iter == parent case */
1513 GtkTreeIter children;
1516 g_return_val_if_fail (VALID_ITER (parent, tree_model_sort), FALSE);
1518 /* Use this instead of has_child to force us to build the level, if needed */
1519 if (gtk_tree_model_sort_iter_children (tree_model, &children, parent) == FALSE)
1525 level = children.user_data;
1526 if (n >= g_sequence_get_length (level->seq))
1532 iter->stamp = tree_model_sort->priv->stamp;
1533 iter->user_data = level;
1534 iter->user_data2 = g_sequence_get (g_sequence_get_iter_at_pos (level->seq, n));
1540 gtk_tree_model_sort_iter_parent (GtkTreeModel *tree_model,
1544 GtkTreeModelSort *tree_model_sort = (GtkTreeModelSort *) tree_model;
1545 GtkTreeModelSortPrivate *priv = tree_model_sort->priv;
1549 g_return_val_if_fail (priv->child_model != NULL, FALSE);
1550 g_return_val_if_fail (VALID_ITER (child, tree_model_sort), FALSE);
1552 level = child->user_data;
1554 if (level->parent_level)
1556 iter->stamp = priv->stamp;
1557 iter->user_data = level->parent_level;
1558 iter->user_data2 = level->parent_elt;
1566 gtk_tree_model_sort_ref_node (GtkTreeModel *tree_model,
1569 GtkTreeModelSort *tree_model_sort = (GtkTreeModelSort *) tree_model;
1570 GtkTreeModelSortPrivate *priv = tree_model_sort->priv;
1571 GtkTreeIter child_iter;
1575 g_return_if_fail (priv->child_model != NULL);
1576 g_return_if_fail (VALID_ITER (iter, tree_model_sort));
1578 GET_CHILD_ITER (tree_model_sort, &child_iter, iter);
1580 /* Reference the node in the child model */
1581 gtk_tree_model_ref_node (priv->child_model, &child_iter);
1583 /* Increase the reference count of this element and its level */
1584 level = iter->user_data;
1585 elt = iter->user_data2;
1590 if (level->ref_count == 1)
1592 SortLevel *parent_level = level->parent_level;
1593 SortElt *parent_elt = level->parent_elt;
1595 /* We were at zero -- time to decrement the zero_ref_count val */
1596 while (parent_level)
1598 parent_elt->zero_ref_count--;
1600 parent_elt = parent_level->parent_elt;
1601 parent_level = parent_level->parent_level;
1604 if (priv->root != level)
1605 priv->zero_ref_count--;
1610 gtk_tree_model_sort_real_unref_node (GtkTreeModel *tree_model,
1612 gboolean propagate_unref)
1614 GtkTreeModelSort *tree_model_sort = (GtkTreeModelSort *) tree_model;
1615 GtkTreeModelSortPrivate *priv = tree_model_sort->priv;
1619 g_return_if_fail (priv->child_model != NULL);
1620 g_return_if_fail (VALID_ITER (iter, tree_model_sort));
1622 if (propagate_unref)
1624 GtkTreeIter child_iter;
1626 GET_CHILD_ITER (tree_model_sort, &child_iter, iter);
1627 gtk_tree_model_unref_node (priv->child_model, &child_iter);
1630 level = iter->user_data;
1631 elt = iter->user_data2;
1633 g_return_if_fail (elt->ref_count > 0);
1638 if (level->ref_count == 0)
1640 SortLevel *parent_level = level->parent_level;
1641 SortElt *parent_elt = level->parent_elt;
1643 /* We are at zero -- time to increment the zero_ref_count val */
1644 while (parent_level)
1646 parent_elt->zero_ref_count++;
1648 parent_elt = parent_level->parent_elt;
1649 parent_level = parent_level->parent_level;
1652 if (priv->root != level)
1653 priv->zero_ref_count++;
1658 gtk_tree_model_sort_unref_node (GtkTreeModel *tree_model,
1661 gtk_tree_model_sort_real_unref_node (tree_model, iter, TRUE);
1664 /* Sortable interface */
1666 gtk_tree_model_sort_get_sort_column_id (GtkTreeSortable *sortable,
1667 gint *sort_column_id,
1670 GtkTreeModelSort *tree_model_sort = (GtkTreeModelSort *)sortable;
1671 GtkTreeModelSortPrivate *priv = tree_model_sort->priv;
1674 *sort_column_id = priv->sort_column_id;
1676 *order = priv->order;
1678 if (priv->sort_column_id == GTK_TREE_SORTABLE_DEFAULT_SORT_COLUMN_ID ||
1679 priv->sort_column_id == GTK_TREE_SORTABLE_UNSORTED_SORT_COLUMN_ID)
1686 gtk_tree_model_sort_set_sort_column_id (GtkTreeSortable *sortable,
1687 gint sort_column_id,
1690 GtkTreeModelSort *tree_model_sort = (GtkTreeModelSort *)sortable;
1691 GtkTreeModelSortPrivate *priv = tree_model_sort->priv;
1693 if (sort_column_id != GTK_TREE_SORTABLE_UNSORTED_SORT_COLUMN_ID)
1695 if (sort_column_id != GTK_TREE_SORTABLE_DEFAULT_SORT_COLUMN_ID)
1697 GtkTreeDataSortHeader *header = NULL;
1699 header = _gtk_tree_data_list_get_header (priv->sort_list,
1702 /* we want to make sure that we have a function */
1703 g_return_if_fail (header != NULL);
1704 g_return_if_fail (header->func != NULL);
1707 g_return_if_fail (priv->default_sort_func != NULL);
1709 if (priv->sort_column_id == sort_column_id)
1711 if (sort_column_id != GTK_TREE_SORTABLE_DEFAULT_SORT_COLUMN_ID)
1713 if (priv->order == order)
1721 priv->sort_column_id = sort_column_id;
1722 priv->order = order;
1724 gtk_tree_sortable_sort_column_changed (sortable);
1726 gtk_tree_model_sort_sort (tree_model_sort);
1730 gtk_tree_model_sort_set_sort_func (GtkTreeSortable *sortable,
1731 gint sort_column_id,
1732 GtkTreeIterCompareFunc func,
1734 GDestroyNotify destroy)
1736 GtkTreeModelSort *tree_model_sort = (GtkTreeModelSort *) sortable;
1737 GtkTreeModelSortPrivate *priv = tree_model_sort->priv;
1739 priv->sort_list = _gtk_tree_data_list_set_header (priv->sort_list,
1741 func, data, destroy);
1743 if (priv->sort_column_id == sort_column_id)
1744 gtk_tree_model_sort_sort (tree_model_sort);
1748 gtk_tree_model_sort_set_default_sort_func (GtkTreeSortable *sortable,
1749 GtkTreeIterCompareFunc func,
1751 GDestroyNotify destroy)
1753 GtkTreeModelSort *tree_model_sort = (GtkTreeModelSort *)sortable;
1754 GtkTreeModelSortPrivate *priv = tree_model_sort->priv;
1756 if (priv->default_sort_destroy)
1758 GDestroyNotify d = priv->default_sort_destroy;
1760 priv->default_sort_destroy = NULL;
1761 d (priv->default_sort_data);
1764 priv->default_sort_func = func;
1765 priv->default_sort_data = data;
1766 priv->default_sort_destroy = destroy;
1768 if (priv->sort_column_id == GTK_TREE_SORTABLE_DEFAULT_SORT_COLUMN_ID)
1769 gtk_tree_model_sort_sort (tree_model_sort);
1773 gtk_tree_model_sort_has_default_sort_func (GtkTreeSortable *sortable)
1775 GtkTreeModelSort *tree_model_sort = (GtkTreeModelSort *)sortable;
1777 return (tree_model_sort->priv->default_sort_func != NULL);
1780 /* DragSource interface */
1782 gtk_tree_model_sort_row_draggable (GtkTreeDragSource *drag_source,
1785 GtkTreeModelSort *tree_model_sort = (GtkTreeModelSort *)drag_source;
1786 GtkTreePath *child_path;
1789 child_path = gtk_tree_model_sort_convert_path_to_child_path (tree_model_sort,
1791 draggable = gtk_tree_drag_source_row_draggable (GTK_TREE_DRAG_SOURCE (tree_model_sort->priv->child_model), child_path);
1792 gtk_tree_path_free (child_path);
1798 gtk_tree_model_sort_drag_data_get (GtkTreeDragSource *drag_source,
1800 GtkSelectionData *selection_data)
1802 GtkTreeModelSort *tree_model_sort = (GtkTreeModelSort *)drag_source;
1803 GtkTreePath *child_path;
1806 child_path = gtk_tree_model_sort_convert_path_to_child_path (tree_model_sort, path);
1807 gotten = gtk_tree_drag_source_drag_data_get (GTK_TREE_DRAG_SOURCE (tree_model_sort->priv->child_model), child_path, selection_data);
1808 gtk_tree_path_free (child_path);
1814 gtk_tree_model_sort_drag_data_delete (GtkTreeDragSource *drag_source,
1817 GtkTreeModelSort *tree_model_sort = (GtkTreeModelSort *)drag_source;
1818 GtkTreePath *child_path;
1821 child_path = gtk_tree_model_sort_convert_path_to_child_path (tree_model_sort, path);
1822 deleted = gtk_tree_drag_source_drag_data_delete (GTK_TREE_DRAG_SOURCE (tree_model_sort->priv->child_model), child_path);
1823 gtk_tree_path_free (child_path);
1828 /* sorting code - private */
1830 gtk_tree_model_sort_compare_func (gconstpointer a,
1834 SortData *data = (SortData *)user_data;
1835 GtkTreeModelSort *tree_model_sort = data->tree_model_sort;
1836 GtkTreeModelSortPrivate *priv = tree_model_sort->priv;
1837 const SortElt *sa = a;
1838 const SortElt *sb = b;
1840 GtkTreeIter iter_a, iter_b;
1843 if (GTK_TREE_MODEL_SORT_CACHE_CHILD_ITERS (tree_model_sort))
1850 data->parent_path_indices [data->parent_path_depth-1] = sa->offset;
1851 gtk_tree_model_get_iter (GTK_TREE_MODEL (priv->child_model), &iter_a, data->parent_path);
1852 data->parent_path_indices [data->parent_path_depth-1] = sb->offset;
1853 gtk_tree_model_get_iter (GTK_TREE_MODEL (priv->child_model), &iter_b, data->parent_path);
1856 retval = (* data->sort_func) (GTK_TREE_MODEL (priv->child_model),
1860 if (priv->order == GTK_SORT_DESCENDING)
1864 else if (retval < 0)
1872 gtk_tree_model_sort_offset_compare_func (gconstpointer a,
1878 const SortElt *sa = (SortElt *)a;
1879 const SortElt *sb = (SortElt *)b;
1881 SortData *data = (SortData *)user_data;
1883 if (sa->offset < sb->offset)
1885 else if (sa->offset > sb->offset)
1890 if (data->tree_model_sort->priv->order == GTK_SORT_DESCENDING)
1894 else if (retval < 0)
1902 gtk_tree_model_sort_sort_level (GtkTreeModelSort *tree_model_sort,
1905 gboolean emit_reordered)
1907 GtkTreeModelSortPrivate *priv = tree_model_sort->priv;
1909 GSequenceIter *begin_siter, *end_siter, *siter;
1918 g_return_if_fail (level != NULL);
1920 begin_siter = g_sequence_get_begin_iter (level->seq);
1921 begin_elt = g_sequence_get (begin_siter);
1923 if (g_sequence_get_length (level->seq) < 1 && !begin_elt->children)
1926 iter.stamp = priv->stamp;
1927 iter.user_data = level;
1928 iter.user_data2 = begin_elt;
1930 gtk_tree_model_sort_ref_node (GTK_TREE_MODEL (tree_model_sort), &iter);
1933 end_siter = g_sequence_get_end_iter (level->seq);
1934 for (siter = g_sequence_get_begin_iter (level->seq);
1936 siter = g_sequence_iter_next (siter))
1938 SortElt *elt = g_sequence_get (siter);
1944 fill_sort_data (&data, tree_model_sort, level);
1946 if (data.sort_func == NO_SORT_FUNC)
1947 g_sequence_sort (level->seq, gtk_tree_model_sort_offset_compare_func,
1950 g_sequence_sort (level->seq, gtk_tree_model_sort_compare_func, &data);
1952 free_sort_data (&data);
1954 new_order = g_new (gint, g_sequence_get_length (level->seq));
1957 end_siter = g_sequence_get_end_iter (level->seq);
1958 for (siter = g_sequence_get_begin_iter (level->seq);
1960 siter = g_sequence_iter_next (siter))
1962 SortElt *elt = g_sequence_get (siter);
1964 new_order[i++] = elt->old_index;
1969 gtk_tree_model_sort_increment_stamp (tree_model_sort);
1970 if (level->parent_elt)
1972 iter.stamp = priv->stamp;
1973 iter.user_data = level->parent_level;
1974 iter.user_data2 = level->parent_elt;
1976 path = gtk_tree_model_get_path (GTK_TREE_MODEL (tree_model_sort),
1979 gtk_tree_model_rows_reordered (GTK_TREE_MODEL (tree_model_sort), path,
1985 path = gtk_tree_path_new ();
1986 gtk_tree_model_rows_reordered (GTK_TREE_MODEL (tree_model_sort), path,
1990 gtk_tree_path_free (path);
1993 /* recurse, if possible */
1996 end_siter = g_sequence_get_end_iter (level->seq);
1997 for (siter = g_sequence_get_begin_iter (level->seq);
1999 siter = g_sequence_iter_next (siter))
2001 SortElt *elt = g_sequence_get (siter);
2004 gtk_tree_model_sort_sort_level (tree_model_sort,
2006 TRUE, emit_reordered);
2012 /* get the iter we referenced at the beginning of this function and
2015 iter.stamp = priv->stamp;
2016 iter.user_data = level;
2017 iter.user_data2 = begin_elt;
2019 gtk_tree_model_sort_unref_node (GTK_TREE_MODEL (tree_model_sort), &iter);
2023 gtk_tree_model_sort_sort (GtkTreeModelSort *tree_model_sort)
2025 GtkTreeModelSortPrivate *priv = tree_model_sort->priv;
2027 if (priv->sort_column_id == GTK_TREE_SORTABLE_UNSORTED_SORT_COLUMN_ID)
2033 if (priv->sort_column_id != GTK_TREE_SORTABLE_DEFAULT_SORT_COLUMN_ID)
2035 GtkTreeDataSortHeader *header = NULL;
2037 header = _gtk_tree_data_list_get_header (priv->sort_list,
2038 priv->sort_column_id);
2040 /* we want to make sure that we have a function */
2041 g_return_if_fail (header != NULL);
2042 g_return_if_fail (header->func != NULL);
2045 g_return_if_fail (priv->default_sort_func != NULL);
2047 gtk_tree_model_sort_sort_level (tree_model_sort, priv->root,
2051 /* signal helpers */
2053 gtk_tree_model_sort_insert_value (GtkTreeModelSort *tree_model_sort,
2055 GtkTreePath *s_path,
2056 GtkTreeIter *s_iter)
2058 GtkTreeModelSortPrivate *priv = tree_model_sort->priv;
2063 elt = sort_elt_new ();
2065 offset = gtk_tree_path_get_indices (s_path)[gtk_tree_path_get_depth (s_path) - 1];
2067 if (GTK_TREE_MODEL_SORT_CACHE_CHILD_ITERS (tree_model_sort))
2068 elt->iter = *s_iter;
2069 elt->offset = offset;
2070 elt->zero_ref_count = 0;
2072 elt->children = NULL;
2074 /* update all larger offsets */
2075 g_sequence_foreach (level->seq, increase_offset_iter, GINT_TO_POINTER (offset));
2077 fill_sort_data (&data, tree_model_sort, level);
2079 if (priv->sort_column_id == GTK_TREE_SORTABLE_DEFAULT_SORT_COLUMN_ID &&
2080 priv->default_sort_func == NO_SORT_FUNC)
2082 elt->siter = g_sequence_insert_sorted (level->seq, elt,
2083 gtk_tree_model_sort_offset_compare_func,
2088 elt->siter = g_sequence_insert_sorted (level->seq, elt,
2089 gtk_tree_model_sort_compare_func,
2093 free_sort_data (&data);
2098 /* sort elt stuff */
2099 static GtkTreePath *
2100 gtk_tree_model_sort_elt_get_path (SortLevel *level,
2103 SortLevel *walker = level;
2104 SortElt *walker2 = elt;
2107 g_return_val_if_fail (level != NULL, NULL);
2108 g_return_val_if_fail (elt != NULL, NULL);
2110 path = gtk_tree_path_new ();
2114 gtk_tree_path_prepend_index (path, walker2->offset);
2116 if (!walker->parent_level)
2119 walker2 = walker->parent_elt;
2120 walker = walker->parent_level;
2127 * gtk_tree_model_sort_set_model:
2128 * @tree_model_sort: The #GtkTreeModelSort.
2129 * @child_model: (allow-none): A #GtkTreeModel, or %NULL.
2131 * Sets the model of @tree_model_sort to be @model. If @model is %NULL,
2132 * then the old model is unset. The sort function is unset as a result
2133 * of this call. The model will be in an unsorted state until a sort
2137 gtk_tree_model_sort_set_model (GtkTreeModelSort *tree_model_sort,
2138 GtkTreeModel *child_model)
2140 GtkTreeModelSortPrivate *priv = tree_model_sort->priv;
2143 g_object_ref (child_model);
2145 if (priv->child_model)
2147 g_signal_handler_disconnect (priv->child_model,
2149 g_signal_handler_disconnect (priv->child_model,
2151 g_signal_handler_disconnect (priv->child_model,
2152 priv->has_child_toggled_id);
2153 g_signal_handler_disconnect (priv->child_model,
2155 g_signal_handler_disconnect (priv->child_model,
2156 priv->reordered_id);
2158 /* reset our state */
2160 gtk_tree_model_sort_free_level (tree_model_sort, priv->root, TRUE);
2162 _gtk_tree_data_list_header_free (priv->sort_list);
2163 priv->sort_list = NULL;
2164 g_object_unref (priv->child_model);
2167 priv->child_model = child_model;
2175 g_signal_connect (child_model, "row-changed",
2176 G_CALLBACK (gtk_tree_model_sort_row_changed),
2179 g_signal_connect (child_model, "row-inserted",
2180 G_CALLBACK (gtk_tree_model_sort_row_inserted),
2182 priv->has_child_toggled_id =
2183 g_signal_connect (child_model, "row-has-child-toggled",
2184 G_CALLBACK (gtk_tree_model_sort_row_has_child_toggled),
2187 g_signal_connect (child_model, "row-deleted",
2188 G_CALLBACK (gtk_tree_model_sort_row_deleted),
2190 priv->reordered_id =
2191 g_signal_connect (child_model, "rows-reordered",
2192 G_CALLBACK (gtk_tree_model_sort_rows_reordered),
2195 priv->child_flags = gtk_tree_model_get_flags (child_model);
2196 n_columns = gtk_tree_model_get_n_columns (child_model);
2198 types = g_new (GType, n_columns);
2199 for (i = 0; i < n_columns; i++)
2200 types[i] = gtk_tree_model_get_column_type (child_model, i);
2202 priv->sort_list = _gtk_tree_data_list_header_new (n_columns, types);
2205 priv->default_sort_func = NO_SORT_FUNC;
2206 priv->stamp = g_random_int ();
2211 * gtk_tree_model_sort_get_model:
2212 * @tree_model: a #GtkTreeModelSort
2214 * Returns the model the #GtkTreeModelSort is sorting.
2216 * Return value: (transfer none): the "child model" being sorted
2219 gtk_tree_model_sort_get_model (GtkTreeModelSort *tree_model)
2221 g_return_val_if_fail (GTK_IS_TREE_MODEL_SORT (tree_model), NULL);
2223 return tree_model->priv->child_model;
2227 static GtkTreePath *
2228 gtk_real_tree_model_sort_convert_child_path_to_path (GtkTreeModelSort *tree_model_sort,
2229 GtkTreePath *child_path,
2230 gboolean build_levels)
2232 GtkTreeModelSortPrivate *priv = tree_model_sort->priv;
2233 gint *child_indices;
2234 GtkTreePath *retval;
2238 g_return_val_if_fail (priv->child_model != NULL, NULL);
2239 g_return_val_if_fail (child_path != NULL, NULL);
2241 retval = gtk_tree_path_new ();
2242 child_indices = gtk_tree_path_get_indices (child_path);
2244 if (priv->root == NULL && build_levels)
2245 gtk_tree_model_sort_build_level (tree_model_sort, NULL, NULL);
2246 level = SORT_LEVEL (priv->root);
2248 for (i = 0; i < gtk_tree_path_get_depth (child_path); i++)
2251 GSequenceIter *siter;
2252 gboolean found_child = FALSE;
2256 gtk_tree_path_free (retval);
2260 if (child_indices[i] >= g_sequence_get_length (level->seq))
2262 gtk_tree_path_free (retval);
2265 tmp = lookup_elt_with_offset (tree_model_sort, level,
2266 child_indices[i], &siter);
2269 gtk_tree_path_append_index (retval, g_sequence_iter_get_position (siter));
2270 if (tmp->children == NULL && build_levels)
2271 gtk_tree_model_sort_build_level (tree_model_sort, level, tmp);
2273 level = tmp->children;
2279 gtk_tree_path_free (retval);
2289 * gtk_tree_model_sort_convert_child_path_to_path:
2290 * @tree_model_sort: A #GtkTreeModelSort
2291 * @child_path: A #GtkTreePath to convert
2293 * Converts @child_path to a path relative to @tree_model_sort. That is,
2294 * @child_path points to a path in the child model. The returned path will
2295 * point to the same row in the sorted model. If @child_path isn't a valid
2296 * path on the child model, then %NULL is returned.
2298 * Return value: A newly allocated #GtkTreePath, or %NULL
2301 gtk_tree_model_sort_convert_child_path_to_path (GtkTreeModelSort *tree_model_sort,
2302 GtkTreePath *child_path)
2304 g_return_val_if_fail (GTK_IS_TREE_MODEL_SORT (tree_model_sort), NULL);
2305 g_return_val_if_fail (tree_model_sort->priv->child_model != NULL, NULL);
2306 g_return_val_if_fail (child_path != NULL, NULL);
2308 return gtk_real_tree_model_sort_convert_child_path_to_path (tree_model_sort, child_path, TRUE);
2312 * gtk_tree_model_sort_convert_child_iter_to_iter:
2313 * @tree_model_sort: A #GtkTreeModelSort
2314 * @sort_iter: (out): An uninitialized #GtkTreeIter.
2315 * @child_iter: A valid #GtkTreeIter pointing to a row on the child model
2317 * Sets @sort_iter to point to the row in @tree_model_sort that corresponds to
2318 * the row pointed at by @child_iter. If @sort_iter was not set, %FALSE
2319 * is returned. Note: a boolean is only returned since 2.14.
2321 * Return value: %TRUE, if @sort_iter was set, i.e. if @sort_iter is a
2322 * valid iterator pointer to a visible row in the child model.
2325 gtk_tree_model_sort_convert_child_iter_to_iter (GtkTreeModelSort *tree_model_sort,
2326 GtkTreeIter *sort_iter,
2327 GtkTreeIter *child_iter)
2330 GtkTreePath *child_path, *path;
2331 GtkTreeModelSortPrivate *priv = tree_model_sort->priv;
2333 g_return_val_if_fail (GTK_IS_TREE_MODEL_SORT (tree_model_sort), FALSE);
2334 g_return_val_if_fail (priv->child_model != NULL, FALSE);
2335 g_return_val_if_fail (sort_iter != NULL, FALSE);
2336 g_return_val_if_fail (child_iter != NULL, FALSE);
2337 g_return_val_if_fail (sort_iter != child_iter, FALSE);
2339 sort_iter->stamp = 0;
2341 child_path = gtk_tree_model_get_path (priv->child_model, child_iter);
2342 g_return_val_if_fail (child_path != NULL, FALSE);
2344 path = gtk_tree_model_sort_convert_child_path_to_path (tree_model_sort, child_path);
2345 gtk_tree_path_free (child_path);
2349 g_warning ("%s: The conversion of the child path to a GtkTreeModel sort path failed", G_STRLOC);
2353 ret = gtk_tree_model_get_iter (GTK_TREE_MODEL (tree_model_sort),
2355 gtk_tree_path_free (path);
2361 * gtk_tree_model_sort_convert_path_to_child_path:
2362 * @tree_model_sort: A #GtkTreeModelSort
2363 * @sorted_path: A #GtkTreePath to convert
2365 * Converts @sorted_path to a path on the child model of @tree_model_sort.
2366 * That is, @sorted_path points to a location in @tree_model_sort. The
2367 * returned path will point to the same location in the model not being
2368 * sorted. If @sorted_path does not point to a location in the child model,
2369 * %NULL is returned.
2371 * Return value: A newly allocated #GtkTreePath, or %NULL
2374 gtk_tree_model_sort_convert_path_to_child_path (GtkTreeModelSort *tree_model_sort,
2375 GtkTreePath *sorted_path)
2377 GtkTreeModelSortPrivate *priv = tree_model_sort->priv;
2378 gint *sorted_indices;
2379 GtkTreePath *retval;
2383 g_return_val_if_fail (GTK_IS_TREE_MODEL_SORT (tree_model_sort), NULL);
2384 g_return_val_if_fail (priv->child_model != NULL, NULL);
2385 g_return_val_if_fail (sorted_path != NULL, NULL);
2387 retval = gtk_tree_path_new ();
2388 sorted_indices = gtk_tree_path_get_indices (sorted_path);
2389 if (priv->root == NULL)
2390 gtk_tree_model_sort_build_level (tree_model_sort, NULL, NULL);
2391 level = SORT_LEVEL (priv->root);
2393 for (i = 0; i < gtk_tree_path_get_depth (sorted_path); i++)
2395 SortElt *elt = NULL;
2396 GSequenceIter *siter;
2398 if ((level == NULL) ||
2399 (g_sequence_get_length (level->seq) <= sorted_indices[i]))
2401 gtk_tree_path_free (retval);
2405 siter = g_sequence_get_iter_at_pos (level->seq, sorted_indices[i]);
2406 if (g_sequence_iter_is_end (siter))
2408 gtk_tree_path_free (retval);
2412 elt = GET_ELT (siter);
2413 if (elt->children == NULL)
2414 gtk_tree_model_sort_build_level (tree_model_sort, level, elt);
2418 gtk_tree_path_free (retval);
2422 gtk_tree_path_append_index (retval, elt->offset);
2423 level = elt->children;
2430 * gtk_tree_model_sort_convert_iter_to_child_iter:
2431 * @tree_model_sort: A #GtkTreeModelSort
2432 * @child_iter: (out): An uninitialized #GtkTreeIter
2433 * @sorted_iter: A valid #GtkTreeIter pointing to a row on @tree_model_sort.
2435 * Sets @child_iter to point to the row pointed to by @sorted_iter.
2438 gtk_tree_model_sort_convert_iter_to_child_iter (GtkTreeModelSort *tree_model_sort,
2439 GtkTreeIter *child_iter,
2440 GtkTreeIter *sorted_iter)
2442 GtkTreeModelSortPrivate *priv = tree_model_sort->priv;
2443 g_return_if_fail (GTK_IS_TREE_MODEL_SORT (tree_model_sort));
2444 g_return_if_fail (priv->child_model != NULL);
2445 g_return_if_fail (child_iter != NULL);
2446 g_return_if_fail (VALID_ITER (sorted_iter, tree_model_sort));
2447 g_return_if_fail (sorted_iter != child_iter);
2449 if (GTK_TREE_MODEL_SORT_CACHE_CHILD_ITERS (tree_model_sort))
2451 *child_iter = SORT_ELT (sorted_iter->user_data2)->iter;
2456 gboolean valid = FALSE;
2458 path = gtk_tree_model_sort_elt_get_path (sorted_iter->user_data,
2459 sorted_iter->user_data2);
2460 valid = gtk_tree_model_get_iter (priv->child_model, child_iter, path);
2461 gtk_tree_path_free (path);
2463 g_return_if_fail (valid == TRUE);
2468 gtk_tree_model_sort_build_level (GtkTreeModelSort *tree_model_sort,
2469 SortLevel *parent_level,
2470 SortElt *parent_elt)
2472 GtkTreeModelSortPrivate *priv = tree_model_sort->priv;
2474 SortLevel *new_level;
2478 g_assert (priv->child_model != NULL);
2480 if (parent_level == NULL)
2482 if (gtk_tree_model_get_iter_first (priv->child_model, &iter) == FALSE)
2484 length = gtk_tree_model_iter_n_children (priv->child_model, NULL);
2488 GtkTreeIter parent_iter;
2489 GtkTreeIter child_parent_iter;
2491 parent_iter.stamp = priv->stamp;
2492 parent_iter.user_data = parent_level;
2493 parent_iter.user_data2 = parent_elt;
2495 gtk_tree_model_sort_convert_iter_to_child_iter (tree_model_sort,
2498 if (gtk_tree_model_iter_children (priv->child_model,
2500 &child_parent_iter) == FALSE)
2503 /* stamp may have changed */
2504 gtk_tree_model_sort_convert_iter_to_child_iter (tree_model_sort,
2508 length = gtk_tree_model_iter_n_children (priv->child_model, &child_parent_iter);
2510 gtk_tree_model_sort_ref_node (GTK_TREE_MODEL (tree_model_sort),
2514 g_return_if_fail (length > 0);
2516 new_level = g_new (SortLevel, 1);
2517 new_level->seq = g_sequence_new (sort_elt_free);
2518 new_level->ref_count = 0;
2519 new_level->parent_level = parent_level;
2520 new_level->parent_elt = parent_elt;
2523 parent_elt->children = new_level;
2525 priv->root = new_level;
2527 /* increase the count of zero ref_counts.*/
2528 while (parent_level)
2530 parent_elt->zero_ref_count++;
2532 parent_elt = parent_level->parent_elt;
2533 parent_level = parent_level->parent_level;
2536 if (new_level != priv->root)
2537 priv->zero_ref_count++;
2539 for (i = 0; i < length; i++)
2543 sort_elt = sort_elt_new ();
2544 sort_elt->offset = i;
2545 sort_elt->zero_ref_count = 0;
2546 sort_elt->ref_count = 0;
2547 sort_elt->children = NULL;
2549 if (GTK_TREE_MODEL_SORT_CACHE_CHILD_ITERS (tree_model_sort))
2551 sort_elt->iter = iter;
2552 if (gtk_tree_model_iter_next (priv->child_model, &iter) == FALSE &&
2560 level = gtk_tree_model_sort_elt_get_path (parent_level,
2562 str = gtk_tree_path_to_string (level);
2563 gtk_tree_path_free (level);
2565 g_warning ("%s: There is a discrepancy between the sort model "
2566 "and the child model. The child model is "
2567 "advertising a wrong length for level %s:.",
2573 g_warning ("%s: There is a discrepancy between the sort model "
2574 "and the child model. The child model is "
2575 "advertising a wrong length for the root level.",
2583 sort_elt->siter = g_sequence_append (new_level->seq, sort_elt);
2587 gtk_tree_model_sort_sort_level (tree_model_sort, new_level,
2592 gtk_tree_model_sort_free_level (GtkTreeModelSort *tree_model_sort,
2593 SortLevel *sort_level,
2596 GtkTreeModelSortPrivate *priv = tree_model_sort->priv;
2597 GSequenceIter *siter;
2598 GSequenceIter *end_siter;
2600 g_assert (sort_level);
2602 end_siter = g_sequence_get_end_iter (sort_level->seq);
2603 for (siter = g_sequence_get_begin_iter (sort_level->seq);
2605 siter = g_sequence_iter_next (siter))
2607 SortElt *elt = g_sequence_get (siter);
2610 gtk_tree_model_sort_free_level (tree_model_sort,
2611 elt->children, unref);
2614 if (sort_level->ref_count == 0)
2616 SortLevel *parent_level = sort_level->parent_level;
2617 SortElt *parent_elt = sort_level->parent_elt;
2619 while (parent_level)
2621 parent_elt->zero_ref_count--;
2623 parent_elt = parent_level->parent_elt;
2624 parent_level = parent_level->parent_level;
2627 if (sort_level != priv->root)
2628 priv->zero_ref_count--;
2631 if (sort_level->parent_elt)
2635 GtkTreeIter parent_iter;
2637 parent_iter.stamp = tree_model_sort->priv->stamp;
2638 parent_iter.user_data = sort_level->parent_level;
2639 parent_iter.user_data2 = sort_level->parent_elt;
2641 gtk_tree_model_sort_unref_node (GTK_TREE_MODEL (tree_model_sort),
2645 sort_level->parent_elt->children = NULL;
2650 g_sequence_free (sort_level->seq);
2651 sort_level->seq = NULL;
2653 g_free (sort_level);
2658 gtk_tree_model_sort_increment_stamp (GtkTreeModelSort *tree_model_sort)
2660 GtkTreeModelSortPrivate *priv = tree_model_sort->priv;
2666 while (priv->stamp == 0);
2668 gtk_tree_model_sort_clear_cache (tree_model_sort);
2672 gtk_tree_model_sort_clear_cache_helper_iter (gpointer data,
2675 GtkTreeModelSort *tree_model_sort = user_data;
2676 SortElt *elt = data;
2678 if (elt->zero_ref_count > 0)
2679 gtk_tree_model_sort_clear_cache_helper (tree_model_sort, elt->children);
2683 gtk_tree_model_sort_clear_cache_helper (GtkTreeModelSort *tree_model_sort,
2686 g_assert (level != NULL);
2688 g_sequence_foreach (level->seq, gtk_tree_model_sort_clear_cache_helper_iter,
2691 if (level->ref_count == 0 && level != tree_model_sort->priv->root)
2692 gtk_tree_model_sort_free_level (tree_model_sort, level, TRUE);
2696 * gtk_tree_model_sort_reset_default_sort_func:
2697 * @tree_model_sort: A #GtkTreeModelSort
2699 * This resets the default sort function to be in the 'unsorted' state. That
2700 * is, it is in the same order as the child model. It will re-sort the model
2701 * to be in the same order as the child model only if the #GtkTreeModelSort
2702 * is in 'unsorted' state.
2705 gtk_tree_model_sort_reset_default_sort_func (GtkTreeModelSort *tree_model_sort)
2707 GtkTreeModelSortPrivate *priv = tree_model_sort->priv;
2709 g_return_if_fail (GTK_IS_TREE_MODEL_SORT (tree_model_sort));
2711 if (priv->default_sort_destroy)
2713 GDestroyNotify d = priv->default_sort_destroy;
2715 priv->default_sort_destroy = NULL;
2716 d (priv->default_sort_data);
2719 priv->default_sort_func = NO_SORT_FUNC;
2720 priv->default_sort_data = NULL;
2721 priv->default_sort_destroy = NULL;
2723 if (priv->sort_column_id == GTK_TREE_SORTABLE_DEFAULT_SORT_COLUMN_ID)
2724 gtk_tree_model_sort_sort (tree_model_sort);
2725 priv->sort_column_id = GTK_TREE_SORTABLE_DEFAULT_SORT_COLUMN_ID;
2729 * gtk_tree_model_sort_clear_cache:
2730 * @tree_model_sort: A #GtkTreeModelSort
2732 * This function should almost never be called. It clears the @tree_model_sort
2733 * of any cached iterators that haven't been reffed with
2734 * gtk_tree_model_ref_node(). This might be useful if the child model being
2735 * sorted is static (and doesn't change often) and there has been a lot of
2736 * unreffed access to nodes. As a side effect of this function, all unreffed
2737 * iters will be invalid.
2740 gtk_tree_model_sort_clear_cache (GtkTreeModelSort *tree_model_sort)
2742 g_return_if_fail (GTK_IS_TREE_MODEL_SORT (tree_model_sort));
2744 if (tree_model_sort->priv->zero_ref_count > 0)
2745 gtk_tree_model_sort_clear_cache_helper (tree_model_sort, (SortLevel *)tree_model_sort->priv->root);
2749 gtk_tree_model_sort_iter_is_valid_helper (GtkTreeIter *iter,
2752 GSequenceIter *siter;
2753 GSequenceIter *end_siter;
2755 end_siter = g_sequence_get_end_iter (level->seq);
2756 for (siter = g_sequence_get_begin_iter (level->seq);
2757 siter != end_siter; siter = g_sequence_iter_next (siter))
2759 SortElt *elt = g_sequence_get (siter);
2761 if (iter->user_data == level && iter->user_data2 == elt)
2765 if (gtk_tree_model_sort_iter_is_valid_helper (iter, elt->children))
2773 * gtk_tree_model_sort_iter_is_valid:
2774 * @tree_model_sort: A #GtkTreeModelSort.
2775 * @iter: A #GtkTreeIter.
2778 * This function is slow. Only use it for debugging and/or testing purposes.
2781 * Checks if the given iter is a valid iter for this #GtkTreeModelSort.
2783 * Return value: %TRUE if the iter is valid, %FALSE if the iter is invalid.
2788 gtk_tree_model_sort_iter_is_valid (GtkTreeModelSort *tree_model_sort,
2791 g_return_val_if_fail (GTK_IS_TREE_MODEL_SORT (tree_model_sort), FALSE);
2792 g_return_val_if_fail (iter != NULL, FALSE);
2794 if (!VALID_ITER (iter, tree_model_sort))
2797 return gtk_tree_model_sort_iter_is_valid_helper (iter,
2798 tree_model_sort->priv->root);