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"
31 * iter->stamp = filter->priv->stamp
32 * iter->user_data = FilterLevel
33 * iter->user_data2 = FilterElt
36 /* all paths, iters, etc prefixed with c_ are paths, iters, etc relative to the
41 * There are three model/views involved, so there are two mappings:
42 * * this model -> child model: mapped via offset in FilterElt.
43 * * this model -> parent model (or view): mapped via the array index
46 * Note that there are two kinds of paths relative to the filter model
47 * (those generated from the array indices): paths taking non-visible
48 * nodes into account, and paths which don't. Paths which take
49 * non-visible nodes into account should only be used internally and
50 * NEVER be passed along with a signal emission.
52 * The filter model has a reference on every node that is not in the root
53 * level and has a parent with ref_count > 1. Exception is a virtual root
54 * level; all nodes in the virtual root level are referenced too.
57 typedef struct _FilterElt FilterElt;
58 typedef struct _FilterLevel FilterLevel;
63 FilterLevel *children;
76 FilterElt *parent_elt;
77 FilterLevel *parent_level;
80 #define GTK_TREE_MODEL_FILTER_GET_PRIVATE(obj) (G_TYPE_INSTANCE_GET_PRIVATE ((obj), GTK_TYPE_TREE_MODEL_FILTER, GtkTreeModelFilterPrivate))
82 struct _GtkTreeModelFilterPrivate
87 GtkTreeModel *child_model;
90 GtkTreePath *virtual_root;
92 GtkTreeModelFilterVisibleFunc visible_func;
93 gpointer visible_data;
94 GDestroyNotify visible_destroy;
96 gint modify_n_columns;
98 GtkTreeModelFilterModifyFunc modify_func;
100 GDestroyNotify modify_destroy;
104 gboolean visible_method_set;
105 gboolean modify_func_set;
107 gboolean in_row_deleted;
108 gboolean virtual_root_deleted;
113 guint has_child_toggled_id;
126 #define GTK_TREE_MODEL_FILTER_CACHE_CHILD_ITERS(filter) \
127 (((GtkTreeModelFilter *)filter)->priv->child_flags & GTK_TREE_MODEL_ITERS_PERSIST)
129 #define FILTER_ELT(filter_elt) ((FilterElt *)filter_elt)
130 #define FILTER_LEVEL(filter_level) ((FilterLevel *)filter_level)
132 /* general code (object/interface init, properties, etc) */
133 static void gtk_tree_model_filter_tree_model_init (GtkTreeModelIface *iface);
134 static void gtk_tree_model_filter_drag_source_init (GtkTreeDragSourceIface *iface);
135 static void gtk_tree_model_filter_finalize (GObject *object);
136 static void gtk_tree_model_filter_set_property (GObject *object,
140 static void gtk_tree_model_filter_get_property (GObject *object,
145 /* signal handlers */
146 static void gtk_tree_model_filter_row_changed (GtkTreeModel *c_model,
150 static void gtk_tree_model_filter_row_inserted (GtkTreeModel *c_model,
154 static void gtk_tree_model_filter_row_has_child_toggled (GtkTreeModel *c_model,
158 static void gtk_tree_model_filter_row_deleted (GtkTreeModel *c_model,
161 static void gtk_tree_model_filter_rows_reordered (GtkTreeModel *c_model,
167 /* GtkTreeModel interface */
168 static GtkTreeModelFlags gtk_tree_model_filter_get_flags (GtkTreeModel *model);
169 static gint gtk_tree_model_filter_get_n_columns (GtkTreeModel *model);
170 static GType gtk_tree_model_filter_get_column_type (GtkTreeModel *model,
172 static gboolean gtk_tree_model_filter_get_iter_full (GtkTreeModel *model,
175 static gboolean gtk_tree_model_filter_get_iter (GtkTreeModel *model,
178 static GtkTreePath *gtk_tree_model_filter_get_path (GtkTreeModel *model,
180 static void gtk_tree_model_filter_get_value (GtkTreeModel *model,
184 static gboolean gtk_tree_model_filter_iter_next (GtkTreeModel *model,
186 static gboolean gtk_tree_model_filter_iter_children (GtkTreeModel *model,
188 GtkTreeIter *parent);
189 static gboolean gtk_tree_model_filter_iter_has_child (GtkTreeModel *model,
191 static gint gtk_tree_model_filter_iter_n_children (GtkTreeModel *model,
193 static gboolean gtk_tree_model_filter_iter_nth_child (GtkTreeModel *model,
197 static gboolean gtk_tree_model_filter_iter_parent (GtkTreeModel *model,
200 static void gtk_tree_model_filter_ref_node (GtkTreeModel *model,
202 static void gtk_tree_model_filter_unref_node (GtkTreeModel *model,
205 /* TreeDragSource interface */
206 static gboolean gtk_tree_model_filter_row_draggable (GtkTreeDragSource *drag_source,
208 static gboolean gtk_tree_model_filter_drag_data_get (GtkTreeDragSource *drag_source,
210 GtkSelectionData *selection_data);
211 static gboolean gtk_tree_model_filter_drag_data_delete (GtkTreeDragSource *drag_source,
214 /* private functions */
215 static void gtk_tree_model_filter_build_level (GtkTreeModelFilter *filter,
216 FilterLevel *parent_level,
217 FilterElt *parent_elt,
218 gboolean emit_inserted);
220 static void gtk_tree_model_filter_free_level (GtkTreeModelFilter *filter,
221 FilterLevel *filter_level);
223 static GtkTreePath *gtk_tree_model_filter_elt_get_path (FilterLevel *level,
227 static GtkTreePath *gtk_tree_model_filter_add_root (GtkTreePath *src,
229 static GtkTreePath *gtk_tree_model_filter_remove_root (GtkTreePath *src,
232 static void gtk_tree_model_filter_increment_stamp (GtkTreeModelFilter *filter);
234 static gboolean gtk_tree_model_filter_visible (GtkTreeModelFilter *filter,
235 GtkTreeIter *child_iter);
236 static void gtk_tree_model_filter_clear_cache_helper (GtkTreeModelFilter *filter,
239 static void gtk_tree_model_filter_real_unref_node (GtkTreeModel *model,
241 gboolean propagate_unref);
243 static void gtk_tree_model_filter_set_model (GtkTreeModelFilter *filter,
244 GtkTreeModel *child_model);
245 static void gtk_tree_model_filter_ref_path (GtkTreeModelFilter *filter,
247 static void gtk_tree_model_filter_unref_path (GtkTreeModelFilter *filter,
249 static void gtk_tree_model_filter_set_root (GtkTreeModelFilter *filter,
252 static GtkTreePath *gtk_real_tree_model_filter_convert_child_path_to_path (GtkTreeModelFilter *filter,
253 GtkTreePath *child_path,
254 gboolean build_levels,
255 gboolean fetch_children);
257 static FilterElt *gtk_tree_model_filter_get_nth (GtkTreeModelFilter *filter,
260 static FilterElt *gtk_tree_model_filter_get_nth_visible (GtkTreeModelFilter *filter,
264 static FilterElt *gtk_tree_model_filter_fetch_child (GtkTreeModelFilter *filter,
268 static void gtk_tree_model_filter_remove_node (GtkTreeModelFilter *filter,
270 static void gtk_tree_model_filter_update_children (GtkTreeModelFilter *filter,
273 static FilterElt *bsearch_elt_with_offset (GArray *array,
278 G_DEFINE_TYPE_WITH_CODE (GtkTreeModelFilter, gtk_tree_model_filter, G_TYPE_OBJECT,
279 G_IMPLEMENT_INTERFACE (GTK_TYPE_TREE_MODEL,
280 gtk_tree_model_filter_tree_model_init)
281 G_IMPLEMENT_INTERFACE (GTK_TYPE_TREE_DRAG_SOURCE,
282 gtk_tree_model_filter_drag_source_init))
285 gtk_tree_model_filter_init (GtkTreeModelFilter *filter)
287 filter->priv = GTK_TREE_MODEL_FILTER_GET_PRIVATE (filter);
289 filter->priv->visible_column = -1;
290 filter->priv->zero_ref_count = 0;
291 filter->priv->visible_method_set = FALSE;
292 filter->priv->modify_func_set = FALSE;
293 filter->priv->in_row_deleted = FALSE;
294 filter->priv->virtual_root_deleted = FALSE;
298 gtk_tree_model_filter_class_init (GtkTreeModelFilterClass *filter_class)
300 GObjectClass *object_class;
302 object_class = (GObjectClass *) filter_class;
304 object_class->set_property = gtk_tree_model_filter_set_property;
305 object_class->get_property = gtk_tree_model_filter_get_property;
307 object_class->finalize = gtk_tree_model_filter_finalize;
309 /* Properties -- FIXME: disabled translations for now, until I can come up with a
312 g_object_class_install_property (object_class,
314 g_param_spec_object ("child-model",
316 ("The model for the filtermodel to filter"),
318 GTK_PARAM_READWRITE | G_PARAM_CONSTRUCT_ONLY));
320 g_object_class_install_property (object_class,
322 g_param_spec_boxed ("virtual-root",
323 ("The virtual root"),
324 ("The virtual root (relative to the child model) for this filtermodel"),
326 GTK_PARAM_READWRITE | G_PARAM_CONSTRUCT_ONLY));
328 g_type_class_add_private (object_class, sizeof (GtkTreeModelFilterPrivate));
332 gtk_tree_model_filter_tree_model_init (GtkTreeModelIface *iface)
334 iface->get_flags = gtk_tree_model_filter_get_flags;
335 iface->get_n_columns = gtk_tree_model_filter_get_n_columns;
336 iface->get_column_type = gtk_tree_model_filter_get_column_type;
337 iface->get_iter = gtk_tree_model_filter_get_iter;
338 iface->get_path = gtk_tree_model_filter_get_path;
339 iface->get_value = gtk_tree_model_filter_get_value;
340 iface->iter_next = gtk_tree_model_filter_iter_next;
341 iface->iter_children = gtk_tree_model_filter_iter_children;
342 iface->iter_has_child = gtk_tree_model_filter_iter_has_child;
343 iface->iter_n_children = gtk_tree_model_filter_iter_n_children;
344 iface->iter_nth_child = gtk_tree_model_filter_iter_nth_child;
345 iface->iter_parent = gtk_tree_model_filter_iter_parent;
346 iface->ref_node = gtk_tree_model_filter_ref_node;
347 iface->unref_node = gtk_tree_model_filter_unref_node;
351 gtk_tree_model_filter_drag_source_init (GtkTreeDragSourceIface *iface)
353 iface->row_draggable = gtk_tree_model_filter_row_draggable;
354 iface->drag_data_delete = gtk_tree_model_filter_drag_data_delete;
355 iface->drag_data_get = gtk_tree_model_filter_drag_data_get;
360 gtk_tree_model_filter_finalize (GObject *object)
362 GtkTreeModelFilter *filter = (GtkTreeModelFilter *) object;
364 if (filter->priv->virtual_root && !filter->priv->virtual_root_deleted)
366 gtk_tree_model_filter_unref_path (filter, filter->priv->virtual_root);
367 filter->priv->virtual_root_deleted = TRUE;
370 gtk_tree_model_filter_set_model (filter, NULL);
372 if (filter->priv->virtual_root)
373 gtk_tree_path_free (filter->priv->virtual_root);
375 if (filter->priv->root)
376 gtk_tree_model_filter_free_level (filter, filter->priv->root);
378 g_free (filter->priv->modify_types);
380 if (filter->priv->modify_destroy)
381 filter->priv->modify_destroy (filter->priv->modify_data);
383 if (filter->priv->visible_destroy)
384 filter->priv->visible_destroy (filter->priv->visible_data);
387 G_OBJECT_CLASS (gtk_tree_model_filter_parent_class)->finalize (object);
391 gtk_tree_model_filter_set_property (GObject *object,
396 GtkTreeModelFilter *filter = GTK_TREE_MODEL_FILTER (object);
400 case PROP_CHILD_MODEL:
401 gtk_tree_model_filter_set_model (filter, g_value_get_object (value));
403 case PROP_VIRTUAL_ROOT:
404 gtk_tree_model_filter_set_root (filter, g_value_get_boxed (value));
407 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
413 gtk_tree_model_filter_get_property (GObject *object,
418 GtkTreeModelFilter *filter = GTK_TREE_MODEL_FILTER (object);
422 case PROP_CHILD_MODEL:
423 g_value_set_object (value, filter->priv->child_model);
425 case PROP_VIRTUAL_ROOT:
426 g_value_set_boxed (value, filter->priv->virtual_root);
429 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
437 gtk_tree_model_filter_build_level (GtkTreeModelFilter *filter,
438 FilterLevel *parent_level,
439 FilterElt *parent_elt,
440 gboolean emit_inserted)
443 GtkTreeIter first_node;
445 FilterLevel *new_level;
449 g_assert (filter->priv->child_model != NULL);
451 if (filter->priv->in_row_deleted)
456 if (filter->priv->virtual_root)
458 if (gtk_tree_model_get_iter (filter->priv->child_model, &root, filter->priv->virtual_root) == FALSE)
460 length = gtk_tree_model_iter_n_children (filter->priv->child_model, &root);
462 if (gtk_tree_model_iter_children (filter->priv->child_model, &iter, &root) == FALSE)
467 if (!gtk_tree_model_get_iter_first (filter->priv->child_model, &iter))
469 length = gtk_tree_model_iter_n_children (filter->priv->child_model, NULL);
474 GtkTreeIter parent_iter;
475 GtkTreeIter child_parent_iter;
477 parent_iter.stamp = filter->priv->stamp;
478 parent_iter.user_data = parent_level;
479 parent_iter.user_data2 = parent_elt;
481 gtk_tree_model_filter_convert_iter_to_child_iter (filter,
484 if (gtk_tree_model_iter_children (filter->priv->child_model, &iter, &child_parent_iter) == FALSE)
487 /* stamp may have changed */
488 gtk_tree_model_filter_convert_iter_to_child_iter (filter,
491 length = gtk_tree_model_iter_n_children (filter->priv->child_model, &child_parent_iter);
494 g_return_if_fail (length > 0);
496 new_level = g_new (FilterLevel, 1);
497 new_level->array = g_array_sized_new (FALSE, FALSE,
500 new_level->ref_count = 0;
501 new_level->visible_nodes = 0;
502 new_level->parent_elt = parent_elt;
503 new_level->parent_level = parent_level;
506 parent_elt->children = new_level;
508 filter->priv->root = new_level;
510 /* increase the count of zero ref_counts */
513 parent_elt->zero_ref_count++;
515 parent_elt = parent_level->parent_elt;
516 parent_level = parent_level->parent_level;
518 if (new_level != filter->priv->root)
519 filter->priv->zero_ref_count++;
527 if (gtk_tree_model_filter_visible (filter, &iter))
529 FilterElt filter_elt;
531 filter_elt.offset = i;
532 filter_elt.zero_ref_count = 0;
533 filter_elt.ref_count = 0;
534 filter_elt.children = NULL;
535 filter_elt.visible = TRUE;
537 if (GTK_TREE_MODEL_FILTER_CACHE_CHILD_ITERS (filter))
538 filter_elt.iter = iter;
540 g_array_append_val (new_level->array, filter_elt);
541 new_level->visible_nodes++;
543 if (new_level->parent_level || filter->priv->virtual_root)
547 f_iter.stamp = filter->priv->stamp;
548 f_iter.user_data = new_level;
549 f_iter.user_data2 = &(g_array_index (new_level->array, FilterElt, new_level->array->len - 1));
551 gtk_tree_model_filter_ref_node (GTK_TREE_MODEL (filter), &f_iter);
557 f_path = gtk_tree_model_get_path (GTK_TREE_MODEL (filter),
559 gtk_tree_model_row_inserted (GTK_TREE_MODEL (filter),
561 gtk_tree_path_free (f_path);
567 while (gtk_tree_model_iter_next (filter->priv->child_model, &iter));
569 if (new_level->array->len == 0
570 && (new_level != filter->priv->root || filter->priv->virtual_root))
572 /* If none of the nodes are visible, we will just pull in the
573 * first node of the level and keep a reference on it. We need this
574 * to make sure that we get all signals for this level.
576 FilterElt filter_elt;
579 filter_elt.offset = 0;
580 filter_elt.zero_ref_count = 0;
581 filter_elt.ref_count = 0;
582 filter_elt.children = NULL;
583 filter_elt.visible = FALSE;
585 if (GTK_TREE_MODEL_FILTER_CACHE_CHILD_ITERS (filter))
586 filter_elt.iter = first_node;
588 g_array_append_val (new_level->array, filter_elt);
590 f_iter.stamp = filter->priv->stamp;
591 f_iter.user_data = new_level;
592 f_iter.user_data2 = &(g_array_index (new_level->array, FilterElt, new_level->array->len - 1));
594 gtk_tree_model_filter_ref_node (GTK_TREE_MODEL (filter), &f_iter);
596 else if (new_level->array->len == 0)
597 gtk_tree_model_filter_free_level (filter, new_level);
601 gtk_tree_model_filter_free_level (GtkTreeModelFilter *filter,
602 FilterLevel *filter_level)
606 g_assert (filter_level);
608 for (i = 0; i < filter_level->array->len; i++)
610 if (g_array_index (filter_level->array, FilterElt, i).children)
611 gtk_tree_model_filter_free_level (filter,
612 FILTER_LEVEL (g_array_index (filter_level->array, FilterElt, i).children));
614 if (filter_level->parent_level || filter->priv->virtual_root)
618 f_iter.stamp = filter->priv->stamp;
619 f_iter.user_data = filter_level;
620 f_iter.user_data2 = &(g_array_index (filter_level->array, FilterElt, i));
622 gtk_tree_model_filter_unref_node (GTK_TREE_MODEL (filter), &f_iter);
626 if (filter_level->ref_count == 0)
628 FilterLevel *parent_level = filter_level->parent_level;
629 FilterElt *parent_elt = filter_level->parent_elt;
633 parent_elt->zero_ref_count--;
635 parent_elt = parent_level->parent_elt;
636 parent_level = parent_level->parent_level;
639 if (filter_level != filter->priv->root)
640 filter->priv->zero_ref_count--;
643 if (filter_level->parent_elt)
644 filter_level->parent_elt->children = NULL;
646 filter->priv->root = NULL;
648 g_array_free (filter_level->array, TRUE);
649 filter_level->array = NULL;
651 g_free (filter_level);
655 /* Creates paths suitable for accessing the child model. */
657 gtk_tree_model_filter_elt_get_path (FilterLevel *level,
661 FilterLevel *walker = level;
662 FilterElt *walker2 = elt;
664 GtkTreePath *real_path;
666 g_return_val_if_fail (level != NULL, NULL);
667 g_return_val_if_fail (elt != NULL, NULL);
669 path = gtk_tree_path_new ();
673 gtk_tree_path_prepend_index (path, walker2->offset);
675 walker2 = walker->parent_elt;
676 walker = walker->parent_level;
681 real_path = gtk_tree_model_filter_add_root (path, root);
682 gtk_tree_path_free (path);
690 gtk_tree_model_filter_add_root (GtkTreePath *src,
696 retval = gtk_tree_path_copy (root);
698 for (i = 0; i < gtk_tree_path_get_depth (src); i++)
699 gtk_tree_path_append_index (retval, gtk_tree_path_get_indices (src)[i]);
705 gtk_tree_model_filter_remove_root (GtkTreePath *src,
713 if (gtk_tree_path_get_depth (src) <= gtk_tree_path_get_depth (root))
716 depth = gtk_tree_path_get_depth (src);
717 indices = gtk_tree_path_get_indices (src);
719 for (i = 0; i < gtk_tree_path_get_depth (root); i++)
720 if (indices[i] != gtk_tree_path_get_indices (root)[i])
723 retval = gtk_tree_path_new ();
725 for (; i < depth; i++)
726 gtk_tree_path_append_index (retval, indices[i]);
732 gtk_tree_model_filter_increment_stamp (GtkTreeModelFilter *filter)
736 filter->priv->stamp++;
738 while (filter->priv->stamp == 0);
740 gtk_tree_model_filter_clear_cache (filter);
744 gtk_tree_model_filter_visible (GtkTreeModelFilter *filter,
745 GtkTreeIter *child_iter)
747 if (filter->priv->visible_func)
749 return filter->priv->visible_func (filter->priv->child_model,
751 filter->priv->visible_data)
754 else if (filter->priv->visible_column >= 0)
758 gtk_tree_model_get_value (filter->priv->child_model, child_iter,
759 filter->priv->visible_column, &val);
761 if (g_value_get_boolean (&val))
763 g_value_unset (&val);
767 g_value_unset (&val);
771 /* no visible function set, so always visible */
776 gtk_tree_model_filter_clear_cache_helper (GtkTreeModelFilter *filter,
783 for (i = 0; i < level->array->len; i++)
785 if (g_array_index (level->array, FilterElt, i).zero_ref_count > 0)
786 gtk_tree_model_filter_clear_cache_helper (filter, g_array_index (level->array, FilterElt, i).children);
789 if (level->ref_count == 0 && level != filter->priv->root)
791 gtk_tree_model_filter_free_level (filter, level);
797 gtk_tree_model_filter_get_nth (GtkTreeModelFilter *filter,
801 if (level->array->len <= n)
804 return &g_array_index (level->array, FilterElt, n);
808 gtk_tree_model_filter_get_nth_visible (GtkTreeModelFilter *filter,
815 if (level->visible_nodes <= n)
818 elt = FILTER_ELT (level->array->data);
819 while (!elt->visible)
829 while (!elt->visible)
836 gtk_tree_model_filter_fetch_child (GtkTreeModelFilter *filter,
842 gint start, middle, end;
844 GtkTreePath *c_path = NULL;
846 GtkTreePath *c_parent_path = NULL;
847 GtkTreeIter c_parent_iter;
850 /* check if child exists and is visible */
851 if (level->parent_elt)
854 gtk_tree_model_filter_elt_get_path (level->parent_level,
856 filter->priv->virtual_root);
862 if (filter->priv->virtual_root)
863 c_parent_path = gtk_tree_path_copy (filter->priv->virtual_root);
865 c_parent_path = NULL;
870 gtk_tree_model_get_iter (filter->priv->child_model,
873 len = gtk_tree_model_iter_n_children (filter->priv->child_model,
876 c_path = gtk_tree_path_copy (c_parent_path);
877 gtk_tree_path_free (c_parent_path);
881 len = gtk_tree_model_iter_n_children (filter->priv->child_model, NULL);
882 c_path = gtk_tree_path_new ();
885 gtk_tree_path_append_index (c_path, offset);
886 gtk_tree_model_get_iter (filter->priv->child_model, &c_iter, c_path);
887 gtk_tree_path_free (c_path);
889 if (offset >= len || !gtk_tree_model_filter_visible (filter, &c_iter))
894 elt.zero_ref_count = 0;
897 /* visibility should be FALSE as we don't emit row_inserted */
900 if (GTK_TREE_MODEL_FILTER_CACHE_CHILD_ITERS (filter))
903 /* find index (binary search on offset) */
905 end = level->array->len;
911 middle = (start + end) / 2;
913 if (g_array_index (level->array, FilterElt, middle).offset <= offset)
919 if (g_array_index (level->array, FilterElt, middle).offset <= offset)
927 g_array_insert_val (level->array, i, elt);
930 for (i = 0; i < level->array->len; i++)
932 FilterElt *e = &(g_array_index (level->array, FilterElt, i));
934 e->children->parent_elt = e;
937 c_iter.stamp = filter->priv->stamp;
938 c_iter.user_data = level;
939 c_iter.user_data2 = &g_array_index (level->array, FilterElt, *index);
941 if (level->parent_level || filter->priv->virtual_root)
942 gtk_tree_model_filter_ref_node (GTK_TREE_MODEL (filter), &c_iter);
944 return &g_array_index (level->array, FilterElt, *index);
948 gtk_tree_model_filter_remove_node (GtkTreeModelFilter *filter,
951 FilterElt *elt, *parent;
952 FilterLevel *level, *parent_level;
955 gboolean emit_child_toggled = FALSE;
957 level = FILTER_LEVEL (iter->user_data);
958 elt = FILTER_ELT (iter->user_data2);
960 parent = level->parent_elt;
961 parent_level = level->parent_level;
963 length = level->array->len;
965 /* we distinguish a couple of cases:
966 * - root level, length > 1: emit row-deleted and remove.
967 * - root level, length == 1: emit row-deleted and keep in cache.
968 * - level, length == 1: parent->ref_count > 1: emit row-deleted and keep.
969 * - level, length > 1: emit row-deleted and remove.
970 * - else, remove level.
972 * if level != root level and visible nodes == 0, emit row-has-child-toggled.
975 if (level != filter->priv->root && level->visible_nodes == 0)
976 emit_child_toggled = TRUE;
983 /* we emit row-deleted, and remove the node from the cache.
986 path = gtk_tree_model_get_path (GTK_TREE_MODEL (filter), iter);
987 elt->visible = FALSE;
988 gtk_tree_model_filter_increment_stamp (filter);
989 iter->stamp = filter->priv->stamp;
990 gtk_tree_model_row_deleted (GTK_TREE_MODEL (filter), path);
991 gtk_tree_path_free (path);
993 while (elt->ref_count > 1)
994 gtk_tree_model_filter_real_unref_node (GTK_TREE_MODEL (filter),
997 if (parent_level || filter->priv->virtual_root)
998 gtk_tree_model_filter_unref_node (GTK_TREE_MODEL (filter), iter);
999 else if (elt->ref_count > 0)
1000 gtk_tree_model_filter_real_unref_node (GTK_TREE_MODEL (filter),
1003 /* remove the node */
1004 tmp = bsearch_elt_with_offset (level->array, elt->offset, &i);
1008 g_array_remove_index (level->array, i);
1011 for (i = MAX (i, 0); i < level->array->len; i++)
1013 /* NOTE: here we do *not* decrease offsets, because the node was
1014 * not removed from the child model
1016 elt = &g_array_index (level->array, FilterElt, i);
1018 elt->children->parent_elt = elt;
1022 else if ((length == 1 && parent && parent->ref_count > 1)
1023 || (length == 1 && level == filter->priv->root))
1027 /* we emit row-deleted, but keep the node in the cache and
1031 path = gtk_tree_model_get_path (GTK_TREE_MODEL (filter), iter);
1032 elt->visible = FALSE;
1033 gtk_tree_model_filter_increment_stamp (filter);
1034 gtk_tree_model_row_deleted (GTK_TREE_MODEL (filter), path);
1035 gtk_tree_path_free (path);
1041 /* blow level away */
1043 path = gtk_tree_model_get_path (GTK_TREE_MODEL (filter), iter);
1044 elt->visible = FALSE;
1045 gtk_tree_model_filter_increment_stamp (filter);
1046 iter->stamp = filter->priv->stamp;
1047 gtk_tree_model_row_deleted (GTK_TREE_MODEL (filter), path);
1048 gtk_tree_path_free (path);
1050 while (elt->ref_count > 1)
1051 gtk_tree_model_filter_real_unref_node (GTK_TREE_MODEL (filter),
1054 gtk_tree_model_filter_free_level (filter, level);
1057 if (emit_child_toggled)
1062 piter.stamp = filter->priv->stamp;
1063 piter.user_data = parent_level;
1064 piter.user_data2 = parent;
1066 ppath = gtk_tree_model_get_path (GTK_TREE_MODEL (filter), &piter);
1068 gtk_tree_model_row_has_child_toggled (GTK_TREE_MODEL (filter),
1070 gtk_tree_path_free (ppath);
1075 gtk_tree_model_filter_update_children (GtkTreeModelFilter *filter,
1085 iter.stamp = filter->priv->stamp;
1086 iter.user_data = level;
1087 iter.user_data2 = elt;
1089 gtk_tree_model_filter_convert_iter_to_child_iter (filter, &c_iter, &iter);
1091 if (gtk_tree_model_iter_has_child (filter->priv->child_model, &c_iter))
1093 GtkTreePath *path = gtk_tree_model_get_path (GTK_TREE_MODEL (filter),
1095 gtk_tree_model_row_has_child_toggled (GTK_TREE_MODEL (filter),
1099 gtk_tree_path_free (path);
1104 bsearch_elt_with_offset (GArray *array,
1108 gint start, middle, end;
1119 elt = &g_array_index (array, FilterElt, 0);
1121 if (elt->offset == offset)
1132 middle = (start + end) / 2;
1134 elt = &g_array_index (array, FilterElt, middle);
1136 if (elt->offset < offset)
1138 else if (elt->offset > offset)
1143 while (start != end);
1145 if (elt->offset == offset)
1154 /* TreeModel signals */
1156 gtk_tree_model_filter_row_changed (GtkTreeModel *c_model,
1157 GtkTreePath *c_path,
1158 GtkTreeIter *c_iter,
1161 GtkTreeModelFilter *filter = GTK_TREE_MODEL_FILTER (data);
1163 GtkTreeIter children;
1164 GtkTreeIter real_c_iter;
1165 GtkTreePath *path = NULL;
1170 gboolean requested_state;
1171 gboolean current_state;
1172 gboolean free_c_path = FALSE;
1174 g_return_if_fail (c_path != NULL || c_iter != NULL);
1178 c_path = gtk_tree_model_get_path (c_model, c_iter);
1183 real_c_iter = *c_iter;
1185 gtk_tree_model_get_iter (c_model, &real_c_iter, c_path);
1187 /* is this node above the virtual root? */
1188 if (filter->priv->virtual_root
1189 && (gtk_tree_path_get_depth (filter->priv->virtual_root)
1190 >= gtk_tree_path_get_depth (c_path)))
1193 /* what's the requested state? */
1194 requested_state = gtk_tree_model_filter_visible (filter, &real_c_iter);
1196 /* now, let's see whether the item is there */
1197 path = gtk_real_tree_model_filter_convert_child_path_to_path (filter,
1204 gtk_tree_model_filter_get_iter_full (GTK_TREE_MODEL (filter),
1206 current_state = FILTER_ELT (iter.user_data2)->visible;
1209 current_state = FALSE;
1211 if (current_state == FALSE && requested_state == FALSE)
1212 /* no changes required */
1215 if (current_state == TRUE && requested_state == FALSE)
1217 /* get rid of this node */
1218 level = FILTER_LEVEL (iter.user_data);
1219 level->visible_nodes--;
1221 gtk_tree_model_filter_remove_node (filter, &iter);
1226 if (current_state == TRUE && requested_state == TRUE)
1228 /* propagate the signal; also get a path taking only visible
1229 * nodes into account.
1231 gtk_tree_path_free (path);
1232 path = gtk_tree_model_get_path (GTK_TREE_MODEL (filter), &iter);
1233 gtk_tree_model_row_changed (GTK_TREE_MODEL (filter), path, &iter);
1235 level = FILTER_LEVEL (iter.user_data);
1236 elt = FILTER_ELT (iter.user_data2);
1238 /* and update the children */
1239 if (gtk_tree_model_iter_children (c_model, &children, &real_c_iter))
1240 gtk_tree_model_filter_update_children (filter, level, elt);
1245 /* only current == FALSE and requested == TRUE is left,
1248 g_return_if_fail (current_state == FALSE && requested_state == TRUE);
1250 /* make sure the new item has been pulled in */
1251 if (!filter->priv->root)
1256 gtk_tree_model_filter_build_level (filter, NULL, NULL, FALSE);
1258 root = FILTER_LEVEL (filter->priv->root);
1262 for (i = 0; i < root->array->len; i++)
1263 g_array_index (root->array, FilterElt, i).visible = FALSE;
1264 root->visible_nodes = 0;
1268 gtk_tree_model_filter_increment_stamp (filter);
1271 path = gtk_real_tree_model_filter_convert_child_path_to_path (filter,
1277 /* parent is probably being filtered out */
1280 gtk_tree_model_filter_get_iter_full (GTK_TREE_MODEL (filter), &iter, path);
1282 level = FILTER_LEVEL (iter.user_data);
1283 elt = FILTER_ELT (iter.user_data2);
1285 /* elt->visible can be TRUE at this point if it was pulled in above */
1288 elt->visible = TRUE;
1289 level->visible_nodes++;
1292 if ((level->parent_elt && level->parent_elt->visible) || !level->parent_elt)
1294 /* visibility changed -- reget path */
1295 gtk_tree_path_free (path);
1296 path = gtk_tree_model_get_path (GTK_TREE_MODEL (filter), &iter);
1298 gtk_tree_model_row_inserted (GTK_TREE_MODEL (filter), path, &iter);
1300 if (gtk_tree_model_iter_children (c_model, &children, c_iter))
1301 gtk_tree_model_filter_update_children (filter, level, elt);
1306 gtk_tree_path_free (path);
1309 gtk_tree_path_free (c_path);
1313 gtk_tree_model_filter_row_inserted (GtkTreeModel *c_model,
1314 GtkTreePath *c_path,
1315 GtkTreeIter *c_iter,
1318 GtkTreeModelFilter *filter = GTK_TREE_MODEL_FILTER (data);
1319 GtkTreePath *path = NULL;
1320 GtkTreePath *real_path = NULL;
1323 GtkTreeIter real_c_iter;
1327 FilterLevel *parent_level;
1331 gboolean free_c_path = FALSE;
1333 g_return_if_fail (c_path != NULL || c_iter != NULL);
1337 c_path = gtk_tree_model_get_path (c_model, c_iter);
1342 real_c_iter = *c_iter;
1344 gtk_tree_model_get_iter (c_model, &real_c_iter, c_path);
1346 /* the row has already been inserted. so we need to fixup the
1347 * virtual root here first
1349 if (filter->priv->virtual_root)
1351 if (gtk_tree_path_get_depth (filter->priv->virtual_root) >=
1352 gtk_tree_path_get_depth (c_path))
1355 gint *v_indices, *c_indices;
1356 gboolean common_prefix = TRUE;
1358 level = gtk_tree_path_get_depth (c_path) - 1;
1359 v_indices = gtk_tree_path_get_indices (filter->priv->virtual_root);
1360 c_indices = gtk_tree_path_get_indices (c_path);
1362 for (i = 0; i < level; i++)
1363 if (v_indices[i] != c_indices[i])
1365 common_prefix = FALSE;
1369 if (common_prefix && v_indices[level] >= c_indices[level])
1370 (v_indices[level])++;
1374 if (!filter->priv->root)
1376 /* No point in building the level if this node is not visible. */
1377 if (!filter->priv->virtual_root
1378 && !gtk_tree_model_filter_visible (filter, c_iter))
1381 /* build level will pull in the new child */
1382 gtk_tree_model_filter_build_level (filter, NULL, NULL, FALSE);
1384 if (filter->priv->root
1385 && FILTER_LEVEL (filter->priv->root)->visible_nodes)
1391 parent_level = level = FILTER_LEVEL (filter->priv->root);
1393 /* subtract virtual root if necessary */
1394 if (filter->priv->virtual_root)
1396 real_path = gtk_tree_model_filter_remove_root (c_path,
1397 filter->priv->virtual_root);
1403 real_path = gtk_tree_path_copy (c_path);
1405 if (gtk_tree_path_get_depth (real_path) - 1 >= 1)
1407 /* find the parent level */
1408 while (i < gtk_tree_path_get_depth (real_path) - 1)
1413 /* we don't cover this signal */
1416 elt = bsearch_elt_with_offset (level->array,
1417 gtk_tree_path_get_indices (real_path)[i],
1421 /* parent is probably being filtered out */
1426 GtkTreePath *tmppath;
1427 GtkTreeIter tmpiter;
1429 tmpiter.stamp = filter->priv->stamp;
1430 tmpiter.user_data = level;
1431 tmpiter.user_data2 = elt;
1433 tmppath = gtk_tree_model_get_path (GTK_TREE_MODEL (data),
1438 gtk_tree_model_row_has_child_toggled (GTK_TREE_MODEL (data),
1440 gtk_tree_path_free (tmppath);
1443 /* not covering this signal */
1447 level = elt->children;
1448 parent_level = level;
1456 /* let's try to insert the value */
1457 offset = gtk_tree_path_get_indices (real_path)[gtk_tree_path_get_depth (real_path) - 1];
1459 /* update the offsets, yes if we didn't insert the node above, there will
1460 * be a gap here. This will be filled with the node (via fetch_child) when
1461 * it becomes visible
1463 for (i = 0; i < level->array->len; i++)
1465 FilterElt *e = &g_array_index (level->array, FilterElt, i);
1466 if ((e->offset >= offset))
1470 /* only insert when visible */
1471 if (gtk_tree_model_filter_visible (filter, &real_c_iter))
1475 if (GTK_TREE_MODEL_FILTER_CACHE_CHILD_ITERS (filter))
1476 felt.iter = real_c_iter;
1478 felt.offset = offset;
1479 felt.zero_ref_count = 0;
1481 felt.visible = TRUE;
1482 felt.children = NULL;
1484 for (i = 0; i < level->array->len; i++)
1485 if (g_array_index (level->array, FilterElt, i).offset > offset)
1488 level->visible_nodes++;
1490 g_array_insert_val (level->array, i, felt);
1492 if (level->parent_level || filter->priv->virtual_root)
1496 f_iter.stamp = filter->priv->stamp;
1497 f_iter.user_data = level;
1498 f_iter.user_data2 = &g_array_index (level->array, FilterElt, i);
1500 gtk_tree_model_filter_ref_node (GTK_TREE_MODEL (filter), &f_iter);
1504 /* another iteration to update the references of children to parents. */
1505 for (i = 0; i < level->array->len; i++)
1507 FilterElt *e = &g_array_index (level->array, FilterElt, i);
1509 e->children->parent_elt = e;
1512 /* don't emit the signal if we aren't visible */
1513 if (!gtk_tree_model_filter_visible (filter, &real_c_iter))
1517 /* NOTE: pass c_path here and NOT real_path. This function does
1518 * root subtraction itself
1520 path = gtk_real_tree_model_filter_convert_child_path_to_path (filter,
1527 gtk_tree_model_filter_increment_stamp (filter);
1529 gtk_tree_model_filter_get_iter_full (GTK_TREE_MODEL (data), &iter, path);
1531 /* get a path taking only visible nodes into account */
1532 gtk_tree_path_free (path);
1533 path = gtk_tree_model_get_path (GTK_TREE_MODEL (data), &iter);
1535 gtk_tree_model_row_inserted (GTK_TREE_MODEL (data), path, &iter);
1537 gtk_tree_path_free (path);
1541 gtk_tree_path_free (real_path);
1544 gtk_tree_path_free (c_path);
1548 gtk_tree_model_filter_row_has_child_toggled (GtkTreeModel *c_model,
1549 GtkTreePath *c_path,
1550 GtkTreeIter *c_iter,
1553 GtkTreeModelFilter *filter = GTK_TREE_MODEL_FILTER (data);
1559 g_return_if_fail (c_path != NULL && c_iter != NULL);
1561 /* If we get row-has-child-toggled on the virtual root, and there is
1562 * no root level; try to build it now.
1564 if (filter->priv->virtual_root && !filter->priv->root
1565 && !gtk_tree_path_compare (c_path, filter->priv->virtual_root))
1567 gtk_tree_model_filter_build_level (filter, NULL, NULL, TRUE);
1571 if (!gtk_tree_model_filter_visible (filter, c_iter))
1574 path = gtk_real_tree_model_filter_convert_child_path_to_path (filter,
1581 gtk_tree_model_filter_get_iter_full (GTK_TREE_MODEL (data), &iter, path);
1583 gtk_tree_path_free (path);
1585 level = FILTER_LEVEL (iter.user_data);
1586 elt = FILTER_ELT (iter.user_data2);
1588 g_assert (elt->visible);
1590 /* If this node is referenced and has children, build the level so we
1591 * can monitor it for changes.
1593 if (elt->ref_count > 1 && gtk_tree_model_iter_has_child (c_model, c_iter))
1594 gtk_tree_model_filter_build_level (filter, level, elt, TRUE);
1596 /* get a path taking only visible nodes into account */
1597 path = gtk_tree_model_get_path (GTK_TREE_MODEL (data), &iter);
1598 gtk_tree_model_row_has_child_toggled (GTK_TREE_MODEL (data), path, &iter);
1599 gtk_tree_path_free (path);
1603 gtk_tree_model_filter_row_deleted (GtkTreeModel *c_model,
1604 GtkTreePath *c_path,
1607 GtkTreeModelFilter *filter = GTK_TREE_MODEL_FILTER (data);
1610 FilterElt *elt, *parent = NULL;
1611 FilterLevel *level, *parent_level = NULL;
1612 gboolean emit_child_toggled = FALSE;
1616 g_return_if_fail (c_path != NULL);
1618 /* special case the deletion of an ancestor of the virtual root */
1619 if (filter->priv->virtual_root &&
1620 (gtk_tree_path_is_ancestor (c_path, filter->priv->virtual_root) ||
1621 !gtk_tree_path_compare (c_path, filter->priv->virtual_root)))
1625 FilterLevel *level = FILTER_LEVEL (filter->priv->root);
1627 gtk_tree_model_filter_unref_path (filter, filter->priv->virtual_root);
1628 filter->priv->virtual_root_deleted = TRUE;
1633 /* remove everything in the filter model
1635 * For now, we just iterate over the root level and emit a
1636 * row_deleted for each FilterElt. Not sure if this is correct.
1639 gtk_tree_model_filter_increment_stamp (filter);
1640 path = gtk_tree_path_new ();
1641 gtk_tree_path_append_index (path, 0);
1643 for (i = 0; i < level->visible_nodes; i++)
1644 gtk_tree_model_row_deleted (GTK_TREE_MODEL (data), path);
1646 gtk_tree_path_free (path);
1647 gtk_tree_model_filter_free_level (filter, filter->priv->root);
1652 /* fixup virtual root */
1653 if (filter->priv->virtual_root)
1655 if (gtk_tree_path_get_depth (filter->priv->virtual_root) >=
1656 gtk_tree_path_get_depth (c_path))
1659 gint *v_indices, *c_indices;
1660 gboolean common_prefix = TRUE;
1662 level = gtk_tree_path_get_depth (c_path) - 1;
1663 v_indices = gtk_tree_path_get_indices (filter->priv->virtual_root);
1664 c_indices = gtk_tree_path_get_indices (c_path);
1666 for (i = 0; i < level; i++)
1667 if (v_indices[i] != c_indices[i])
1669 common_prefix = FALSE;
1673 if (common_prefix && v_indices[level] > c_indices[level])
1674 (v_indices[level])--;
1678 path = gtk_real_tree_model_filter_convert_child_path_to_path (filter,
1685 /* The node deleted in the child model is not visible in the
1686 * filter model. We will not emit a signal, just fixup the offsets
1687 * of the other nodes.
1689 GtkTreePath *real_path;
1691 if (!filter->priv->root)
1694 level = FILTER_LEVEL (filter->priv->root);
1696 /* subtract vroot if necessary */
1697 if (filter->priv->virtual_root)
1699 real_path = gtk_tree_model_filter_remove_root (c_path,
1700 filter->priv->virtual_root);
1701 /* we don't handle this */
1706 real_path = gtk_tree_path_copy (c_path);
1709 if (gtk_tree_path_get_depth (real_path) - 1 >= 1)
1711 /* find the level where the deletion occurred */
1712 while (i < gtk_tree_path_get_depth (real_path) - 1)
1718 /* we don't cover this */
1719 gtk_tree_path_free (real_path);
1723 elt = bsearch_elt_with_offset (level->array,
1724 gtk_tree_path_get_indices (real_path)[i],
1727 if (!elt || !elt->children)
1729 /* parent is filtered out, so no level */
1730 gtk_tree_path_free (real_path);
1734 level = elt->children;
1739 offset = gtk_tree_path_get_indices (real_path)[gtk_tree_path_get_depth (real_path) - 1];
1740 gtk_tree_path_free (real_path);
1745 /* decrease offset of all nodes following the deleted node */
1746 for (i = 0; i < level->array->len; i++)
1748 elt = &g_array_index (level->array, FilterElt, i);
1749 if (elt->offset > offset)
1752 elt->children->parent_elt = elt;
1758 /* a node was deleted, which was in our cache */
1759 gtk_tree_model_filter_get_iter_full (GTK_TREE_MODEL (data), &iter, path);
1761 level = FILTER_LEVEL (iter.user_data);
1762 elt = FILTER_ELT (iter.user_data2);
1763 offset = elt->offset;
1767 /* get a path taking only visible nodes into account */
1768 gtk_tree_path_free (path);
1769 path = gtk_tree_model_get_path (GTK_TREE_MODEL (filter), &iter);
1771 level->visible_nodes--;
1773 if (level->visible_nodes == 0)
1775 emit_child_toggled = TRUE;
1776 parent_level = level->parent_level;
1777 parent = level->parent_elt;
1780 /* emit row_deleted */
1781 gtk_tree_model_filter_increment_stamp (filter);
1782 gtk_tree_model_row_deleted (GTK_TREE_MODEL (data), path);
1783 iter.stamp = filter->priv->stamp;
1786 /* The filter model's reference on the child node is released
1789 while (elt->ref_count > 1)
1790 gtk_tree_model_filter_real_unref_node (GTK_TREE_MODEL (data), &iter,
1793 if (level->array->len == 1)
1796 gtk_tree_model_filter_free_level (filter, level);
1802 /* release the filter model's reference on the node */
1803 if (level->parent_level || filter->priv->virtual_root)
1804 gtk_tree_model_filter_unref_node (GTK_TREE_MODEL (filter), &iter);
1805 else if (elt->ref_count > 0)
1806 gtk_tree_model_filter_real_unref_node (GTK_TREE_MODEL (data), &iter,
1809 /* remove the row */
1810 tmp = bsearch_elt_with_offset (level->array, elt->offset, &i);
1812 offset = tmp->offset;
1813 g_array_remove_index (level->array, i);
1816 for (i = MAX (i, 0); i < level->array->len; i++)
1818 elt = &g_array_index (level->array, FilterElt, i);
1819 if (elt->offset > offset)
1822 elt->children->parent_elt = elt;
1826 if (emit_child_toggled && parent_level)
1831 iter.stamp = filter->priv->stamp;
1832 iter.user_data = parent_level;
1833 iter.user_data2 = parent;
1835 /* We set in_row_deleted to TRUE to avoid a level build triggered
1836 * by row-has-child-toggled (parent model could call iter_has_child
1839 filter->priv->in_row_deleted = TRUE;
1840 path = gtk_tree_model_get_path (GTK_TREE_MODEL (filter), &iter);
1841 gtk_tree_model_row_has_child_toggled (GTK_TREE_MODEL (filter),
1843 gtk_tree_path_free (path);
1844 filter->priv->in_row_deleted = FALSE;
1847 gtk_tree_path_free (path);
1851 gtk_tree_model_filter_rows_reordered (GtkTreeModel *c_model,
1852 GtkTreePath *c_path,
1853 GtkTreeIter *c_iter,
1859 GtkTreeModelFilter *filter = GTK_TREE_MODEL_FILTER (data);
1865 gint i, j, elt_count;
1870 g_return_if_fail (new_order != NULL);
1872 if (c_path == NULL || gtk_tree_path_get_depth (c_path) == 0)
1874 length = gtk_tree_model_iter_n_children (c_model, NULL);
1876 if (filter->priv->virtual_root)
1880 /* reorder root level of path */
1881 for (i = 0; i < length; i++)
1882 if (new_order[i] == gtk_tree_path_get_indices (filter->priv->virtual_root)[0])
1888 gtk_tree_path_get_indices (filter->priv->virtual_root)[0] = new_pos;
1892 path = gtk_tree_path_new ();
1893 level = FILTER_LEVEL (filter->priv->root);
1897 GtkTreeIter child_iter;
1899 /* virtual root anchor reordering */
1900 if (filter->priv->virtual_root &&
1901 gtk_tree_path_is_ancestor (c_path, filter->priv->virtual_root))
1906 GtkTreeIter real_c_iter;
1908 level = gtk_tree_path_get_depth (c_path);
1911 real_c_iter = *c_iter;
1913 gtk_tree_model_get_iter (c_model, &real_c_iter, c_path);
1915 length = gtk_tree_model_iter_n_children (c_model, &real_c_iter);
1917 for (i = 0; i < length; i++)
1918 if (new_order[i] == gtk_tree_path_get_indices (filter->priv->virtual_root)[level])
1924 gtk_tree_path_get_indices (filter->priv->virtual_root)[level] = new_pos;
1928 path = gtk_real_tree_model_filter_convert_child_path_to_path (filter,
1933 if (!path && filter->priv->virtual_root &&
1934 gtk_tree_path_compare (c_path, filter->priv->virtual_root))
1937 if (!path && !filter->priv->virtual_root)
1942 /* root level mode */
1944 gtk_tree_model_get_iter (c_model, c_iter, c_path);
1945 length = gtk_tree_model_iter_n_children (c_model, c_iter);
1946 path = gtk_tree_path_new ();
1947 level = FILTER_LEVEL (filter->priv->root);
1951 gtk_tree_model_filter_get_iter_full (GTK_TREE_MODEL (data),
1954 level = FILTER_LEVEL (iter.user_data);
1955 elt = FILTER_ELT (iter.user_data2);
1959 gtk_tree_path_free (path);
1963 level = elt->children;
1965 gtk_tree_model_filter_convert_iter_to_child_iter (GTK_TREE_MODEL_FILTER (filter), &child_iter, &iter);
1966 length = gtk_tree_model_iter_n_children (c_model, &child_iter);
1970 if (!level || level->array->len < 1)
1972 gtk_tree_path_free (path);
1976 /* NOTE: we do not bail out here if level->array->len < 2 like
1977 * GtkTreeModelSort does. This because we do some special tricky
1981 /* construct a new array */
1982 new_array = g_array_sized_new (FALSE, FALSE, sizeof (FilterElt),
1984 tmp_array = g_new (gint, level->array->len);
1986 for (i = 0, elt_count = 0; i < length; i++)
1988 FilterElt *e = NULL;
1989 gint old_offset = -1;
1991 for (j = 0; j < level->array->len; j++)
1992 if (g_array_index (level->array, FilterElt, j).offset == new_order[i])
1994 e = &g_array_index (level->array, FilterElt, j);
2002 tmp_array[elt_count] = old_offset;
2003 g_array_append_val (new_array, *e);
2004 g_array_index (new_array, FilterElt, elt_count).offset = i;
2008 g_array_free (level->array, TRUE);
2009 level->array = new_array;
2012 for (i = 0; i < level->array->len; i++)
2014 FilterElt *e = &g_array_index (level->array, FilterElt, i);
2016 e->children->parent_elt = e;
2019 /* emit rows_reordered */
2020 if (!gtk_tree_path_get_indices (path))
2021 gtk_tree_model_rows_reordered (GTK_TREE_MODEL (data), path, NULL,
2025 /* get a path taking only visible nodes into account */
2026 gtk_tree_path_free (path);
2027 path = gtk_tree_model_get_path (GTK_TREE_MODEL (data), &iter);
2029 gtk_tree_model_rows_reordered (GTK_TREE_MODEL (data), path, &iter,
2035 gtk_tree_path_free (path);
2038 /* TreeModelIface implementation */
2039 static GtkTreeModelFlags
2040 gtk_tree_model_filter_get_flags (GtkTreeModel *model)
2042 GtkTreeModelFlags flags;
2044 g_return_val_if_fail (GTK_IS_TREE_MODEL_FILTER (model), 0);
2045 g_return_val_if_fail (GTK_TREE_MODEL_FILTER (model)->priv->child_model != NULL, 0);
2047 flags = gtk_tree_model_get_flags (GTK_TREE_MODEL_FILTER (model)->priv->child_model);
2049 if ((flags & GTK_TREE_MODEL_LIST_ONLY) == GTK_TREE_MODEL_LIST_ONLY)
2050 return GTK_TREE_MODEL_LIST_ONLY;
2056 gtk_tree_model_filter_get_n_columns (GtkTreeModel *model)
2058 GtkTreeModelFilter *filter = (GtkTreeModelFilter *)model;
2060 g_return_val_if_fail (GTK_IS_TREE_MODEL_FILTER (model), 0);
2061 g_return_val_if_fail (filter->priv->child_model != NULL, 0);
2063 if (filter->priv->child_model == NULL)
2066 /* so we can't modify the modify func after this ... */
2067 filter->priv->modify_func_set = TRUE;
2069 if (filter->priv->modify_n_columns > 0)
2070 return filter->priv->modify_n_columns;
2072 return gtk_tree_model_get_n_columns (filter->priv->child_model);
2076 gtk_tree_model_filter_get_column_type (GtkTreeModel *model,
2079 GtkTreeModelFilter *filter = (GtkTreeModelFilter *)model;
2081 g_return_val_if_fail (GTK_IS_TREE_MODEL_FILTER (model), G_TYPE_INVALID);
2082 g_return_val_if_fail (filter->priv->child_model != NULL, G_TYPE_INVALID);
2084 /* so we can't modify the modify func after this ... */
2085 filter->priv->modify_func_set = TRUE;
2087 if (filter->priv->modify_types)
2089 g_return_val_if_fail (index < filter->priv->modify_n_columns, G_TYPE_INVALID);
2091 return filter->priv->modify_types[index];
2094 return gtk_tree_model_get_column_type (filter->priv->child_model, index);
2097 /* A special case of _get_iter; this function can also get iters which
2098 * are not visible. These iters should ONLY be passed internally, never
2099 * pass those along with a signal emission.
2102 gtk_tree_model_filter_get_iter_full (GtkTreeModel *model,
2106 GtkTreeModelFilter *filter = (GtkTreeModelFilter *)model;
2111 g_return_val_if_fail (GTK_IS_TREE_MODEL_FILTER (model), FALSE);
2112 g_return_val_if_fail (filter->priv->child_model != NULL, FALSE);
2114 indices = gtk_tree_path_get_indices (path);
2116 if (filter->priv->root == NULL)
2117 gtk_tree_model_filter_build_level (filter, NULL, NULL, FALSE);
2118 level = FILTER_LEVEL (filter->priv->root);
2120 depth = gtk_tree_path_get_depth (path);
2127 for (i = 0; i < depth - 1; i++)
2129 if (!level || indices[i] >= level->array->len)
2134 elt = gtk_tree_model_filter_get_nth (filter, level, indices[i]);
2137 gtk_tree_model_filter_build_level (filter, level, elt, FALSE);
2138 level = elt->children;
2141 if (!level || indices[i] >= level->array->len)
2147 iter->stamp = filter->priv->stamp;
2148 iter->user_data = level;
2150 elt = gtk_tree_model_filter_get_nth (filter, level, indices[depth - 1]);
2151 iter->user_data2 = elt;
2157 gtk_tree_model_filter_get_iter (GtkTreeModel *model,
2161 GtkTreeModelFilter *filter = (GtkTreeModelFilter *)model;
2166 g_return_val_if_fail (GTK_IS_TREE_MODEL_FILTER (model), FALSE);
2167 g_return_val_if_fail (filter->priv->child_model != NULL, FALSE);
2169 indices = gtk_tree_path_get_indices (path);
2171 if (filter->priv->root == NULL)
2172 gtk_tree_model_filter_build_level (filter, NULL, NULL, FALSE);
2173 level = FILTER_LEVEL (filter->priv->root);
2175 depth = gtk_tree_path_get_depth (path);
2182 for (i = 0; i < depth - 1; i++)
2184 if (!level || indices[i] >= level->visible_nodes)
2189 elt = gtk_tree_model_filter_get_nth_visible (filter, level, indices[i]);
2192 gtk_tree_model_filter_build_level (filter, level, elt, FALSE);
2193 level = elt->children;
2196 if (!level || indices[i] >= level->visible_nodes)
2202 iter->stamp = filter->priv->stamp;
2203 iter->user_data = level;
2205 elt = gtk_tree_model_filter_get_nth_visible (filter, level,
2206 indices[depth - 1]);
2207 iter->user_data2 = elt;
2212 static GtkTreePath *
2213 gtk_tree_model_filter_get_path (GtkTreeModel *model,
2216 GtkTreePath *retval;
2220 g_return_val_if_fail (GTK_IS_TREE_MODEL_FILTER (model), NULL);
2221 g_return_val_if_fail (GTK_TREE_MODEL_FILTER (model)->priv->child_model != NULL, NULL);
2222 g_return_val_if_fail (GTK_TREE_MODEL_FILTER (model)->priv->stamp == iter->stamp, NULL);
2224 level = iter->user_data;
2225 elt = iter->user_data2;
2230 retval = gtk_tree_path_new ();
2234 int i = 0, index = 0;
2236 while (&g_array_index (level->array, FilterElt, i) != elt)
2238 if (g_array_index (level->array, FilterElt, i).visible)
2242 g_assert (i < level->array->len);
2245 gtk_tree_path_prepend_index (retval, index);
2246 elt = level->parent_elt;
2247 level = level->parent_level;
2254 gtk_tree_model_filter_get_value (GtkTreeModel *model,
2259 GtkTreeIter child_iter;
2260 GtkTreeModelFilter *filter = GTK_TREE_MODEL_FILTER (model);
2262 g_return_if_fail (GTK_IS_TREE_MODEL_FILTER (model));
2263 g_return_if_fail (GTK_TREE_MODEL_FILTER (model)->priv->child_model != NULL);
2264 g_return_if_fail (GTK_TREE_MODEL_FILTER (model)->priv->stamp == iter->stamp);
2266 if (filter->priv->modify_func)
2268 g_return_if_fail (column < filter->priv->modify_n_columns);
2270 g_value_init (value, filter->priv->modify_types[column]);
2271 filter->priv->modify_func (model,
2275 filter->priv->modify_data);
2280 gtk_tree_model_filter_convert_iter_to_child_iter (GTK_TREE_MODEL_FILTER (model), &child_iter, iter);
2281 gtk_tree_model_get_value (GTK_TREE_MODEL_FILTER (model)->priv->child_model,
2282 &child_iter, column, value);
2286 gtk_tree_model_filter_iter_next (GtkTreeModel *model,
2293 g_return_val_if_fail (GTK_IS_TREE_MODEL_FILTER (model), FALSE);
2294 g_return_val_if_fail (GTK_TREE_MODEL_FILTER (model)->priv->child_model != NULL, FALSE);
2295 g_return_val_if_fail (GTK_TREE_MODEL_FILTER (model)->priv->stamp == iter->stamp, FALSE);
2297 level = iter->user_data;
2298 elt = iter->user_data2;
2300 i = elt - FILTER_ELT (level->array->data);
2302 while (i < level->array->len - 1)
2309 iter->user_data2 = elt;
2314 /* no next visible iter */
2321 gtk_tree_model_filter_iter_children (GtkTreeModel *model,
2323 GtkTreeIter *parent)
2325 GtkTreeModelFilter *filter = (GtkTreeModelFilter *)model;
2329 g_return_val_if_fail (GTK_IS_TREE_MODEL_FILTER (model), FALSE);
2330 g_return_val_if_fail (filter->priv->child_model != NULL, FALSE);
2332 g_return_val_if_fail (filter->priv->stamp == parent->stamp, FALSE);
2338 if (!filter->priv->root)
2339 gtk_tree_model_filter_build_level (filter, NULL, NULL, FALSE);
2340 if (!filter->priv->root)
2343 level = filter->priv->root;
2345 if (!level->visible_nodes)
2348 iter->stamp = filter->priv->stamp;
2349 iter->user_data = level;
2351 while (i < level->array->len)
2353 if (!g_array_index (level->array, FilterElt, i).visible)
2359 iter->user_data2 = &g_array_index (level->array, FilterElt, i);
2370 if (FILTER_ELT (parent->user_data2)->children == NULL)
2371 gtk_tree_model_filter_build_level (filter,
2372 FILTER_LEVEL (parent->user_data),
2373 FILTER_ELT (parent->user_data2),
2375 if (FILTER_ELT (parent->user_data2)->children == NULL)
2378 if (FILTER_ELT (parent->user_data2)->children->visible_nodes <= 0)
2381 iter->stamp = filter->priv->stamp;
2382 iter->user_data = FILTER_ELT (parent->user_data2)->children;
2384 level = FILTER_LEVEL (iter->user_data);
2386 while (i < level->array->len)
2388 if (!g_array_index (level->array, FilterElt, i).visible)
2394 iter->user_data2 = &g_array_index (level->array, FilterElt, i);
2407 gtk_tree_model_filter_iter_has_child (GtkTreeModel *model,
2410 GtkTreeIter child_iter;
2411 GtkTreeModelFilter *filter = (GtkTreeModelFilter *)model;
2414 g_return_val_if_fail (GTK_IS_TREE_MODEL_FILTER (model), FALSE);
2415 g_return_val_if_fail (filter->priv->child_model != NULL, FALSE);
2416 g_return_val_if_fail (filter->priv->stamp == iter->stamp, FALSE);
2418 filter = GTK_TREE_MODEL_FILTER (model);
2420 gtk_tree_model_filter_convert_iter_to_child_iter (GTK_TREE_MODEL_FILTER (model), &child_iter, iter);
2421 elt = FILTER_ELT (iter->user_data2);
2426 /* we need to build the level to check if not all children are filtered
2430 && gtk_tree_model_iter_has_child (filter->priv->child_model, &child_iter))
2431 gtk_tree_model_filter_build_level (filter, FILTER_LEVEL (iter->user_data),
2434 if (elt->children && elt->children->visible_nodes > 0)
2441 gtk_tree_model_filter_iter_n_children (GtkTreeModel *model,
2444 GtkTreeIter child_iter;
2445 GtkTreeModelFilter *filter = (GtkTreeModelFilter *)model;
2448 g_return_val_if_fail (GTK_IS_TREE_MODEL_FILTER (model), 0);
2449 g_return_val_if_fail (filter->priv->child_model != NULL, 0);
2451 g_return_val_if_fail (filter->priv->stamp == iter->stamp, 0);
2455 if (!filter->priv->root)
2456 gtk_tree_model_filter_build_level (filter, NULL, NULL, FALSE);
2458 if (filter->priv->root)
2459 return FILTER_LEVEL (filter->priv->root)->visible_nodes;
2464 elt = FILTER_ELT (iter->user_data2);
2469 gtk_tree_model_filter_convert_iter_to_child_iter (GTK_TREE_MODEL_FILTER (model), &child_iter, iter);
2471 if (!elt->children &&
2472 gtk_tree_model_iter_has_child (filter->priv->child_model, &child_iter))
2473 gtk_tree_model_filter_build_level (filter,
2474 FILTER_LEVEL (iter->user_data),
2478 return elt->children->visible_nodes;
2484 gtk_tree_model_filter_iter_nth_child (GtkTreeModel *model,
2486 GtkTreeIter *parent,
2491 GtkTreeIter children;
2493 g_return_val_if_fail (GTK_IS_TREE_MODEL_FILTER (model), FALSE);
2495 g_return_val_if_fail (GTK_TREE_MODEL_FILTER (model)->priv->stamp == parent->stamp, FALSE);
2497 /* use this instead of has_child to force us to build the level, if needed */
2498 if (gtk_tree_model_filter_iter_children (model, &children, parent) == FALSE)
2504 level = children.user_data;
2505 elt = FILTER_ELT (level->array->data);
2507 if (n >= level->visible_nodes)
2513 elt = gtk_tree_model_filter_get_nth_visible (GTK_TREE_MODEL_FILTER (model),
2516 iter->stamp = GTK_TREE_MODEL_FILTER (model)->priv->stamp;
2517 iter->user_data = level;
2518 iter->user_data2 = elt;
2524 gtk_tree_model_filter_iter_parent (GtkTreeModel *model,
2531 g_return_val_if_fail (GTK_IS_TREE_MODEL_FILTER (model), FALSE);
2532 g_return_val_if_fail (GTK_TREE_MODEL_FILTER (model)->priv->child_model != NULL, FALSE);
2533 g_return_val_if_fail (GTK_TREE_MODEL_FILTER (model)->priv->stamp == child->stamp, FALSE);
2535 level = child->user_data;
2537 if (level->parent_level)
2539 iter->stamp = GTK_TREE_MODEL_FILTER (model)->priv->stamp;
2540 iter->user_data = level->parent_level;
2541 iter->user_data2 = level->parent_elt;
2550 gtk_tree_model_filter_ref_node (GtkTreeModel *model,
2553 GtkTreeModelFilter *filter = (GtkTreeModelFilter *)model;
2554 GtkTreeIter child_iter;
2558 g_return_if_fail (GTK_IS_TREE_MODEL_FILTER (model));
2559 g_return_if_fail (GTK_TREE_MODEL_FILTER (model)->priv->child_model != NULL);
2560 g_return_if_fail (GTK_TREE_MODEL_FILTER (model)->priv->stamp == iter->stamp);
2562 gtk_tree_model_filter_convert_iter_to_child_iter (GTK_TREE_MODEL_FILTER (model), &child_iter, iter);
2564 gtk_tree_model_ref_node (filter->priv->child_model, &child_iter);
2566 level = iter->user_data;
2567 elt = iter->user_data2;
2571 if (level->ref_count == 1)
2573 FilterLevel *parent_level = level->parent_level;
2574 FilterElt *parent_elt = level->parent_elt;
2576 /* we were at zero -- time to decrease the zero_ref_count val */
2577 while (parent_level)
2579 parent_elt->zero_ref_count--;
2581 parent_elt = parent_level->parent_elt;
2582 parent_level = parent_level->parent_level;
2585 if (filter->priv->root != level)
2586 filter->priv->zero_ref_count--;
2591 gtk_tree_model_filter_unref_node (GtkTreeModel *model,
2594 gtk_tree_model_filter_real_unref_node (model, iter, TRUE);
2598 gtk_tree_model_filter_real_unref_node (GtkTreeModel *model,
2600 gboolean propagate_unref)
2602 GtkTreeModelFilter *filter = (GtkTreeModelFilter *)model;
2606 g_return_if_fail (GTK_IS_TREE_MODEL_FILTER (model));
2607 g_return_if_fail (filter->priv->child_model != NULL);
2608 g_return_if_fail (filter->priv->stamp == iter->stamp);
2610 if (propagate_unref)
2612 GtkTreeIter child_iter;
2613 gtk_tree_model_filter_convert_iter_to_child_iter (GTK_TREE_MODEL_FILTER (model), &child_iter, iter);
2614 gtk_tree_model_unref_node (filter->priv->child_model, &child_iter);
2617 level = iter->user_data;
2618 elt = iter->user_data2;
2620 g_return_if_fail (elt->ref_count > 0);
2624 if (level->ref_count == 0)
2626 FilterLevel *parent_level = level->parent_level;
2627 FilterElt *parent_elt = level->parent_elt;
2629 /* we are at zero -- time to increase the zero_ref_count val */
2630 while (parent_level)
2632 parent_elt->zero_ref_count++;
2634 parent_elt = parent_level->parent_elt;
2635 parent_level = parent_level->parent_level;
2638 if (filter->priv->root != level)
2639 filter->priv->zero_ref_count++;
2643 /* TreeDragSource interface implementation */
2645 gtk_tree_model_filter_row_draggable (GtkTreeDragSource *drag_source,
2648 GtkTreeModelFilter *tree_model_filter = (GtkTreeModelFilter *)drag_source;
2649 GtkTreePath *child_path;
2652 g_return_val_if_fail (GTK_IS_TREE_MODEL_FILTER (drag_source), FALSE);
2653 g_return_val_if_fail (path != NULL, FALSE);
2655 child_path = gtk_tree_model_filter_convert_path_to_child_path (tree_model_filter, path);
2656 draggable = gtk_tree_drag_source_row_draggable (GTK_TREE_DRAG_SOURCE (tree_model_filter->priv->child_model), child_path);
2657 gtk_tree_path_free (child_path);
2663 gtk_tree_model_filter_drag_data_get (GtkTreeDragSource *drag_source,
2665 GtkSelectionData *selection_data)
2667 GtkTreeModelFilter *tree_model_filter = (GtkTreeModelFilter *)drag_source;
2668 GtkTreePath *child_path;
2671 g_return_val_if_fail (GTK_IS_TREE_MODEL_FILTER (drag_source), FALSE);
2672 g_return_val_if_fail (path != NULL, FALSE);
2674 child_path = gtk_tree_model_filter_convert_path_to_child_path (tree_model_filter, path);
2675 gotten = gtk_tree_drag_source_drag_data_get (GTK_TREE_DRAG_SOURCE (tree_model_filter->priv->child_model), child_path, selection_data);
2676 gtk_tree_path_free (child_path);
2682 gtk_tree_model_filter_drag_data_delete (GtkTreeDragSource *drag_source,
2685 GtkTreeModelFilter *tree_model_filter = (GtkTreeModelFilter *)drag_source;
2686 GtkTreePath *child_path;
2689 g_return_val_if_fail (GTK_IS_TREE_MODEL_FILTER (drag_source), FALSE);
2690 g_return_val_if_fail (path != NULL, FALSE);
2692 child_path = gtk_tree_model_filter_convert_path_to_child_path (tree_model_filter, path);
2693 deleted = gtk_tree_drag_source_drag_data_delete (GTK_TREE_DRAG_SOURCE (tree_model_filter->priv->child_model), child_path);
2694 gtk_tree_path_free (child_path);
2699 /* bits and pieces */
2701 gtk_tree_model_filter_set_model (GtkTreeModelFilter *filter,
2702 GtkTreeModel *child_model)
2704 g_return_if_fail (GTK_IS_TREE_MODEL_FILTER (filter));
2706 if (filter->priv->child_model)
2708 g_signal_handler_disconnect (filter->priv->child_model,
2709 filter->priv->changed_id);
2710 g_signal_handler_disconnect (filter->priv->child_model,
2711 filter->priv->inserted_id);
2712 g_signal_handler_disconnect (filter->priv->child_model,
2713 filter->priv->has_child_toggled_id);
2714 g_signal_handler_disconnect (filter->priv->child_model,
2715 filter->priv->deleted_id);
2716 g_signal_handler_disconnect (filter->priv->child_model,
2717 filter->priv->reordered_id);
2719 /* reset our state */
2720 if (filter->priv->root)
2721 gtk_tree_model_filter_free_level (filter, filter->priv->root);
2723 filter->priv->root = NULL;
2724 g_object_unref (filter->priv->child_model);
2725 filter->priv->visible_column = -1;
2727 /* FIXME: do we need to destroy more here? */
2730 filter->priv->child_model = child_model;
2734 g_object_ref (filter->priv->child_model);
2735 filter->priv->changed_id =
2736 g_signal_connect (child_model, "row-changed",
2737 G_CALLBACK (gtk_tree_model_filter_row_changed),
2739 filter->priv->inserted_id =
2740 g_signal_connect (child_model, "row-inserted",
2741 G_CALLBACK (gtk_tree_model_filter_row_inserted),
2743 filter->priv->has_child_toggled_id =
2744 g_signal_connect (child_model, "row-has-child-toggled",
2745 G_CALLBACK (gtk_tree_model_filter_row_has_child_toggled),
2747 filter->priv->deleted_id =
2748 g_signal_connect (child_model, "row-deleted",
2749 G_CALLBACK (gtk_tree_model_filter_row_deleted),
2751 filter->priv->reordered_id =
2752 g_signal_connect (child_model, "rows-reordered",
2753 G_CALLBACK (gtk_tree_model_filter_rows_reordered),
2756 filter->priv->child_flags = gtk_tree_model_get_flags (child_model);
2757 filter->priv->stamp = g_random_int ();
2762 gtk_tree_model_filter_ref_path (GtkTreeModelFilter *filter,
2768 len = gtk_tree_path_get_depth (path);
2769 p = gtk_tree_path_copy (path);
2774 gtk_tree_model_get_iter (GTK_TREE_MODEL (filter->priv->child_model), &iter, p);
2775 gtk_tree_model_ref_node (GTK_TREE_MODEL (filter->priv->child_model), &iter);
2776 gtk_tree_path_up (p);
2779 gtk_tree_path_free (p);
2783 gtk_tree_model_filter_unref_path (GtkTreeModelFilter *filter,
2789 len = gtk_tree_path_get_depth (path);
2790 p = gtk_tree_path_copy (path);
2795 gtk_tree_model_get_iter (GTK_TREE_MODEL (filter->priv->child_model), &iter, p);
2796 gtk_tree_model_unref_node (GTK_TREE_MODEL (filter->priv->child_model), &iter);
2797 gtk_tree_path_up (p);
2800 gtk_tree_path_free (p);
2804 gtk_tree_model_filter_set_root (GtkTreeModelFilter *filter,
2807 g_return_if_fail (GTK_IS_TREE_MODEL_FILTER (filter));
2810 filter->priv->virtual_root = NULL;
2812 filter->priv->virtual_root = gtk_tree_path_copy (root);
2818 * gtk_tree_model_filter_new:
2819 * @child_model: A #GtkTreeModel.
2820 * @root: A #GtkTreePath or %NULL.
2822 * Creates a new #GtkTreeModel, with @child_model as the child_model
2823 * and @root as the virtual root.
2825 * Return value: A new #GtkTreeModel.
2830 gtk_tree_model_filter_new (GtkTreeModel *child_model,
2833 GtkTreeModel *retval;
2834 GtkTreeModelFilter *filter;
2836 g_return_val_if_fail (GTK_IS_TREE_MODEL (child_model), NULL);
2838 retval = g_object_new (GTK_TYPE_TREE_MODEL_FILTER,
2839 "child-model", child_model,
2840 "virtual-root", root,
2843 filter = GTK_TREE_MODEL_FILTER (retval);
2844 if (filter->priv->virtual_root)
2846 gtk_tree_model_filter_ref_path (filter, filter->priv->virtual_root);
2847 filter->priv->virtual_root_deleted = FALSE;
2854 * gtk_tree_model_filter_get_model:
2855 * @filter: A #GtkTreeModelFilter.
2857 * Returns a pointer to the child model of @filter.
2859 * Return value: A pointer to a #GtkTreeModel.
2864 gtk_tree_model_filter_get_model (GtkTreeModelFilter *filter)
2866 g_return_val_if_fail (GTK_IS_TREE_MODEL_FILTER (filter), NULL);
2868 return filter->priv->child_model;
2872 * gtk_tree_model_filter_set_visible_func:
2873 * @filter: A #GtkTreeModelFilter.
2874 * @func: A #GtkTreeModelFilterVisibleFunc, the visible function.
2875 * @data: User data to pass to the visible function, or %NULL.
2876 * @destroy: Destroy notifier of @data, or %NULL.
2878 * Sets the visible function used when filtering the @filter to be @func. The
2879 * function should return %TRUE if the given row should be visible and
2882 * If the condition calculated by the function changes over time (e.g. because
2883 * it depends on some global parameters), you must call
2884 * gtk_tree_model_filter_refilter() to keep the visibility information of
2885 * the model uptodate.
2887 * Note that @func is called whenever a row is inserted, when it may still be
2888 * empty. The visible function should therefore take special care of empty
2889 * rows, like in the example below.
2891 * <informalexample><programlisting>
2893 * visible_func (GtkTreeModel *model,
2894 * GtkTreeIter *iter,
2897 * /* Visible if row is non-empty and first column is "HI" */
2899 * gboolean visible = FALSE;
2901 * gtk_tree_model_get (model, iter, 0, &str, -1);
2902 * if (str && strcmp (str, "HI") == 0)
2908 * </programlisting></informalexample>
2913 gtk_tree_model_filter_set_visible_func (GtkTreeModelFilter *filter,
2914 GtkTreeModelFilterVisibleFunc func,
2916 GDestroyNotify destroy)
2918 g_return_if_fail (GTK_IS_TREE_MODEL_FILTER (filter));
2919 g_return_if_fail (func != NULL);
2920 g_return_if_fail (filter->priv->visible_method_set == FALSE);
2922 if (filter->priv->visible_func)
2924 GDestroyNotify d = filter->priv->visible_destroy;
2926 filter->priv->visible_destroy = NULL;
2927 d (filter->priv->visible_data);
2930 filter->priv->visible_func = func;
2931 filter->priv->visible_data = data;
2932 filter->priv->visible_destroy = destroy;
2934 filter->priv->visible_method_set = TRUE;
2938 * gtk_tree_model_filter_set_modify_func:
2939 * @filter: A #GtkTreeModelFilter.
2940 * @n_columns: The number of columns in the filter model.
2941 * @types: The #GType<!-- -->s of the columns.
2942 * @func: A #GtkTreeModelFilterModifyFunc
2943 * @data: User data to pass to the modify function, or %NULL.
2944 * @destroy: Destroy notifier of @data, or %NULL.
2946 * With the @n_columns and @types parameters, you give an array of column
2947 * types for this model (which will be exposed to the parent model/view).
2948 * The @func, @data and @destroy parameters are for specifying the modify
2949 * function. The modify function will get called for <emphasis>each</emphasis>
2950 * data access, the goal of the modify function is to return the data which
2951 * should be displayed at the location specified using the parameters of the
2957 gtk_tree_model_filter_set_modify_func (GtkTreeModelFilter *filter,
2960 GtkTreeModelFilterModifyFunc func,
2962 GDestroyNotify destroy)
2964 g_return_if_fail (GTK_IS_TREE_MODEL_FILTER (filter));
2965 g_return_if_fail (func != NULL);
2966 g_return_if_fail (filter->priv->modify_func_set == FALSE);
2968 if (filter->priv->modify_destroy)
2970 GDestroyNotify d = filter->priv->modify_destroy;
2972 filter->priv->modify_destroy = NULL;
2973 d (filter->priv->modify_data);
2976 filter->priv->modify_n_columns = n_columns;
2977 filter->priv->modify_types = g_new0 (GType, n_columns);
2978 memcpy (filter->priv->modify_types, types, sizeof (GType) * n_columns);
2979 filter->priv->modify_func = func;
2980 filter->priv->modify_data = data;
2981 filter->priv->modify_destroy = destroy;
2983 filter->priv->modify_func_set = TRUE;
2987 * gtk_tree_model_filter_set_visible_column:
2988 * @filter: A #GtkTreeModelFilter.
2989 * @column: A #gint which is the column containing the visible information.
2991 * Sets @column of the child_model to be the column where @filter should
2992 * look for visibility information. @columns should be a column of type
2993 * %G_TYPE_BOOLEAN, where %TRUE means that a row is visible, and %FALSE
2999 gtk_tree_model_filter_set_visible_column (GtkTreeModelFilter *filter,
3002 g_return_if_fail (GTK_IS_TREE_MODEL_FILTER (filter));
3003 g_return_if_fail (column >= 0);
3004 g_return_if_fail (filter->priv->visible_method_set == FALSE);
3006 filter->priv->visible_column = column;
3008 filter->priv->visible_method_set = TRUE;
3014 * gtk_tree_model_filter_convert_child_iter_to_iter:
3015 * @filter: A #GtkTreeModelFilter.
3016 * @filter_iter: An uninitialized #GtkTreeIter.
3017 * @child_iter: A valid #GtkTreeIter pointing to a row on the child model.
3019 * Sets @filter_iter to point to the row in @filter that corresponds to the
3020 * row pointed at by @child_iter. If @filter_iter was not set, %FALSE is
3023 * Return value: %TRUE, if @filter_iter was set, i.e. if @child_iter is a
3024 * valid iterator pointing to a visible row in child model.
3029 gtk_tree_model_filter_convert_child_iter_to_iter (GtkTreeModelFilter *filter,
3030 GtkTreeIter *filter_iter,
3031 GtkTreeIter *child_iter)
3034 GtkTreePath *child_path, *path;
3036 g_return_val_if_fail (GTK_IS_TREE_MODEL_FILTER (filter), FALSE);
3037 g_return_val_if_fail (filter->priv->child_model != NULL, FALSE);
3038 g_return_val_if_fail (filter_iter != NULL, FALSE);
3039 g_return_val_if_fail (child_iter != NULL, FALSE);
3040 g_return_val_if_fail (filter_iter != child_iter, FALSE);
3042 filter_iter->stamp = 0;
3044 child_path = gtk_tree_model_get_path (filter->priv->child_model, child_iter);
3045 g_return_val_if_fail (child_path != NULL, FALSE);
3047 path = gtk_tree_model_filter_convert_child_path_to_path (filter,
3049 gtk_tree_path_free (child_path);
3054 ret = gtk_tree_model_get_iter (GTK_TREE_MODEL (filter), filter_iter, path);
3055 gtk_tree_path_free (path);
3061 * gtk_tree_model_filter_convert_iter_to_child_iter:
3062 * @filter: A #GtkTreeModelFilter.
3063 * @child_iter: An uninitialized #GtkTreeIter.
3064 * @filter_iter: A valid #GtkTreeIter pointing to a row on @filter.
3066 * Sets @child_iter to point to the row pointed to by @filter_iter.
3071 gtk_tree_model_filter_convert_iter_to_child_iter (GtkTreeModelFilter *filter,
3072 GtkTreeIter *child_iter,
3073 GtkTreeIter *filter_iter)
3075 g_return_if_fail (GTK_IS_TREE_MODEL_FILTER (filter));
3076 g_return_if_fail (filter->priv->child_model != NULL);
3077 g_return_if_fail (child_iter != NULL);
3078 g_return_if_fail (filter_iter != NULL);
3079 g_return_if_fail (filter_iter->stamp == filter->priv->stamp);
3080 g_return_if_fail (filter_iter != child_iter);
3082 if (GTK_TREE_MODEL_FILTER_CACHE_CHILD_ITERS (filter))
3084 *child_iter = FILTER_ELT (filter_iter->user_data2)->iter;
3090 path = gtk_tree_model_filter_elt_get_path (filter_iter->user_data,
3091 filter_iter->user_data2,
3092 filter->priv->virtual_root);
3093 gtk_tree_model_get_iter (filter->priv->child_model, child_iter, path);
3094 gtk_tree_path_free (path);
3098 /* The path returned can only be used internally in the filter model. */
3099 static GtkTreePath *
3100 gtk_real_tree_model_filter_convert_child_path_to_path (GtkTreeModelFilter *filter,
3101 GtkTreePath *child_path,
3102 gboolean build_levels,
3103 gboolean fetch_children)
3105 gint *child_indices;
3106 GtkTreePath *retval;
3107 GtkTreePath *real_path;
3112 g_return_val_if_fail (GTK_IS_TREE_MODEL_FILTER (filter), NULL);
3113 g_return_val_if_fail (filter->priv->child_model != NULL, NULL);
3114 g_return_val_if_fail (child_path != NULL, NULL);
3116 if (!filter->priv->virtual_root)
3117 real_path = gtk_tree_path_copy (child_path);
3119 real_path = gtk_tree_model_filter_remove_root (child_path,
3120 filter->priv->virtual_root);
3125 retval = gtk_tree_path_new ();
3126 child_indices = gtk_tree_path_get_indices (real_path);
3128 if (filter->priv->root == NULL && build_levels)
3129 gtk_tree_model_filter_build_level (filter, NULL, NULL, FALSE);
3130 level = FILTER_LEVEL (filter->priv->root);
3132 for (i = 0; i < gtk_tree_path_get_depth (real_path); i++)
3135 gboolean found_child = FALSE;
3139 gtk_tree_path_free (real_path);
3140 gtk_tree_path_free (retval);
3144 tmp = bsearch_elt_with_offset (level->array, child_indices[i], &j);
3147 gtk_tree_path_append_index (retval, j);
3148 if (!tmp->children && build_levels)
3149 gtk_tree_model_filter_build_level (filter, level, tmp, FALSE);
3150 level = tmp->children;
3154 if (!found_child && fetch_children)
3156 tmp = gtk_tree_model_filter_fetch_child (filter, level,
3160 /* didn't find the child, let's try to bring it back */
3161 if (!tmp || tmp->offset != child_indices[i])
3164 gtk_tree_path_free (real_path);
3165 gtk_tree_path_free (retval);
3169 gtk_tree_path_append_index (retval, j);
3170 if (!tmp->children && build_levels)
3171 gtk_tree_model_filter_build_level (filter, level, tmp, FALSE);
3172 level = tmp->children;
3175 else if (!found_child && !fetch_children)
3178 gtk_tree_path_free (real_path);
3179 gtk_tree_path_free (retval);
3184 gtk_tree_path_free (real_path);
3189 * gtk_tree_model_filter_convert_child_path_to_path:
3190 * @filter: A #GtkTreeModelFilter.
3191 * @child_path: A #GtkTreePath to convert.
3193 * Converts @child_path to a path relative to @filter. That is, @child_path
3194 * points to a path in the child model. The rerturned path will point to the
3195 * same row in the filtered model. If @child_path isn't a valid path on the
3196 * child model or points to a row which is not visible in @filter, then %NULL
3199 * Return value: A newly allocated #GtkTreePath, or %NULL.
3204 gtk_tree_model_filter_convert_child_path_to_path (GtkTreeModelFilter *filter,
3205 GtkTreePath *child_path)
3210 /* this function does the sanity checks */
3211 path = gtk_real_tree_model_filter_convert_child_path_to_path (filter,
3219 /* get a new path which only takes visible nodes into account.
3220 * -- if this gives any performance issues, we can write a special
3221 * version of convert_child_path_to_path immediately returning
3222 * a visible-nodes-only path.
3224 gtk_tree_model_filter_get_iter_full (GTK_TREE_MODEL (filter), &iter, path);
3226 gtk_tree_path_free (path);
3227 path = gtk_tree_model_get_path (GTK_TREE_MODEL (filter), &iter);
3233 * gtk_tree_model_filter_convert_path_to_child_path:
3234 * @filter: A #GtkTreeModelFilter.
3235 * @filter_path: A #GtkTreePath to convert.
3237 * Converts @filter_path to a path on the child model of @filter. That is,
3238 * @filter_path points to a location in @filter. The returned path will
3239 * point to the same location in the model not being filtered. If @filter_path
3240 * does not point to a location in the child model, %NULL is returned.
3242 * Return value: A newly allocated #GtkTreePath, or %NULL.
3247 gtk_tree_model_filter_convert_path_to_child_path (GtkTreeModelFilter *filter,
3248 GtkTreePath *filter_path)
3250 gint *filter_indices;
3251 GtkTreePath *retval;
3255 g_return_val_if_fail (GTK_IS_TREE_MODEL_FILTER (filter), NULL);
3256 g_return_val_if_fail (filter->priv->child_model != NULL, NULL);
3257 g_return_val_if_fail (filter_path != NULL, NULL);
3260 retval = gtk_tree_path_new ();
3261 filter_indices = gtk_tree_path_get_indices (filter_path);
3262 if (!filter->priv->root)
3263 gtk_tree_model_filter_build_level (filter, NULL, NULL, FALSE);
3264 level = FILTER_LEVEL (filter->priv->root);
3266 for (i = 0; i < gtk_tree_path_get_depth (filter_path); i++)
3270 if (!level || level->visible_nodes <= filter_indices[i])
3272 gtk_tree_path_free (retval);
3276 elt = gtk_tree_model_filter_get_nth_visible (filter, level,
3279 if (elt->children == NULL)
3280 gtk_tree_model_filter_build_level (filter, level, elt, FALSE);
3282 if (!level || level->visible_nodes <= filter_indices[i])
3284 gtk_tree_path_free (retval);
3288 gtk_tree_path_append_index (retval, elt->offset);
3289 level = elt->children;
3294 if (filter->priv->virtual_root)
3296 GtkTreePath *real_retval;
3298 real_retval = gtk_tree_model_filter_add_root (retval,
3299 filter->priv->virtual_root);
3300 gtk_tree_path_free (retval);
3309 gtk_tree_model_filter_refilter_helper (GtkTreeModel *model,
3314 /* evil, don't try this at home, but certainly speeds things up */
3315 gtk_tree_model_filter_row_changed (model, path, iter, data);
3321 * gtk_tree_model_filter_refilter:
3322 * @filter: A #GtkTreeModelFilter.
3324 * Emits ::row_changed for each row in the child model, which causes
3325 * the filter to re-evaluate whether a row is visible or not.
3330 gtk_tree_model_filter_refilter (GtkTreeModelFilter *filter)
3332 g_return_if_fail (GTK_IS_TREE_MODEL_FILTER (filter));
3335 gtk_tree_model_foreach (filter->priv->child_model,
3336 gtk_tree_model_filter_refilter_helper,
3341 * gtk_tree_model_filter_clear_cache:
3342 * @filter: A #GtkTreeModelFilter.
3344 * This function should almost never be called. It clears the @filter
3345 * of any cached iterators that haven't been reffed with
3346 * gtk_tree_model_ref_node(). This might be useful if the child model
3347 * being filtered is static (and doesn't change often) and there has been
3348 * a lot of unreffed access to nodes. As a side effect of this function,
3349 * all unreffed iters will be invalid.
3354 gtk_tree_model_filter_clear_cache (GtkTreeModelFilter *filter)
3356 g_return_if_fail (GTK_IS_TREE_MODEL_FILTER (filter));
3358 if (filter->priv->zero_ref_count > 0)
3359 gtk_tree_model_filter_clear_cache_helper (filter,
3360 FILTER_LEVEL (filter->priv->root));
3363 #define __GTK_TREE_MODEL_FILTER_C__
3364 #include "gtkaliasdef.c"