1 /* gtktreemodelfilter.c
2 * Copyright (C) 2000,2001 Red Hat, Inc., Jonathan Blandford <jrb@redhat.com>
3 * Copyright (C) 2001-2003 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.
22 #include "gtktreemodelfilter.h"
24 #include "gtktreednd.h"
25 #include "gtkprivate.h"
30 * SECTION:gtktreemodelfilter
31 * @Short_description: A GtkTreeModel which hides parts of an underlying tree model
32 * @Title: GtkTreeModelFilter
33 * @See_also:#GtkTreeModelSort
35 * A #GtkTreeModelFilter is a tree model which wraps another tree model,
36 * and can do the following things:
39 * Filter specific rows, based on data from a "visible column", a column
40 * storing booleans indicating whether the row should be filtered or not,
41 * or based on the return value of a "visible function", which gets a
42 * model, iter and user_data and returns a boolean indicating whether the
43 * row should be filtered or not.
46 * Modify the "appearance" of the model, using a modify function.
47 * This is extremely powerful and allows for just changing
48 * some values and also for creating a completely different model based on
49 * the given child model.
52 * Set a different root node, also known as a "virtual root". You can pass in
53 * a #GtkTreePath indicating the root node for the filter at construction time.
61 * iter->stamp = filter->priv->stamp
62 * iter->user_data = FilterLevel
63 * iter->user_data2 = FilterElt
66 /* all paths, iters, etc prefixed with c_ are paths, iters, etc relative to the
71 * There are three model/views involved, so there are two mappings:
72 * * this model -> child model: mapped via offset in FilterElt.
73 * * this model -> parent model (or view): mapped via the array index
76 * Note that there are two kinds of paths relative to the filter model
77 * (those generated from the array indices): paths taking non-visible
78 * nodes into account, and paths which don't. Paths which take
79 * non-visible nodes into account should only be used internally and
80 * NEVER be passed along with a signal emission.
82 * The filter model has a reference on every node that is not in the root
83 * level and has a parent with ref_count > 1. Exception is a virtual root
84 * level; all nodes in the virtual root level are referenced too.
87 typedef struct _FilterElt FilterElt;
88 typedef struct _FilterLevel FilterLevel;
93 FilterLevel *children;
108 gint parent_elt_index;
109 FilterLevel *parent_level;
113 struct _GtkTreeModelFilterPrivate
115 GtkTreeModel *child_model;
117 GtkTreePath *virtual_root;
124 GtkTreeModelFilterVisibleFunc visible_func;
125 gpointer visible_data;
126 GDestroyNotify visible_destroy;
129 GtkTreeModelFilterModifyFunc modify_func;
130 gpointer modify_data;
131 GDestroyNotify modify_destroy;
132 gint modify_n_columns;
134 guint visible_method_set : 1;
135 guint modify_func_set : 1;
137 guint in_row_deleted : 1;
138 guint virtual_root_deleted : 1;
143 gulong has_child_toggled_id;
156 /* Set this to 0 to disable caching of child iterators. This
157 * allows for more stringent testing. It is recommended to set this
158 * to one when refactoring this code and running the unit tests to
162 # define GTK_TREE_MODEL_FILTER_CACHE_CHILD_ITERS(filter) \
163 (((GtkTreeModelFilter *)filter)->priv->child_flags & GTK_TREE_MODEL_ITERS_PERSIST)
165 # define GTK_TREE_MODEL_FILTER_CACHE_CHILD_ITERS(filter) (FALSE)
168 #define FILTER_ELT(filter_elt) ((FilterElt *)filter_elt)
169 #define FILTER_LEVEL(filter_level) ((FilterLevel *)filter_level)
171 #define FILTER_LEVEL_PARENT_ELT(level) (&g_array_index (FILTER_LEVEL ((level))->parent_level->array, FilterElt, FILTER_LEVEL ((level))->parent_elt_index))
172 #define FILTER_LEVEL_ELT_INDEX(level, elt) (FILTER_ELT ((elt)) - FILTER_ELT (FILTER_LEVEL ((level))->array->data))
174 /* general code (object/interface init, properties, etc) */
175 static void gtk_tree_model_filter_tree_model_init (GtkTreeModelIface *iface);
176 static void gtk_tree_model_filter_drag_source_init (GtkTreeDragSourceIface *iface);
177 static void gtk_tree_model_filter_finalize (GObject *object);
178 static void gtk_tree_model_filter_set_property (GObject *object,
182 static void gtk_tree_model_filter_get_property (GObject *object,
187 /* signal handlers */
188 static void gtk_tree_model_filter_row_changed (GtkTreeModel *c_model,
192 static void gtk_tree_model_filter_row_inserted (GtkTreeModel *c_model,
196 static void gtk_tree_model_filter_row_has_child_toggled (GtkTreeModel *c_model,
200 static void gtk_tree_model_filter_row_deleted (GtkTreeModel *c_model,
203 static void gtk_tree_model_filter_rows_reordered (GtkTreeModel *c_model,
209 /* GtkTreeModel interface */
210 static GtkTreeModelFlags gtk_tree_model_filter_get_flags (GtkTreeModel *model);
211 static gint gtk_tree_model_filter_get_n_columns (GtkTreeModel *model);
212 static GType gtk_tree_model_filter_get_column_type (GtkTreeModel *model,
214 static gboolean gtk_tree_model_filter_get_iter_full (GtkTreeModel *model,
217 static gboolean gtk_tree_model_filter_get_iter (GtkTreeModel *model,
220 static GtkTreePath *gtk_tree_model_filter_get_path (GtkTreeModel *model,
222 static void gtk_tree_model_filter_get_value (GtkTreeModel *model,
226 static gboolean gtk_tree_model_filter_iter_next (GtkTreeModel *model,
228 static gboolean gtk_tree_model_filter_iter_previous (GtkTreeModel *model,
230 static gboolean gtk_tree_model_filter_iter_children (GtkTreeModel *model,
232 GtkTreeIter *parent);
233 static gboolean gtk_tree_model_filter_iter_has_child (GtkTreeModel *model,
235 static gint gtk_tree_model_filter_iter_n_children (GtkTreeModel *model,
237 static gboolean gtk_tree_model_filter_iter_nth_child (GtkTreeModel *model,
241 static gboolean gtk_tree_model_filter_iter_parent (GtkTreeModel *model,
244 static void gtk_tree_model_filter_ref_node (GtkTreeModel *model,
246 static void gtk_tree_model_filter_unref_node (GtkTreeModel *model,
249 /* TreeDragSource interface */
250 static gboolean gtk_tree_model_filter_row_draggable (GtkTreeDragSource *drag_source,
252 static gboolean gtk_tree_model_filter_drag_data_get (GtkTreeDragSource *drag_source,
254 GtkSelectionData *selection_data);
255 static gboolean gtk_tree_model_filter_drag_data_delete (GtkTreeDragSource *drag_source,
258 /* private functions */
259 static void gtk_tree_model_filter_build_level (GtkTreeModelFilter *filter,
260 FilterLevel *parent_level,
261 gint parent_elt_index,
262 gboolean emit_inserted);
264 static void gtk_tree_model_filter_free_level (GtkTreeModelFilter *filter,
265 FilterLevel *filter_level,
268 static GtkTreePath *gtk_tree_model_filter_elt_get_path (FilterLevel *level,
272 static GtkTreePath *gtk_tree_model_filter_add_root (GtkTreePath *src,
274 static GtkTreePath *gtk_tree_model_filter_remove_root (GtkTreePath *src,
277 static void gtk_tree_model_filter_increment_stamp (GtkTreeModelFilter *filter);
279 static void gtk_tree_model_filter_real_modify (GtkTreeModelFilter *self,
280 GtkTreeModel *child_model,
284 static gboolean gtk_tree_model_filter_real_visible (GtkTreeModelFilter *filter,
285 GtkTreeModel *child_model,
286 GtkTreeIter *child_iter);
287 static gboolean gtk_tree_model_filter_visible (GtkTreeModelFilter *filter,
288 GtkTreeIter *child_iter);
289 static void gtk_tree_model_filter_clear_cache_helper (GtkTreeModelFilter *filter,
292 static void gtk_tree_model_filter_real_ref_node (GtkTreeModel *model,
295 static void gtk_tree_model_filter_real_unref_node (GtkTreeModel *model,
298 gboolean propagate_unref);
300 static void gtk_tree_model_filter_set_model (GtkTreeModelFilter *filter,
301 GtkTreeModel *child_model);
302 static void gtk_tree_model_filter_ref_path (GtkTreeModelFilter *filter,
304 static void gtk_tree_model_filter_unref_path (GtkTreeModelFilter *filter,
307 static void gtk_tree_model_filter_set_root (GtkTreeModelFilter *filter,
310 static GtkTreePath *gtk_real_tree_model_filter_convert_child_path_to_path (GtkTreeModelFilter *filter,
311 GtkTreePath *child_path,
312 gboolean build_levels,
313 gboolean fetch_children);
315 static FilterElt *gtk_tree_model_filter_get_nth (GtkTreeModelFilter *filter,
318 static gboolean gtk_tree_model_filter_elt_is_visible_in_target (FilterLevel *level,
320 static FilterElt *gtk_tree_model_filter_get_nth_visible (GtkTreeModelFilter *filter,
324 static FilterElt *gtk_tree_model_filter_insert_elt_in_level (GtkTreeModelFilter *filter,
329 static FilterElt *gtk_tree_model_filter_fetch_child (GtkTreeModelFilter *filter,
333 static void gtk_tree_model_filter_remove_elt_from_level (GtkTreeModelFilter *filter,
336 static void gtk_tree_model_filter_update_children (GtkTreeModelFilter *filter,
339 static FilterElt *bsearch_elt_with_offset (GArray *array,
342 static void gtk_tree_model_filter_emit_row_inserted_for_path (GtkTreeModelFilter *filter,
343 GtkTreeModel *c_model,
345 GtkTreeIter *c_iter);
348 G_DEFINE_TYPE_WITH_CODE (GtkTreeModelFilter, gtk_tree_model_filter, G_TYPE_OBJECT,
349 G_IMPLEMENT_INTERFACE (GTK_TYPE_TREE_MODEL,
350 gtk_tree_model_filter_tree_model_init)
351 G_IMPLEMENT_INTERFACE (GTK_TYPE_TREE_DRAG_SOURCE,
352 gtk_tree_model_filter_drag_source_init))
355 gtk_tree_model_filter_init (GtkTreeModelFilter *filter)
357 filter->priv = G_TYPE_INSTANCE_GET_PRIVATE (filter,
358 GTK_TYPE_TREE_MODEL_FILTER,
359 GtkTreeModelFilterPrivate);
361 filter->priv->visible_column = -1;
362 filter->priv->zero_ref_count = 0;
363 filter->priv->visible_method_set = FALSE;
364 filter->priv->modify_func_set = FALSE;
365 filter->priv->in_row_deleted = FALSE;
366 filter->priv->virtual_root_deleted = FALSE;
370 gtk_tree_model_filter_class_init (GtkTreeModelFilterClass *filter_class)
372 GObjectClass *object_class;
374 object_class = (GObjectClass *) filter_class;
376 object_class->set_property = gtk_tree_model_filter_set_property;
377 object_class->get_property = gtk_tree_model_filter_get_property;
379 object_class->finalize = gtk_tree_model_filter_finalize;
381 filter_class->visible = gtk_tree_model_filter_real_visible;
382 filter_class->modify = gtk_tree_model_filter_real_modify;
384 /* Properties -- FIXME: disabled translations for now, until I can come up with a
387 g_object_class_install_property (object_class,
389 g_param_spec_object ("child-model",
391 ("The model for the filtermodel to filter"),
393 GTK_PARAM_READWRITE | G_PARAM_CONSTRUCT_ONLY));
395 g_object_class_install_property (object_class,
397 g_param_spec_boxed ("virtual-root",
398 ("The virtual root"),
399 ("The virtual root (relative to the child model) for this filtermodel"),
401 GTK_PARAM_READWRITE | G_PARAM_CONSTRUCT_ONLY));
403 g_type_class_add_private (object_class, sizeof (GtkTreeModelFilterPrivate));
407 gtk_tree_model_filter_tree_model_init (GtkTreeModelIface *iface)
409 iface->get_flags = gtk_tree_model_filter_get_flags;
410 iface->get_n_columns = gtk_tree_model_filter_get_n_columns;
411 iface->get_column_type = gtk_tree_model_filter_get_column_type;
412 iface->get_iter = gtk_tree_model_filter_get_iter;
413 iface->get_path = gtk_tree_model_filter_get_path;
414 iface->get_value = gtk_tree_model_filter_get_value;
415 iface->iter_next = gtk_tree_model_filter_iter_next;
416 iface->iter_previous = gtk_tree_model_filter_iter_previous;
417 iface->iter_children = gtk_tree_model_filter_iter_children;
418 iface->iter_has_child = gtk_tree_model_filter_iter_has_child;
419 iface->iter_n_children = gtk_tree_model_filter_iter_n_children;
420 iface->iter_nth_child = gtk_tree_model_filter_iter_nth_child;
421 iface->iter_parent = gtk_tree_model_filter_iter_parent;
422 iface->ref_node = gtk_tree_model_filter_ref_node;
423 iface->unref_node = gtk_tree_model_filter_unref_node;
427 gtk_tree_model_filter_drag_source_init (GtkTreeDragSourceIface *iface)
429 iface->row_draggable = gtk_tree_model_filter_row_draggable;
430 iface->drag_data_delete = gtk_tree_model_filter_drag_data_delete;
431 iface->drag_data_get = gtk_tree_model_filter_drag_data_get;
436 gtk_tree_model_filter_finalize (GObject *object)
438 GtkTreeModelFilter *filter = (GtkTreeModelFilter *) object;
440 if (filter->priv->virtual_root && !filter->priv->virtual_root_deleted)
442 gtk_tree_model_filter_unref_path (filter, filter->priv->virtual_root,
444 filter->priv->virtual_root_deleted = TRUE;
447 gtk_tree_model_filter_set_model (filter, NULL);
449 if (filter->priv->virtual_root)
450 gtk_tree_path_free (filter->priv->virtual_root);
452 if (filter->priv->root)
453 gtk_tree_model_filter_free_level (filter, filter->priv->root, TRUE);
455 g_free (filter->priv->modify_types);
457 if (filter->priv->modify_destroy)
458 filter->priv->modify_destroy (filter->priv->modify_data);
460 if (filter->priv->visible_destroy)
461 filter->priv->visible_destroy (filter->priv->visible_data);
464 G_OBJECT_CLASS (gtk_tree_model_filter_parent_class)->finalize (object);
468 gtk_tree_model_filter_set_property (GObject *object,
473 GtkTreeModelFilter *filter = GTK_TREE_MODEL_FILTER (object);
477 case PROP_CHILD_MODEL:
478 gtk_tree_model_filter_set_model (filter, g_value_get_object (value));
480 case PROP_VIRTUAL_ROOT:
481 gtk_tree_model_filter_set_root (filter, g_value_get_boxed (value));
484 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
490 gtk_tree_model_filter_get_property (GObject *object,
495 GtkTreeModelFilter *filter = GTK_TREE_MODEL_FILTER (object);
499 case PROP_CHILD_MODEL:
500 g_value_set_object (value, filter->priv->child_model);
502 case PROP_VIRTUAL_ROOT:
503 g_value_set_boxed (value, filter->priv->virtual_root);
506 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
514 gtk_tree_model_filter_build_level (GtkTreeModelFilter *filter,
515 FilterLevel *parent_level,
516 gint parent_elt_index,
517 gboolean emit_inserted)
520 GtkTreeIter first_node;
522 FilterElt *parent_elt = NULL;
523 FilterLevel *new_level;
524 FilterLevel *tmp_level;
530 g_assert (filter->priv->child_model != NULL);
532 /* Avoid building a level that already exists */
534 g_assert (g_array_index (parent_level->array, FilterElt, parent_elt_index).children == NULL);
536 g_assert (filter->priv->root == NULL);
538 if (filter->priv->in_row_deleted)
543 if (filter->priv->virtual_root)
545 if (gtk_tree_model_get_iter (filter->priv->child_model, &root, filter->priv->virtual_root) == FALSE)
547 length = gtk_tree_model_iter_n_children (filter->priv->child_model, &root);
549 if (gtk_tree_model_iter_children (filter->priv->child_model, &iter, &root) == FALSE)
554 if (!gtk_tree_model_get_iter_first (filter->priv->child_model, &iter))
556 length = gtk_tree_model_iter_n_children (filter->priv->child_model, NULL);
561 GtkTreeIter parent_iter;
562 GtkTreeIter child_parent_iter;
564 parent_elt = &g_array_index (parent_level->array, FilterElt, parent_elt_index);
566 parent_iter.stamp = filter->priv->stamp;
567 parent_iter.user_data = parent_level;
568 parent_iter.user_data2 = parent_elt;
570 gtk_tree_model_filter_convert_iter_to_child_iter (filter,
573 if (gtk_tree_model_iter_children (filter->priv->child_model, &iter, &child_parent_iter) == FALSE)
576 /* stamp may have changed */
577 gtk_tree_model_filter_convert_iter_to_child_iter (filter,
580 length = gtk_tree_model_iter_n_children (filter->priv->child_model, &child_parent_iter);
582 /* Take a reference on the parent */
583 gtk_tree_model_filter_real_ref_node (GTK_TREE_MODEL (filter),
584 &parent_iter, FALSE);
587 g_return_if_fail (length > 0);
589 new_level = g_new (FilterLevel, 1);
590 new_level->array = g_array_sized_new (FALSE, FALSE,
593 new_level->ref_count = 0;
594 new_level->ext_ref_count = 0;
595 new_level->visible_nodes = 0;
596 new_level->parent_elt_index = parent_elt_index;
597 new_level->parent_level = parent_level;
599 if (parent_elt_index >= 0)
600 parent_elt->children = new_level;
602 filter->priv->root = new_level;
604 /* increase the count of zero ref_counts */
605 tmp_level = parent_level;
606 tmp_elt_index = parent_elt_index;
610 g_array_index (tmp_level->array, FilterElt, tmp_elt_index).zero_ref_count++;
612 tmp_elt_index = tmp_level->parent_elt_index;
613 tmp_level = tmp_level->parent_level;
615 if (new_level != filter->priv->root)
616 filter->priv->zero_ref_count++;
624 if (gtk_tree_model_filter_visible (filter, &iter))
626 FilterElt filter_elt;
628 filter_elt.offset = i;
629 filter_elt.zero_ref_count = 0;
630 filter_elt.ref_count = 0;
631 filter_elt.ext_ref_count = 0;
632 filter_elt.children = NULL;
633 filter_elt.visible = TRUE;
635 if (GTK_TREE_MODEL_FILTER_CACHE_CHILD_ITERS (filter))
636 filter_elt.iter = iter;
638 g_array_append_val (new_level->array, filter_elt);
639 new_level->visible_nodes++;
645 GtkTreeIter children;
647 f_iter.stamp = filter->priv->stamp;
648 f_iter.user_data = new_level;
649 f_iter.user_data2 = &(g_array_index (new_level->array, FilterElt, new_level->array->len - 1));
651 f_path = gtk_tree_model_get_path (GTK_TREE_MODEL (filter),
653 gtk_tree_model_row_inserted (GTK_TREE_MODEL (filter),
655 gtk_tree_path_free (f_path);
657 if (gtk_tree_model_iter_children (filter->priv->child_model,
659 gtk_tree_model_filter_update_children (filter,
661 FILTER_ELT (f_iter.user_data2));
666 while (gtk_tree_model_iter_next (filter->priv->child_model, &iter));
668 /* The level does not contain any visible nodes. However, changes in
669 * this level might affect the parent node, which can either be visible
670 * or invisible. Therefore, this level can only be removed again,
671 * if the parent of the parent node is not visible. In that case,
672 * possible changes in state of the parent are not requested.
674 if (new_level->array->len == 0 &&
675 (parent_level && parent_level->parent_level &&
676 FILTER_LEVEL_PARENT_ELT (parent_level)->ext_ref_count == 0))
678 gtk_tree_model_filter_free_level (filter, new_level, FALSE);
682 /* If none of the nodes are visible, we will just pull in the
683 * first node of the level.
685 if (new_level->array->len == 0)
687 FilterElt filter_elt;
689 filter_elt.offset = 0;
690 filter_elt.zero_ref_count = 0;
691 filter_elt.ref_count = 0;
692 filter_elt.ext_ref_count = 0;
693 filter_elt.children = NULL;
694 filter_elt.visible = FALSE;
696 if (GTK_TREE_MODEL_FILTER_CACHE_CHILD_ITERS (filter))
697 filter_elt.iter = first_node;
699 g_array_append_val (new_level->array, filter_elt);
702 /* Keep a reference on the first node of this level. We need this
703 * to make sure that we get all signals for this level.
705 f_iter.stamp = filter->priv->stamp;
706 f_iter.user_data = new_level;
707 f_iter.user_data2 = &(g_array_index (new_level->array, FilterElt, 0));
709 gtk_tree_model_filter_real_ref_node (GTK_TREE_MODEL (filter), &f_iter,
714 gtk_tree_model_filter_free_level (GtkTreeModelFilter *filter,
715 FilterLevel *filter_level,
720 g_assert (filter_level);
722 for (i = 0; i < filter_level->array->len; i++)
724 if (g_array_index (filter_level->array, FilterElt, i).children)
725 gtk_tree_model_filter_free_level (filter,
726 FILTER_LEVEL (g_array_index (filter_level->array, FilterElt, i).children),
730 /* Release the reference on the first item.
736 f_iter.stamp = filter->priv->stamp;
737 f_iter.user_data = filter_level;
738 f_iter.user_data2 = &(g_array_index (filter_level->array, FilterElt, 0));
740 gtk_tree_model_filter_real_unref_node (GTK_TREE_MODEL (filter),
741 &f_iter, FALSE, TRUE);
744 if (filter_level->ext_ref_count == 0)
746 FilterLevel *parent_level = filter_level->parent_level;
747 gint parent_elt_index = filter_level->parent_elt_index;
751 g_array_index (parent_level->array, FilterElt, parent_elt_index).zero_ref_count--;
753 parent_elt_index = parent_level->parent_elt_index;
754 parent_level = parent_level->parent_level;
757 if (filter_level != filter->priv->root)
758 filter->priv->zero_ref_count--;
761 if (filter_level->parent_elt_index >= 0)
763 /* Release reference on parent */
766 GtkTreeIter parent_iter;
768 parent_iter.stamp = filter->priv->stamp;
769 parent_iter.user_data = filter_level->parent_level;
770 parent_iter.user_data2 = FILTER_LEVEL_PARENT_ELT (filter_level);
772 gtk_tree_model_filter_real_unref_node (GTK_TREE_MODEL (filter),
773 &parent_iter, FALSE, TRUE);
776 FILTER_LEVEL_PARENT_ELT (filter_level)->children = NULL;
779 filter->priv->root = NULL;
781 g_array_free (filter_level->array, TRUE);
782 filter_level->array = NULL;
784 g_free (filter_level);
789 gtk_tree_model_filter_level_transfer_first_ref (GtkTreeModelFilter *filter,
796 f_iter.stamp = filter->priv->stamp;
797 f_iter.user_data = level;
798 f_iter.user_data2 = &(g_array_index (level->array, FilterElt, to_index));
800 gtk_tree_model_filter_real_ref_node (GTK_TREE_MODEL (filter),
803 f_iter.stamp = filter->priv->stamp;
804 f_iter.user_data = level;
805 f_iter.user_data2 = &(g_array_index (level->array, FilterElt, from_index));
807 gtk_tree_model_filter_real_unref_node (GTK_TREE_MODEL (filter),
808 &f_iter, FALSE, TRUE);
812 /* Creates paths suitable for accessing the child model. */
814 gtk_tree_model_filter_elt_get_path (FilterLevel *level,
818 FilterLevel *walker = level;
819 FilterElt *walker2 = elt;
821 GtkTreePath *real_path;
823 g_return_val_if_fail (level != NULL, NULL);
824 g_return_val_if_fail (elt != NULL, NULL);
826 path = gtk_tree_path_new ();
830 gtk_tree_path_prepend_index (path, walker2->offset);
832 if (!walker->parent_level)
835 walker2 = FILTER_LEVEL_PARENT_ELT (walker);
836 walker = walker->parent_level;
841 real_path = gtk_tree_model_filter_add_root (path, root);
842 gtk_tree_path_free (path);
850 gtk_tree_model_filter_add_root (GtkTreePath *src,
856 retval = gtk_tree_path_copy (root);
858 for (i = 0; i < gtk_tree_path_get_depth (src); i++)
859 gtk_tree_path_append_index (retval, gtk_tree_path_get_indices (src)[i]);
865 gtk_tree_model_filter_remove_root (GtkTreePath *src,
873 if (gtk_tree_path_get_depth (src) <= gtk_tree_path_get_depth (root))
876 depth = gtk_tree_path_get_depth (src);
877 indices = gtk_tree_path_get_indices (src);
879 for (i = 0; i < gtk_tree_path_get_depth (root); i++)
880 if (indices[i] != gtk_tree_path_get_indices (root)[i])
883 retval = gtk_tree_path_new ();
885 for (; i < depth; i++)
886 gtk_tree_path_append_index (retval, indices[i]);
892 gtk_tree_model_filter_increment_stamp (GtkTreeModelFilter *filter)
896 filter->priv->stamp++;
898 while (filter->priv->stamp == 0);
900 gtk_tree_model_filter_clear_cache (filter);
904 gtk_tree_model_filter_real_visible (GtkTreeModelFilter *filter,
905 GtkTreeModel *child_model,
906 GtkTreeIter *child_iter)
908 if (filter->priv->visible_func)
910 return filter->priv->visible_func (child_model,
912 filter->priv->visible_data)
915 else if (filter->priv->visible_column >= 0)
919 gtk_tree_model_get_value (child_model, child_iter,
920 filter->priv->visible_column, &val);
922 if (g_value_get_boolean (&val))
924 g_value_unset (&val);
928 g_value_unset (&val);
932 /* no visible function set, so always visible */
937 gtk_tree_model_filter_visible (GtkTreeModelFilter *self,
938 GtkTreeIter *child_iter)
940 return GTK_TREE_MODEL_FILTER_GET_CLASS (self)->visible (self,
941 self->priv->child_model, child_iter);
945 gtk_tree_model_filter_clear_cache_helper (GtkTreeModelFilter *filter,
952 for (i = 0; i < level->array->len; i++)
954 if (g_array_index (level->array, FilterElt, i).zero_ref_count > 0)
955 gtk_tree_model_filter_clear_cache_helper (filter, g_array_index (level->array, FilterElt, i).children);
958 /* If the level's ext_ref_count is zero, it means the level is not visible
959 * and can be removed. But, since we support monitoring a child level
960 * of a parent for changes (these might affect the parent), we will only
961 * free the level if the parent's parent also has an external ref
962 * count of zero. In that case, changes concerning our parent are
965 if (level->ext_ref_count == 0 && level != filter->priv->root &&
966 level->parent_level && FILTER_LEVEL_PARENT_ELT (level) &&
967 level->parent_level->parent_level &&
968 FILTER_LEVEL_PARENT_ELT (level->parent_level)->ext_ref_count == 0)
970 gtk_tree_model_filter_free_level (filter, level, TRUE);
976 gtk_tree_model_filter_get_nth (GtkTreeModelFilter *filter,
980 if (level->array->len <= n)
983 return &g_array_index (level->array, FilterElt, n);
987 gtk_tree_model_filter_elt_is_visible_in_target (FilterLevel *level,
995 if (level->parent_elt_index == -1)
1000 elt_index = level->parent_elt_index;
1001 level = level->parent_level;
1004 && !g_array_index (level->array, FilterElt, elt_index).visible)
1012 /* If a change has occurred in path (inserted, changed or deleted),
1013 * then this function is used to check all its ancestors. An ancestor
1014 * could have changed state as a result and this needs to be propagated
1015 * to the objects monitoring the filter model.
1018 gtk_tree_model_filter_check_ancestors (GtkTreeModelFilter *filter,
1022 int *indices = gtk_tree_path_get_indices (path);
1025 GtkTreeIter c_iter, tmp_iter;
1027 level = FILTER_LEVEL (filter->priv->root);
1032 if (filter->priv->virtual_root)
1033 gtk_tree_model_get_iter (filter->priv->child_model, &c_iter,
1034 filter->priv->virtual_root);
1037 gtk_tree_model_iter_nth_child (filter->priv->child_model, &c_iter,
1038 filter->priv->virtual_root ? &tmp_iter : NULL,
1041 while (i < gtk_tree_path_get_depth (path) - 1)
1044 gboolean requested_state;
1046 elt = bsearch_elt_with_offset (level->array,
1047 gtk_tree_path_get_indices (path)[i],
1050 requested_state = gtk_tree_model_filter_visible (filter, &c_iter);
1055 GtkTreePath *c_path;
1057 if (requested_state == FALSE)
1060 /* The elt does not exist in this level (so it is not
1061 * visible), but should now be visible. We emit the
1062 * row-inserted and row-has-child-toggled signals.
1064 elt = gtk_tree_model_filter_insert_elt_in_level (filter,
1070 /* insert_elt_in_level defaults to FALSE */
1071 elt->visible = TRUE;
1072 level->visible_nodes++;
1074 c_path = gtk_tree_model_get_path (filter->priv->child_model,
1077 gtk_tree_model_filter_emit_row_inserted_for_path (filter,
1078 filter->priv->child_model,
1082 gtk_tree_path_free (c_path);
1084 /* We can immediately return, because this node was not visible
1085 * before and its children will be checked for in response to
1086 * the emitted row-has-child-toggled signal.
1090 else if (elt->visible)
1092 if (!requested_state)
1094 /* A node has turned invisible. Remove it from the level
1095 * and emit row-deleted. Since this node is being
1096 * deleted. it makes no sense to look further up the
1099 gtk_tree_model_filter_remove_elt_from_level (filter,
1104 /* Otherwise continue up the chain */
1106 else if (!elt->visible)
1108 if (requested_state)
1110 /* A node is already in the cache, but invisible. This
1111 * is usually a node on which a reference is kept by
1112 * the filter model, or a node fetched on the filter's
1113 * request, and thus not shown. Therefore, we will
1114 * not emit row-inserted for this node. Instead,
1115 * we signal to its parent that a change has occurred.
1117 * Exception: root level, in this case, we must emit
1120 if (level->parent_level)
1123 GtkTreePath *f_path;
1125 elt->visible = TRUE;
1126 level->visible_nodes++;
1128 f_iter.stamp = filter->priv->stamp;
1129 f_iter.user_data = level->parent_level;
1130 f_iter.user_data2 = FILTER_LEVEL_PARENT_ELT(level);
1132 f_path = gtk_tree_model_get_path (GTK_TREE_MODEL (filter),
1134 gtk_tree_model_row_has_child_toggled (GTK_TREE_MODEL (filter),
1136 gtk_tree_path_free (f_path);
1140 GtkTreePath *c_path;
1142 elt->visible = TRUE;
1143 level->visible_nodes++;
1145 c_path = gtk_tree_model_get_path (filter->priv->child_model,
1148 gtk_tree_model_filter_emit_row_inserted_for_path (filter,
1149 filter->priv->child_model,
1153 gtk_tree_path_free (c_path);
1156 /* We can immediately return, because this node was not visible
1157 * before and the parent will check its children, including
1158 * this node, in response to the emitted row-has-child-toggled
1164 /* Not visible, so no need to continue. */
1170 /* If an elt does not have children, these are not visible.
1171 * Therefore, any signals emitted for these children will
1172 * be ignored, so we do not have to emit them.
1177 level = elt->children;
1181 gtk_tree_model_iter_nth_child (filter->priv->child_model, &c_iter,
1182 &tmp_iter, indices[i]);
1187 gtk_tree_model_filter_get_nth_visible (GtkTreeModelFilter *filter,
1194 if (level->visible_nodes <= n)
1197 elt = FILTER_ELT (level->array->data);
1198 while (!elt->visible)
1208 while (!elt->visible)
1215 gtk_tree_model_filter_insert_elt_in_level (GtkTreeModelFilter *filter,
1216 GtkTreeIter *c_iter,
1222 gint start, middle, end;
1225 if (GTK_TREE_MODEL_FILTER_CACHE_CHILD_ITERS (filter))
1228 elt.offset = offset;
1229 elt.zero_ref_count = 0;
1231 elt.ext_ref_count = 0;
1232 elt.children = NULL;
1233 /* visibility should be FALSE as we don't emit row_inserted */
1234 elt.visible = FALSE;
1236 /* find index (binary search on offset) */
1238 end = level->array->len;
1242 while (start != end)
1244 middle = (start + end) / 2;
1246 if (g_array_index (level->array, FilterElt, middle).offset <= offset)
1252 if (g_array_index (level->array, FilterElt, middle).offset <= offset)
1260 g_array_insert_val (level->array, i, elt);
1263 for (i = 0; i < level->array->len; i++)
1265 FilterElt *e = &(g_array_index (level->array, FilterElt, i));
1267 e->children->parent_elt_index = i;
1270 /* If the insert location is zero, we need to move our reference
1271 * on the old first node to the new first node.
1274 gtk_tree_model_filter_level_transfer_first_ref (filter, level,
1277 return &g_array_index (level->array, FilterElt, *index);
1281 gtk_tree_model_filter_fetch_child (GtkTreeModelFilter *filter,
1287 GtkTreePath *c_path = NULL;
1289 GtkTreePath *c_parent_path = NULL;
1290 GtkTreeIter c_parent_iter;
1292 /* check if child exists and is visible */
1293 if (level->parent_elt_index >= 0)
1296 gtk_tree_model_filter_elt_get_path (level->parent_level,
1297 FILTER_LEVEL_PARENT_ELT (level),
1298 filter->priv->virtual_root);
1304 if (filter->priv->virtual_root)
1305 c_parent_path = gtk_tree_path_copy (filter->priv->virtual_root);
1307 c_parent_path = NULL;
1312 gtk_tree_model_get_iter (filter->priv->child_model,
1315 len = gtk_tree_model_iter_n_children (filter->priv->child_model,
1318 c_path = gtk_tree_path_copy (c_parent_path);
1319 gtk_tree_path_free (c_parent_path);
1323 len = gtk_tree_model_iter_n_children (filter->priv->child_model, NULL);
1324 c_path = gtk_tree_path_new ();
1327 gtk_tree_path_append_index (c_path, offset);
1328 gtk_tree_model_get_iter (filter->priv->child_model, &c_iter, c_path);
1329 gtk_tree_path_free (c_path);
1331 if (offset >= len || !gtk_tree_model_filter_visible (filter, &c_iter))
1334 return gtk_tree_model_filter_insert_elt_in_level (filter, &c_iter,
1339 /* Note that this function is never called from the row-deleted handler.
1340 * This means that this function is only used for removing elements
1341 * which are still present in the child model. As a result, we must
1342 * take care to properly release the references the filter model has
1343 * on the child model nodes.
1346 gtk_tree_model_filter_remove_elt_from_level (GtkTreeModelFilter *filter,
1351 FilterLevel *parent_level;
1352 gint i, length, parent_elt_index, orig_level_ext_ref_count;
1354 GtkTreePath *path = NULL;
1356 gboolean emit_child_toggled = FALSE;
1358 iter.stamp = filter->priv->stamp;
1359 iter.user_data = level;
1360 iter.user_data2 = elt;
1362 path = gtk_tree_model_get_path (GTK_TREE_MODEL (filter), &iter);
1364 parent_elt_index = level->parent_elt_index;
1365 if (parent_elt_index >= 0)
1366 parent = FILTER_LEVEL_PARENT_ELT (level);
1369 parent_level = level->parent_level;
1371 length = level->array->len;
1373 /* We need to know about the level's ext ref count before removal
1376 orig_level_ext_ref_count = level->ext_ref_count;
1378 /* first register the node to be invisible */
1379 level->visible_nodes--;
1380 elt->visible = FALSE;
1382 /* we distinguish a couple of cases:
1383 * - root level, length > 1: emit row-deleted and remove.
1384 * - root level, length == 1: emit row-deleted and keep in cache.
1385 * - level, length == 1: parent->ext_ref_count > 0: emit row-deleted
1387 * - level, length > 1: emit row-deleted and remove.
1388 * - else, remove level.
1390 * if level != root level and visible nodes == 0, emit row-has-child-toggled.
1393 if (level != filter->priv->root
1394 && level->visible_nodes == 0
1397 emit_child_toggled = TRUE;
1403 /* We emit row-deleted, and remove the node from the cache.
1404 * If it has any children, these will be removed here as well.
1408 gtk_tree_model_filter_free_level (filter, elt->children, TRUE);
1410 /* If the first node is being removed, transfer, the reference */
1411 if (elt == &g_array_index (level->array, FilterElt, 0))
1413 gtk_tree_model_filter_level_transfer_first_ref (filter, level,
1417 while (elt->ext_ref_count > 0)
1418 gtk_tree_model_filter_real_unref_node (GTK_TREE_MODEL (filter),
1419 &iter, TRUE, FALSE);
1420 while (elt->ref_count > 0)
1421 gtk_tree_model_filter_real_unref_node (GTK_TREE_MODEL (filter),
1422 &iter, FALSE, FALSE);
1424 /* remove the node */
1425 tmp = bsearch_elt_with_offset (level->array, elt->offset, &i);
1429 g_array_remove_index (level->array, i);
1432 for (i = MAX (i, 0); i < level->array->len; i++)
1434 /* NOTE: here we do *not* decrease offsets, because the node was
1435 * not removed from the child model
1437 elt = &g_array_index (level->array, FilterElt, i);
1439 elt->children->parent_elt_index = i;
1443 gtk_tree_model_filter_increment_stamp (filter);
1445 /* Only if the node is in the root level (parent == NULL) or
1446 * the level is visible, a row-deleted signal is necessary.
1448 if (!parent || orig_level_ext_ref_count > 0)
1449 gtk_tree_model_row_deleted (GTK_TREE_MODEL (filter), path);
1451 else if ((length == 1 && parent && parent->ext_ref_count > 0)
1452 || (length == 1 && level == filter->priv->root))
1454 /* We emit row-deleted, but keep the node in the cache and
1455 * referenced. Its children will be removed.
1460 gtk_tree_model_filter_free_level (filter, elt->children, TRUE);
1461 elt->children = NULL;
1464 gtk_tree_model_filter_increment_stamp (filter);
1466 /* Only if the node is in the root level (parent == NULL) or
1467 * the level is visible, a row-deleted signal is necessary.
1469 if (!parent || orig_level_ext_ref_count > 0)
1470 gtk_tree_model_row_deleted (GTK_TREE_MODEL (filter), path);
1474 while (elt->ext_ref_count > 0)
1475 gtk_tree_model_filter_real_unref_node (GTK_TREE_MODEL (filter),
1476 &iter, TRUE, FALSE);
1477 while (elt->ref_count > 0)
1478 gtk_tree_model_filter_real_unref_node (GTK_TREE_MODEL (filter),
1479 &iter, FALSE, FALSE);
1481 /* Blow level away, including any child levels */
1482 gtk_tree_model_filter_free_level (filter, level, TRUE);
1484 gtk_tree_model_filter_increment_stamp (filter);
1486 if (!parent || orig_level_ext_ref_count > 0)
1487 gtk_tree_model_row_deleted (GTK_TREE_MODEL (filter), path);
1490 gtk_tree_path_free (path);
1492 if (emit_child_toggled && parent->ext_ref_count > 0)
1497 piter.stamp = filter->priv->stamp;
1498 piter.user_data = parent_level;
1499 piter.user_data2 = parent;
1501 ppath = gtk_tree_model_get_path (GTK_TREE_MODEL (filter), &piter);
1503 gtk_tree_model_row_has_child_toggled (GTK_TREE_MODEL (filter),
1505 gtk_tree_path_free (ppath);
1509 /* This function is called after the given node has become visible.
1510 * When the node has children, we should build the level and
1511 * take a reference on the first child.
1514 gtk_tree_model_filter_update_children (GtkTreeModelFilter *filter,
1524 iter.stamp = filter->priv->stamp;
1525 iter.user_data = level;
1526 iter.user_data2 = elt;
1528 gtk_tree_model_filter_convert_iter_to_child_iter (filter, &c_iter, &iter);
1530 if ((!level->parent_level || FILTER_LEVEL_PARENT_ELT (level)->ext_ref_count > 0) &&
1531 gtk_tree_model_iter_has_child (filter->priv->child_model, &c_iter))
1534 gtk_tree_model_filter_build_level (filter, level,
1535 FILTER_LEVEL_ELT_INDEX (level, elt),
1538 if (elt->ext_ref_count > 0 && elt->children && elt->children->array->len)
1541 path = gtk_tree_model_get_path (GTK_TREE_MODEL (filter), &iter);
1542 gtk_tree_model_row_has_child_toggled (GTK_TREE_MODEL (filter),
1546 gtk_tree_path_free (path);
1552 bsearch_elt_with_offset (GArray *array,
1556 gint start, middle, end;
1567 elt = &g_array_index (array, FilterElt, 0);
1569 if (elt->offset == offset)
1580 middle = (start + end) / 2;
1582 elt = &g_array_index (array, FilterElt, middle);
1584 if (elt->offset < offset)
1586 else if (elt->offset > offset)
1591 while (start != end);
1593 if (elt->offset == offset)
1602 /* Path is relative to the child model (this is on search on elt offset)
1603 * but with the virtual root already removed if necesssary.
1606 find_elt_with_offset (GtkTreeModelFilter *filter,
1608 FilterLevel **level_,
1613 FilterLevel *parent_level = NULL;
1614 FilterElt *elt = NULL;
1616 level = FILTER_LEVEL (filter->priv->root);
1618 while (i < gtk_tree_path_get_depth (path))
1625 elt = bsearch_elt_with_offset (level->array,
1626 gtk_tree_path_get_indices (path)[i],
1632 parent_level = level;
1633 level = elt->children;
1638 *level_ = parent_level;
1646 /* TreeModel signals */
1648 gtk_tree_model_filter_emit_row_inserted_for_path (GtkTreeModelFilter *filter,
1649 GtkTreeModel *c_model,
1650 GtkTreePath *c_path,
1651 GtkTreeIter *c_iter)
1656 GtkTreeIter iter, children;
1657 gboolean signals_emitted = FALSE;
1659 if (!filter->priv->root)
1661 /* The root level has not been exposed to the view yet, so we
1662 * need to emit signals for any node that is being inserted.
1664 gtk_tree_model_filter_build_level (filter, NULL, -1, TRUE);
1666 /* Check if the root level was built. Then child levels
1667 * that matter have also been built (due to update_children,
1668 * which triggers iter_n_children).
1670 if (filter->priv->root &&
1671 FILTER_LEVEL (filter->priv->root)->visible_nodes)
1672 signals_emitted = TRUE;
1675 gtk_tree_model_filter_increment_stamp (filter);
1677 /* We need to disallow to build new levels, because we are then pulling
1678 * in a child in an invisible level. We only want to find path if it
1679 * is in a visible level (and thus has a parent that is visible).
1681 path = gtk_real_tree_model_filter_convert_child_path_to_path (filter,
1687 /* parent is probably being filtered out */
1690 gtk_tree_model_filter_get_iter_full (GTK_TREE_MODEL (filter), &iter, path);
1692 level = FILTER_LEVEL (iter.user_data);
1693 elt = FILTER_ELT (iter.user_data2);
1695 /* Make sure elt is visible. elt can already be visible in case
1696 * it was pulled in above, so avoid increasing level->visible_nodes twice.
1700 elt->visible = TRUE;
1701 level->visible_nodes++;
1704 /* Check whether the node and all of its parents are visible */
1705 if (gtk_tree_model_filter_elt_is_visible_in_target (level, elt))
1707 /* visibility changed -- reget path */
1708 gtk_tree_path_free (path);
1709 path = gtk_tree_model_get_path (GTK_TREE_MODEL (filter), &iter);
1711 if (!signals_emitted &&
1712 (!level->parent_level || level->ext_ref_count > 0))
1713 gtk_tree_model_row_inserted (GTK_TREE_MODEL (filter), path, &iter);
1715 if (level->parent_level && FILTER_LEVEL_PARENT_ELT (level)->ext_ref_count > 0 &&
1716 level->visible_nodes == 1)
1718 /* We know that this is the first visible node in this level, so
1719 * we need to emit row-has-child-toggled on the parent. This
1720 * does not apply to the root level.
1723 gtk_tree_path_up (path);
1724 gtk_tree_model_get_iter (GTK_TREE_MODEL (filter), &iter, path);
1726 gtk_tree_model_row_has_child_toggled (GTK_TREE_MODEL (filter),
1731 if (!signals_emitted
1732 && gtk_tree_model_iter_children (c_model, &children, c_iter))
1733 gtk_tree_model_filter_update_children (filter, level, elt);
1736 gtk_tree_path_free (path);
1740 gtk_tree_model_filter_row_changed (GtkTreeModel *c_model,
1741 GtkTreePath *c_path,
1742 GtkTreeIter *c_iter,
1745 GtkTreeModelFilter *filter = GTK_TREE_MODEL_FILTER (data);
1747 GtkTreeIter children;
1748 GtkTreeIter real_c_iter;
1749 GtkTreePath *path = NULL;
1750 GtkTreePath *real_path = NULL;
1755 gboolean requested_state;
1756 gboolean current_state;
1757 gboolean free_c_path = FALSE;
1759 g_return_if_fail (c_path != NULL || c_iter != NULL);
1763 c_path = gtk_tree_model_get_path (c_model, c_iter);
1767 if (filter->priv->virtual_root)
1768 real_path = gtk_tree_model_filter_remove_root (c_path,
1769 filter->priv->virtual_root);
1771 real_path = gtk_tree_path_copy (c_path);
1774 real_c_iter = *c_iter;
1776 gtk_tree_model_get_iter (c_model, &real_c_iter, c_path);
1778 /* is this node above the virtual root? */
1779 if (filter->priv->virtual_root &&
1780 (gtk_tree_path_get_depth (filter->priv->virtual_root)
1781 >= gtk_tree_path_get_depth (c_path)))
1784 /* what's the requested state? */
1785 requested_state = gtk_tree_model_filter_visible (filter, &real_c_iter);
1787 /* now, let's see whether the item is there */
1788 path = gtk_real_tree_model_filter_convert_child_path_to_path (filter,
1795 gtk_tree_model_filter_get_iter_full (GTK_TREE_MODEL (filter),
1797 current_state = FILTER_ELT (iter.user_data2)->visible;
1800 current_state = FALSE;
1802 if (current_state == FALSE && requested_state == FALSE)
1803 /* no changes required */
1806 if (current_state == TRUE && requested_state == FALSE)
1808 gtk_tree_model_filter_remove_elt_from_level (filter,
1809 FILTER_LEVEL (iter.user_data),
1810 FILTER_ELT (iter.user_data2));
1813 gtk_tree_model_filter_check_ancestors (filter, real_path);
1818 if (current_state == TRUE && requested_state == TRUE)
1820 /* propagate the signal; also get a path taking only visible
1821 * nodes into account.
1823 gtk_tree_path_free (path);
1824 path = gtk_tree_model_get_path (GTK_TREE_MODEL (filter), &iter);
1826 level = FILTER_LEVEL (iter.user_data);
1827 elt = FILTER_ELT (iter.user_data2);
1829 if (gtk_tree_model_filter_elt_is_visible_in_target (level, elt))
1831 if (level->ext_ref_count > 0)
1832 gtk_tree_model_row_changed (GTK_TREE_MODEL (filter), path, &iter);
1834 /* and update the children */
1835 if (gtk_tree_model_iter_children (c_model, &children, &real_c_iter))
1836 gtk_tree_model_filter_update_children (filter, level, elt);
1840 gtk_tree_model_filter_check_ancestors (filter, real_path);
1845 /* only current == FALSE and requested == TRUE is left,
1848 g_return_if_fail (current_state == FALSE && requested_state == TRUE);
1851 gtk_tree_model_filter_check_ancestors (filter, real_path);
1853 gtk_tree_model_filter_emit_row_inserted_for_path (filter, c_model,
1858 gtk_tree_path_free (path);
1861 gtk_tree_path_free (real_path);
1864 gtk_tree_path_free (c_path);
1868 gtk_tree_model_filter_row_inserted (GtkTreeModel *c_model,
1869 GtkTreePath *c_path,
1870 GtkTreeIter *c_iter,
1873 GtkTreeModelFilter *filter = GTK_TREE_MODEL_FILTER (data);
1874 GtkTreePath *real_path = NULL;
1876 GtkTreeIter real_c_iter;
1878 FilterElt *elt = NULL;
1879 FilterLevel *level = NULL;
1880 FilterLevel *parent_level = NULL;
1884 gboolean free_c_path = FALSE;
1885 gboolean emit_row_inserted = FALSE;
1887 g_return_if_fail (c_path != NULL || c_iter != NULL);
1891 c_path = gtk_tree_model_get_path (c_model, c_iter);
1896 real_c_iter = *c_iter;
1898 gtk_tree_model_get_iter (c_model, &real_c_iter, c_path);
1900 /* the row has already been inserted. so we need to fixup the
1901 * virtual root here first
1903 if (filter->priv->virtual_root)
1905 if (gtk_tree_path_get_depth (filter->priv->virtual_root) >=
1906 gtk_tree_path_get_depth (c_path))
1909 gint *v_indices, *c_indices;
1910 gboolean common_prefix = TRUE;
1912 level = gtk_tree_path_get_depth (c_path) - 1;
1913 v_indices = gtk_tree_path_get_indices (filter->priv->virtual_root);
1914 c_indices = gtk_tree_path_get_indices (c_path);
1916 for (i = 0; i < level; i++)
1917 if (v_indices[i] != c_indices[i])
1919 common_prefix = FALSE;
1923 if (common_prefix && v_indices[level] >= c_indices[level])
1924 (v_indices[level])++;
1928 /* subtract virtual root if necessary */
1929 if (filter->priv->virtual_root)
1931 real_path = gtk_tree_model_filter_remove_root (c_path,
1932 filter->priv->virtual_root);
1938 real_path = gtk_tree_path_copy (c_path);
1940 if (!filter->priv->root)
1942 /* The root level has not been exposed to the view yet, so we
1943 * need to emit signals for any node that is being inserted.
1945 gtk_tree_model_filter_build_level (filter, NULL, -1, TRUE);
1947 /* Check if the root level was built. Then child levels
1948 * that matter have also been built (due to update_children,
1949 * which triggers iter_n_children).
1951 if (filter->priv->root)
1953 emit_row_inserted = FALSE;
1958 if (gtk_tree_path_get_depth (real_path) - 1 >= 1)
1960 gboolean found = FALSE;
1961 GtkTreePath *parent = gtk_tree_path_copy (real_path);
1962 gtk_tree_path_up (parent);
1964 found = find_elt_with_offset (filter, parent, &parent_level, &elt);
1966 gtk_tree_path_free (parent);
1969 /* Parent is not in the cache and probably being filtered out */
1972 level = elt->children;
1975 level = FILTER_LEVEL (filter->priv->root);
1979 if (elt && elt->visible)
1981 /* The level in which the new node should be inserted does not
1982 * exist, but the parent, elt, does. If elt is visible, emit
1983 * row-has-child-toggled.
1985 GtkTreePath *tmppath;
1986 GtkTreeIter tmpiter;
1988 tmpiter.stamp = filter->priv->stamp;
1989 tmpiter.user_data = parent_level;
1990 tmpiter.user_data2 = elt;
1992 tmppath = gtk_tree_model_get_path (GTK_TREE_MODEL (filter),
1997 gtk_tree_model_row_has_child_toggled (GTK_TREE_MODEL (filter),
1999 gtk_tree_path_free (tmppath);
2005 /* let's try to insert the value */
2006 offset = gtk_tree_path_get_indices (real_path)[gtk_tree_path_get_depth (real_path) - 1];
2008 /* update the offsets, yes if we didn't insert the node above, there will
2009 * be a gap here. This will be filled with the node (via fetch_child) when
2010 * it becomes visible
2012 for (i = 0; i < level->array->len; i++)
2014 FilterElt *e = &g_array_index (level->array, FilterElt, i);
2015 if ((e->offset >= offset))
2019 /* only insert when visible */
2020 if (gtk_tree_model_filter_visible (filter, &real_c_iter))
2024 felt = gtk_tree_model_filter_insert_elt_in_level (filter,
2029 /* insert_elt_in_level defaults to FALSE */
2030 felt->visible = TRUE;
2031 level->visible_nodes++;
2033 emit_row_inserted = TRUE;
2037 gtk_tree_model_filter_check_ancestors (filter, real_path);
2039 if (emit_row_inserted)
2040 gtk_tree_model_filter_emit_row_inserted_for_path (filter, c_model,
2044 gtk_tree_path_free (real_path);
2047 gtk_tree_path_free (c_path);
2051 gtk_tree_model_filter_row_has_child_toggled (GtkTreeModel *c_model,
2052 GtkTreePath *c_path,
2053 GtkTreeIter *c_iter,
2056 GtkTreeModelFilter *filter = GTK_TREE_MODEL_FILTER (data);
2061 gboolean requested_state;
2063 g_return_if_fail (c_path != NULL && c_iter != NULL);
2065 /* If we get row-has-child-toggled on the virtual root, and there is
2066 * no root level; try to build it now.
2068 if (filter->priv->virtual_root && !filter->priv->root
2069 && !gtk_tree_path_compare (c_path, filter->priv->virtual_root))
2071 gtk_tree_model_filter_build_level (filter, NULL, -1, TRUE);
2075 /* For all other levels, there is a chance that the visibility state
2076 * of the parent has changed now.
2079 path = gtk_real_tree_model_filter_convert_child_path_to_path (filter,
2086 gtk_tree_model_filter_get_iter_full (GTK_TREE_MODEL (data), &iter, path);
2088 level = FILTER_LEVEL (iter.user_data);
2089 elt = FILTER_ELT (iter.user_data2);
2091 gtk_tree_path_free (path);
2093 requested_state = gtk_tree_model_filter_visible (filter, c_iter);
2095 if (!elt->visible && !requested_state)
2097 /* The parent node currently is not visible and will not become
2098 * visible, so we will not pass on the row-has-child-toggled event.
2102 else if (elt->visible && !requested_state)
2104 /* The node is no longer visible, so it has to be removed.
2105 * _remove_elt_from_level() takes care of emitting row-has-child-toggled
2108 gtk_tree_model_filter_remove_elt_from_level (filter, level, elt);
2112 else if (!elt->visible && requested_state)
2114 elt->visible = TRUE;
2115 level->visible_nodes++;
2117 /* Only insert if the parent is visible in the target */
2118 if (gtk_tree_model_filter_elt_is_visible_in_target (level, elt))
2120 path = gtk_tree_model_get_path (GTK_TREE_MODEL (filter), &iter);
2121 gtk_tree_model_row_inserted (GTK_TREE_MODEL (filter), path, &iter);
2122 gtk_tree_path_free (path);
2124 /* We do not update children now, because that will happen
2129 /* For the remaining possibility, elt->visible && requested_state
2130 * no action is required.
2133 /* If this node is referenced and has children, build the level so we
2134 * can monitor it for changes.
2136 if (elt->ref_count > 1 && !elt->children &&
2137 gtk_tree_model_iter_has_child (c_model, c_iter))
2138 gtk_tree_model_filter_build_level (filter, level,
2139 FILTER_LEVEL_ELT_INDEX (level, elt),
2142 /* get a path taking only visible nodes into account */
2143 path = gtk_tree_model_get_path (GTK_TREE_MODEL (data), &iter);
2144 gtk_tree_model_row_has_child_toggled (GTK_TREE_MODEL (data), path, &iter);
2145 gtk_tree_path_free (path);
2149 gtk_tree_model_filter_virtual_root_deleted (GtkTreeModelFilter *filter,
2150 GtkTreePath *c_path)
2154 FilterLevel *level = FILTER_LEVEL (filter->priv->root);
2156 /* The virtual root (or one of its ancestors) has been deleted. This
2157 * means that all content for our model is now gone. We deal with
2158 * this by removing everything in the filter model: we just iterate
2159 * over the root level and emit a row-deleted for each FilterElt.
2160 * (FIXME: Should we emit row-deleted for child nodes as well? This
2161 * has never been fully clear in TreeModel).
2164 /* We unref the path of the virtual root, up to and not including the
2165 * deleted node which can no longer be unreffed.
2167 gtk_tree_model_filter_unref_path (filter, filter->priv->virtual_root,
2168 gtk_tree_path_get_depth (c_path) - 1);
2169 filter->priv->virtual_root_deleted = TRUE;
2174 nodes = level->visible_nodes;
2176 /* We should not propagate the unref here. An unref for any of these
2177 * nodes will fail, since the respective nodes in the child model are
2180 gtk_tree_model_filter_free_level (filter, filter->priv->root, FALSE);
2182 gtk_tree_model_filter_increment_stamp (filter);
2184 path = gtk_tree_path_new ();
2185 gtk_tree_path_append_index (path, 0);
2187 for (i = 0; i < nodes; i++)
2188 gtk_tree_model_row_deleted (GTK_TREE_MODEL (filter), path);
2190 gtk_tree_path_free (path);
2194 gtk_tree_model_filter_adjust_virtual_root (GtkTreeModelFilter *filter,
2195 GtkTreePath *c_path)
2199 gint *v_indices, *c_indices;
2200 gboolean common_prefix = TRUE;
2202 level = gtk_tree_path_get_depth (c_path) - 1;
2203 v_indices = gtk_tree_path_get_indices (filter->priv->virtual_root);
2204 c_indices = gtk_tree_path_get_indices (c_path);
2206 for (i = 0; i < level; i++)
2207 if (v_indices[i] != c_indices[i])
2209 common_prefix = FALSE;
2213 if (common_prefix && v_indices[level] > c_indices[level])
2214 (v_indices[level])--;
2218 gtk_tree_model_filter_row_deleted_invisible_node (GtkTreeModelFilter *filter,
2219 GtkTreePath *c_path)
2223 GtkTreePath *real_path;
2227 /* The node deleted in the child model is not visible in the
2228 * filter model. We will not emit a signal, just fixup the offsets
2229 * of the other nodes.
2232 if (!filter->priv->root)
2235 level = FILTER_LEVEL (filter->priv->root);
2237 /* subtract vroot if necessary */
2238 if (filter->priv->virtual_root)
2240 real_path = gtk_tree_model_filter_remove_root (c_path,
2241 filter->priv->virtual_root);
2242 /* we don't handle this */
2247 real_path = gtk_tree_path_copy (c_path);
2249 if (gtk_tree_path_get_depth (real_path) - 1 >= 1)
2251 gboolean found = FALSE;
2252 GtkTreePath *parent = gtk_tree_path_copy (real_path);
2253 gtk_tree_path_up (parent);
2255 found = find_elt_with_offset (filter, parent, &level, &elt);
2257 gtk_tree_path_free (parent);
2261 /* parent is filtered out, so no level */
2262 gtk_tree_path_free (real_path);
2266 level = elt->children;
2269 offset = gtk_tree_path_get_indices (real_path)[gtk_tree_path_get_depth (real_path) - 1];
2270 gtk_tree_path_free (real_path);
2275 /* decrease offset of all nodes following the deleted node */
2276 for (i = 0; i < level->array->len; i++)
2278 elt = &g_array_index (level->array, FilterElt, i);
2279 if (elt->offset > offset)
2282 elt->children->parent_elt_index = i;
2287 gtk_tree_model_filter_row_deleted (GtkTreeModel *c_model,
2288 GtkTreePath *c_path,
2291 GtkTreeModelFilter *filter = GTK_TREE_MODEL_FILTER (data);
2295 FilterLevel *level, *parent_level = NULL;
2296 gboolean emit_child_toggled = FALSE;
2297 gboolean emit_row_deleted = FALSE;
2300 gint parent_elt_index = -1;
2301 gint orig_level_ext_ref_count;
2303 g_return_if_fail (c_path != NULL);
2305 /* special case the deletion of an ancestor of the virtual root */
2306 if (filter->priv->virtual_root &&
2307 (gtk_tree_path_is_ancestor (c_path, filter->priv->virtual_root) ||
2308 !gtk_tree_path_compare (c_path, filter->priv->virtual_root)))
2310 gtk_tree_model_filter_virtual_root_deleted (filter, c_path);
2314 /* adjust the virtual root for the deleted row */
2315 if (filter->priv->virtual_root &&
2316 gtk_tree_path_get_depth (filter->priv->virtual_root) >=
2317 gtk_tree_path_get_depth (c_path))
2318 gtk_tree_model_filter_adjust_virtual_root (filter, c_path);
2320 path = gtk_real_tree_model_filter_convert_child_path_to_path (filter,
2327 gtk_tree_model_filter_row_deleted_invisible_node (filter, c_path);
2331 /* a node was deleted, which was in our cache */
2332 gtk_tree_model_filter_get_iter_full (GTK_TREE_MODEL (data), &iter, path);
2334 level = FILTER_LEVEL (iter.user_data);
2335 elt = FILTER_ELT (iter.user_data2);
2336 offset = elt->offset;
2337 orig_level_ext_ref_count = level->ext_ref_count;
2341 /* get a path taking only visible nodes into account */
2342 gtk_tree_path_free (path);
2343 path = gtk_tree_model_get_path (GTK_TREE_MODEL (filter), &iter);
2345 level->visible_nodes--;
2347 if (level->visible_nodes == 0)
2349 emit_child_toggled = TRUE;
2350 parent_level = level->parent_level;
2351 parent_elt_index = level->parent_elt_index;
2354 emit_row_deleted = TRUE;
2357 /* Release the references on this node, without propagation because
2358 * the node does not exist anymore in the child model. The filter
2359 * model's references on the node in case of level->parent or use
2360 * of a virtual root are automatically destroyed by the child model.
2362 while (elt->ext_ref_count > 0)
2363 gtk_tree_model_filter_real_unref_node (GTK_TREE_MODEL (data), &iter,
2365 while (elt->ref_count > 0)
2366 gtk_tree_model_filter_real_unref_node (GTK_TREE_MODEL (data), &iter,
2369 if (level->array->len == 1)
2372 gtk_tree_model_filter_free_level (filter, level, FALSE);
2379 is_first = elt == &g_array_index (level->array, FilterElt, 0);
2381 /* remove the row */
2382 tmp = bsearch_elt_with_offset (level->array, elt->offset, &i);
2384 offset = tmp->offset;
2385 g_array_remove_index (level->array, i);
2388 for (i = MAX (i, 0); i < level->array->len; i++)
2390 elt = &g_array_index (level->array, FilterElt, i);
2391 if (elt->offset > offset)
2394 elt->children->parent_elt_index = i;
2397 /* Take a reference on the new first node. The first node previously
2398 * keeping this reference has been removed above.
2404 f_iter.stamp = filter->priv->stamp;
2405 f_iter.user_data = level;
2406 f_iter.user_data2 = &(g_array_index (level->array, FilterElt, 0));
2408 gtk_tree_model_filter_real_ref_node (GTK_TREE_MODEL (filter),
2413 if (emit_row_deleted)
2415 /* emit row_deleted */
2416 gtk_tree_model_filter_increment_stamp (filter);
2418 if (parent_elt_index == -1 || orig_level_ext_ref_count > 0)
2419 gtk_tree_model_row_deleted (GTK_TREE_MODEL (data), path);
2422 if (emit_child_toggled && parent_level)
2427 iter2.stamp = filter->priv->stamp;
2428 iter2.user_data = parent_level;
2429 iter2.user_data2 = &g_array_index (parent_level->array, FilterElt, parent_elt_index);
2431 /* We set in_row_deleted to TRUE to avoid a level build triggered
2432 * by row-has-child-toggled (parent model could call iter_has_child
2435 filter->priv->in_row_deleted = TRUE;
2436 path2 = gtk_tree_model_get_path (GTK_TREE_MODEL (filter), &iter2);
2437 gtk_tree_model_row_has_child_toggled (GTK_TREE_MODEL (filter),
2439 gtk_tree_path_free (path2);
2440 filter->priv->in_row_deleted = FALSE;
2443 if (filter->priv->virtual_root)
2445 GtkTreePath *real_path;
2447 real_path = gtk_tree_model_filter_remove_root (c_path,
2448 filter->priv->root);
2451 gtk_tree_model_filter_check_ancestors (filter, real_path);
2452 gtk_tree_path_free (real_path);
2456 gtk_tree_model_filter_check_ancestors (filter, c_path);
2458 gtk_tree_path_free (path);
2462 gtk_tree_model_filter_rows_reordered (GtkTreeModel *c_model,
2463 GtkTreePath *c_path,
2464 GtkTreeIter *c_iter,
2470 GtkTreeModelFilter *filter = GTK_TREE_MODEL_FILTER (data);
2476 gint i, j, elt_count;
2478 gint first_elt_new_index = -1;
2482 g_return_if_fail (new_order != NULL);
2484 if (c_path == NULL || gtk_tree_path_get_depth (c_path) == 0)
2486 length = gtk_tree_model_iter_n_children (c_model, NULL);
2488 if (filter->priv->virtual_root)
2492 /* reorder root level of path */
2493 for (i = 0; i < length; i++)
2494 if (new_order[i] == gtk_tree_path_get_indices (filter->priv->virtual_root)[0])
2500 gtk_tree_path_get_indices (filter->priv->virtual_root)[0] = new_pos;
2504 path = gtk_tree_path_new ();
2505 level = FILTER_LEVEL (filter->priv->root);
2509 GtkTreeIter child_iter;
2511 /* virtual root anchor reordering */
2512 if (filter->priv->virtual_root &&
2513 gtk_tree_path_is_ancestor (c_path, filter->priv->virtual_root))
2518 GtkTreeIter real_c_iter;
2520 level = gtk_tree_path_get_depth (c_path);
2523 real_c_iter = *c_iter;
2525 gtk_tree_model_get_iter (c_model, &real_c_iter, c_path);
2527 length = gtk_tree_model_iter_n_children (c_model, &real_c_iter);
2529 for (i = 0; i < length; i++)
2530 if (new_order[i] == gtk_tree_path_get_indices (filter->priv->virtual_root)[level])
2536 gtk_tree_path_get_indices (filter->priv->virtual_root)[level] = new_pos;
2540 path = gtk_real_tree_model_filter_convert_child_path_to_path (filter,
2545 if (!path && filter->priv->virtual_root &&
2546 gtk_tree_path_compare (c_path, filter->priv->virtual_root))
2549 if (!path && !filter->priv->virtual_root)
2554 /* root level mode */
2556 gtk_tree_model_get_iter (c_model, c_iter, c_path);
2557 length = gtk_tree_model_iter_n_children (c_model, c_iter);
2558 path = gtk_tree_path_new ();
2559 level = FILTER_LEVEL (filter->priv->root);
2563 gtk_tree_model_filter_get_iter_full (GTK_TREE_MODEL (data),
2566 level = FILTER_LEVEL (iter.user_data);
2567 elt = FILTER_ELT (iter.user_data2);
2571 gtk_tree_path_free (path);
2575 level = elt->children;
2577 gtk_tree_model_filter_convert_iter_to_child_iter (GTK_TREE_MODEL_FILTER (filter), &child_iter, &iter);
2578 length = gtk_tree_model_iter_n_children (c_model, &child_iter);
2582 if (!level || level->array->len < 1)
2584 gtk_tree_path_free (path);
2588 /* NOTE: we do not bail out here if level->array->len < 2 like
2589 * GtkTreeModelSort does. This because we do some special tricky
2593 /* construct a new array */
2594 new_array = g_array_sized_new (FALSE, FALSE, sizeof (FilterElt),
2596 tmp_array = g_new (gint, level->array->len);
2598 for (i = 0, elt_count = 0; i < length; i++)
2600 FilterElt *e = NULL;
2601 gint old_offset = -1;
2603 for (j = 0; j < level->array->len; j++)
2604 if (g_array_index (level->array, FilterElt, j).offset == new_order[i])
2606 e = &g_array_index (level->array, FilterElt, j);
2614 if (old_offset == 0)
2615 first_elt_new_index = elt_count;
2617 tmp_array[elt_count] = old_offset;
2618 g_array_append_val (new_array, *e);
2619 g_array_index (new_array, FilterElt, elt_count).offset = i;
2623 g_array_free (level->array, TRUE);
2624 level->array = new_array;
2627 for (i = 0; i < level->array->len; i++)
2629 FilterElt *e = &g_array_index (level->array, FilterElt, i);
2631 e->children->parent_elt_index = i;
2634 /* Transfer the reference from the old item at position 0 to the
2635 * new item at position 0.
2637 if (first_elt_new_index != -1 && first_elt_new_index != 0)
2638 gtk_tree_model_filter_level_transfer_first_ref (filter,
2640 first_elt_new_index, 0);
2643 /* emit rows_reordered */
2644 if (level->visible_nodes > 0)
2646 if (!gtk_tree_path_get_indices (path))
2647 gtk_tree_model_rows_reordered (GTK_TREE_MODEL (data), path, NULL,
2651 /* get a path taking only visible nodes into account */
2652 gtk_tree_path_free (path);
2653 path = gtk_tree_model_get_path (GTK_TREE_MODEL (data), &iter);
2655 gtk_tree_model_rows_reordered (GTK_TREE_MODEL (data), path, &iter,
2662 gtk_tree_path_free (path);
2665 /* TreeModelIface implementation */
2666 static GtkTreeModelFlags
2667 gtk_tree_model_filter_get_flags (GtkTreeModel *model)
2669 GtkTreeModelFlags flags;
2671 g_return_val_if_fail (GTK_IS_TREE_MODEL_FILTER (model), 0);
2672 g_return_val_if_fail (GTK_TREE_MODEL_FILTER (model)->priv->child_model != NULL, 0);
2674 flags = gtk_tree_model_get_flags (GTK_TREE_MODEL_FILTER (model)->priv->child_model);
2676 if ((flags & GTK_TREE_MODEL_LIST_ONLY) == GTK_TREE_MODEL_LIST_ONLY)
2677 return GTK_TREE_MODEL_LIST_ONLY;
2683 gtk_tree_model_filter_get_n_columns (GtkTreeModel *model)
2685 GtkTreeModelFilter *filter = (GtkTreeModelFilter *)model;
2687 g_return_val_if_fail (GTK_IS_TREE_MODEL_FILTER (model), 0);
2688 g_return_val_if_fail (filter->priv->child_model != NULL, 0);
2690 if (filter->priv->child_model == NULL)
2693 /* so we can't modify the modify func after this ... */
2694 filter->priv->modify_func_set = TRUE;
2696 if (filter->priv->modify_n_columns > 0)
2697 return filter->priv->modify_n_columns;
2699 return gtk_tree_model_get_n_columns (filter->priv->child_model);
2703 gtk_tree_model_filter_get_column_type (GtkTreeModel *model,
2706 GtkTreeModelFilter *filter = (GtkTreeModelFilter *)model;
2708 g_return_val_if_fail (GTK_IS_TREE_MODEL_FILTER (model), G_TYPE_INVALID);
2709 g_return_val_if_fail (filter->priv->child_model != NULL, G_TYPE_INVALID);
2711 /* so we can't modify the modify func after this ... */
2712 filter->priv->modify_func_set = TRUE;
2714 if (filter->priv->modify_types)
2716 g_return_val_if_fail (index < filter->priv->modify_n_columns, G_TYPE_INVALID);
2718 return filter->priv->modify_types[index];
2721 return gtk_tree_model_get_column_type (filter->priv->child_model, index);
2724 /* A special case of _get_iter; this function can also get iters which
2725 * are not visible. These iters should ONLY be passed internally, never
2726 * pass those along with a signal emission.
2729 gtk_tree_model_filter_get_iter_full (GtkTreeModel *model,
2733 GtkTreeModelFilter *filter = (GtkTreeModelFilter *)model;
2738 g_return_val_if_fail (GTK_IS_TREE_MODEL_FILTER (model), FALSE);
2739 g_return_val_if_fail (filter->priv->child_model != NULL, FALSE);
2741 indices = gtk_tree_path_get_indices (path);
2743 if (filter->priv->root == NULL)
2744 gtk_tree_model_filter_build_level (filter, NULL, -1, FALSE);
2745 level = FILTER_LEVEL (filter->priv->root);
2747 depth = gtk_tree_path_get_depth (path);
2754 for (i = 0; i < depth - 1; i++)
2756 if (!level || indices[i] >= level->array->len)
2762 elt = gtk_tree_model_filter_get_nth (filter, level, indices[i]);
2765 gtk_tree_model_filter_build_level (filter, level,
2766 FILTER_LEVEL_ELT_INDEX (level, elt),
2768 level = elt->children;
2771 if (!level || indices[i] >= level->array->len)
2777 iter->stamp = filter->priv->stamp;
2778 iter->user_data = level;
2780 elt = gtk_tree_model_filter_get_nth (filter, level, indices[depth - 1]);
2781 iter->user_data2 = elt;
2787 gtk_tree_model_filter_get_iter (GtkTreeModel *model,
2791 GtkTreeModelFilter *filter = (GtkTreeModelFilter *)model;
2796 g_return_val_if_fail (GTK_IS_TREE_MODEL_FILTER (model), FALSE);
2797 g_return_val_if_fail (filter->priv->child_model != NULL, FALSE);
2799 indices = gtk_tree_path_get_indices (path);
2801 if (filter->priv->root == NULL)
2802 gtk_tree_model_filter_build_level (filter, NULL, -1, FALSE);
2803 level = FILTER_LEVEL (filter->priv->root);
2805 depth = gtk_tree_path_get_depth (path);
2812 for (i = 0; i < depth - 1; i++)
2814 if (!level || indices[i] >= level->visible_nodes)
2820 elt = gtk_tree_model_filter_get_nth_visible (filter, level, indices[i]);
2823 gtk_tree_model_filter_build_level (filter, level,
2824 FILTER_LEVEL_ELT_INDEX (level, elt),
2826 level = elt->children;
2829 if (!level || indices[i] >= level->visible_nodes)
2835 iter->stamp = filter->priv->stamp;
2836 iter->user_data = level;
2838 elt = gtk_tree_model_filter_get_nth_visible (filter, level,
2839 indices[depth - 1]);
2840 iter->user_data2 = elt;
2845 static GtkTreePath *
2846 gtk_tree_model_filter_get_path (GtkTreeModel *model,
2849 GtkTreePath *retval;
2854 g_return_val_if_fail (GTK_IS_TREE_MODEL_FILTER (model), NULL);
2855 g_return_val_if_fail (GTK_TREE_MODEL_FILTER (model)->priv->child_model != NULL, NULL);
2856 g_return_val_if_fail (GTK_TREE_MODEL_FILTER (model)->priv->stamp == iter->stamp, NULL);
2858 level = iter->user_data;
2859 elt = iter->user_data2;
2860 elt_index = FILTER_LEVEL_ELT_INDEX (level, elt);
2865 retval = gtk_tree_path_new ();
2869 int i = 0, index = 0;
2871 while (i < elt_index)
2873 if (g_array_index (level->array, FilterElt, i).visible)
2877 g_assert (i < level->array->len);
2880 gtk_tree_path_prepend_index (retval, index);
2881 elt_index = level->parent_elt_index;
2882 level = level->parent_level;
2889 gtk_tree_model_filter_real_modify (GtkTreeModelFilter *self,
2890 GtkTreeModel *child_model,
2895 if (self->priv->modify_func)
2897 g_return_if_fail (column < self->priv->modify_n_columns);
2899 g_value_init (value, self->priv->modify_types[column]);
2900 self->priv->modify_func (GTK_TREE_MODEL (self),
2904 self->priv->modify_data);
2908 GtkTreeIter child_iter;
2910 gtk_tree_model_filter_convert_iter_to_child_iter (
2911 GTK_TREE_MODEL_FILTER (self), &child_iter, iter);
2912 gtk_tree_model_get_value (child_model,
2913 &child_iter, column, value);
2918 gtk_tree_model_filter_get_value (GtkTreeModel *model,
2923 GtkTreeModelFilter *filter = GTK_TREE_MODEL_FILTER (model);
2925 g_return_if_fail (GTK_IS_TREE_MODEL_FILTER (model));
2926 g_return_if_fail (GTK_TREE_MODEL_FILTER (model)->priv->child_model != NULL);
2927 g_return_if_fail (GTK_TREE_MODEL_FILTER (model)->priv->stamp == iter->stamp);
2929 GTK_TREE_MODEL_FILTER_GET_CLASS (model)->modify (filter,
2930 filter->priv->child_model, iter, value, column);
2934 gtk_tree_model_filter_iter_next (GtkTreeModel *model,
2941 g_return_val_if_fail (GTK_IS_TREE_MODEL_FILTER (model), FALSE);
2942 g_return_val_if_fail (GTK_TREE_MODEL_FILTER (model)->priv->child_model != NULL, FALSE);
2943 g_return_val_if_fail (GTK_TREE_MODEL_FILTER (model)->priv->stamp == iter->stamp, FALSE);
2945 level = iter->user_data;
2946 elt = iter->user_data2;
2948 i = elt - FILTER_ELT (level->array->data);
2950 while (i < level->array->len - 1)
2957 iter->user_data2 = elt;
2962 /* no next visible iter */
2969 gtk_tree_model_filter_iter_previous (GtkTreeModel *model,
2976 g_return_val_if_fail (GTK_IS_TREE_MODEL_FILTER (model), FALSE);
2977 g_return_val_if_fail (GTK_TREE_MODEL_FILTER (model)->priv->child_model != NULL, FALSE);
2978 g_return_val_if_fail (GTK_TREE_MODEL_FILTER (model)->priv->stamp == iter->stamp, FALSE);
2980 level = iter->user_data;
2981 elt = iter->user_data2;
2983 i = elt - FILTER_ELT (level->array->data);
2992 iter->user_data2 = elt;
2997 /* no previous visible iter */
3004 gtk_tree_model_filter_iter_children (GtkTreeModel *model,
3006 GtkTreeIter *parent)
3008 GtkTreeModelFilter *filter = (GtkTreeModelFilter *)model;
3012 g_return_val_if_fail (GTK_IS_TREE_MODEL_FILTER (model), FALSE);
3013 g_return_val_if_fail (filter->priv->child_model != NULL, FALSE);
3015 g_return_val_if_fail (filter->priv->stamp == parent->stamp, FALSE);
3021 if (!filter->priv->root)
3022 gtk_tree_model_filter_build_level (filter, NULL, -1, FALSE);
3023 if (!filter->priv->root)
3026 level = filter->priv->root;
3028 if (!level->visible_nodes)
3031 iter->stamp = filter->priv->stamp;
3032 iter->user_data = level;
3034 while (i < level->array->len)
3036 if (!g_array_index (level->array, FilterElt, i).visible)
3042 iter->user_data2 = &g_array_index (level->array, FilterElt, i);
3054 elt = FILTER_ELT (parent->user_data2);
3056 if (elt->children == NULL)
3057 gtk_tree_model_filter_build_level (filter,
3058 FILTER_LEVEL (parent->user_data),
3059 FILTER_LEVEL_ELT_INDEX (parent->user_data, elt),
3062 if (elt->children == NULL)
3065 if (elt->children->visible_nodes <= 0)
3068 iter->stamp = filter->priv->stamp;
3069 iter->user_data = elt->children;
3071 level = FILTER_LEVEL (iter->user_data);
3073 while (i < level->array->len)
3075 if (!g_array_index (level->array, FilterElt, i).visible)
3081 iter->user_data2 = &g_array_index (level->array, FilterElt, i);
3094 gtk_tree_model_filter_iter_has_child (GtkTreeModel *model,
3097 GtkTreeIter child_iter;
3098 GtkTreeModelFilter *filter = (GtkTreeModelFilter *)model;
3101 g_return_val_if_fail (GTK_IS_TREE_MODEL_FILTER (model), FALSE);
3102 g_return_val_if_fail (filter->priv->child_model != NULL, FALSE);
3103 g_return_val_if_fail (filter->priv->stamp == iter->stamp, FALSE);
3105 filter = GTK_TREE_MODEL_FILTER (model);
3107 gtk_tree_model_filter_convert_iter_to_child_iter (GTK_TREE_MODEL_FILTER (model), &child_iter, iter);
3108 elt = FILTER_ELT (iter->user_data2);
3113 /* we need to build the level to check if not all children are filtered
3117 && gtk_tree_model_iter_has_child (filter->priv->child_model, &child_iter))
3118 gtk_tree_model_filter_build_level (filter, FILTER_LEVEL (iter->user_data),
3119 FILTER_LEVEL_ELT_INDEX (iter->user_data, elt),
3122 if (elt->children && elt->children->visible_nodes > 0)
3129 gtk_tree_model_filter_iter_n_children (GtkTreeModel *model,
3132 GtkTreeIter child_iter;
3133 GtkTreeModelFilter *filter = (GtkTreeModelFilter *)model;
3136 g_return_val_if_fail (GTK_IS_TREE_MODEL_FILTER (model), 0);
3137 g_return_val_if_fail (filter->priv->child_model != NULL, 0);
3139 g_return_val_if_fail (filter->priv->stamp == iter->stamp, 0);
3143 if (!filter->priv->root)
3144 gtk_tree_model_filter_build_level (filter, NULL, -1, FALSE);
3146 if (filter->priv->root)
3147 return FILTER_LEVEL (filter->priv->root)->visible_nodes;
3152 elt = FILTER_ELT (iter->user_data2);
3157 gtk_tree_model_filter_convert_iter_to_child_iter (GTK_TREE_MODEL_FILTER (model), &child_iter, iter);
3159 if (!elt->children &&
3160 gtk_tree_model_iter_has_child (filter->priv->child_model, &child_iter))
3161 gtk_tree_model_filter_build_level (filter,
3162 FILTER_LEVEL (iter->user_data),
3163 FILTER_LEVEL_ELT_INDEX (iter->user_data, elt),
3167 return elt->children->visible_nodes;
3173 gtk_tree_model_filter_iter_nth_child (GtkTreeModel *model,
3175 GtkTreeIter *parent,
3180 GtkTreeIter children;
3182 g_return_val_if_fail (GTK_IS_TREE_MODEL_FILTER (model), FALSE);
3184 g_return_val_if_fail (GTK_TREE_MODEL_FILTER (model)->priv->stamp == parent->stamp, FALSE);
3186 /* use this instead of has_child to force us to build the level, if needed */
3187 if (gtk_tree_model_filter_iter_children (model, &children, parent) == FALSE)
3193 level = children.user_data;
3194 elt = FILTER_ELT (level->array->data);
3196 if (n >= level->visible_nodes)
3202 elt = gtk_tree_model_filter_get_nth_visible (GTK_TREE_MODEL_FILTER (model),
3205 iter->stamp = GTK_TREE_MODEL_FILTER (model)->priv->stamp;
3206 iter->user_data = level;
3207 iter->user_data2 = elt;
3213 gtk_tree_model_filter_iter_parent (GtkTreeModel *model,
3220 g_return_val_if_fail (GTK_IS_TREE_MODEL_FILTER (model), FALSE);
3221 g_return_val_if_fail (GTK_TREE_MODEL_FILTER (model)->priv->child_model != NULL, FALSE);
3222 g_return_val_if_fail (GTK_TREE_MODEL_FILTER (model)->priv->stamp == child->stamp, FALSE);
3224 level = child->user_data;
3226 if (level->parent_level)
3228 iter->stamp = GTK_TREE_MODEL_FILTER (model)->priv->stamp;
3229 iter->user_data = level->parent_level;
3230 iter->user_data2 = FILTER_LEVEL_PARENT_ELT (level);
3239 gtk_tree_model_filter_ref_node (GtkTreeModel *model,
3242 gtk_tree_model_filter_real_ref_node (model, iter, TRUE);
3246 gtk_tree_model_filter_real_ref_node (GtkTreeModel *model,
3250 GtkTreeModelFilter *filter = (GtkTreeModelFilter *)model;
3251 GtkTreeIter child_iter;
3255 g_return_if_fail (GTK_IS_TREE_MODEL_FILTER (model));
3256 g_return_if_fail (GTK_TREE_MODEL_FILTER (model)->priv->child_model != NULL);
3257 g_return_if_fail (GTK_TREE_MODEL_FILTER (model)->priv->stamp == iter->stamp);
3259 gtk_tree_model_filter_convert_iter_to_child_iter (GTK_TREE_MODEL_FILTER (model), &child_iter, iter);
3261 gtk_tree_model_ref_node (filter->priv->child_model, &child_iter);
3263 level = iter->user_data;
3264 elt = iter->user_data2;
3271 elt->ext_ref_count++;
3272 level->ext_ref_count++;
3274 if (level->ext_ref_count == 1)
3276 FilterLevel *parent_level = level->parent_level;
3277 gint parent_elt_index = level->parent_elt_index;
3279 /* we were at zero -- time to decrease the zero_ref_count val */
3280 while (parent_level)
3282 g_array_index (parent_level->array, FilterElt, parent_elt_index).zero_ref_count--;
3284 parent_elt_index = parent_level->parent_elt_index;
3285 parent_level = parent_level->parent_level;
3288 if (filter->priv->root != level)
3289 filter->priv->zero_ref_count--;
3295 gtk_tree_model_filter_unref_node (GtkTreeModel *model,
3298 gtk_tree_model_filter_real_unref_node (model, iter, TRUE, TRUE);
3302 gtk_tree_model_filter_real_unref_node (GtkTreeModel *model,
3305 gboolean propagate_unref)
3307 GtkTreeModelFilter *filter = (GtkTreeModelFilter *)model;
3311 g_return_if_fail (GTK_IS_TREE_MODEL_FILTER (model));
3312 g_return_if_fail (filter->priv->child_model != NULL);
3313 g_return_if_fail (filter->priv->stamp == iter->stamp);
3315 if (propagate_unref)
3317 GtkTreeIter child_iter;
3318 gtk_tree_model_filter_convert_iter_to_child_iter (GTK_TREE_MODEL_FILTER (model), &child_iter, iter);
3319 gtk_tree_model_unref_node (filter->priv->child_model, &child_iter);
3322 level = iter->user_data;
3323 elt = iter->user_data2;
3325 g_return_if_fail (elt->ref_count > 0);
3332 elt->ext_ref_count--;
3333 level->ext_ref_count--;
3335 if (level->ext_ref_count == 0)
3337 FilterLevel *parent_level = level->parent_level;
3338 gint parent_elt_index = level->parent_elt_index;
3340 /* we are at zero -- time to increase the zero_ref_count val */
3341 while (parent_level)
3343 g_array_index (parent_level->array, FilterElt, parent_elt_index).zero_ref_count++;
3345 parent_elt_index = parent_level->parent_elt_index;
3346 parent_level = parent_level->parent_level;
3349 if (filter->priv->root != level)
3350 filter->priv->zero_ref_count++;
3355 /* TreeDragSource interface implementation */
3357 gtk_tree_model_filter_row_draggable (GtkTreeDragSource *drag_source,
3360 GtkTreeModelFilter *tree_model_filter = (GtkTreeModelFilter *)drag_source;
3361 GtkTreePath *child_path;
3364 g_return_val_if_fail (GTK_IS_TREE_MODEL_FILTER (drag_source), FALSE);
3365 g_return_val_if_fail (path != NULL, FALSE);
3367 child_path = gtk_tree_model_filter_convert_path_to_child_path (tree_model_filter, path);
3368 draggable = gtk_tree_drag_source_row_draggable (GTK_TREE_DRAG_SOURCE (tree_model_filter->priv->child_model), child_path);
3369 gtk_tree_path_free (child_path);
3375 gtk_tree_model_filter_drag_data_get (GtkTreeDragSource *drag_source,
3377 GtkSelectionData *selection_data)
3379 GtkTreeModelFilter *tree_model_filter = (GtkTreeModelFilter *)drag_source;
3380 GtkTreePath *child_path;
3383 g_return_val_if_fail (GTK_IS_TREE_MODEL_FILTER (drag_source), FALSE);
3384 g_return_val_if_fail (path != NULL, FALSE);
3386 child_path = gtk_tree_model_filter_convert_path_to_child_path (tree_model_filter, path);
3387 gotten = gtk_tree_drag_source_drag_data_get (GTK_TREE_DRAG_SOURCE (tree_model_filter->priv->child_model), child_path, selection_data);
3388 gtk_tree_path_free (child_path);
3394 gtk_tree_model_filter_drag_data_delete (GtkTreeDragSource *drag_source,
3397 GtkTreeModelFilter *tree_model_filter = (GtkTreeModelFilter *)drag_source;
3398 GtkTreePath *child_path;
3401 g_return_val_if_fail (GTK_IS_TREE_MODEL_FILTER (drag_source), FALSE);
3402 g_return_val_if_fail (path != NULL, FALSE);
3404 child_path = gtk_tree_model_filter_convert_path_to_child_path (tree_model_filter, path);
3405 deleted = gtk_tree_drag_source_drag_data_delete (GTK_TREE_DRAG_SOURCE (tree_model_filter->priv->child_model), child_path);
3406 gtk_tree_path_free (child_path);
3411 /* bits and pieces */
3413 gtk_tree_model_filter_set_model (GtkTreeModelFilter *filter,
3414 GtkTreeModel *child_model)
3416 g_return_if_fail (GTK_IS_TREE_MODEL_FILTER (filter));
3418 if (filter->priv->child_model)
3420 g_signal_handler_disconnect (filter->priv->child_model,
3421 filter->priv->changed_id);
3422 g_signal_handler_disconnect (filter->priv->child_model,
3423 filter->priv->inserted_id);
3424 g_signal_handler_disconnect (filter->priv->child_model,
3425 filter->priv->has_child_toggled_id);
3426 g_signal_handler_disconnect (filter->priv->child_model,
3427 filter->priv->deleted_id);
3428 g_signal_handler_disconnect (filter->priv->child_model,
3429 filter->priv->reordered_id);
3431 /* reset our state */
3432 if (filter->priv->root)
3433 gtk_tree_model_filter_free_level (filter, filter->priv->root, TRUE);
3435 filter->priv->root = NULL;
3436 g_object_unref (filter->priv->child_model);
3437 filter->priv->visible_column = -1;
3439 /* FIXME: do we need to destroy more here? */
3442 filter->priv->child_model = child_model;
3446 g_object_ref (filter->priv->child_model);
3447 filter->priv->changed_id =
3448 g_signal_connect (child_model, "row-changed",
3449 G_CALLBACK (gtk_tree_model_filter_row_changed),
3451 filter->priv->inserted_id =
3452 g_signal_connect (child_model, "row-inserted",
3453 G_CALLBACK (gtk_tree_model_filter_row_inserted),
3455 filter->priv->has_child_toggled_id =
3456 g_signal_connect (child_model, "row-has-child-toggled",
3457 G_CALLBACK (gtk_tree_model_filter_row_has_child_toggled),
3459 filter->priv->deleted_id =
3460 g_signal_connect (child_model, "row-deleted",
3461 G_CALLBACK (gtk_tree_model_filter_row_deleted),
3463 filter->priv->reordered_id =
3464 g_signal_connect (child_model, "rows-reordered",
3465 G_CALLBACK (gtk_tree_model_filter_rows_reordered),
3468 filter->priv->child_flags = gtk_tree_model_get_flags (child_model);
3469 filter->priv->stamp = g_random_int ();
3474 gtk_tree_model_filter_ref_path (GtkTreeModelFilter *filter,
3480 len = gtk_tree_path_get_depth (path);
3481 p = gtk_tree_path_copy (path);
3486 gtk_tree_model_get_iter (GTK_TREE_MODEL (filter->priv->child_model), &iter, p);
3487 gtk_tree_model_ref_node (GTK_TREE_MODEL (filter->priv->child_model), &iter);
3488 gtk_tree_path_up (p);
3491 gtk_tree_path_free (p);
3495 gtk_tree_model_filter_unref_path (GtkTreeModelFilter *filter,
3505 len = gtk_tree_path_get_depth (path);
3507 p = gtk_tree_path_copy (path);
3512 gtk_tree_model_get_iter (GTK_TREE_MODEL (filter->priv->child_model), &iter, p);
3513 gtk_tree_model_unref_node (GTK_TREE_MODEL (filter->priv->child_model), &iter);
3514 gtk_tree_path_up (p);
3517 gtk_tree_path_free (p);
3521 gtk_tree_model_filter_set_root (GtkTreeModelFilter *filter,
3524 g_return_if_fail (GTK_IS_TREE_MODEL_FILTER (filter));
3527 filter->priv->virtual_root = NULL;
3529 filter->priv->virtual_root = gtk_tree_path_copy (root);
3535 * gtk_tree_model_filter_new:
3536 * @child_model: A #GtkTreeModel.
3537 * @root: (allow-none): A #GtkTreePath or %NULL.
3539 * Creates a new #GtkTreeModel, with @child_model as the child_model
3540 * and @root as the virtual root.
3542 * Return value: (transfer full): A new #GtkTreeModel.
3547 gtk_tree_model_filter_new (GtkTreeModel *child_model,
3550 GtkTreeModel *retval;
3551 GtkTreeModelFilter *filter;
3553 g_return_val_if_fail (GTK_IS_TREE_MODEL (child_model), NULL);
3555 retval = g_object_new (GTK_TYPE_TREE_MODEL_FILTER,
3556 "child-model", child_model,
3557 "virtual-root", root,
3560 filter = GTK_TREE_MODEL_FILTER (retval);
3561 if (filter->priv->virtual_root)
3563 gtk_tree_model_filter_ref_path (filter, filter->priv->virtual_root);
3564 filter->priv->virtual_root_deleted = FALSE;
3571 * gtk_tree_model_filter_get_model:
3572 * @filter: A #GtkTreeModelFilter.
3574 * Returns a pointer to the child model of @filter.
3576 * Return value: (transfer none): A pointer to a #GtkTreeModel.
3581 gtk_tree_model_filter_get_model (GtkTreeModelFilter *filter)
3583 g_return_val_if_fail (GTK_IS_TREE_MODEL_FILTER (filter), NULL);
3585 return filter->priv->child_model;
3589 * gtk_tree_model_filter_set_visible_func:
3590 * @filter: A #GtkTreeModelFilter.
3591 * @func: A #GtkTreeModelFilterVisibleFunc, the visible function.
3592 * @data: (allow-none): User data to pass to the visible function, or %NULL.
3593 * @destroy: (allow-none): Destroy notifier of @data, or %NULL.
3595 * Sets the visible function used when filtering the @filter to be @func. The
3596 * function should return %TRUE if the given row should be visible and
3599 * If the condition calculated by the function changes over time (e.g. because
3600 * it depends on some global parameters), you must call
3601 * gtk_tree_model_filter_refilter() to keep the visibility information of
3602 * the model uptodate.
3604 * Note that @func is called whenever a row is inserted, when it may still be
3605 * empty. The visible function should therefore take special care of empty
3606 * rows, like in the example below.
3608 * <informalexample><programlisting>
3610 * visible_func (GtkTreeModel *model,
3611 * GtkTreeIter *iter,
3614 * /* Visible if row is non-empty and first column is "HI" */
3616 * gboolean visible = FALSE;
3618 * gtk_tree_model_get (model, iter, 0, &str, -1);
3619 * if (str && strcmp (str, "HI") == 0)
3625 * </programlisting></informalexample>
3630 gtk_tree_model_filter_set_visible_func (GtkTreeModelFilter *filter,
3631 GtkTreeModelFilterVisibleFunc func,
3633 GDestroyNotify destroy)
3635 g_return_if_fail (GTK_IS_TREE_MODEL_FILTER (filter));
3636 g_return_if_fail (func != NULL);
3637 g_return_if_fail (filter->priv->visible_method_set == FALSE);
3639 filter->priv->visible_func = func;
3640 filter->priv->visible_data = data;
3641 filter->priv->visible_destroy = destroy;
3643 filter->priv->visible_method_set = TRUE;
3647 * gtk_tree_model_filter_set_modify_func:
3648 * @filter: A #GtkTreeModelFilter.
3649 * @n_columns: The number of columns in the filter model.
3650 * @types: (array length=n_columns): The #GType<!-- -->s of the columns.
3651 * @func: A #GtkTreeModelFilterModifyFunc
3652 * @data: (allow-none): User data to pass to the modify function, or %NULL.
3653 * @destroy: (allow-none): Destroy notifier of @data, or %NULL.
3655 * With the @n_columns and @types parameters, you give an array of column
3656 * types for this model (which will be exposed to the parent model/view).
3657 * The @func, @data and @destroy parameters are for specifying the modify
3658 * function. The modify function will get called for <emphasis>each</emphasis>
3659 * data access, the goal of the modify function is to return the data which
3660 * should be displayed at the location specified using the parameters of the
3666 gtk_tree_model_filter_set_modify_func (GtkTreeModelFilter *filter,
3669 GtkTreeModelFilterModifyFunc func,
3671 GDestroyNotify destroy)
3673 g_return_if_fail (GTK_IS_TREE_MODEL_FILTER (filter));
3674 g_return_if_fail (func != NULL);
3675 g_return_if_fail (filter->priv->modify_func_set == FALSE);
3677 if (filter->priv->modify_destroy)
3679 GDestroyNotify d = filter->priv->modify_destroy;
3681 filter->priv->modify_destroy = NULL;
3682 d (filter->priv->modify_data);
3685 filter->priv->modify_n_columns = n_columns;
3686 filter->priv->modify_types = g_new0 (GType, n_columns);
3687 memcpy (filter->priv->modify_types, types, sizeof (GType) * n_columns);
3688 filter->priv->modify_func = func;
3689 filter->priv->modify_data = data;
3690 filter->priv->modify_destroy = destroy;
3692 filter->priv->modify_func_set = TRUE;
3696 * gtk_tree_model_filter_set_visible_column:
3697 * @filter: A #GtkTreeModelFilter.
3698 * @column: A #gint which is the column containing the visible information.
3700 * Sets @column of the child_model to be the column where @filter should
3701 * look for visibility information. @columns should be a column of type
3702 * %G_TYPE_BOOLEAN, where %TRUE means that a row is visible, and %FALSE
3708 gtk_tree_model_filter_set_visible_column (GtkTreeModelFilter *filter,
3711 g_return_if_fail (GTK_IS_TREE_MODEL_FILTER (filter));
3712 g_return_if_fail (column >= 0);
3713 g_return_if_fail (filter->priv->visible_method_set == FALSE);
3715 filter->priv->visible_column = column;
3717 filter->priv->visible_method_set = TRUE;
3723 * gtk_tree_model_filter_convert_child_iter_to_iter:
3724 * @filter: A #GtkTreeModelFilter.
3725 * @filter_iter: (out): An uninitialized #GtkTreeIter.
3726 * @child_iter: A valid #GtkTreeIter pointing to a row on the child model.
3728 * Sets @filter_iter to point to the row in @filter that corresponds to the
3729 * row pointed at by @child_iter. If @filter_iter was not set, %FALSE is
3732 * Return value: %TRUE, if @filter_iter was set, i.e. if @child_iter is a
3733 * valid iterator pointing to a visible row in child model.
3738 gtk_tree_model_filter_convert_child_iter_to_iter (GtkTreeModelFilter *filter,
3739 GtkTreeIter *filter_iter,
3740 GtkTreeIter *child_iter)
3743 GtkTreePath *child_path, *path;
3745 g_return_val_if_fail (GTK_IS_TREE_MODEL_FILTER (filter), FALSE);
3746 g_return_val_if_fail (filter->priv->child_model != NULL, FALSE);
3747 g_return_val_if_fail (filter_iter != NULL, FALSE);
3748 g_return_val_if_fail (child_iter != NULL, FALSE);
3749 g_return_val_if_fail (filter_iter != child_iter, FALSE);
3751 filter_iter->stamp = 0;
3753 child_path = gtk_tree_model_get_path (filter->priv->child_model, child_iter);
3754 g_return_val_if_fail (child_path != NULL, FALSE);
3756 path = gtk_tree_model_filter_convert_child_path_to_path (filter,
3758 gtk_tree_path_free (child_path);
3763 ret = gtk_tree_model_get_iter (GTK_TREE_MODEL (filter), filter_iter, path);
3764 gtk_tree_path_free (path);
3770 * gtk_tree_model_filter_convert_iter_to_child_iter:
3771 * @filter: A #GtkTreeModelFilter.
3772 * @child_iter: (out): An uninitialized #GtkTreeIter.
3773 * @filter_iter: A valid #GtkTreeIter pointing to a row on @filter.
3775 * Sets @child_iter to point to the row pointed to by @filter_iter.
3780 gtk_tree_model_filter_convert_iter_to_child_iter (GtkTreeModelFilter *filter,
3781 GtkTreeIter *child_iter,
3782 GtkTreeIter *filter_iter)
3784 g_return_if_fail (GTK_IS_TREE_MODEL_FILTER (filter));
3785 g_return_if_fail (filter->priv->child_model != NULL);
3786 g_return_if_fail (child_iter != NULL);
3787 g_return_if_fail (filter_iter != NULL);
3788 g_return_if_fail (filter_iter->stamp == filter->priv->stamp);
3789 g_return_if_fail (filter_iter != child_iter);
3791 if (GTK_TREE_MODEL_FILTER_CACHE_CHILD_ITERS (filter))
3793 *child_iter = FILTER_ELT (filter_iter->user_data2)->iter;
3798 gboolean valid = FALSE;
3800 path = gtk_tree_model_filter_elt_get_path (filter_iter->user_data,
3801 filter_iter->user_data2,
3802 filter->priv->virtual_root);
3803 valid = gtk_tree_model_get_iter (filter->priv->child_model, child_iter,
3805 gtk_tree_path_free (path);
3807 g_return_if_fail (valid == TRUE);
3811 /* The path returned can only be used internally in the filter model. */
3812 static GtkTreePath *
3813 gtk_real_tree_model_filter_convert_child_path_to_path (GtkTreeModelFilter *filter,
3814 GtkTreePath *child_path,
3815 gboolean build_levels,
3816 gboolean fetch_children)
3818 gint *child_indices;
3819 GtkTreePath *retval;
3820 GtkTreePath *real_path;
3825 g_return_val_if_fail (GTK_IS_TREE_MODEL_FILTER (filter), NULL);
3826 g_return_val_if_fail (filter->priv->child_model != NULL, NULL);
3827 g_return_val_if_fail (child_path != NULL, NULL);
3829 if (!filter->priv->virtual_root)
3830 real_path = gtk_tree_path_copy (child_path);
3832 real_path = gtk_tree_model_filter_remove_root (child_path,
3833 filter->priv->virtual_root);
3838 retval = gtk_tree_path_new ();
3839 child_indices = gtk_tree_path_get_indices (real_path);
3841 if (filter->priv->root == NULL && build_levels)
3842 gtk_tree_model_filter_build_level (filter, NULL, -1, FALSE);
3843 level = FILTER_LEVEL (filter->priv->root);
3845 for (i = 0; i < gtk_tree_path_get_depth (real_path); i++)
3848 gboolean found_child = FALSE;
3852 gtk_tree_path_free (real_path);
3853 gtk_tree_path_free (retval);
3857 tmp = bsearch_elt_with_offset (level->array, child_indices[i], &j);
3860 gtk_tree_path_append_index (retval, j);
3861 if (!tmp->children && build_levels)
3862 gtk_tree_model_filter_build_level (filter, level,
3863 FILTER_LEVEL_ELT_INDEX (level, tmp),
3865 level = tmp->children;
3869 if (!found_child && fetch_children)
3871 tmp = gtk_tree_model_filter_fetch_child (filter, level,
3875 /* didn't find the child, let's try to bring it back */
3876 if (!tmp || tmp->offset != child_indices[i])
3879 gtk_tree_path_free (real_path);
3880 gtk_tree_path_free (retval);
3884 gtk_tree_path_append_index (retval, j);
3885 if (!tmp->children && build_levels)
3886 gtk_tree_model_filter_build_level (filter, level,
3887 FILTER_LEVEL_ELT_INDEX (level, tmp),
3889 level = tmp->children;
3892 else if (!found_child && !fetch_children)
3895 gtk_tree_path_free (real_path);
3896 gtk_tree_path_free (retval);
3901 gtk_tree_path_free (real_path);
3906 * gtk_tree_model_filter_convert_child_path_to_path:
3907 * @filter: A #GtkTreeModelFilter.
3908 * @child_path: A #GtkTreePath to convert.
3910 * Converts @child_path to a path relative to @filter. That is, @child_path
3911 * points to a path in the child model. The rerturned path will point to the
3912 * same row in the filtered model. If @child_path isn't a valid path on the
3913 * child model or points to a row which is not visible in @filter, then %NULL
3916 * Return value: A newly allocated #GtkTreePath, or %NULL.
3921 gtk_tree_model_filter_convert_child_path_to_path (GtkTreeModelFilter *filter,
3922 GtkTreePath *child_path)
3927 /* this function does the sanity checks */
3928 path = gtk_real_tree_model_filter_convert_child_path_to_path (filter,
3936 /* get a new path which only takes visible nodes into account.
3937 * -- if this gives any performance issues, we can write a special
3938 * version of convert_child_path_to_path immediately returning
3939 * a visible-nodes-only path.
3941 gtk_tree_model_filter_get_iter_full (GTK_TREE_MODEL (filter), &iter, path);
3943 gtk_tree_path_free (path);
3944 path = gtk_tree_model_get_path (GTK_TREE_MODEL (filter), &iter);
3950 * gtk_tree_model_filter_convert_path_to_child_path:
3951 * @filter: A #GtkTreeModelFilter.
3952 * @filter_path: A #GtkTreePath to convert.
3954 * Converts @filter_path to a path on the child model of @filter. That is,
3955 * @filter_path points to a location in @filter. The returned path will
3956 * point to the same location in the model not being filtered. If @filter_path
3957 * does not point to a location in the child model, %NULL is returned.
3959 * Return value: A newly allocated #GtkTreePath, or %NULL.
3964 gtk_tree_model_filter_convert_path_to_child_path (GtkTreeModelFilter *filter,
3965 GtkTreePath *filter_path)
3967 gint *filter_indices;
3968 GtkTreePath *retval;
3972 g_return_val_if_fail (GTK_IS_TREE_MODEL_FILTER (filter), NULL);
3973 g_return_val_if_fail (filter->priv->child_model != NULL, NULL);
3974 g_return_val_if_fail (filter_path != NULL, NULL);
3977 retval = gtk_tree_path_new ();
3978 filter_indices = gtk_tree_path_get_indices (filter_path);
3979 if (!filter->priv->root)
3980 gtk_tree_model_filter_build_level (filter, NULL, -1, FALSE);
3981 level = FILTER_LEVEL (filter->priv->root);
3983 for (i = 0; i < gtk_tree_path_get_depth (filter_path); i++)
3987 if (!level || level->visible_nodes <= filter_indices[i])
3989 gtk_tree_path_free (retval);
3993 elt = gtk_tree_model_filter_get_nth_visible (filter, level,
3996 if (elt->children == NULL)
3997 gtk_tree_model_filter_build_level (filter, level,
3998 FILTER_LEVEL_ELT_INDEX (level, elt),
4001 if (!level || level->visible_nodes <= filter_indices[i])
4003 gtk_tree_path_free (retval);
4007 gtk_tree_path_append_index (retval, elt->offset);
4008 level = elt->children;
4013 if (filter->priv->virtual_root)
4015 GtkTreePath *real_retval;
4017 real_retval = gtk_tree_model_filter_add_root (retval,
4018 filter->priv->virtual_root);
4019 gtk_tree_path_free (retval);
4028 gtk_tree_model_filter_refilter_helper (GtkTreeModel *model,
4033 /* evil, don't try this at home, but certainly speeds things up */
4034 gtk_tree_model_filter_row_changed (model, path, iter, data);
4040 * gtk_tree_model_filter_refilter:
4041 * @filter: A #GtkTreeModelFilter.
4043 * Emits ::row_changed for each row in the child model, which causes
4044 * the filter to re-evaluate whether a row is visible or not.
4049 gtk_tree_model_filter_refilter (GtkTreeModelFilter *filter)
4051 g_return_if_fail (GTK_IS_TREE_MODEL_FILTER (filter));
4054 gtk_tree_model_foreach (filter->priv->child_model,
4055 gtk_tree_model_filter_refilter_helper,
4060 * gtk_tree_model_filter_clear_cache:
4061 * @filter: A #GtkTreeModelFilter.
4063 * This function should almost never be called. It clears the @filter
4064 * of any cached iterators that haven't been reffed with
4065 * gtk_tree_model_ref_node(). This might be useful if the child model
4066 * being filtered is static (and doesn't change often) and there has been
4067 * a lot of unreffed access to nodes. As a side effect of this function,
4068 * all unreffed iters will be invalid.
4073 gtk_tree_model_filter_clear_cache (GtkTreeModelFilter *filter)
4075 g_return_if_fail (GTK_IS_TREE_MODEL_FILTER (filter));
4077 if (filter->priv->zero_ref_count > 0)
4078 gtk_tree_model_filter_clear_cache_helper (filter,
4079 FILTER_LEVEL (filter->priv->root));