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;
106 gint parent_elt_index;
107 FilterLevel *parent_level;
111 struct _GtkTreeModelFilterPrivate
113 GtkTreeModel *child_model;
115 GtkTreePath *virtual_root;
122 GtkTreeModelFilterVisibleFunc visible_func;
123 gpointer visible_data;
124 GDestroyNotify visible_destroy;
127 GtkTreeModelFilterModifyFunc modify_func;
128 gpointer modify_data;
129 GDestroyNotify modify_destroy;
130 gint modify_n_columns;
132 guint visible_method_set : 1;
133 guint modify_func_set : 1;
135 guint in_row_deleted : 1;
136 guint virtual_root_deleted : 1;
141 gulong has_child_toggled_id;
154 /* Set this to 0 to disable caching of child iterators. This
155 * allows for more stringent testing. It is recommended to set this
156 * to one when refactoring this code and running the unit tests to
160 # define GTK_TREE_MODEL_FILTER_CACHE_CHILD_ITERS(filter) \
161 (((GtkTreeModelFilter *)filter)->priv->child_flags & GTK_TREE_MODEL_ITERS_PERSIST)
163 # define GTK_TREE_MODEL_FILTER_CACHE_CHILD_ITERS(filter) (FALSE)
166 #define FILTER_ELT(filter_elt) ((FilterElt *)filter_elt)
167 #define FILTER_LEVEL(filter_level) ((FilterLevel *)filter_level)
169 #define FILTER_LEVEL_PARENT_ELT(level) (&g_array_index (FILTER_LEVEL ((level))->parent_level->array, FilterElt, FILTER_LEVEL ((level))->parent_elt_index))
170 #define FILTER_LEVEL_ELT_INDEX(level, elt) (FILTER_ELT ((elt)) - FILTER_ELT (FILTER_LEVEL ((level))->array->data))
172 /* general code (object/interface init, properties, etc) */
173 static void gtk_tree_model_filter_tree_model_init (GtkTreeModelIface *iface);
174 static void gtk_tree_model_filter_drag_source_init (GtkTreeDragSourceIface *iface);
175 static void gtk_tree_model_filter_finalize (GObject *object);
176 static void gtk_tree_model_filter_set_property (GObject *object,
180 static void gtk_tree_model_filter_get_property (GObject *object,
185 /* signal handlers */
186 static void gtk_tree_model_filter_row_changed (GtkTreeModel *c_model,
190 static void gtk_tree_model_filter_row_inserted (GtkTreeModel *c_model,
194 static void gtk_tree_model_filter_row_has_child_toggled (GtkTreeModel *c_model,
198 static void gtk_tree_model_filter_row_deleted (GtkTreeModel *c_model,
201 static void gtk_tree_model_filter_rows_reordered (GtkTreeModel *c_model,
207 /* GtkTreeModel interface */
208 static GtkTreeModelFlags gtk_tree_model_filter_get_flags (GtkTreeModel *model);
209 static gint gtk_tree_model_filter_get_n_columns (GtkTreeModel *model);
210 static GType gtk_tree_model_filter_get_column_type (GtkTreeModel *model,
212 static gboolean gtk_tree_model_filter_get_iter_full (GtkTreeModel *model,
215 static gboolean gtk_tree_model_filter_get_iter (GtkTreeModel *model,
218 static GtkTreePath *gtk_tree_model_filter_get_path (GtkTreeModel *model,
220 static void gtk_tree_model_filter_get_value (GtkTreeModel *model,
224 static gboolean gtk_tree_model_filter_iter_next (GtkTreeModel *model,
226 static gboolean gtk_tree_model_filter_iter_previous (GtkTreeModel *model,
228 static gboolean gtk_tree_model_filter_iter_children (GtkTreeModel *model,
230 GtkTreeIter *parent);
231 static gboolean gtk_tree_model_filter_iter_has_child (GtkTreeModel *model,
233 static gint gtk_tree_model_filter_iter_n_children (GtkTreeModel *model,
235 static gboolean gtk_tree_model_filter_iter_nth_child (GtkTreeModel *model,
239 static gboolean gtk_tree_model_filter_iter_parent (GtkTreeModel *model,
242 static void gtk_tree_model_filter_ref_node (GtkTreeModel *model,
244 static void gtk_tree_model_filter_unref_node (GtkTreeModel *model,
247 /* TreeDragSource interface */
248 static gboolean gtk_tree_model_filter_row_draggable (GtkTreeDragSource *drag_source,
250 static gboolean gtk_tree_model_filter_drag_data_get (GtkTreeDragSource *drag_source,
252 GtkSelectionData *selection_data);
253 static gboolean gtk_tree_model_filter_drag_data_delete (GtkTreeDragSource *drag_source,
256 /* private functions */
257 static void gtk_tree_model_filter_build_level (GtkTreeModelFilter *filter,
258 FilterLevel *parent_level,
259 gint parent_elt_index,
260 gboolean emit_inserted);
262 static void gtk_tree_model_filter_free_level (GtkTreeModelFilter *filter,
263 FilterLevel *filter_level,
266 static GtkTreePath *gtk_tree_model_filter_elt_get_path (FilterLevel *level,
270 static GtkTreePath *gtk_tree_model_filter_add_root (GtkTreePath *src,
272 static GtkTreePath *gtk_tree_model_filter_remove_root (GtkTreePath *src,
275 static void gtk_tree_model_filter_increment_stamp (GtkTreeModelFilter *filter);
277 static void gtk_tree_model_filter_real_modify (GtkTreeModelFilter *self,
278 GtkTreeModel *child_model,
282 static gboolean gtk_tree_model_filter_real_visible (GtkTreeModelFilter *filter,
283 GtkTreeModel *child_model,
284 GtkTreeIter *child_iter);
285 static gboolean gtk_tree_model_filter_visible (GtkTreeModelFilter *filter,
286 GtkTreeIter *child_iter);
287 static void gtk_tree_model_filter_clear_cache_helper (GtkTreeModelFilter *filter,
290 static void gtk_tree_model_filter_real_unref_node (GtkTreeModel *model,
292 gboolean propagate_unref);
294 static void gtk_tree_model_filter_set_model (GtkTreeModelFilter *filter,
295 GtkTreeModel *child_model);
296 static void gtk_tree_model_filter_ref_path (GtkTreeModelFilter *filter,
298 static void gtk_tree_model_filter_unref_path (GtkTreeModelFilter *filter,
301 static void gtk_tree_model_filter_set_root (GtkTreeModelFilter *filter,
304 static GtkTreePath *gtk_real_tree_model_filter_convert_child_path_to_path (GtkTreeModelFilter *filter,
305 GtkTreePath *child_path,
306 gboolean build_levels,
307 gboolean fetch_children);
309 static FilterElt *gtk_tree_model_filter_get_nth (GtkTreeModelFilter *filter,
312 static gboolean gtk_tree_model_filter_elt_is_visible_in_target (FilterLevel *level,
314 static FilterElt *gtk_tree_model_filter_get_nth_visible (GtkTreeModelFilter *filter,
318 static FilterElt *gtk_tree_model_filter_insert_elt_in_level (GtkTreeModelFilter *filter,
323 static FilterElt *gtk_tree_model_filter_fetch_child (GtkTreeModelFilter *filter,
327 static void gtk_tree_model_filter_remove_elt_from_level (GtkTreeModelFilter *filter,
330 static void gtk_tree_model_filter_update_children (GtkTreeModelFilter *filter,
333 static FilterElt *bsearch_elt_with_offset (GArray *array,
338 G_DEFINE_TYPE_WITH_CODE (GtkTreeModelFilter, gtk_tree_model_filter, G_TYPE_OBJECT,
339 G_IMPLEMENT_INTERFACE (GTK_TYPE_TREE_MODEL,
340 gtk_tree_model_filter_tree_model_init)
341 G_IMPLEMENT_INTERFACE (GTK_TYPE_TREE_DRAG_SOURCE,
342 gtk_tree_model_filter_drag_source_init))
345 gtk_tree_model_filter_init (GtkTreeModelFilter *filter)
347 filter->priv = G_TYPE_INSTANCE_GET_PRIVATE (filter,
348 GTK_TYPE_TREE_MODEL_FILTER,
349 GtkTreeModelFilterPrivate);
351 filter->priv->visible_column = -1;
352 filter->priv->zero_ref_count = 0;
353 filter->priv->visible_method_set = FALSE;
354 filter->priv->modify_func_set = FALSE;
355 filter->priv->in_row_deleted = FALSE;
356 filter->priv->virtual_root_deleted = FALSE;
360 gtk_tree_model_filter_class_init (GtkTreeModelFilterClass *filter_class)
362 GObjectClass *object_class;
364 object_class = (GObjectClass *) filter_class;
366 object_class->set_property = gtk_tree_model_filter_set_property;
367 object_class->get_property = gtk_tree_model_filter_get_property;
369 object_class->finalize = gtk_tree_model_filter_finalize;
371 filter_class->visible = gtk_tree_model_filter_real_visible;
372 filter_class->modify = gtk_tree_model_filter_real_modify;
374 /* Properties -- FIXME: disabled translations for now, until I can come up with a
377 g_object_class_install_property (object_class,
379 g_param_spec_object ("child-model",
381 ("The model for the filtermodel to filter"),
383 GTK_PARAM_READWRITE | G_PARAM_CONSTRUCT_ONLY));
385 g_object_class_install_property (object_class,
387 g_param_spec_boxed ("virtual-root",
388 ("The virtual root"),
389 ("The virtual root (relative to the child model) for this filtermodel"),
391 GTK_PARAM_READWRITE | G_PARAM_CONSTRUCT_ONLY));
393 g_type_class_add_private (object_class, sizeof (GtkTreeModelFilterPrivate));
397 gtk_tree_model_filter_tree_model_init (GtkTreeModelIface *iface)
399 iface->get_flags = gtk_tree_model_filter_get_flags;
400 iface->get_n_columns = gtk_tree_model_filter_get_n_columns;
401 iface->get_column_type = gtk_tree_model_filter_get_column_type;
402 iface->get_iter = gtk_tree_model_filter_get_iter;
403 iface->get_path = gtk_tree_model_filter_get_path;
404 iface->get_value = gtk_tree_model_filter_get_value;
405 iface->iter_next = gtk_tree_model_filter_iter_next;
406 iface->iter_previous = gtk_tree_model_filter_iter_previous;
407 iface->iter_children = gtk_tree_model_filter_iter_children;
408 iface->iter_has_child = gtk_tree_model_filter_iter_has_child;
409 iface->iter_n_children = gtk_tree_model_filter_iter_n_children;
410 iface->iter_nth_child = gtk_tree_model_filter_iter_nth_child;
411 iface->iter_parent = gtk_tree_model_filter_iter_parent;
412 iface->ref_node = gtk_tree_model_filter_ref_node;
413 iface->unref_node = gtk_tree_model_filter_unref_node;
417 gtk_tree_model_filter_drag_source_init (GtkTreeDragSourceIface *iface)
419 iface->row_draggable = gtk_tree_model_filter_row_draggable;
420 iface->drag_data_delete = gtk_tree_model_filter_drag_data_delete;
421 iface->drag_data_get = gtk_tree_model_filter_drag_data_get;
426 gtk_tree_model_filter_finalize (GObject *object)
428 GtkTreeModelFilter *filter = (GtkTreeModelFilter *) object;
430 if (filter->priv->virtual_root && !filter->priv->virtual_root_deleted)
432 gtk_tree_model_filter_unref_path (filter, filter->priv->virtual_root,
434 filter->priv->virtual_root_deleted = TRUE;
437 gtk_tree_model_filter_set_model (filter, NULL);
439 if (filter->priv->virtual_root)
440 gtk_tree_path_free (filter->priv->virtual_root);
442 if (filter->priv->root)
443 gtk_tree_model_filter_free_level (filter, filter->priv->root, TRUE);
445 g_free (filter->priv->modify_types);
447 if (filter->priv->modify_destroy)
448 filter->priv->modify_destroy (filter->priv->modify_data);
450 if (filter->priv->visible_destroy)
451 filter->priv->visible_destroy (filter->priv->visible_data);
454 G_OBJECT_CLASS (gtk_tree_model_filter_parent_class)->finalize (object);
458 gtk_tree_model_filter_set_property (GObject *object,
463 GtkTreeModelFilter *filter = GTK_TREE_MODEL_FILTER (object);
467 case PROP_CHILD_MODEL:
468 gtk_tree_model_filter_set_model (filter, g_value_get_object (value));
470 case PROP_VIRTUAL_ROOT:
471 gtk_tree_model_filter_set_root (filter, g_value_get_boxed (value));
474 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
480 gtk_tree_model_filter_get_property (GObject *object,
485 GtkTreeModelFilter *filter = GTK_TREE_MODEL_FILTER (object);
489 case PROP_CHILD_MODEL:
490 g_value_set_object (value, filter->priv->child_model);
492 case PROP_VIRTUAL_ROOT:
493 g_value_set_boxed (value, filter->priv->virtual_root);
496 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
504 gtk_tree_model_filter_build_level (GtkTreeModelFilter *filter,
505 FilterLevel *parent_level,
506 gint parent_elt_index,
507 gboolean emit_inserted)
510 GtkTreeIter first_node;
512 FilterElt *parent_elt = NULL;
513 FilterLevel *new_level;
517 g_assert (filter->priv->child_model != NULL);
519 if (filter->priv->in_row_deleted)
524 if (filter->priv->virtual_root)
526 if (gtk_tree_model_get_iter (filter->priv->child_model, &root, filter->priv->virtual_root) == FALSE)
528 length = gtk_tree_model_iter_n_children (filter->priv->child_model, &root);
530 if (gtk_tree_model_iter_children (filter->priv->child_model, &iter, &root) == FALSE)
535 if (!gtk_tree_model_get_iter_first (filter->priv->child_model, &iter))
537 length = gtk_tree_model_iter_n_children (filter->priv->child_model, NULL);
542 GtkTreeIter parent_iter;
543 GtkTreeIter child_parent_iter;
545 parent_elt = &g_array_index (parent_level->array, FilterElt, parent_elt_index);
547 parent_iter.stamp = filter->priv->stamp;
548 parent_iter.user_data = parent_level;
549 parent_iter.user_data2 = parent_elt;
551 gtk_tree_model_filter_convert_iter_to_child_iter (filter,
554 if (gtk_tree_model_iter_children (filter->priv->child_model, &iter, &child_parent_iter) == FALSE)
557 /* stamp may have changed */
558 gtk_tree_model_filter_convert_iter_to_child_iter (filter,
561 length = gtk_tree_model_iter_n_children (filter->priv->child_model, &child_parent_iter);
564 g_return_if_fail (length > 0);
566 new_level = g_new (FilterLevel, 1);
567 new_level->array = g_array_sized_new (FALSE, FALSE,
570 new_level->ref_count = 0;
571 new_level->visible_nodes = 0;
572 new_level->parent_elt_index = parent_elt_index;
573 new_level->parent_level = parent_level;
575 if (parent_elt_index >= 0)
576 parent_elt->children = new_level;
578 filter->priv->root = new_level;
580 /* increase the count of zero ref_counts */
583 g_array_index (parent_level->array, FilterElt, parent_elt_index).zero_ref_count++;
585 parent_elt_index = parent_level->parent_elt_index;
586 parent_level = parent_level->parent_level;
588 if (new_level != filter->priv->root)
589 filter->priv->zero_ref_count++;
597 if (gtk_tree_model_filter_visible (filter, &iter))
600 FilterElt filter_elt;
602 filter_elt.offset = i;
603 filter_elt.zero_ref_count = 0;
604 filter_elt.ref_count = 0;
605 filter_elt.children = NULL;
606 filter_elt.visible = TRUE;
608 if (GTK_TREE_MODEL_FILTER_CACHE_CHILD_ITERS (filter))
609 filter_elt.iter = iter;
611 g_array_append_val (new_level->array, filter_elt);
612 new_level->visible_nodes++;
614 f_iter.stamp = filter->priv->stamp;
615 f_iter.user_data = new_level;
616 f_iter.user_data2 = &(g_array_index (new_level->array, FilterElt, new_level->array->len - 1));
618 if (new_level->parent_level || filter->priv->virtual_root)
619 gtk_tree_model_filter_ref_node (GTK_TREE_MODEL (filter), &f_iter);
624 GtkTreeIter children;
626 f_path = gtk_tree_model_get_path (GTK_TREE_MODEL (filter),
628 gtk_tree_model_row_inserted (GTK_TREE_MODEL (filter),
630 gtk_tree_path_free (f_path);
632 if (gtk_tree_model_iter_children (filter->priv->child_model,
634 gtk_tree_model_filter_update_children (filter,
636 FILTER_ELT (f_iter.user_data2));
641 while (gtk_tree_model_iter_next (filter->priv->child_model, &iter));
643 if (new_level->array->len == 0
644 && (new_level != filter->priv->root || filter->priv->virtual_root))
646 /* If none of the nodes are visible, we will just pull in the
647 * first node of the level and keep a reference on it. We need this
648 * to make sure that we get all signals for this level.
650 FilterElt filter_elt;
653 filter_elt.offset = 0;
654 filter_elt.zero_ref_count = 0;
655 filter_elt.ref_count = 0;
656 filter_elt.children = NULL;
657 filter_elt.visible = FALSE;
659 if (GTK_TREE_MODEL_FILTER_CACHE_CHILD_ITERS (filter))
660 filter_elt.iter = first_node;
662 g_array_append_val (new_level->array, filter_elt);
664 f_iter.stamp = filter->priv->stamp;
665 f_iter.user_data = new_level;
666 f_iter.user_data2 = &(g_array_index (new_level->array, FilterElt, new_level->array->len - 1));
668 gtk_tree_model_filter_ref_node (GTK_TREE_MODEL (filter), &f_iter);
670 else if (new_level->array->len == 0)
671 gtk_tree_model_filter_free_level (filter, new_level, TRUE);
675 gtk_tree_model_filter_free_level (GtkTreeModelFilter *filter,
676 FilterLevel *filter_level,
681 g_assert (filter_level);
683 for (i = 0; i < filter_level->array->len; i++)
685 if (g_array_index (filter_level->array, FilterElt, i).children)
686 gtk_tree_model_filter_free_level (filter,
687 FILTER_LEVEL (g_array_index (filter_level->array, FilterElt, i).children),
691 (filter_level->parent_level || filter->priv->virtual_root))
695 f_iter.stamp = filter->priv->stamp;
696 f_iter.user_data = filter_level;
697 f_iter.user_data2 = &(g_array_index (filter_level->array, FilterElt, i));
699 gtk_tree_model_filter_unref_node (GTK_TREE_MODEL (filter), &f_iter);
703 if (filter_level->ref_count == 0)
705 FilterLevel *parent_level = filter_level->parent_level;
706 gint parent_elt_index = filter_level->parent_elt_index;
710 g_array_index (parent_level->array, FilterElt, parent_elt_index).zero_ref_count--;
712 parent_elt_index = parent_level->parent_elt_index;
713 parent_level = parent_level->parent_level;
716 if (filter_level != filter->priv->root)
717 filter->priv->zero_ref_count--;
720 if (filter_level->parent_elt_index >= 0)
721 FILTER_LEVEL_PARENT_ELT (filter_level)->children = NULL;
723 filter->priv->root = NULL;
725 g_array_free (filter_level->array, TRUE);
726 filter_level->array = NULL;
728 g_free (filter_level);
732 /* Creates paths suitable for accessing the child model. */
734 gtk_tree_model_filter_elt_get_path (FilterLevel *level,
738 FilterLevel *walker = level;
739 FilterElt *walker2 = elt;
741 GtkTreePath *real_path;
743 g_return_val_if_fail (level != NULL, NULL);
744 g_return_val_if_fail (elt != NULL, NULL);
746 path = gtk_tree_path_new ();
750 gtk_tree_path_prepend_index (path, walker2->offset);
752 if (!walker->parent_level)
755 walker2 = FILTER_LEVEL_PARENT_ELT (walker);
756 walker = walker->parent_level;
761 real_path = gtk_tree_model_filter_add_root (path, root);
762 gtk_tree_path_free (path);
770 gtk_tree_model_filter_add_root (GtkTreePath *src,
776 retval = gtk_tree_path_copy (root);
778 for (i = 0; i < gtk_tree_path_get_depth (src); i++)
779 gtk_tree_path_append_index (retval, gtk_tree_path_get_indices (src)[i]);
785 gtk_tree_model_filter_remove_root (GtkTreePath *src,
793 if (gtk_tree_path_get_depth (src) <= gtk_tree_path_get_depth (root))
796 depth = gtk_tree_path_get_depth (src);
797 indices = gtk_tree_path_get_indices (src);
799 for (i = 0; i < gtk_tree_path_get_depth (root); i++)
800 if (indices[i] != gtk_tree_path_get_indices (root)[i])
803 retval = gtk_tree_path_new ();
805 for (; i < depth; i++)
806 gtk_tree_path_append_index (retval, indices[i]);
812 gtk_tree_model_filter_increment_stamp (GtkTreeModelFilter *filter)
816 filter->priv->stamp++;
818 while (filter->priv->stamp == 0);
820 gtk_tree_model_filter_clear_cache (filter);
824 gtk_tree_model_filter_real_visible (GtkTreeModelFilter *filter,
825 GtkTreeModel *child_model,
826 GtkTreeIter *child_iter)
828 if (filter->priv->visible_func)
830 return filter->priv->visible_func (child_model,
832 filter->priv->visible_data)
835 else if (filter->priv->visible_column >= 0)
839 gtk_tree_model_get_value (child_model, child_iter,
840 filter->priv->visible_column, &val);
842 if (g_value_get_boolean (&val))
844 g_value_unset (&val);
848 g_value_unset (&val);
852 /* no visible function set, so always visible */
857 gtk_tree_model_filter_visible (GtkTreeModelFilter *self,
858 GtkTreeIter *child_iter)
860 return GTK_TREE_MODEL_FILTER_GET_CLASS (self)->visible (self,
861 self->priv->child_model, child_iter);
865 gtk_tree_model_filter_clear_cache_helper (GtkTreeModelFilter *filter,
872 for (i = 0; i < level->array->len; i++)
874 if (g_array_index (level->array, FilterElt, i).zero_ref_count > 0)
875 gtk_tree_model_filter_clear_cache_helper (filter, g_array_index (level->array, FilterElt, i).children);
878 if (level->ref_count == 0 && level != filter->priv->root)
880 gtk_tree_model_filter_free_level (filter, level, TRUE);
886 gtk_tree_model_filter_get_nth (GtkTreeModelFilter *filter,
890 if (level->array->len <= n)
893 return &g_array_index (level->array, FilterElt, n);
897 gtk_tree_model_filter_elt_is_visible_in_target (FilterLevel *level,
905 if (level->parent_elt_index == -1)
910 elt_index = level->parent_elt_index;
911 level = level->parent_level;
914 && !g_array_index (level->array, FilterElt, elt_index).visible)
923 gtk_tree_model_filter_get_nth_visible (GtkTreeModelFilter *filter,
930 if (level->visible_nodes <= n)
933 elt = FILTER_ELT (level->array->data);
934 while (!elt->visible)
944 while (!elt->visible)
951 gtk_tree_model_filter_insert_elt_in_level (GtkTreeModelFilter *filter,
958 gint start, middle, end;
961 if (GTK_TREE_MODEL_FILTER_CACHE_CHILD_ITERS (filter))
965 elt.zero_ref_count = 0;
968 /* visibility should be FALSE as we don't emit row_inserted */
971 /* find index (binary search on offset) */
973 end = level->array->len;
979 middle = (start + end) / 2;
981 if (g_array_index (level->array, FilterElt, middle).offset <= offset)
987 if (g_array_index (level->array, FilterElt, middle).offset <= offset)
995 g_array_insert_val (level->array, i, elt);
998 for (i = 0; i < level->array->len; i++)
1000 FilterElt *e = &(g_array_index (level->array, FilterElt, i));
1002 e->children->parent_elt_index = i;
1005 if (level->parent_level || filter->priv->virtual_root)
1009 f_iter.stamp = filter->priv->stamp;
1010 f_iter.user_data = level;
1011 f_iter.user_data2 = &g_array_index (level->array, FilterElt, *index);
1013 gtk_tree_model_filter_ref_node (GTK_TREE_MODEL (filter), &f_iter);
1016 return &g_array_index (level->array, FilterElt, *index);
1020 gtk_tree_model_filter_fetch_child (GtkTreeModelFilter *filter,
1026 GtkTreePath *c_path = NULL;
1028 GtkTreePath *c_parent_path = NULL;
1029 GtkTreeIter c_parent_iter;
1031 /* check if child exists and is visible */
1032 if (level->parent_elt_index >= 0)
1035 gtk_tree_model_filter_elt_get_path (level->parent_level,
1036 FILTER_LEVEL_PARENT_ELT (level),
1037 filter->priv->virtual_root);
1043 if (filter->priv->virtual_root)
1044 c_parent_path = gtk_tree_path_copy (filter->priv->virtual_root);
1046 c_parent_path = NULL;
1051 gtk_tree_model_get_iter (filter->priv->child_model,
1054 len = gtk_tree_model_iter_n_children (filter->priv->child_model,
1057 c_path = gtk_tree_path_copy (c_parent_path);
1058 gtk_tree_path_free (c_parent_path);
1062 len = gtk_tree_model_iter_n_children (filter->priv->child_model, NULL);
1063 c_path = gtk_tree_path_new ();
1066 gtk_tree_path_append_index (c_path, offset);
1067 gtk_tree_model_get_iter (filter->priv->child_model, &c_iter, c_path);
1068 gtk_tree_path_free (c_path);
1070 if (offset >= len || !gtk_tree_model_filter_visible (filter, &c_iter))
1073 return gtk_tree_model_filter_insert_elt_in_level (filter, &c_iter,
1079 gtk_tree_model_filter_remove_elt_from_level (GtkTreeModelFilter *filter,
1084 FilterLevel *parent_level;
1085 gint i, length, parent_elt_index;
1088 gboolean emit_child_toggled = FALSE;
1090 iter.stamp = filter->priv->stamp;
1091 iter.user_data = level;
1092 iter.user_data2 = elt;
1094 parent_elt_index = level->parent_elt_index;
1095 if (parent_elt_index >= 0)
1096 parent = FILTER_LEVEL_PARENT_ELT (level);
1099 parent_level = level->parent_level;
1101 length = level->array->len;
1103 /* we distinguish a couple of cases:
1104 * - root level, length > 1: emit row-deleted and remove.
1105 * - root level, length == 1: emit row-deleted and keep in cache.
1106 * - level, length == 1: parent->ref_count > 1: emit row-deleted and keep.
1107 * - level, length > 1: emit row-deleted and remove.
1108 * - else, remove level.
1110 * if level != root level and visible nodes == 0, emit row-has-child-toggled.
1113 if (level != filter->priv->root
1114 && level->visible_nodes == 0
1117 emit_child_toggled = TRUE;
1124 /* We emit row-deleted, and remove the node from the cache.
1125 * If it has any children, these will be removed here as well.
1129 gtk_tree_model_filter_free_level (filter, elt->children, TRUE);
1131 path = gtk_tree_model_get_path (GTK_TREE_MODEL (filter), &iter);
1132 elt->visible = FALSE;
1133 gtk_tree_model_filter_increment_stamp (filter);
1134 iter.stamp = filter->priv->stamp;
1135 gtk_tree_model_row_deleted (GTK_TREE_MODEL (filter), path);
1136 gtk_tree_path_free (path);
1138 while (elt->ref_count > 1)
1139 gtk_tree_model_filter_real_unref_node (GTK_TREE_MODEL (filter),
1142 if (parent_level || filter->priv->virtual_root)
1143 gtk_tree_model_filter_unref_node (GTK_TREE_MODEL (filter), &iter);
1144 else if (elt->ref_count > 0)
1145 gtk_tree_model_filter_real_unref_node (GTK_TREE_MODEL (filter),
1148 /* remove the node */
1149 tmp = bsearch_elt_with_offset (level->array, elt->offset, &i);
1153 g_array_remove_index (level->array, i);
1156 for (i = MAX (i, 0); i < level->array->len; i++)
1158 /* NOTE: here we do *not* decrease offsets, because the node was
1159 * not removed from the child model
1161 elt = &g_array_index (level->array, FilterElt, i);
1163 elt->children->parent_elt_index = i;
1167 else if ((length == 1 && parent && parent->ref_count > 1)
1168 || (length == 1 && level == filter->priv->root))
1172 /* We emit row-deleted, but keep the node in the cache and
1173 * referenced. Its children will be removed.
1178 gtk_tree_model_filter_free_level (filter, elt->children, TRUE);
1179 elt->children = NULL;
1182 path = gtk_tree_model_get_path (GTK_TREE_MODEL (filter), &iter);
1183 elt->visible = FALSE;
1184 gtk_tree_model_filter_increment_stamp (filter);
1185 gtk_tree_model_row_deleted (GTK_TREE_MODEL (filter), path);
1186 gtk_tree_path_free (path);
1192 /* Blow level away, including any child levels */
1194 path = gtk_tree_model_get_path (GTK_TREE_MODEL (filter), &iter);
1195 elt->visible = FALSE;
1196 gtk_tree_model_filter_increment_stamp (filter);
1197 iter.stamp = filter->priv->stamp;
1198 gtk_tree_model_row_deleted (GTK_TREE_MODEL (filter), path);
1199 gtk_tree_path_free (path);
1201 while (elt->ref_count > 1)
1202 gtk_tree_model_filter_real_unref_node (GTK_TREE_MODEL (filter),
1205 gtk_tree_model_filter_free_level (filter, level, TRUE);
1208 if (emit_child_toggled)
1213 piter.stamp = filter->priv->stamp;
1214 piter.user_data = parent_level;
1215 piter.user_data2 = parent;
1217 ppath = gtk_tree_model_get_path (GTK_TREE_MODEL (filter), &piter);
1219 gtk_tree_model_row_has_child_toggled (GTK_TREE_MODEL (filter),
1221 gtk_tree_path_free (ppath);
1226 gtk_tree_model_filter_update_children (GtkTreeModelFilter *filter,
1236 iter.stamp = filter->priv->stamp;
1237 iter.user_data = level;
1238 iter.user_data2 = elt;
1240 gtk_tree_model_filter_convert_iter_to_child_iter (filter, &c_iter, &iter);
1242 if (gtk_tree_model_iter_has_child (filter->priv->child_model, &c_iter))
1244 GtkTreePath *path = gtk_tree_model_get_path (GTK_TREE_MODEL (filter),
1246 gtk_tree_model_row_has_child_toggled (GTK_TREE_MODEL (filter),
1250 gtk_tree_path_free (path);
1255 bsearch_elt_with_offset (GArray *array,
1259 gint start, middle, end;
1270 elt = &g_array_index (array, FilterElt, 0);
1272 if (elt->offset == offset)
1283 middle = (start + end) / 2;
1285 elt = &g_array_index (array, FilterElt, middle);
1287 if (elt->offset < offset)
1289 else if (elt->offset > offset)
1294 while (start != end);
1296 if (elt->offset == offset)
1305 /* Path is relative to the child model (this is on search on elt offset)
1306 * but with the virtual root already removed if necesssary.
1309 find_elt_with_offset (GtkTreeModelFilter *filter,
1311 FilterLevel **level_,
1316 FilterLevel *parent_level = NULL;
1317 FilterElt *elt = NULL;
1319 level = FILTER_LEVEL (filter->priv->root);
1321 while (i < gtk_tree_path_get_depth (path))
1328 elt = bsearch_elt_with_offset (level->array,
1329 gtk_tree_path_get_indices (path)[i],
1335 parent_level = level;
1336 level = elt->children;
1341 *level_ = parent_level;
1349 /* TreeModel signals */
1351 gtk_tree_model_filter_emit_row_inserted_for_path (GtkTreeModelFilter *filter,
1352 GtkTreeModel *c_model,
1353 GtkTreePath *c_path,
1354 GtkTreeIter *c_iter)
1359 GtkTreeIter iter, children;
1360 gboolean signals_emitted = FALSE;
1362 if (!filter->priv->root)
1364 gtk_tree_model_filter_build_level (filter, NULL, -1, TRUE);
1366 /* We will only proceed below if the item is found. If the item
1367 * is found, we can be sure row-inserted has just been emitted
1370 if (filter->priv->root &&
1371 FILTER_LEVEL (filter->priv->root)->visible_nodes)
1372 signals_emitted = TRUE;
1375 /* We need to disallow to build new levels, because we are then pulling
1376 * in a child in an invisible level. We only want to find path if it
1377 * is in a visible level (and thus has a parent that is visible).
1379 path = gtk_real_tree_model_filter_convert_child_path_to_path (filter,
1385 /* parent is probably being filtered out */
1388 gtk_tree_model_filter_increment_stamp (filter);
1390 gtk_tree_model_filter_get_iter_full (GTK_TREE_MODEL (filter), &iter, path);
1392 level = FILTER_LEVEL (iter.user_data);
1393 elt = FILTER_ELT (iter.user_data2);
1395 /* Make sure elt is visible. elt can already be visible in case
1396 * it was pulled in above, so avoid increasing level->visible_nodes twice.
1400 elt->visible = TRUE;
1401 level->visible_nodes++;
1404 /* Check whether the node and all of its parents are visible */
1405 if (gtk_tree_model_filter_elt_is_visible_in_target (level, elt))
1407 /* visibility changed -- reget path */
1408 gtk_tree_path_free (path);
1409 path = gtk_tree_model_get_path (GTK_TREE_MODEL (filter), &iter);
1411 if (!signals_emitted)
1412 gtk_tree_model_row_inserted (GTK_TREE_MODEL (filter), path, &iter);
1414 if (level->parent_level && level->visible_nodes == 1)
1416 /* We know that this is the first visible node in this level, so
1417 * we need to emit row-has-child-toggled on the parent. This
1418 * does not apply to the root level.
1421 gtk_tree_path_up (path);
1422 gtk_tree_model_get_iter (GTK_TREE_MODEL (filter), &iter, path);
1424 gtk_tree_model_row_has_child_toggled (GTK_TREE_MODEL (filter),
1429 if (!signals_emitted
1430 && gtk_tree_model_iter_children (c_model, &children, c_iter))
1431 gtk_tree_model_filter_update_children (filter, level, elt);
1434 gtk_tree_path_free (path);
1438 gtk_tree_model_filter_row_changed (GtkTreeModel *c_model,
1439 GtkTreePath *c_path,
1440 GtkTreeIter *c_iter,
1443 GtkTreeModelFilter *filter = GTK_TREE_MODEL_FILTER (data);
1445 GtkTreeIter children;
1446 GtkTreeIter real_c_iter;
1447 GtkTreePath *path = NULL;
1452 gboolean requested_state;
1453 gboolean current_state;
1454 gboolean free_c_path = FALSE;
1456 g_return_if_fail (c_path != NULL || c_iter != NULL);
1460 c_path = gtk_tree_model_get_path (c_model, c_iter);
1465 real_c_iter = *c_iter;
1467 gtk_tree_model_get_iter (c_model, &real_c_iter, c_path);
1469 /* is this node above the virtual root? */
1470 if (filter->priv->virtual_root &&
1471 (gtk_tree_path_get_depth (filter->priv->virtual_root)
1472 >= gtk_tree_path_get_depth (c_path)))
1475 /* what's the requested state? */
1476 requested_state = gtk_tree_model_filter_visible (filter, &real_c_iter);
1478 /* now, let's see whether the item is there */
1479 path = gtk_real_tree_model_filter_convert_child_path_to_path (filter,
1486 gtk_tree_model_filter_get_iter_full (GTK_TREE_MODEL (filter),
1488 current_state = FILTER_ELT (iter.user_data2)->visible;
1491 current_state = FALSE;
1493 if (current_state == FALSE && requested_state == FALSE)
1494 /* no changes required */
1497 if (current_state == TRUE && requested_state == FALSE)
1499 /* get rid of this node */
1500 level = FILTER_LEVEL (iter.user_data);
1501 level->visible_nodes--;
1503 gtk_tree_model_filter_remove_elt_from_level (filter, level,
1504 FILTER_ELT (iter.user_data2));
1509 if (current_state == TRUE && requested_state == TRUE)
1511 /* propagate the signal; also get a path taking only visible
1512 * nodes into account.
1514 gtk_tree_path_free (path);
1515 path = gtk_tree_model_get_path (GTK_TREE_MODEL (filter), &iter);
1517 level = FILTER_LEVEL (iter.user_data);
1518 elt = FILTER_ELT (iter.user_data2);
1520 if (gtk_tree_model_filter_elt_is_visible_in_target (level, elt))
1522 gtk_tree_model_row_changed (GTK_TREE_MODEL (filter), path, &iter);
1524 /* and update the children */
1525 if (gtk_tree_model_iter_children (c_model, &children, &real_c_iter))
1526 gtk_tree_model_filter_update_children (filter, level, elt);
1532 /* only current == FALSE and requested == TRUE is left,
1535 g_return_if_fail (current_state == FALSE && requested_state == TRUE);
1537 gtk_tree_model_filter_emit_row_inserted_for_path (filter, c_model,
1542 gtk_tree_path_free (path);
1545 gtk_tree_path_free (c_path);
1549 gtk_tree_model_filter_row_inserted (GtkTreeModel *c_model,
1550 GtkTreePath *c_path,
1551 GtkTreeIter *c_iter,
1554 GtkTreeModelFilter *filter = GTK_TREE_MODEL_FILTER (data);
1555 GtkTreePath *real_path = NULL;
1557 GtkTreeIter real_c_iter;
1559 FilterElt *elt = NULL;
1560 FilterLevel *level = NULL;
1561 FilterLevel *parent_level = NULL;
1565 gboolean free_c_path = FALSE;
1566 gboolean emit_row_inserted = FALSE;
1568 g_return_if_fail (c_path != NULL || c_iter != NULL);
1572 c_path = gtk_tree_model_get_path (c_model, c_iter);
1577 real_c_iter = *c_iter;
1579 gtk_tree_model_get_iter (c_model, &real_c_iter, c_path);
1581 /* the row has already been inserted. so we need to fixup the
1582 * virtual root here first
1584 if (filter->priv->virtual_root)
1586 if (gtk_tree_path_get_depth (filter->priv->virtual_root) >=
1587 gtk_tree_path_get_depth (c_path))
1590 gint *v_indices, *c_indices;
1591 gboolean common_prefix = TRUE;
1593 level = gtk_tree_path_get_depth (c_path) - 1;
1594 v_indices = gtk_tree_path_get_indices (filter->priv->virtual_root);
1595 c_indices = gtk_tree_path_get_indices (c_path);
1597 for (i = 0; i < level; i++)
1598 if (v_indices[i] != c_indices[i])
1600 common_prefix = FALSE;
1604 if (common_prefix && v_indices[level] >= c_indices[level])
1605 (v_indices[level])++;
1609 if (!filter->priv->root)
1611 /* No point in building the level if this node is not visible. */
1612 if (!filter->priv->virtual_root
1613 && !gtk_tree_model_filter_visible (filter, c_iter))
1616 /* build level will pull in the new child */
1617 gtk_tree_model_filter_build_level (filter, NULL, -1, FALSE);
1619 if (filter->priv->root
1620 && FILTER_LEVEL (filter->priv->root)->visible_nodes)
1621 emit_row_inserted = TRUE;
1626 /* subtract virtual root if necessary */
1627 if (filter->priv->virtual_root)
1629 real_path = gtk_tree_model_filter_remove_root (c_path,
1630 filter->priv->virtual_root);
1636 real_path = gtk_tree_path_copy (c_path);
1638 if (gtk_tree_path_get_depth (real_path) - 1 >= 1)
1640 gboolean found = FALSE;
1641 GtkTreePath *parent = gtk_tree_path_copy (real_path);
1642 gtk_tree_path_up (parent);
1644 found = find_elt_with_offset (filter, parent, &parent_level, &elt);
1646 gtk_tree_path_free (parent);
1649 /* Parent is not in the cache and probably being filtered out */
1652 level = elt->children;
1655 level = FILTER_LEVEL (filter->priv->root);
1659 if (elt && elt->visible)
1661 /* The level in which the new node should be inserted does not
1662 * exist, but the parent, elt, does. If elt is visible, emit
1663 * row-has-child-toggled.
1665 GtkTreePath *tmppath;
1666 GtkTreeIter tmpiter;
1668 tmpiter.stamp = filter->priv->stamp;
1669 tmpiter.user_data = parent_level;
1670 tmpiter.user_data2 = elt;
1672 tmppath = gtk_tree_model_get_path (GTK_TREE_MODEL (filter),
1677 gtk_tree_model_row_has_child_toggled (GTK_TREE_MODEL (filter),
1679 gtk_tree_path_free (tmppath);
1685 /* let's try to insert the value */
1686 offset = gtk_tree_path_get_indices (real_path)[gtk_tree_path_get_depth (real_path) - 1];
1688 /* update the offsets, yes if we didn't insert the node above, there will
1689 * be a gap here. This will be filled with the node (via fetch_child) when
1690 * it becomes visible
1692 for (i = 0; i < level->array->len; i++)
1694 FilterElt *e = &g_array_index (level->array, FilterElt, i);
1695 if ((e->offset >= offset))
1699 /* only insert when visible */
1700 if (gtk_tree_model_filter_visible (filter, &real_c_iter))
1704 felt = gtk_tree_model_filter_insert_elt_in_level (filter,
1709 /* insert_elt_in_level defaults to FALSE */
1710 felt->visible = TRUE;
1711 level->visible_nodes++;
1713 emit_row_inserted = TRUE;
1717 if (emit_row_inserted)
1718 gtk_tree_model_filter_emit_row_inserted_for_path (filter, c_model,
1722 gtk_tree_path_free (real_path);
1725 gtk_tree_path_free (c_path);
1729 gtk_tree_model_filter_row_has_child_toggled (GtkTreeModel *c_model,
1730 GtkTreePath *c_path,
1731 GtkTreeIter *c_iter,
1734 GtkTreeModelFilter *filter = GTK_TREE_MODEL_FILTER (data);
1739 gboolean requested_state;
1741 g_return_if_fail (c_path != NULL && c_iter != NULL);
1743 /* If we get row-has-child-toggled on the virtual root, and there is
1744 * no root level; try to build it now.
1746 if (filter->priv->virtual_root && !filter->priv->root
1747 && !gtk_tree_path_compare (c_path, filter->priv->virtual_root))
1749 gtk_tree_model_filter_build_level (filter, NULL, -1, TRUE);
1753 /* For all other levels, there is a chance that the visibility state
1754 * of the parent has changed now.
1757 path = gtk_real_tree_model_filter_convert_child_path_to_path (filter,
1764 gtk_tree_model_filter_get_iter_full (GTK_TREE_MODEL (data), &iter, path);
1766 level = FILTER_LEVEL (iter.user_data);
1767 elt = FILTER_ELT (iter.user_data2);
1769 gtk_tree_path_free (path);
1771 requested_state = gtk_tree_model_filter_visible (filter, c_iter);
1773 if (!elt->visible && !requested_state)
1775 /* The parent node currently is not visible and will not become
1776 * visible, so we will not pass on the row-has-child-toggled event.
1780 else if (elt->visible && !requested_state)
1782 /* The node is no longer visible, so it has to be removed.
1783 * _remove_elt_from_level() takes care of emitting row-has-child-toggled
1786 level->visible_nodes--;
1788 gtk_tree_model_filter_remove_elt_from_level (filter, level, elt);
1792 else if (!elt->visible && requested_state)
1794 elt->visible = TRUE;
1795 level->visible_nodes++;
1797 /* Only insert if the parent is visible in the target */
1798 if (gtk_tree_model_filter_elt_is_visible_in_target (level, elt))
1800 path = gtk_tree_model_get_path (GTK_TREE_MODEL (filter), &iter);
1801 gtk_tree_model_row_inserted (GTK_TREE_MODEL (filter), path, &iter);
1802 gtk_tree_path_free (path);
1804 /* We do not update children now, because that will happen
1809 /* For the remaining possibility, elt->visible && requested_state
1810 * no action is required.
1813 /* If this node is referenced and has children, build the level so we
1814 * can monitor it for changes.
1816 if (elt->ref_count > 1 && gtk_tree_model_iter_has_child (c_model, c_iter))
1817 gtk_tree_model_filter_build_level (filter, level,
1818 FILTER_LEVEL_ELT_INDEX (level, elt),
1821 /* get a path taking only visible nodes into account */
1822 path = gtk_tree_model_get_path (GTK_TREE_MODEL (data), &iter);
1823 gtk_tree_model_row_has_child_toggled (GTK_TREE_MODEL (data), path, &iter);
1824 gtk_tree_path_free (path);
1828 gtk_tree_model_filter_virtual_root_deleted (GtkTreeModelFilter *filter,
1829 GtkTreePath *c_path)
1833 FilterLevel *level = FILTER_LEVEL (filter->priv->root);
1835 /* The virtual root (or one of its ancestors) has been deleted. This
1836 * means that all content for our model is now gone. We deal with
1837 * this by removing everything in the filter model: we just iterate
1838 * over the root level and emit a row-deleted for each FilterElt.
1839 * (FIXME: Should we emit row-deleted for child nodes as well? This
1840 * has never been fully clear in TreeModel).
1843 /* We unref the path of the virtual root, up to and not including the
1844 * deleted node which can no longer be unreffed.
1846 gtk_tree_model_filter_unref_path (filter, filter->priv->virtual_root,
1847 gtk_tree_path_get_depth (c_path) - 1);
1848 filter->priv->virtual_root_deleted = TRUE;
1853 gtk_tree_model_filter_increment_stamp (filter);
1854 path = gtk_tree_path_new ();
1855 gtk_tree_path_append_index (path, 0);
1857 for (i = 0; i < level->visible_nodes; i++)
1858 gtk_tree_model_row_deleted (GTK_TREE_MODEL (filter), path);
1860 gtk_tree_path_free (path);
1862 /* We should not propagate the unref here. An unref for any of these
1863 * nodes will fail, since the respective nodes in the child model are
1866 gtk_tree_model_filter_free_level (filter, filter->priv->root, FALSE);
1870 gtk_tree_model_filter_adjust_virtual_root (GtkTreeModelFilter *filter,
1871 GtkTreePath *c_path)
1875 gint *v_indices, *c_indices;
1876 gboolean common_prefix = TRUE;
1878 level = gtk_tree_path_get_depth (c_path) - 1;
1879 v_indices = gtk_tree_path_get_indices (filter->priv->virtual_root);
1880 c_indices = gtk_tree_path_get_indices (c_path);
1882 for (i = 0; i < level; i++)
1883 if (v_indices[i] != c_indices[i])
1885 common_prefix = FALSE;
1889 if (common_prefix && v_indices[level] > c_indices[level])
1890 (v_indices[level])--;
1894 gtk_tree_model_filter_row_deleted_invisible_node (GtkTreeModelFilter *filter,
1895 GtkTreePath *c_path)
1899 GtkTreePath *real_path;
1903 /* The node deleted in the child model is not visible in the
1904 * filter model. We will not emit a signal, just fixup the offsets
1905 * of the other nodes.
1908 if (!filter->priv->root)
1911 level = FILTER_LEVEL (filter->priv->root);
1913 /* subtract vroot if necessary */
1914 if (filter->priv->virtual_root)
1916 real_path = gtk_tree_model_filter_remove_root (c_path,
1917 filter->priv->virtual_root);
1918 /* we don't handle this */
1923 real_path = gtk_tree_path_copy (c_path);
1925 if (gtk_tree_path_get_depth (real_path) - 1 >= 1)
1927 gboolean found = FALSE;
1928 GtkTreePath *parent = gtk_tree_path_copy (real_path);
1929 gtk_tree_path_up (parent);
1931 found = find_elt_with_offset (filter, parent, &level, &elt);
1933 gtk_tree_path_free (parent);
1937 /* parent is filtered out, so no level */
1938 gtk_tree_path_free (real_path);
1942 level = elt->children;
1945 offset = gtk_tree_path_get_indices (real_path)[gtk_tree_path_get_depth (real_path) - 1];
1946 gtk_tree_path_free (real_path);
1951 /* decrease offset of all nodes following the deleted node */
1952 for (i = 0; i < level->array->len; i++)
1954 elt = &g_array_index (level->array, FilterElt, i);
1955 if (elt->offset > offset)
1958 elt->children->parent_elt_index = i;
1963 gtk_tree_model_filter_row_deleted (GtkTreeModel *c_model,
1964 GtkTreePath *c_path,
1967 GtkTreeModelFilter *filter = GTK_TREE_MODEL_FILTER (data);
1971 FilterLevel *level, *parent_level = NULL;
1972 gboolean emit_child_toggled = FALSE;
1973 gboolean emit_row_deleted = FALSE;
1976 gint parent_elt_index = -1;
1978 g_return_if_fail (c_path != NULL);
1980 /* special case the deletion of an ancestor of the virtual root */
1981 if (filter->priv->virtual_root &&
1982 (gtk_tree_path_is_ancestor (c_path, filter->priv->virtual_root) ||
1983 !gtk_tree_path_compare (c_path, filter->priv->virtual_root)))
1985 gtk_tree_model_filter_virtual_root_deleted (filter, c_path);
1989 /* adjust the virtual root for the deleted row */
1990 if (filter->priv->virtual_root &&
1991 gtk_tree_path_get_depth (filter->priv->virtual_root) >=
1992 gtk_tree_path_get_depth (c_path))
1993 gtk_tree_model_filter_adjust_virtual_root (filter, c_path);
1995 path = gtk_real_tree_model_filter_convert_child_path_to_path (filter,
2002 gtk_tree_model_filter_row_deleted_invisible_node (filter, c_path);
2006 /* a node was deleted, which was in our cache */
2007 gtk_tree_model_filter_get_iter_full (GTK_TREE_MODEL (data), &iter, path);
2009 level = FILTER_LEVEL (iter.user_data);
2010 elt = FILTER_ELT (iter.user_data2);
2011 offset = elt->offset;
2015 /* get a path taking only visible nodes into account */
2016 gtk_tree_path_free (path);
2017 path = gtk_tree_model_get_path (GTK_TREE_MODEL (filter), &iter);
2019 level->visible_nodes--;
2021 if (level->visible_nodes == 0)
2023 emit_child_toggled = TRUE;
2024 parent_level = level->parent_level;
2025 parent_elt_index = level->parent_elt_index;
2028 emit_row_deleted = TRUE;
2031 /* Release the references on this node, without propagation because
2032 * the node does not exist anymore in the child model. The filter
2033 * model's references on the node in case of level->parent or use
2034 * of a virtual root are automatically destroyed by the child model.
2036 while (elt->ref_count > 0)
2037 gtk_tree_model_filter_real_unref_node (GTK_TREE_MODEL (data), &iter, FALSE);
2039 if (level->array->len == 1)
2042 gtk_tree_model_filter_free_level (filter, level, FALSE);
2048 /* remove the row */
2049 tmp = bsearch_elt_with_offset (level->array, elt->offset, &i);
2051 offset = tmp->offset;
2052 g_array_remove_index (level->array, i);
2055 for (i = MAX (i, 0); i < level->array->len; i++)
2057 elt = &g_array_index (level->array, FilterElt, i);
2058 if (elt->offset > offset)
2061 elt->children->parent_elt_index = i;
2065 if (emit_row_deleted)
2067 /* emit row_deleted */
2068 gtk_tree_model_filter_increment_stamp (filter);
2069 gtk_tree_model_row_deleted (GTK_TREE_MODEL (data), path);
2070 iter.stamp = filter->priv->stamp;
2073 if (emit_child_toggled && parent_level)
2078 iter2.stamp = filter->priv->stamp;
2079 iter2.user_data = parent_level;
2080 iter2.user_data2 = &g_array_index (parent_level->array, FilterElt, parent_elt_index);
2082 /* We set in_row_deleted to TRUE to avoid a level build triggered
2083 * by row-has-child-toggled (parent model could call iter_has_child
2086 filter->priv->in_row_deleted = TRUE;
2087 path2 = gtk_tree_model_get_path (GTK_TREE_MODEL (filter), &iter2);
2088 gtk_tree_model_row_has_child_toggled (GTK_TREE_MODEL (filter),
2090 gtk_tree_path_free (path2);
2091 filter->priv->in_row_deleted = FALSE;
2094 gtk_tree_path_free (path);
2098 gtk_tree_model_filter_rows_reordered (GtkTreeModel *c_model,
2099 GtkTreePath *c_path,
2100 GtkTreeIter *c_iter,
2106 GtkTreeModelFilter *filter = GTK_TREE_MODEL_FILTER (data);
2112 gint i, j, elt_count;
2117 g_return_if_fail (new_order != NULL);
2119 if (c_path == NULL || gtk_tree_path_get_depth (c_path) == 0)
2121 length = gtk_tree_model_iter_n_children (c_model, NULL);
2123 if (filter->priv->virtual_root)
2127 /* reorder root level of path */
2128 for (i = 0; i < length; i++)
2129 if (new_order[i] == gtk_tree_path_get_indices (filter->priv->virtual_root)[0])
2135 gtk_tree_path_get_indices (filter->priv->virtual_root)[0] = new_pos;
2139 path = gtk_tree_path_new ();
2140 level = FILTER_LEVEL (filter->priv->root);
2144 GtkTreeIter child_iter;
2146 /* virtual root anchor reordering */
2147 if (filter->priv->virtual_root &&
2148 gtk_tree_path_is_ancestor (c_path, filter->priv->virtual_root))
2153 GtkTreeIter real_c_iter;
2155 level = gtk_tree_path_get_depth (c_path);
2158 real_c_iter = *c_iter;
2160 gtk_tree_model_get_iter (c_model, &real_c_iter, c_path);
2162 length = gtk_tree_model_iter_n_children (c_model, &real_c_iter);
2164 for (i = 0; i < length; i++)
2165 if (new_order[i] == gtk_tree_path_get_indices (filter->priv->virtual_root)[level])
2171 gtk_tree_path_get_indices (filter->priv->virtual_root)[level] = new_pos;
2175 path = gtk_real_tree_model_filter_convert_child_path_to_path (filter,
2180 if (!path && filter->priv->virtual_root &&
2181 gtk_tree_path_compare (c_path, filter->priv->virtual_root))
2184 if (!path && !filter->priv->virtual_root)
2189 /* root level mode */
2191 gtk_tree_model_get_iter (c_model, c_iter, c_path);
2192 length = gtk_tree_model_iter_n_children (c_model, c_iter);
2193 path = gtk_tree_path_new ();
2194 level = FILTER_LEVEL (filter->priv->root);
2198 gtk_tree_model_filter_get_iter_full (GTK_TREE_MODEL (data),
2201 level = FILTER_LEVEL (iter.user_data);
2202 elt = FILTER_ELT (iter.user_data2);
2206 gtk_tree_path_free (path);
2210 level = elt->children;
2212 gtk_tree_model_filter_convert_iter_to_child_iter (GTK_TREE_MODEL_FILTER (filter), &child_iter, &iter);
2213 length = gtk_tree_model_iter_n_children (c_model, &child_iter);
2217 if (!level || level->array->len < 1)
2219 gtk_tree_path_free (path);
2223 /* NOTE: we do not bail out here if level->array->len < 2 like
2224 * GtkTreeModelSort does. This because we do some special tricky
2228 /* construct a new array */
2229 new_array = g_array_sized_new (FALSE, FALSE, sizeof (FilterElt),
2231 tmp_array = g_new (gint, level->array->len);
2233 for (i = 0, elt_count = 0; i < length; i++)
2235 FilterElt *e = NULL;
2236 gint old_offset = -1;
2238 for (j = 0; j < level->array->len; j++)
2239 if (g_array_index (level->array, FilterElt, j).offset == new_order[i])
2241 e = &g_array_index (level->array, FilterElt, j);
2249 tmp_array[elt_count] = old_offset;
2250 g_array_append_val (new_array, *e);
2251 g_array_index (new_array, FilterElt, elt_count).offset = i;
2255 g_array_free (level->array, TRUE);
2256 level->array = new_array;
2259 for (i = 0; i < level->array->len; i++)
2261 FilterElt *e = &g_array_index (level->array, FilterElt, i);
2263 e->children->parent_elt_index = i;
2266 /* emit rows_reordered */
2267 if (!gtk_tree_path_get_indices (path))
2268 gtk_tree_model_rows_reordered (GTK_TREE_MODEL (data), path, NULL,
2272 /* get a path taking only visible nodes into account */
2273 gtk_tree_path_free (path);
2274 path = gtk_tree_model_get_path (GTK_TREE_MODEL (data), &iter);
2276 gtk_tree_model_rows_reordered (GTK_TREE_MODEL (data), path, &iter,
2282 gtk_tree_path_free (path);
2285 /* TreeModelIface implementation */
2286 static GtkTreeModelFlags
2287 gtk_tree_model_filter_get_flags (GtkTreeModel *model)
2289 GtkTreeModelFlags flags;
2291 g_return_val_if_fail (GTK_IS_TREE_MODEL_FILTER (model), 0);
2292 g_return_val_if_fail (GTK_TREE_MODEL_FILTER (model)->priv->child_model != NULL, 0);
2294 flags = gtk_tree_model_get_flags (GTK_TREE_MODEL_FILTER (model)->priv->child_model);
2296 if ((flags & GTK_TREE_MODEL_LIST_ONLY) == GTK_TREE_MODEL_LIST_ONLY)
2297 return GTK_TREE_MODEL_LIST_ONLY;
2303 gtk_tree_model_filter_get_n_columns (GtkTreeModel *model)
2305 GtkTreeModelFilter *filter = (GtkTreeModelFilter *)model;
2307 g_return_val_if_fail (GTK_IS_TREE_MODEL_FILTER (model), 0);
2308 g_return_val_if_fail (filter->priv->child_model != NULL, 0);
2310 if (filter->priv->child_model == NULL)
2313 /* so we can't modify the modify func after this ... */
2314 filter->priv->modify_func_set = TRUE;
2316 if (filter->priv->modify_n_columns > 0)
2317 return filter->priv->modify_n_columns;
2319 return gtk_tree_model_get_n_columns (filter->priv->child_model);
2323 gtk_tree_model_filter_get_column_type (GtkTreeModel *model,
2326 GtkTreeModelFilter *filter = (GtkTreeModelFilter *)model;
2328 g_return_val_if_fail (GTK_IS_TREE_MODEL_FILTER (model), G_TYPE_INVALID);
2329 g_return_val_if_fail (filter->priv->child_model != NULL, G_TYPE_INVALID);
2331 /* so we can't modify the modify func after this ... */
2332 filter->priv->modify_func_set = TRUE;
2334 if (filter->priv->modify_types)
2336 g_return_val_if_fail (index < filter->priv->modify_n_columns, G_TYPE_INVALID);
2338 return filter->priv->modify_types[index];
2341 return gtk_tree_model_get_column_type (filter->priv->child_model, index);
2344 /* A special case of _get_iter; this function can also get iters which
2345 * are not visible. These iters should ONLY be passed internally, never
2346 * pass those along with a signal emission.
2349 gtk_tree_model_filter_get_iter_full (GtkTreeModel *model,
2353 GtkTreeModelFilter *filter = (GtkTreeModelFilter *)model;
2358 g_return_val_if_fail (GTK_IS_TREE_MODEL_FILTER (model), FALSE);
2359 g_return_val_if_fail (filter->priv->child_model != NULL, FALSE);
2361 indices = gtk_tree_path_get_indices (path);
2363 if (filter->priv->root == NULL)
2364 gtk_tree_model_filter_build_level (filter, NULL, -1, FALSE);
2365 level = FILTER_LEVEL (filter->priv->root);
2367 depth = gtk_tree_path_get_depth (path);
2374 for (i = 0; i < depth - 1; i++)
2376 if (!level || indices[i] >= level->array->len)
2382 elt = gtk_tree_model_filter_get_nth (filter, level, indices[i]);
2385 gtk_tree_model_filter_build_level (filter, level,
2386 FILTER_LEVEL_ELT_INDEX (level, elt),
2388 level = elt->children;
2391 if (!level || indices[i] >= level->array->len)
2397 iter->stamp = filter->priv->stamp;
2398 iter->user_data = level;
2400 elt = gtk_tree_model_filter_get_nth (filter, level, indices[depth - 1]);
2401 iter->user_data2 = elt;
2407 gtk_tree_model_filter_get_iter (GtkTreeModel *model,
2411 GtkTreeModelFilter *filter = (GtkTreeModelFilter *)model;
2416 g_return_val_if_fail (GTK_IS_TREE_MODEL_FILTER (model), FALSE);
2417 g_return_val_if_fail (filter->priv->child_model != NULL, FALSE);
2419 indices = gtk_tree_path_get_indices (path);
2421 if (filter->priv->root == NULL)
2422 gtk_tree_model_filter_build_level (filter, NULL, -1, FALSE);
2423 level = FILTER_LEVEL (filter->priv->root);
2425 depth = gtk_tree_path_get_depth (path);
2432 for (i = 0; i < depth - 1; i++)
2434 if (!level || indices[i] >= level->visible_nodes)
2440 elt = gtk_tree_model_filter_get_nth_visible (filter, level, indices[i]);
2443 gtk_tree_model_filter_build_level (filter, level,
2444 FILTER_LEVEL_ELT_INDEX (level, elt),
2446 level = elt->children;
2449 if (!level || indices[i] >= level->visible_nodes)
2455 iter->stamp = filter->priv->stamp;
2456 iter->user_data = level;
2458 elt = gtk_tree_model_filter_get_nth_visible (filter, level,
2459 indices[depth - 1]);
2460 iter->user_data2 = elt;
2465 static GtkTreePath *
2466 gtk_tree_model_filter_get_path (GtkTreeModel *model,
2469 GtkTreePath *retval;
2474 g_return_val_if_fail (GTK_IS_TREE_MODEL_FILTER (model), NULL);
2475 g_return_val_if_fail (GTK_TREE_MODEL_FILTER (model)->priv->child_model != NULL, NULL);
2476 g_return_val_if_fail (GTK_TREE_MODEL_FILTER (model)->priv->stamp == iter->stamp, NULL);
2478 level = iter->user_data;
2479 elt = iter->user_data2;
2480 elt_index = FILTER_LEVEL_ELT_INDEX (level, elt);
2485 retval = gtk_tree_path_new ();
2489 int i = 0, index = 0;
2491 while (i < elt_index)
2493 if (g_array_index (level->array, FilterElt, i).visible)
2497 g_assert (i < level->array->len);
2500 gtk_tree_path_prepend_index (retval, index);
2501 elt_index = level->parent_elt_index;
2502 level = level->parent_level;
2509 gtk_tree_model_filter_real_modify (GtkTreeModelFilter *self,
2510 GtkTreeModel *child_model,
2515 if (self->priv->modify_func)
2517 g_return_if_fail (column < self->priv->modify_n_columns);
2519 g_value_init (value, self->priv->modify_types[column]);
2520 self->priv->modify_func (GTK_TREE_MODEL (self),
2524 self->priv->modify_data);
2528 GtkTreeIter child_iter;
2530 gtk_tree_model_filter_convert_iter_to_child_iter (
2531 GTK_TREE_MODEL_FILTER (self), &child_iter, iter);
2532 gtk_tree_model_get_value (child_model,
2533 &child_iter, column, value);
2538 gtk_tree_model_filter_get_value (GtkTreeModel *model,
2543 GtkTreeModelFilter *filter = GTK_TREE_MODEL_FILTER (model);
2545 g_return_if_fail (GTK_IS_TREE_MODEL_FILTER (model));
2546 g_return_if_fail (GTK_TREE_MODEL_FILTER (model)->priv->child_model != NULL);
2547 g_return_if_fail (GTK_TREE_MODEL_FILTER (model)->priv->stamp == iter->stamp);
2549 GTK_TREE_MODEL_FILTER_GET_CLASS (model)->modify (filter,
2550 filter->priv->child_model, iter, value, column);
2554 gtk_tree_model_filter_iter_next (GtkTreeModel *model,
2561 g_return_val_if_fail (GTK_IS_TREE_MODEL_FILTER (model), FALSE);
2562 g_return_val_if_fail (GTK_TREE_MODEL_FILTER (model)->priv->child_model != NULL, FALSE);
2563 g_return_val_if_fail (GTK_TREE_MODEL_FILTER (model)->priv->stamp == iter->stamp, FALSE);
2565 level = iter->user_data;
2566 elt = iter->user_data2;
2568 i = elt - FILTER_ELT (level->array->data);
2570 while (i < level->array->len - 1)
2577 iter->user_data2 = elt;
2582 /* no next visible iter */
2589 gtk_tree_model_filter_iter_previous (GtkTreeModel *model,
2596 g_return_val_if_fail (GTK_IS_TREE_MODEL_FILTER (model), FALSE);
2597 g_return_val_if_fail (GTK_TREE_MODEL_FILTER (model)->priv->child_model != NULL, FALSE);
2598 g_return_val_if_fail (GTK_TREE_MODEL_FILTER (model)->priv->stamp == iter->stamp, FALSE);
2600 level = iter->user_data;
2601 elt = iter->user_data2;
2603 i = elt - FILTER_ELT (level->array->data);
2612 iter->user_data2 = elt;
2617 /* no previous visible iter */
2624 gtk_tree_model_filter_iter_children (GtkTreeModel *model,
2626 GtkTreeIter *parent)
2628 GtkTreeModelFilter *filter = (GtkTreeModelFilter *)model;
2632 g_return_val_if_fail (GTK_IS_TREE_MODEL_FILTER (model), FALSE);
2633 g_return_val_if_fail (filter->priv->child_model != NULL, FALSE);
2635 g_return_val_if_fail (filter->priv->stamp == parent->stamp, FALSE);
2641 if (!filter->priv->root)
2642 gtk_tree_model_filter_build_level (filter, NULL, -1, FALSE);
2643 if (!filter->priv->root)
2646 level = filter->priv->root;
2648 if (!level->visible_nodes)
2651 iter->stamp = filter->priv->stamp;
2652 iter->user_data = level;
2654 while (i < level->array->len)
2656 if (!g_array_index (level->array, FilterElt, i).visible)
2662 iter->user_data2 = &g_array_index (level->array, FilterElt, i);
2674 elt = FILTER_ELT (parent->user_data2);
2676 if (elt->children == NULL)
2677 gtk_tree_model_filter_build_level (filter,
2678 FILTER_LEVEL (parent->user_data),
2679 FILTER_LEVEL_ELT_INDEX (parent->user_data, elt),
2682 if (elt->children == NULL)
2685 if (elt->children->visible_nodes <= 0)
2688 iter->stamp = filter->priv->stamp;
2689 iter->user_data = elt->children;
2691 level = FILTER_LEVEL (iter->user_data);
2693 while (i < level->array->len)
2695 if (!g_array_index (level->array, FilterElt, i).visible)
2701 iter->user_data2 = &g_array_index (level->array, FilterElt, i);
2714 gtk_tree_model_filter_iter_has_child (GtkTreeModel *model,
2717 GtkTreeIter child_iter;
2718 GtkTreeModelFilter *filter = (GtkTreeModelFilter *)model;
2721 g_return_val_if_fail (GTK_IS_TREE_MODEL_FILTER (model), FALSE);
2722 g_return_val_if_fail (filter->priv->child_model != NULL, FALSE);
2723 g_return_val_if_fail (filter->priv->stamp == iter->stamp, FALSE);
2725 filter = GTK_TREE_MODEL_FILTER (model);
2727 gtk_tree_model_filter_convert_iter_to_child_iter (GTK_TREE_MODEL_FILTER (model), &child_iter, iter);
2728 elt = FILTER_ELT (iter->user_data2);
2733 /* we need to build the level to check if not all children are filtered
2737 && gtk_tree_model_iter_has_child (filter->priv->child_model, &child_iter))
2738 gtk_tree_model_filter_build_level (filter, FILTER_LEVEL (iter->user_data),
2739 FILTER_LEVEL_ELT_INDEX (iter->user_data, elt),
2742 if (elt->children && elt->children->visible_nodes > 0)
2749 gtk_tree_model_filter_iter_n_children (GtkTreeModel *model,
2752 GtkTreeIter child_iter;
2753 GtkTreeModelFilter *filter = (GtkTreeModelFilter *)model;
2756 g_return_val_if_fail (GTK_IS_TREE_MODEL_FILTER (model), 0);
2757 g_return_val_if_fail (filter->priv->child_model != NULL, 0);
2759 g_return_val_if_fail (filter->priv->stamp == iter->stamp, 0);
2763 if (!filter->priv->root)
2764 gtk_tree_model_filter_build_level (filter, NULL, -1, FALSE);
2766 if (filter->priv->root)
2767 return FILTER_LEVEL (filter->priv->root)->visible_nodes;
2772 elt = FILTER_ELT (iter->user_data2);
2777 gtk_tree_model_filter_convert_iter_to_child_iter (GTK_TREE_MODEL_FILTER (model), &child_iter, iter);
2779 if (!elt->children &&
2780 gtk_tree_model_iter_has_child (filter->priv->child_model, &child_iter))
2781 gtk_tree_model_filter_build_level (filter,
2782 FILTER_LEVEL (iter->user_data),
2783 FILTER_LEVEL_ELT_INDEX (iter->user_data, elt),
2787 return elt->children->visible_nodes;
2793 gtk_tree_model_filter_iter_nth_child (GtkTreeModel *model,
2795 GtkTreeIter *parent,
2800 GtkTreeIter children;
2802 g_return_val_if_fail (GTK_IS_TREE_MODEL_FILTER (model), FALSE);
2804 g_return_val_if_fail (GTK_TREE_MODEL_FILTER (model)->priv->stamp == parent->stamp, FALSE);
2806 /* use this instead of has_child to force us to build the level, if needed */
2807 if (gtk_tree_model_filter_iter_children (model, &children, parent) == FALSE)
2813 level = children.user_data;
2814 elt = FILTER_ELT (level->array->data);
2816 if (n >= level->visible_nodes)
2822 elt = gtk_tree_model_filter_get_nth_visible (GTK_TREE_MODEL_FILTER (model),
2825 iter->stamp = GTK_TREE_MODEL_FILTER (model)->priv->stamp;
2826 iter->user_data = level;
2827 iter->user_data2 = elt;
2833 gtk_tree_model_filter_iter_parent (GtkTreeModel *model,
2840 g_return_val_if_fail (GTK_IS_TREE_MODEL_FILTER (model), FALSE);
2841 g_return_val_if_fail (GTK_TREE_MODEL_FILTER (model)->priv->child_model != NULL, FALSE);
2842 g_return_val_if_fail (GTK_TREE_MODEL_FILTER (model)->priv->stamp == child->stamp, FALSE);
2844 level = child->user_data;
2846 if (level->parent_level)
2848 iter->stamp = GTK_TREE_MODEL_FILTER (model)->priv->stamp;
2849 iter->user_data = level->parent_level;
2850 iter->user_data2 = FILTER_LEVEL_PARENT_ELT (level);
2859 gtk_tree_model_filter_ref_node (GtkTreeModel *model,
2862 GtkTreeModelFilter *filter = (GtkTreeModelFilter *)model;
2863 GtkTreeIter child_iter;
2867 g_return_if_fail (GTK_IS_TREE_MODEL_FILTER (model));
2868 g_return_if_fail (GTK_TREE_MODEL_FILTER (model)->priv->child_model != NULL);
2869 g_return_if_fail (GTK_TREE_MODEL_FILTER (model)->priv->stamp == iter->stamp);
2871 gtk_tree_model_filter_convert_iter_to_child_iter (GTK_TREE_MODEL_FILTER (model), &child_iter, iter);
2873 gtk_tree_model_ref_node (filter->priv->child_model, &child_iter);
2875 level = iter->user_data;
2876 elt = iter->user_data2;
2880 if (level->ref_count == 1)
2882 FilterLevel *parent_level = level->parent_level;
2883 gint parent_elt_index = level->parent_elt_index;
2885 /* we were at zero -- time to decrease the zero_ref_count val */
2886 while (parent_level)
2888 g_array_index (parent_level->array, FilterElt, parent_elt_index).zero_ref_count--;
2890 parent_elt_index = parent_level->parent_elt_index;
2891 parent_level = parent_level->parent_level;
2894 if (filter->priv->root != level)
2895 filter->priv->zero_ref_count--;
2900 gtk_tree_model_filter_unref_node (GtkTreeModel *model,
2903 gtk_tree_model_filter_real_unref_node (model, iter, TRUE);
2907 gtk_tree_model_filter_real_unref_node (GtkTreeModel *model,
2909 gboolean propagate_unref)
2911 GtkTreeModelFilter *filter = (GtkTreeModelFilter *)model;
2915 g_return_if_fail (GTK_IS_TREE_MODEL_FILTER (model));
2916 g_return_if_fail (filter->priv->child_model != NULL);
2917 g_return_if_fail (filter->priv->stamp == iter->stamp);
2919 if (propagate_unref)
2921 GtkTreeIter child_iter;
2922 gtk_tree_model_filter_convert_iter_to_child_iter (GTK_TREE_MODEL_FILTER (model), &child_iter, iter);
2923 gtk_tree_model_unref_node (filter->priv->child_model, &child_iter);
2926 level = iter->user_data;
2927 elt = iter->user_data2;
2929 g_return_if_fail (elt->ref_count > 0);
2933 if (level->ref_count == 0)
2935 FilterLevel *parent_level = level->parent_level;
2936 gint parent_elt_index = level->parent_elt_index;
2938 /* we are at zero -- time to increase the zero_ref_count val */
2939 while (parent_level)
2941 g_array_index (parent_level->array, FilterElt, parent_elt_index).zero_ref_count++;
2943 parent_elt_index = parent_level->parent_elt_index;
2944 parent_level = parent_level->parent_level;
2947 if (filter->priv->root != level)
2948 filter->priv->zero_ref_count++;
2952 /* TreeDragSource interface implementation */
2954 gtk_tree_model_filter_row_draggable (GtkTreeDragSource *drag_source,
2957 GtkTreeModelFilter *tree_model_filter = (GtkTreeModelFilter *)drag_source;
2958 GtkTreePath *child_path;
2961 g_return_val_if_fail (GTK_IS_TREE_MODEL_FILTER (drag_source), FALSE);
2962 g_return_val_if_fail (path != NULL, FALSE);
2964 child_path = gtk_tree_model_filter_convert_path_to_child_path (tree_model_filter, path);
2965 draggable = gtk_tree_drag_source_row_draggable (GTK_TREE_DRAG_SOURCE (tree_model_filter->priv->child_model), child_path);
2966 gtk_tree_path_free (child_path);
2972 gtk_tree_model_filter_drag_data_get (GtkTreeDragSource *drag_source,
2974 GtkSelectionData *selection_data)
2976 GtkTreeModelFilter *tree_model_filter = (GtkTreeModelFilter *)drag_source;
2977 GtkTreePath *child_path;
2980 g_return_val_if_fail (GTK_IS_TREE_MODEL_FILTER (drag_source), FALSE);
2981 g_return_val_if_fail (path != NULL, FALSE);
2983 child_path = gtk_tree_model_filter_convert_path_to_child_path (tree_model_filter, path);
2984 gotten = gtk_tree_drag_source_drag_data_get (GTK_TREE_DRAG_SOURCE (tree_model_filter->priv->child_model), child_path, selection_data);
2985 gtk_tree_path_free (child_path);
2991 gtk_tree_model_filter_drag_data_delete (GtkTreeDragSource *drag_source,
2994 GtkTreeModelFilter *tree_model_filter = (GtkTreeModelFilter *)drag_source;
2995 GtkTreePath *child_path;
2998 g_return_val_if_fail (GTK_IS_TREE_MODEL_FILTER (drag_source), FALSE);
2999 g_return_val_if_fail (path != NULL, FALSE);
3001 child_path = gtk_tree_model_filter_convert_path_to_child_path (tree_model_filter, path);
3002 deleted = gtk_tree_drag_source_drag_data_delete (GTK_TREE_DRAG_SOURCE (tree_model_filter->priv->child_model), child_path);
3003 gtk_tree_path_free (child_path);
3008 /* bits and pieces */
3010 gtk_tree_model_filter_set_model (GtkTreeModelFilter *filter,
3011 GtkTreeModel *child_model)
3013 g_return_if_fail (GTK_IS_TREE_MODEL_FILTER (filter));
3015 if (filter->priv->child_model)
3017 g_signal_handler_disconnect (filter->priv->child_model,
3018 filter->priv->changed_id);
3019 g_signal_handler_disconnect (filter->priv->child_model,
3020 filter->priv->inserted_id);
3021 g_signal_handler_disconnect (filter->priv->child_model,
3022 filter->priv->has_child_toggled_id);
3023 g_signal_handler_disconnect (filter->priv->child_model,
3024 filter->priv->deleted_id);
3025 g_signal_handler_disconnect (filter->priv->child_model,
3026 filter->priv->reordered_id);
3028 /* reset our state */
3029 if (filter->priv->root)
3030 gtk_tree_model_filter_free_level (filter, filter->priv->root, TRUE);
3032 filter->priv->root = NULL;
3033 g_object_unref (filter->priv->child_model);
3034 filter->priv->visible_column = -1;
3036 /* FIXME: do we need to destroy more here? */
3039 filter->priv->child_model = child_model;
3043 g_object_ref (filter->priv->child_model);
3044 filter->priv->changed_id =
3045 g_signal_connect (child_model, "row-changed",
3046 G_CALLBACK (gtk_tree_model_filter_row_changed),
3048 filter->priv->inserted_id =
3049 g_signal_connect (child_model, "row-inserted",
3050 G_CALLBACK (gtk_tree_model_filter_row_inserted),
3052 filter->priv->has_child_toggled_id =
3053 g_signal_connect (child_model, "row-has-child-toggled",
3054 G_CALLBACK (gtk_tree_model_filter_row_has_child_toggled),
3056 filter->priv->deleted_id =
3057 g_signal_connect (child_model, "row-deleted",
3058 G_CALLBACK (gtk_tree_model_filter_row_deleted),
3060 filter->priv->reordered_id =
3061 g_signal_connect (child_model, "rows-reordered",
3062 G_CALLBACK (gtk_tree_model_filter_rows_reordered),
3065 filter->priv->child_flags = gtk_tree_model_get_flags (child_model);
3066 filter->priv->stamp = g_random_int ();
3071 gtk_tree_model_filter_ref_path (GtkTreeModelFilter *filter,
3077 len = gtk_tree_path_get_depth (path);
3078 p = gtk_tree_path_copy (path);
3083 gtk_tree_model_get_iter (GTK_TREE_MODEL (filter->priv->child_model), &iter, p);
3084 gtk_tree_model_ref_node (GTK_TREE_MODEL (filter->priv->child_model), &iter);
3085 gtk_tree_path_up (p);
3088 gtk_tree_path_free (p);
3092 gtk_tree_model_filter_unref_path (GtkTreeModelFilter *filter,
3102 len = gtk_tree_path_get_depth (path);
3104 p = gtk_tree_path_copy (path);
3109 gtk_tree_model_get_iter (GTK_TREE_MODEL (filter->priv->child_model), &iter, p);
3110 gtk_tree_model_unref_node (GTK_TREE_MODEL (filter->priv->child_model), &iter);
3111 gtk_tree_path_up (p);
3114 gtk_tree_path_free (p);
3118 gtk_tree_model_filter_set_root (GtkTreeModelFilter *filter,
3121 g_return_if_fail (GTK_IS_TREE_MODEL_FILTER (filter));
3124 filter->priv->virtual_root = NULL;
3126 filter->priv->virtual_root = gtk_tree_path_copy (root);
3132 * gtk_tree_model_filter_new:
3133 * @child_model: A #GtkTreeModel.
3134 * @root: (allow-none): A #GtkTreePath or %NULL.
3136 * Creates a new #GtkTreeModel, with @child_model as the child_model
3137 * and @root as the virtual root.
3139 * Return value: (transfer full): A new #GtkTreeModel.
3144 gtk_tree_model_filter_new (GtkTreeModel *child_model,
3147 GtkTreeModel *retval;
3148 GtkTreeModelFilter *filter;
3150 g_return_val_if_fail (GTK_IS_TREE_MODEL (child_model), NULL);
3152 retval = g_object_new (GTK_TYPE_TREE_MODEL_FILTER,
3153 "child-model", child_model,
3154 "virtual-root", root,
3157 filter = GTK_TREE_MODEL_FILTER (retval);
3158 if (filter->priv->virtual_root)
3160 gtk_tree_model_filter_ref_path (filter, filter->priv->virtual_root);
3161 filter->priv->virtual_root_deleted = FALSE;
3168 * gtk_tree_model_filter_get_model:
3169 * @filter: A #GtkTreeModelFilter.
3171 * Returns a pointer to the child model of @filter.
3173 * Return value: (transfer none): A pointer to a #GtkTreeModel.
3178 gtk_tree_model_filter_get_model (GtkTreeModelFilter *filter)
3180 g_return_val_if_fail (GTK_IS_TREE_MODEL_FILTER (filter), NULL);
3182 return filter->priv->child_model;
3186 * gtk_tree_model_filter_set_visible_func:
3187 * @filter: A #GtkTreeModelFilter.
3188 * @func: A #GtkTreeModelFilterVisibleFunc, the visible function.
3189 * @data: (allow-none): User data to pass to the visible function, or %NULL.
3190 * @destroy: (allow-none): Destroy notifier of @data, or %NULL.
3192 * Sets the visible function used when filtering the @filter to be @func. The
3193 * function should return %TRUE if the given row should be visible and
3196 * If the condition calculated by the function changes over time (e.g. because
3197 * it depends on some global parameters), you must call
3198 * gtk_tree_model_filter_refilter() to keep the visibility information of
3199 * the model uptodate.
3201 * Note that @func is called whenever a row is inserted, when it may still be
3202 * empty. The visible function should therefore take special care of empty
3203 * rows, like in the example below.
3205 * <informalexample><programlisting>
3207 * visible_func (GtkTreeModel *model,
3208 * GtkTreeIter *iter,
3211 * /* Visible if row is non-empty and first column is "HI" */
3213 * gboolean visible = FALSE;
3215 * gtk_tree_model_get (model, iter, 0, &str, -1);
3216 * if (str && strcmp (str, "HI") == 0)
3222 * </programlisting></informalexample>
3227 gtk_tree_model_filter_set_visible_func (GtkTreeModelFilter *filter,
3228 GtkTreeModelFilterVisibleFunc func,
3230 GDestroyNotify destroy)
3232 g_return_if_fail (GTK_IS_TREE_MODEL_FILTER (filter));
3233 g_return_if_fail (func != NULL);
3234 g_return_if_fail (filter->priv->visible_method_set == FALSE);
3236 filter->priv->visible_func = func;
3237 filter->priv->visible_data = data;
3238 filter->priv->visible_destroy = destroy;
3240 filter->priv->visible_method_set = TRUE;
3244 * gtk_tree_model_filter_set_modify_func:
3245 * @filter: A #GtkTreeModelFilter.
3246 * @n_columns: The number of columns in the filter model.
3247 * @types: (array length=n_columns): The #GType<!-- -->s of the columns.
3248 * @func: A #GtkTreeModelFilterModifyFunc
3249 * @data: (allow-none): User data to pass to the modify function, or %NULL.
3250 * @destroy: (allow-none): Destroy notifier of @data, or %NULL.
3252 * With the @n_columns and @types parameters, you give an array of column
3253 * types for this model (which will be exposed to the parent model/view).
3254 * The @func, @data and @destroy parameters are for specifying the modify
3255 * function. The modify function will get called for <emphasis>each</emphasis>
3256 * data access, the goal of the modify function is to return the data which
3257 * should be displayed at the location specified using the parameters of the
3263 gtk_tree_model_filter_set_modify_func (GtkTreeModelFilter *filter,
3266 GtkTreeModelFilterModifyFunc func,
3268 GDestroyNotify destroy)
3270 g_return_if_fail (GTK_IS_TREE_MODEL_FILTER (filter));
3271 g_return_if_fail (func != NULL);
3272 g_return_if_fail (filter->priv->modify_func_set == FALSE);
3274 if (filter->priv->modify_destroy)
3276 GDestroyNotify d = filter->priv->modify_destroy;
3278 filter->priv->modify_destroy = NULL;
3279 d (filter->priv->modify_data);
3282 filter->priv->modify_n_columns = n_columns;
3283 filter->priv->modify_types = g_new0 (GType, n_columns);
3284 memcpy (filter->priv->modify_types, types, sizeof (GType) * n_columns);
3285 filter->priv->modify_func = func;
3286 filter->priv->modify_data = data;
3287 filter->priv->modify_destroy = destroy;
3289 filter->priv->modify_func_set = TRUE;
3293 * gtk_tree_model_filter_set_visible_column:
3294 * @filter: A #GtkTreeModelFilter.
3295 * @column: A #gint which is the column containing the visible information.
3297 * Sets @column of the child_model to be the column where @filter should
3298 * look for visibility information. @columns should be a column of type
3299 * %G_TYPE_BOOLEAN, where %TRUE means that a row is visible, and %FALSE
3305 gtk_tree_model_filter_set_visible_column (GtkTreeModelFilter *filter,
3308 g_return_if_fail (GTK_IS_TREE_MODEL_FILTER (filter));
3309 g_return_if_fail (column >= 0);
3310 g_return_if_fail (filter->priv->visible_method_set == FALSE);
3312 filter->priv->visible_column = column;
3314 filter->priv->visible_method_set = TRUE;
3320 * gtk_tree_model_filter_convert_child_iter_to_iter:
3321 * @filter: A #GtkTreeModelFilter.
3322 * @filter_iter: (out): An uninitialized #GtkTreeIter.
3323 * @child_iter: A valid #GtkTreeIter pointing to a row on the child model.
3325 * Sets @filter_iter to point to the row in @filter that corresponds to the
3326 * row pointed at by @child_iter. If @filter_iter was not set, %FALSE is
3329 * Return value: %TRUE, if @filter_iter was set, i.e. if @child_iter is a
3330 * valid iterator pointing to a visible row in child model.
3335 gtk_tree_model_filter_convert_child_iter_to_iter (GtkTreeModelFilter *filter,
3336 GtkTreeIter *filter_iter,
3337 GtkTreeIter *child_iter)
3340 GtkTreePath *child_path, *path;
3342 g_return_val_if_fail (GTK_IS_TREE_MODEL_FILTER (filter), FALSE);
3343 g_return_val_if_fail (filter->priv->child_model != NULL, FALSE);
3344 g_return_val_if_fail (filter_iter != NULL, FALSE);
3345 g_return_val_if_fail (child_iter != NULL, FALSE);
3346 g_return_val_if_fail (filter_iter != child_iter, FALSE);
3348 filter_iter->stamp = 0;
3350 child_path = gtk_tree_model_get_path (filter->priv->child_model, child_iter);
3351 g_return_val_if_fail (child_path != NULL, FALSE);
3353 path = gtk_tree_model_filter_convert_child_path_to_path (filter,
3355 gtk_tree_path_free (child_path);
3360 ret = gtk_tree_model_get_iter (GTK_TREE_MODEL (filter), filter_iter, path);
3361 gtk_tree_path_free (path);
3367 * gtk_tree_model_filter_convert_iter_to_child_iter:
3368 * @filter: A #GtkTreeModelFilter.
3369 * @child_iter: (out): An uninitialized #GtkTreeIter.
3370 * @filter_iter: A valid #GtkTreeIter pointing to a row on @filter.
3372 * Sets @child_iter to point to the row pointed to by @filter_iter.
3377 gtk_tree_model_filter_convert_iter_to_child_iter (GtkTreeModelFilter *filter,
3378 GtkTreeIter *child_iter,
3379 GtkTreeIter *filter_iter)
3381 g_return_if_fail (GTK_IS_TREE_MODEL_FILTER (filter));
3382 g_return_if_fail (filter->priv->child_model != NULL);
3383 g_return_if_fail (child_iter != NULL);
3384 g_return_if_fail (filter_iter != NULL);
3385 g_return_if_fail (filter_iter->stamp == filter->priv->stamp);
3386 g_return_if_fail (filter_iter != child_iter);
3388 if (GTK_TREE_MODEL_FILTER_CACHE_CHILD_ITERS (filter))
3390 *child_iter = FILTER_ELT (filter_iter->user_data2)->iter;
3395 gboolean valid = FALSE;
3397 path = gtk_tree_model_filter_elt_get_path (filter_iter->user_data,
3398 filter_iter->user_data2,
3399 filter->priv->virtual_root);
3400 valid = gtk_tree_model_get_iter (filter->priv->child_model, child_iter,
3402 gtk_tree_path_free (path);
3404 g_return_if_fail (valid == TRUE);
3408 /* The path returned can only be used internally in the filter model. */
3409 static GtkTreePath *
3410 gtk_real_tree_model_filter_convert_child_path_to_path (GtkTreeModelFilter *filter,
3411 GtkTreePath *child_path,
3412 gboolean build_levels,
3413 gboolean fetch_children)
3415 gint *child_indices;
3416 GtkTreePath *retval;
3417 GtkTreePath *real_path;
3422 g_return_val_if_fail (GTK_IS_TREE_MODEL_FILTER (filter), NULL);
3423 g_return_val_if_fail (filter->priv->child_model != NULL, NULL);
3424 g_return_val_if_fail (child_path != NULL, NULL);
3426 if (!filter->priv->virtual_root)
3427 real_path = gtk_tree_path_copy (child_path);
3429 real_path = gtk_tree_model_filter_remove_root (child_path,
3430 filter->priv->virtual_root);
3435 retval = gtk_tree_path_new ();
3436 child_indices = gtk_tree_path_get_indices (real_path);
3438 if (filter->priv->root == NULL && build_levels)
3439 gtk_tree_model_filter_build_level (filter, NULL, -1, FALSE);
3440 level = FILTER_LEVEL (filter->priv->root);
3442 for (i = 0; i < gtk_tree_path_get_depth (real_path); i++)
3445 gboolean found_child = FALSE;
3449 gtk_tree_path_free (real_path);
3450 gtk_tree_path_free (retval);
3454 tmp = bsearch_elt_with_offset (level->array, child_indices[i], &j);
3457 gtk_tree_path_append_index (retval, j);
3458 if (!tmp->children && build_levels)
3459 gtk_tree_model_filter_build_level (filter, level,
3460 FILTER_LEVEL_ELT_INDEX (level, tmp),
3462 level = tmp->children;
3466 if (!found_child && fetch_children)
3468 tmp = gtk_tree_model_filter_fetch_child (filter, level,
3472 /* didn't find the child, let's try to bring it back */
3473 if (!tmp || tmp->offset != child_indices[i])
3476 gtk_tree_path_free (real_path);
3477 gtk_tree_path_free (retval);
3481 gtk_tree_path_append_index (retval, j);
3482 if (!tmp->children && build_levels)
3483 gtk_tree_model_filter_build_level (filter, level,
3484 FILTER_LEVEL_ELT_INDEX (level, tmp),
3486 level = tmp->children;
3489 else if (!found_child && !fetch_children)
3492 gtk_tree_path_free (real_path);
3493 gtk_tree_path_free (retval);
3498 gtk_tree_path_free (real_path);
3503 * gtk_tree_model_filter_convert_child_path_to_path:
3504 * @filter: A #GtkTreeModelFilter.
3505 * @child_path: A #GtkTreePath to convert.
3507 * Converts @child_path to a path relative to @filter. That is, @child_path
3508 * points to a path in the child model. The rerturned path will point to the
3509 * same row in the filtered model. If @child_path isn't a valid path on the
3510 * child model or points to a row which is not visible in @filter, then %NULL
3513 * Return value: A newly allocated #GtkTreePath, or %NULL.
3518 gtk_tree_model_filter_convert_child_path_to_path (GtkTreeModelFilter *filter,
3519 GtkTreePath *child_path)
3524 /* this function does the sanity checks */
3525 path = gtk_real_tree_model_filter_convert_child_path_to_path (filter,
3533 /* get a new path which only takes visible nodes into account.
3534 * -- if this gives any performance issues, we can write a special
3535 * version of convert_child_path_to_path immediately returning
3536 * a visible-nodes-only path.
3538 gtk_tree_model_filter_get_iter_full (GTK_TREE_MODEL (filter), &iter, path);
3540 gtk_tree_path_free (path);
3541 path = gtk_tree_model_get_path (GTK_TREE_MODEL (filter), &iter);
3547 * gtk_tree_model_filter_convert_path_to_child_path:
3548 * @filter: A #GtkTreeModelFilter.
3549 * @filter_path: A #GtkTreePath to convert.
3551 * Converts @filter_path to a path on the child model of @filter. That is,
3552 * @filter_path points to a location in @filter. The returned path will
3553 * point to the same location in the model not being filtered. If @filter_path
3554 * does not point to a location in the child model, %NULL is returned.
3556 * Return value: A newly allocated #GtkTreePath, or %NULL.
3561 gtk_tree_model_filter_convert_path_to_child_path (GtkTreeModelFilter *filter,
3562 GtkTreePath *filter_path)
3564 gint *filter_indices;
3565 GtkTreePath *retval;
3569 g_return_val_if_fail (GTK_IS_TREE_MODEL_FILTER (filter), NULL);
3570 g_return_val_if_fail (filter->priv->child_model != NULL, NULL);
3571 g_return_val_if_fail (filter_path != NULL, NULL);
3574 retval = gtk_tree_path_new ();
3575 filter_indices = gtk_tree_path_get_indices (filter_path);
3576 if (!filter->priv->root)
3577 gtk_tree_model_filter_build_level (filter, NULL, -1, FALSE);
3578 level = FILTER_LEVEL (filter->priv->root);
3580 for (i = 0; i < gtk_tree_path_get_depth (filter_path); i++)
3584 if (!level || level->visible_nodes <= filter_indices[i])
3586 gtk_tree_path_free (retval);
3590 elt = gtk_tree_model_filter_get_nth_visible (filter, level,
3593 if (elt->children == NULL)
3594 gtk_tree_model_filter_build_level (filter, level,
3595 FILTER_LEVEL_ELT_INDEX (level, elt),
3598 if (!level || level->visible_nodes <= filter_indices[i])
3600 gtk_tree_path_free (retval);
3604 gtk_tree_path_append_index (retval, elt->offset);
3605 level = elt->children;
3610 if (filter->priv->virtual_root)
3612 GtkTreePath *real_retval;
3614 real_retval = gtk_tree_model_filter_add_root (retval,
3615 filter->priv->virtual_root);
3616 gtk_tree_path_free (retval);
3625 gtk_tree_model_filter_refilter_helper (GtkTreeModel *model,
3630 /* evil, don't try this at home, but certainly speeds things up */
3631 gtk_tree_model_filter_row_changed (model, path, iter, data);
3637 * gtk_tree_model_filter_refilter:
3638 * @filter: A #GtkTreeModelFilter.
3640 * Emits ::row_changed for each row in the child model, which causes
3641 * the filter to re-evaluate whether a row is visible or not.
3646 gtk_tree_model_filter_refilter (GtkTreeModelFilter *filter)
3648 g_return_if_fail (GTK_IS_TREE_MODEL_FILTER (filter));
3651 gtk_tree_model_foreach (filter->priv->child_model,
3652 gtk_tree_model_filter_refilter_helper,
3657 * gtk_tree_model_filter_clear_cache:
3658 * @filter: A #GtkTreeModelFilter.
3660 * This function should almost never be called. It clears the @filter
3661 * of any cached iterators that haven't been reffed with
3662 * gtk_tree_model_ref_node(). This might be useful if the child model
3663 * being filtered is static (and doesn't change often) and there has been
3664 * a lot of unreffed access to nodes. As a side effect of this function,
3665 * all unreffed iters will be invalid.
3670 gtk_tree_model_filter_clear_cache (GtkTreeModelFilter *filter)
3672 g_return_if_fail (GTK_IS_TREE_MODEL_FILTER (filter));
3674 if (filter->priv->zero_ref_count > 0)
3675 gtk_tree_model_filter_clear_cache_helper (filter,
3676 FILTER_LEVEL (filter->priv->root));