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 gboolean gtk_tree_model_filter_elt_is_visible_in_target (FilterLevel *level,
262 static FilterElt *gtk_tree_model_filter_get_nth_visible (GtkTreeModelFilter *filter,
266 static FilterElt *gtk_tree_model_filter_fetch_child (GtkTreeModelFilter *filter,
270 static void gtk_tree_model_filter_remove_node (GtkTreeModelFilter *filter,
272 static void gtk_tree_model_filter_update_children (GtkTreeModelFilter *filter,
275 static FilterElt *bsearch_elt_with_offset (GArray *array,
280 G_DEFINE_TYPE_WITH_CODE (GtkTreeModelFilter, gtk_tree_model_filter, G_TYPE_OBJECT,
281 G_IMPLEMENT_INTERFACE (GTK_TYPE_TREE_MODEL,
282 gtk_tree_model_filter_tree_model_init)
283 G_IMPLEMENT_INTERFACE (GTK_TYPE_TREE_DRAG_SOURCE,
284 gtk_tree_model_filter_drag_source_init))
287 gtk_tree_model_filter_init (GtkTreeModelFilter *filter)
289 filter->priv = GTK_TREE_MODEL_FILTER_GET_PRIVATE (filter);
291 filter->priv->visible_column = -1;
292 filter->priv->zero_ref_count = 0;
293 filter->priv->visible_method_set = FALSE;
294 filter->priv->modify_func_set = FALSE;
295 filter->priv->in_row_deleted = FALSE;
296 filter->priv->virtual_root_deleted = FALSE;
300 gtk_tree_model_filter_class_init (GtkTreeModelFilterClass *filter_class)
302 GObjectClass *object_class;
304 object_class = (GObjectClass *) filter_class;
306 object_class->set_property = gtk_tree_model_filter_set_property;
307 object_class->get_property = gtk_tree_model_filter_get_property;
309 object_class->finalize = gtk_tree_model_filter_finalize;
311 /* Properties -- FIXME: disabled translations for now, until I can come up with a
314 g_object_class_install_property (object_class,
316 g_param_spec_object ("child-model",
318 ("The model for the filtermodel to filter"),
320 GTK_PARAM_READWRITE | G_PARAM_CONSTRUCT_ONLY));
322 g_object_class_install_property (object_class,
324 g_param_spec_boxed ("virtual-root",
325 ("The virtual root"),
326 ("The virtual root (relative to the child model) for this filtermodel"),
328 GTK_PARAM_READWRITE | G_PARAM_CONSTRUCT_ONLY));
330 g_type_class_add_private (object_class, sizeof (GtkTreeModelFilterPrivate));
334 gtk_tree_model_filter_tree_model_init (GtkTreeModelIface *iface)
336 iface->get_flags = gtk_tree_model_filter_get_flags;
337 iface->get_n_columns = gtk_tree_model_filter_get_n_columns;
338 iface->get_column_type = gtk_tree_model_filter_get_column_type;
339 iface->get_iter = gtk_tree_model_filter_get_iter;
340 iface->get_path = gtk_tree_model_filter_get_path;
341 iface->get_value = gtk_tree_model_filter_get_value;
342 iface->iter_next = gtk_tree_model_filter_iter_next;
343 iface->iter_children = gtk_tree_model_filter_iter_children;
344 iface->iter_has_child = gtk_tree_model_filter_iter_has_child;
345 iface->iter_n_children = gtk_tree_model_filter_iter_n_children;
346 iface->iter_nth_child = gtk_tree_model_filter_iter_nth_child;
347 iface->iter_parent = gtk_tree_model_filter_iter_parent;
348 iface->ref_node = gtk_tree_model_filter_ref_node;
349 iface->unref_node = gtk_tree_model_filter_unref_node;
353 gtk_tree_model_filter_drag_source_init (GtkTreeDragSourceIface *iface)
355 iface->row_draggable = gtk_tree_model_filter_row_draggable;
356 iface->drag_data_delete = gtk_tree_model_filter_drag_data_delete;
357 iface->drag_data_get = gtk_tree_model_filter_drag_data_get;
362 gtk_tree_model_filter_finalize (GObject *object)
364 GtkTreeModelFilter *filter = (GtkTreeModelFilter *) object;
366 if (filter->priv->virtual_root && !filter->priv->virtual_root_deleted)
368 gtk_tree_model_filter_unref_path (filter, filter->priv->virtual_root);
369 filter->priv->virtual_root_deleted = TRUE;
372 gtk_tree_model_filter_set_model (filter, NULL);
374 if (filter->priv->virtual_root)
375 gtk_tree_path_free (filter->priv->virtual_root);
377 if (filter->priv->root)
378 gtk_tree_model_filter_free_level (filter, filter->priv->root);
380 g_free (filter->priv->modify_types);
382 if (filter->priv->modify_destroy)
383 filter->priv->modify_destroy (filter->priv->modify_data);
385 if (filter->priv->visible_destroy)
386 filter->priv->visible_destroy (filter->priv->visible_data);
389 G_OBJECT_CLASS (gtk_tree_model_filter_parent_class)->finalize (object);
393 gtk_tree_model_filter_set_property (GObject *object,
398 GtkTreeModelFilter *filter = GTK_TREE_MODEL_FILTER (object);
402 case PROP_CHILD_MODEL:
403 gtk_tree_model_filter_set_model (filter, g_value_get_object (value));
405 case PROP_VIRTUAL_ROOT:
406 gtk_tree_model_filter_set_root (filter, g_value_get_boxed (value));
409 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
415 gtk_tree_model_filter_get_property (GObject *object,
420 GtkTreeModelFilter *filter = GTK_TREE_MODEL_FILTER (object);
424 case PROP_CHILD_MODEL:
425 g_value_set_object (value, filter->priv->child_model);
427 case PROP_VIRTUAL_ROOT:
428 g_value_set_boxed (value, filter->priv->virtual_root);
431 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
439 gtk_tree_model_filter_build_level (GtkTreeModelFilter *filter,
440 FilterLevel *parent_level,
441 FilterElt *parent_elt,
442 gboolean emit_inserted)
445 GtkTreeIter first_node;
447 FilterLevel *new_level;
451 g_assert (filter->priv->child_model != NULL);
453 if (filter->priv->in_row_deleted)
458 if (filter->priv->virtual_root)
460 if (gtk_tree_model_get_iter (filter->priv->child_model, &root, filter->priv->virtual_root) == FALSE)
462 length = gtk_tree_model_iter_n_children (filter->priv->child_model, &root);
464 if (gtk_tree_model_iter_children (filter->priv->child_model, &iter, &root) == FALSE)
469 if (!gtk_tree_model_get_iter_first (filter->priv->child_model, &iter))
471 length = gtk_tree_model_iter_n_children (filter->priv->child_model, NULL);
476 GtkTreeIter parent_iter;
477 GtkTreeIter child_parent_iter;
479 parent_iter.stamp = filter->priv->stamp;
480 parent_iter.user_data = parent_level;
481 parent_iter.user_data2 = parent_elt;
483 gtk_tree_model_filter_convert_iter_to_child_iter (filter,
486 if (gtk_tree_model_iter_children (filter->priv->child_model, &iter, &child_parent_iter) == FALSE)
489 /* stamp may have changed */
490 gtk_tree_model_filter_convert_iter_to_child_iter (filter,
493 length = gtk_tree_model_iter_n_children (filter->priv->child_model, &child_parent_iter);
496 g_return_if_fail (length > 0);
498 new_level = g_new (FilterLevel, 1);
499 new_level->array = g_array_sized_new (FALSE, FALSE,
502 new_level->ref_count = 0;
503 new_level->visible_nodes = 0;
504 new_level->parent_elt = parent_elt;
505 new_level->parent_level = parent_level;
508 parent_elt->children = new_level;
510 filter->priv->root = new_level;
512 /* increase the count of zero ref_counts */
515 parent_elt->zero_ref_count++;
517 parent_elt = parent_level->parent_elt;
518 parent_level = parent_level->parent_level;
520 if (new_level != filter->priv->root)
521 filter->priv->zero_ref_count++;
529 if (gtk_tree_model_filter_visible (filter, &iter))
531 FilterElt filter_elt;
533 filter_elt.offset = i;
534 filter_elt.zero_ref_count = 0;
535 filter_elt.ref_count = 0;
536 filter_elt.children = NULL;
537 filter_elt.visible = TRUE;
539 if (GTK_TREE_MODEL_FILTER_CACHE_CHILD_ITERS (filter))
540 filter_elt.iter = iter;
542 g_array_append_val (new_level->array, filter_elt);
543 new_level->visible_nodes++;
545 if (new_level->parent_level || filter->priv->virtual_root)
549 f_iter.stamp = filter->priv->stamp;
550 f_iter.user_data = new_level;
551 f_iter.user_data2 = &(g_array_index (new_level->array, FilterElt, new_level->array->len - 1));
553 gtk_tree_model_filter_ref_node (GTK_TREE_MODEL (filter), &f_iter);
559 f_path = gtk_tree_model_get_path (GTK_TREE_MODEL (filter),
561 gtk_tree_model_row_inserted (GTK_TREE_MODEL (filter),
563 gtk_tree_path_free (f_path);
569 while (gtk_tree_model_iter_next (filter->priv->child_model, &iter));
571 if (new_level->array->len == 0
572 && (new_level != filter->priv->root || filter->priv->virtual_root))
574 /* If none of the nodes are visible, we will just pull in the
575 * first node of the level and keep a reference on it. We need this
576 * to make sure that we get all signals for this level.
578 FilterElt filter_elt;
581 filter_elt.offset = 0;
582 filter_elt.zero_ref_count = 0;
583 filter_elt.ref_count = 0;
584 filter_elt.children = NULL;
585 filter_elt.visible = FALSE;
587 if (GTK_TREE_MODEL_FILTER_CACHE_CHILD_ITERS (filter))
588 filter_elt.iter = first_node;
590 g_array_append_val (new_level->array, filter_elt);
592 f_iter.stamp = filter->priv->stamp;
593 f_iter.user_data = new_level;
594 f_iter.user_data2 = &(g_array_index (new_level->array, FilterElt, new_level->array->len - 1));
596 gtk_tree_model_filter_ref_node (GTK_TREE_MODEL (filter), &f_iter);
598 else if (new_level->array->len == 0)
599 gtk_tree_model_filter_free_level (filter, new_level);
603 gtk_tree_model_filter_free_level (GtkTreeModelFilter *filter,
604 FilterLevel *filter_level)
608 g_assert (filter_level);
610 for (i = 0; i < filter_level->array->len; i++)
612 if (g_array_index (filter_level->array, FilterElt, i).children)
613 gtk_tree_model_filter_free_level (filter,
614 FILTER_LEVEL (g_array_index (filter_level->array, FilterElt, i).children));
616 if (filter_level->parent_level || filter->priv->virtual_root)
620 f_iter.stamp = filter->priv->stamp;
621 f_iter.user_data = filter_level;
622 f_iter.user_data2 = &(g_array_index (filter_level->array, FilterElt, i));
624 gtk_tree_model_filter_unref_node (GTK_TREE_MODEL (filter), &f_iter);
628 if (filter_level->ref_count == 0)
630 FilterLevel *parent_level = filter_level->parent_level;
631 FilterElt *parent_elt = filter_level->parent_elt;
635 parent_elt->zero_ref_count--;
637 parent_elt = parent_level->parent_elt;
638 parent_level = parent_level->parent_level;
641 if (filter_level != filter->priv->root)
642 filter->priv->zero_ref_count--;
645 if (filter_level->parent_elt)
646 filter_level->parent_elt->children = NULL;
648 filter->priv->root = NULL;
650 g_array_free (filter_level->array, TRUE);
651 filter_level->array = NULL;
653 g_free (filter_level);
657 /* Creates paths suitable for accessing the child model. */
659 gtk_tree_model_filter_elt_get_path (FilterLevel *level,
663 FilterLevel *walker = level;
664 FilterElt *walker2 = elt;
666 GtkTreePath *real_path;
668 g_return_val_if_fail (level != NULL, NULL);
669 g_return_val_if_fail (elt != NULL, NULL);
671 path = gtk_tree_path_new ();
675 gtk_tree_path_prepend_index (path, walker2->offset);
677 walker2 = walker->parent_elt;
678 walker = walker->parent_level;
683 real_path = gtk_tree_model_filter_add_root (path, root);
684 gtk_tree_path_free (path);
692 gtk_tree_model_filter_add_root (GtkTreePath *src,
698 retval = gtk_tree_path_copy (root);
700 for (i = 0; i < gtk_tree_path_get_depth (src); i++)
701 gtk_tree_path_append_index (retval, gtk_tree_path_get_indices (src)[i]);
707 gtk_tree_model_filter_remove_root (GtkTreePath *src,
715 if (gtk_tree_path_get_depth (src) <= gtk_tree_path_get_depth (root))
718 depth = gtk_tree_path_get_depth (src);
719 indices = gtk_tree_path_get_indices (src);
721 for (i = 0; i < gtk_tree_path_get_depth (root); i++)
722 if (indices[i] != gtk_tree_path_get_indices (root)[i])
725 retval = gtk_tree_path_new ();
727 for (; i < depth; i++)
728 gtk_tree_path_append_index (retval, indices[i]);
734 gtk_tree_model_filter_increment_stamp (GtkTreeModelFilter *filter)
738 filter->priv->stamp++;
740 while (filter->priv->stamp == 0);
742 gtk_tree_model_filter_clear_cache (filter);
746 gtk_tree_model_filter_visible (GtkTreeModelFilter *filter,
747 GtkTreeIter *child_iter)
749 if (filter->priv->visible_func)
751 return filter->priv->visible_func (filter->priv->child_model,
753 filter->priv->visible_data)
756 else if (filter->priv->visible_column >= 0)
760 gtk_tree_model_get_value (filter->priv->child_model, child_iter,
761 filter->priv->visible_column, &val);
763 if (g_value_get_boolean (&val))
765 g_value_unset (&val);
769 g_value_unset (&val);
773 /* no visible function set, so always visible */
778 gtk_tree_model_filter_clear_cache_helper (GtkTreeModelFilter *filter,
785 for (i = 0; i < level->array->len; i++)
787 if (g_array_index (level->array, FilterElt, i).zero_ref_count > 0)
788 gtk_tree_model_filter_clear_cache_helper (filter, g_array_index (level->array, FilterElt, i).children);
791 if (level->ref_count == 0 && level != filter->priv->root)
793 gtk_tree_model_filter_free_level (filter, level);
799 gtk_tree_model_filter_get_nth (GtkTreeModelFilter *filter,
803 if (level->array->len <= n)
806 return &g_array_index (level->array, FilterElt, n);
810 gtk_tree_model_filter_elt_is_visible_in_target (FilterLevel *level,
816 if (!level->parent_elt)
821 elt = level->parent_elt;
822 level = level->parent_level;
824 if (elt && !elt->visible)
833 gtk_tree_model_filter_get_nth_visible (GtkTreeModelFilter *filter,
840 if (level->visible_nodes <= n)
843 elt = FILTER_ELT (level->array->data);
844 while (!elt->visible)
854 while (!elt->visible)
861 gtk_tree_model_filter_fetch_child (GtkTreeModelFilter *filter,
867 gint start, middle, end;
869 GtkTreePath *c_path = NULL;
871 GtkTreePath *c_parent_path = NULL;
872 GtkTreeIter c_parent_iter;
875 /* check if child exists and is visible */
876 if (level->parent_elt)
879 gtk_tree_model_filter_elt_get_path (level->parent_level,
881 filter->priv->virtual_root);
887 if (filter->priv->virtual_root)
888 c_parent_path = gtk_tree_path_copy (filter->priv->virtual_root);
890 c_parent_path = NULL;
895 gtk_tree_model_get_iter (filter->priv->child_model,
898 len = gtk_tree_model_iter_n_children (filter->priv->child_model,
901 c_path = gtk_tree_path_copy (c_parent_path);
902 gtk_tree_path_free (c_parent_path);
906 len = gtk_tree_model_iter_n_children (filter->priv->child_model, NULL);
907 c_path = gtk_tree_path_new ();
910 gtk_tree_path_append_index (c_path, offset);
911 gtk_tree_model_get_iter (filter->priv->child_model, &c_iter, c_path);
912 gtk_tree_path_free (c_path);
914 if (offset >= len || !gtk_tree_model_filter_visible (filter, &c_iter))
919 elt.zero_ref_count = 0;
922 /* visibility should be FALSE as we don't emit row_inserted */
925 if (GTK_TREE_MODEL_FILTER_CACHE_CHILD_ITERS (filter))
928 /* find index (binary search on offset) */
930 end = level->array->len;
936 middle = (start + end) / 2;
938 if (g_array_index (level->array, FilterElt, middle).offset <= offset)
944 if (g_array_index (level->array, FilterElt, middle).offset <= offset)
952 g_array_insert_val (level->array, i, elt);
955 for (i = 0; i < level->array->len; i++)
957 FilterElt *e = &(g_array_index (level->array, FilterElt, i));
959 e->children->parent_elt = e;
962 c_iter.stamp = filter->priv->stamp;
963 c_iter.user_data = level;
964 c_iter.user_data2 = &g_array_index (level->array, FilterElt, *index);
966 if (level->parent_level || filter->priv->virtual_root)
967 gtk_tree_model_filter_ref_node (GTK_TREE_MODEL (filter), &c_iter);
969 return &g_array_index (level->array, FilterElt, *index);
973 gtk_tree_model_filter_remove_node (GtkTreeModelFilter *filter,
976 FilterElt *elt, *parent;
977 FilterLevel *level, *parent_level;
980 gboolean emit_child_toggled = FALSE;
982 level = FILTER_LEVEL (iter->user_data);
983 elt = FILTER_ELT (iter->user_data2);
985 parent = level->parent_elt;
986 parent_level = level->parent_level;
988 length = level->array->len;
990 /* we distinguish a couple of cases:
991 * - root level, length > 1: emit row-deleted and remove.
992 * - root level, length == 1: emit row-deleted and keep in cache.
993 * - level, length == 1: parent->ref_count > 1: emit row-deleted and keep.
994 * - level, length > 1: emit row-deleted and remove.
995 * - else, remove level.
997 * if level != root level and visible nodes == 0, emit row-has-child-toggled.
1000 if (level != filter->priv->root
1001 && level->visible_nodes == 0
1002 && level->parent_elt
1003 && level->parent_elt->visible)
1004 emit_child_toggled = TRUE;
1011 /* We emit row-deleted, and remove the node from the cache.
1012 * If it has any children, these will be removed here as well.
1016 gtk_tree_model_filter_free_level (filter, elt->children);
1018 path = gtk_tree_model_get_path (GTK_TREE_MODEL (filter), iter);
1019 elt->visible = FALSE;
1020 gtk_tree_model_filter_increment_stamp (filter);
1021 iter->stamp = filter->priv->stamp;
1022 gtk_tree_model_row_deleted (GTK_TREE_MODEL (filter), path);
1023 gtk_tree_path_free (path);
1025 while (elt->ref_count > 1)
1026 gtk_tree_model_filter_real_unref_node (GTK_TREE_MODEL (filter),
1029 if (parent_level || filter->priv->virtual_root)
1030 gtk_tree_model_filter_unref_node (GTK_TREE_MODEL (filter), iter);
1031 else if (elt->ref_count > 0)
1032 gtk_tree_model_filter_real_unref_node (GTK_TREE_MODEL (filter),
1035 /* remove the node */
1036 tmp = bsearch_elt_with_offset (level->array, elt->offset, &i);
1040 g_array_remove_index (level->array, i);
1043 for (i = MAX (i, 0); i < level->array->len; i++)
1045 /* NOTE: here we do *not* decrease offsets, because the node was
1046 * not removed from the child model
1048 elt = &g_array_index (level->array, FilterElt, i);
1050 elt->children->parent_elt = elt;
1054 else if ((length == 1 && parent && parent->ref_count > 1)
1055 || (length == 1 && level == filter->priv->root))
1059 /* We emit row-deleted, but keep the node in the cache and
1060 * referenced. Its children will be removed.
1065 gtk_tree_model_filter_free_level (filter, elt->children);
1066 elt->children = NULL;
1069 path = gtk_tree_model_get_path (GTK_TREE_MODEL (filter), iter);
1070 elt->visible = FALSE;
1071 gtk_tree_model_filter_increment_stamp (filter);
1072 gtk_tree_model_row_deleted (GTK_TREE_MODEL (filter), path);
1073 gtk_tree_path_free (path);
1079 /* Blow level away, including any child levels */
1081 path = gtk_tree_model_get_path (GTK_TREE_MODEL (filter), iter);
1082 elt->visible = FALSE;
1083 gtk_tree_model_filter_increment_stamp (filter);
1084 iter->stamp = filter->priv->stamp;
1085 gtk_tree_model_row_deleted (GTK_TREE_MODEL (filter), path);
1086 gtk_tree_path_free (path);
1088 while (elt->ref_count > 1)
1089 gtk_tree_model_filter_real_unref_node (GTK_TREE_MODEL (filter),
1092 gtk_tree_model_filter_free_level (filter, level);
1095 if (emit_child_toggled)
1100 piter.stamp = filter->priv->stamp;
1101 piter.user_data = parent_level;
1102 piter.user_data2 = parent;
1104 ppath = gtk_tree_model_get_path (GTK_TREE_MODEL (filter), &piter);
1106 gtk_tree_model_row_has_child_toggled (GTK_TREE_MODEL (filter),
1108 gtk_tree_path_free (ppath);
1113 gtk_tree_model_filter_update_children (GtkTreeModelFilter *filter,
1123 iter.stamp = filter->priv->stamp;
1124 iter.user_data = level;
1125 iter.user_data2 = elt;
1127 gtk_tree_model_filter_convert_iter_to_child_iter (filter, &c_iter, &iter);
1129 if (gtk_tree_model_iter_has_child (filter->priv->child_model, &c_iter))
1131 GtkTreePath *path = gtk_tree_model_get_path (GTK_TREE_MODEL (filter),
1133 gtk_tree_model_row_has_child_toggled (GTK_TREE_MODEL (filter),
1137 gtk_tree_path_free (path);
1142 bsearch_elt_with_offset (GArray *array,
1146 gint start, middle, end;
1157 elt = &g_array_index (array, FilterElt, 0);
1159 if (elt->offset == offset)
1170 middle = (start + end) / 2;
1172 elt = &g_array_index (array, FilterElt, middle);
1174 if (elt->offset < offset)
1176 else if (elt->offset > offset)
1181 while (start != end);
1183 if (elt->offset == offset)
1192 /* TreeModel signals */
1194 gtk_tree_model_filter_row_changed (GtkTreeModel *c_model,
1195 GtkTreePath *c_path,
1196 GtkTreeIter *c_iter,
1199 GtkTreeModelFilter *filter = GTK_TREE_MODEL_FILTER (data);
1201 GtkTreeIter children;
1202 GtkTreeIter real_c_iter;
1203 GtkTreePath *path = NULL;
1208 gboolean requested_state;
1209 gboolean current_state;
1210 gboolean free_c_path = FALSE;
1212 g_return_if_fail (c_path != NULL || c_iter != NULL);
1216 c_path = gtk_tree_model_get_path (c_model, c_iter);
1221 real_c_iter = *c_iter;
1223 gtk_tree_model_get_iter (c_model, &real_c_iter, c_path);
1225 /* is this node above the virtual root? */
1226 if (filter->priv->virtual_root
1227 && (gtk_tree_path_get_depth (filter->priv->virtual_root)
1228 >= gtk_tree_path_get_depth (c_path)))
1231 /* what's the requested state? */
1232 requested_state = gtk_tree_model_filter_visible (filter, &real_c_iter);
1234 /* now, let's see whether the item is there */
1235 path = gtk_real_tree_model_filter_convert_child_path_to_path (filter,
1242 gtk_tree_model_filter_get_iter_full (GTK_TREE_MODEL (filter),
1244 current_state = FILTER_ELT (iter.user_data2)->visible;
1247 current_state = FALSE;
1249 if (current_state == FALSE && requested_state == FALSE)
1250 /* no changes required */
1253 if (current_state == TRUE && requested_state == FALSE)
1255 /* get rid of this node */
1256 level = FILTER_LEVEL (iter.user_data);
1257 level->visible_nodes--;
1259 gtk_tree_model_filter_remove_node (filter, &iter);
1264 if (current_state == TRUE && requested_state == TRUE)
1266 /* propagate the signal; also get a path taking only visible
1267 * nodes into account.
1269 gtk_tree_path_free (path);
1270 path = gtk_tree_model_get_path (GTK_TREE_MODEL (filter), &iter);
1272 level = FILTER_LEVEL (iter.user_data);
1273 elt = FILTER_ELT (iter.user_data2);
1275 if (gtk_tree_model_filter_elt_is_visible_in_target (level, elt))
1277 gtk_tree_model_row_changed (GTK_TREE_MODEL (filter), path, &iter);
1279 /* and update the children */
1280 if (gtk_tree_model_iter_children (c_model, &children, &real_c_iter))
1281 gtk_tree_model_filter_update_children (filter, level, elt);
1287 /* only current == FALSE and requested == TRUE is left,
1290 g_return_if_fail (current_state == FALSE && requested_state == TRUE);
1292 /* make sure the new item has been pulled in */
1293 if (!filter->priv->root)
1298 gtk_tree_model_filter_build_level (filter, NULL, NULL, FALSE);
1300 root = FILTER_LEVEL (filter->priv->root);
1303 gtk_tree_model_filter_increment_stamp (filter);
1305 /* We need to allow to build new levels, because we are then pulling
1306 * in a child in an invisible level. We only want to find path if it
1307 * is in a visible level (and thus has a parent that is visible).
1310 path = gtk_real_tree_model_filter_convert_child_path_to_path (filter,
1316 /* parent is probably being filtered out */
1319 gtk_tree_model_filter_get_iter_full (GTK_TREE_MODEL (filter), &iter, path);
1321 level = FILTER_LEVEL (iter.user_data);
1322 elt = FILTER_ELT (iter.user_data2);
1324 /* elt->visible can be TRUE at this point if it was pulled in above */
1327 elt->visible = TRUE;
1328 level->visible_nodes++;
1331 if (gtk_tree_model_filter_elt_is_visible_in_target (level, elt))
1333 /* visibility changed -- reget path */
1334 gtk_tree_path_free (path);
1335 path = gtk_tree_model_get_path (GTK_TREE_MODEL (filter), &iter);
1337 gtk_tree_model_row_inserted (GTK_TREE_MODEL (filter), path, &iter);
1339 if (level->parent_level && level->visible_nodes == 1)
1341 /* We know that this is the first visible node in this level, so
1342 * we need to emit row-has-child-toggled on the parent. This
1343 * does not apply to the root level.
1346 gtk_tree_path_up (path);
1347 gtk_tree_model_get_iter (GTK_TREE_MODEL (filter), &iter, path);
1349 gtk_tree_model_row_has_child_toggled (GTK_TREE_MODEL (filter),
1354 if (gtk_tree_model_iter_children (c_model, &children, c_iter))
1355 gtk_tree_model_filter_update_children (filter, level, elt);
1360 gtk_tree_path_free (path);
1363 gtk_tree_path_free (c_path);
1367 gtk_tree_model_filter_row_inserted (GtkTreeModel *c_model,
1368 GtkTreePath *c_path,
1369 GtkTreeIter *c_iter,
1372 GtkTreeModelFilter *filter = GTK_TREE_MODEL_FILTER (data);
1373 GtkTreePath *path = NULL;
1374 GtkTreePath *real_path = NULL;
1377 GtkTreeIter real_c_iter;
1381 FilterLevel *parent_level;
1385 gboolean free_c_path = FALSE;
1387 g_return_if_fail (c_path != NULL || c_iter != NULL);
1391 c_path = gtk_tree_model_get_path (c_model, c_iter);
1396 real_c_iter = *c_iter;
1398 gtk_tree_model_get_iter (c_model, &real_c_iter, c_path);
1400 /* the row has already been inserted. so we need to fixup the
1401 * virtual root here first
1403 if (filter->priv->virtual_root)
1405 if (gtk_tree_path_get_depth (filter->priv->virtual_root) >=
1406 gtk_tree_path_get_depth (c_path))
1409 gint *v_indices, *c_indices;
1410 gboolean common_prefix = TRUE;
1412 level = gtk_tree_path_get_depth (c_path) - 1;
1413 v_indices = gtk_tree_path_get_indices (filter->priv->virtual_root);
1414 c_indices = gtk_tree_path_get_indices (c_path);
1416 for (i = 0; i < level; i++)
1417 if (v_indices[i] != c_indices[i])
1419 common_prefix = FALSE;
1423 if (common_prefix && v_indices[level] >= c_indices[level])
1424 (v_indices[level])++;
1428 if (!filter->priv->root)
1430 /* No point in building the level if this node is not visible. */
1431 if (!filter->priv->virtual_root
1432 && !gtk_tree_model_filter_visible (filter, c_iter))
1435 /* build level will pull in the new child */
1436 gtk_tree_model_filter_build_level (filter, NULL, NULL, FALSE);
1438 if (filter->priv->root
1439 && FILTER_LEVEL (filter->priv->root)->visible_nodes)
1445 parent_level = level = FILTER_LEVEL (filter->priv->root);
1447 /* subtract virtual root if necessary */
1448 if (filter->priv->virtual_root)
1450 real_path = gtk_tree_model_filter_remove_root (c_path,
1451 filter->priv->virtual_root);
1457 real_path = gtk_tree_path_copy (c_path);
1459 if (gtk_tree_path_get_depth (real_path) - 1 >= 1)
1461 /* find the parent level */
1462 while (i < gtk_tree_path_get_depth (real_path) - 1)
1467 /* we don't cover this signal */
1470 elt = bsearch_elt_with_offset (level->array,
1471 gtk_tree_path_get_indices (real_path)[i],
1475 /* parent is probably being filtered out */
1480 GtkTreePath *tmppath;
1481 GtkTreeIter tmpiter;
1483 tmpiter.stamp = filter->priv->stamp;
1484 tmpiter.user_data = level;
1485 tmpiter.user_data2 = elt;
1487 tmppath = gtk_tree_model_get_path (GTK_TREE_MODEL (data),
1492 gtk_tree_model_row_has_child_toggled (GTK_TREE_MODEL (data),
1494 gtk_tree_path_free (tmppath);
1497 /* not covering this signal */
1501 level = elt->children;
1502 parent_level = level;
1510 /* let's try to insert the value */
1511 offset = gtk_tree_path_get_indices (real_path)[gtk_tree_path_get_depth (real_path) - 1];
1513 /* update the offsets, yes if we didn't insert the node above, there will
1514 * be a gap here. This will be filled with the node (via fetch_child) when
1515 * it becomes visible
1517 for (i = 0; i < level->array->len; i++)
1519 FilterElt *e = &g_array_index (level->array, FilterElt, i);
1520 if ((e->offset >= offset))
1524 /* only insert when visible */
1525 if (gtk_tree_model_filter_visible (filter, &real_c_iter))
1529 if (GTK_TREE_MODEL_FILTER_CACHE_CHILD_ITERS (filter))
1530 felt.iter = real_c_iter;
1532 felt.offset = offset;
1533 felt.zero_ref_count = 0;
1535 felt.visible = TRUE;
1536 felt.children = NULL;
1538 for (i = 0; i < level->array->len; i++)
1539 if (g_array_index (level->array, FilterElt, i).offset > offset)
1542 level->visible_nodes++;
1544 g_array_insert_val (level->array, i, felt);
1546 if (level->parent_level || filter->priv->virtual_root)
1550 f_iter.stamp = filter->priv->stamp;
1551 f_iter.user_data = level;
1552 f_iter.user_data2 = &g_array_index (level->array, FilterElt, i);
1554 gtk_tree_model_filter_ref_node (GTK_TREE_MODEL (filter), &f_iter);
1558 /* another iteration to update the references of children to parents. */
1559 for (i = 0; i < level->array->len; i++)
1561 FilterElt *e = &g_array_index (level->array, FilterElt, i);
1563 e->children->parent_elt = e;
1566 /* don't emit the signal if we aren't visible */
1567 if (!gtk_tree_model_filter_visible (filter, &real_c_iter))
1571 /* NOTE: pass c_path here and NOT real_path. This function does
1572 * root subtraction itself
1574 path = gtk_real_tree_model_filter_convert_child_path_to_path (filter,
1581 gtk_tree_model_filter_increment_stamp (filter);
1583 gtk_tree_model_filter_get_iter_full (GTK_TREE_MODEL (data), &iter, path);
1585 /* get a path taking only visible nodes into account */
1586 gtk_tree_path_free (path);
1587 path = gtk_tree_model_get_path (GTK_TREE_MODEL (data), &iter);
1589 gtk_tree_model_row_inserted (GTK_TREE_MODEL (data), path, &iter);
1591 gtk_tree_path_free (path);
1595 gtk_tree_path_free (real_path);
1598 gtk_tree_path_free (c_path);
1602 gtk_tree_model_filter_row_has_child_toggled (GtkTreeModel *c_model,
1603 GtkTreePath *c_path,
1604 GtkTreeIter *c_iter,
1607 GtkTreeModelFilter *filter = GTK_TREE_MODEL_FILTER (data);
1612 gboolean requested_state;
1614 g_return_if_fail (c_path != NULL && c_iter != NULL);
1616 /* If we get row-has-child-toggled on the virtual root, and there is
1617 * no root level; try to build it now.
1619 if (filter->priv->virtual_root && !filter->priv->root
1620 && !gtk_tree_path_compare (c_path, filter->priv->virtual_root))
1622 gtk_tree_model_filter_build_level (filter, NULL, NULL, TRUE);
1626 /* For all other levels, there is a chance that the visibility state
1627 * of the parent has changed now.
1630 path = gtk_real_tree_model_filter_convert_child_path_to_path (filter,
1637 gtk_tree_model_filter_get_iter_full (GTK_TREE_MODEL (data), &iter, path);
1639 level = FILTER_LEVEL (iter.user_data);
1640 elt = FILTER_ELT (iter.user_data2);
1642 gtk_tree_path_free (path);
1644 requested_state = gtk_tree_model_filter_visible (filter, c_iter);
1646 if (!elt->visible && !requested_state)
1648 /* The parent node currently is not visible and will not become
1649 * visible, so we will not pass on the row-has-child-toggled event.
1653 else if (elt->visible && !requested_state)
1655 /* The node is no longer visible, so it has to be removed.
1656 * _remove_node() takes care of emitting row-has-child-toggled
1659 level->visible_nodes--;
1661 gtk_tree_model_filter_remove_node (filter, &iter);
1665 else if (!elt->visible && requested_state)
1667 elt->visible = TRUE;
1668 level->visible_nodes++;
1670 /* Only insert if the parent is visible in the target */
1671 if (gtk_tree_model_filter_elt_is_visible_in_target (level, elt))
1673 path = gtk_tree_model_get_path (GTK_TREE_MODEL (filter), &iter);
1674 gtk_tree_model_row_inserted (GTK_TREE_MODEL (filter), path, &iter);
1675 gtk_tree_path_free (path);
1677 /* We do not update children now, because that will happen
1682 /* For the remaining possibility, elt->visible && requested_state
1683 * no action is required.
1686 /* If this node is referenced and has children, build the level so we
1687 * can monitor it for changes.
1689 if (elt->ref_count > 1 && gtk_tree_model_iter_has_child (c_model, c_iter))
1690 gtk_tree_model_filter_build_level (filter, level, elt, TRUE);
1692 /* get a path taking only visible nodes into account */
1693 path = gtk_tree_model_get_path (GTK_TREE_MODEL (data), &iter);
1694 gtk_tree_model_row_has_child_toggled (GTK_TREE_MODEL (data), path, &iter);
1695 gtk_tree_path_free (path);
1699 gtk_tree_model_filter_row_deleted (GtkTreeModel *c_model,
1700 GtkTreePath *c_path,
1703 GtkTreeModelFilter *filter = GTK_TREE_MODEL_FILTER (data);
1706 FilterElt *elt, *parent = NULL;
1707 FilterLevel *level, *parent_level = NULL;
1708 gboolean emit_child_toggled = FALSE;
1712 g_return_if_fail (c_path != NULL);
1714 /* special case the deletion of an ancestor of the virtual root */
1715 if (filter->priv->virtual_root &&
1716 (gtk_tree_path_is_ancestor (c_path, filter->priv->virtual_root) ||
1717 !gtk_tree_path_compare (c_path, filter->priv->virtual_root)))
1721 FilterLevel *level = FILTER_LEVEL (filter->priv->root);
1723 gtk_tree_model_filter_unref_path (filter, filter->priv->virtual_root);
1724 filter->priv->virtual_root_deleted = TRUE;
1729 /* remove everything in the filter model
1731 * For now, we just iterate over the root level and emit a
1732 * row_deleted for each FilterElt. Not sure if this is correct.
1735 gtk_tree_model_filter_increment_stamp (filter);
1736 path = gtk_tree_path_new ();
1737 gtk_tree_path_append_index (path, 0);
1739 for (i = 0; i < level->visible_nodes; i++)
1740 gtk_tree_model_row_deleted (GTK_TREE_MODEL (data), path);
1742 gtk_tree_path_free (path);
1743 gtk_tree_model_filter_free_level (filter, filter->priv->root);
1748 /* fixup virtual root */
1749 if (filter->priv->virtual_root)
1751 if (gtk_tree_path_get_depth (filter->priv->virtual_root) >=
1752 gtk_tree_path_get_depth (c_path))
1755 gint *v_indices, *c_indices;
1756 gboolean common_prefix = TRUE;
1758 level = gtk_tree_path_get_depth (c_path) - 1;
1759 v_indices = gtk_tree_path_get_indices (filter->priv->virtual_root);
1760 c_indices = gtk_tree_path_get_indices (c_path);
1762 for (i = 0; i < level; i++)
1763 if (v_indices[i] != c_indices[i])
1765 common_prefix = FALSE;
1769 if (common_prefix && v_indices[level] > c_indices[level])
1770 (v_indices[level])--;
1774 path = gtk_real_tree_model_filter_convert_child_path_to_path (filter,
1781 /* The node deleted in the child model is not visible in the
1782 * filter model. We will not emit a signal, just fixup the offsets
1783 * of the other nodes.
1785 GtkTreePath *real_path;
1787 if (!filter->priv->root)
1790 level = FILTER_LEVEL (filter->priv->root);
1792 /* subtract vroot if necessary */
1793 if (filter->priv->virtual_root)
1795 real_path = gtk_tree_model_filter_remove_root (c_path,
1796 filter->priv->virtual_root);
1797 /* we don't handle this */
1802 real_path = gtk_tree_path_copy (c_path);
1805 if (gtk_tree_path_get_depth (real_path) - 1 >= 1)
1807 /* find the level where the deletion occurred */
1808 while (i < gtk_tree_path_get_depth (real_path) - 1)
1814 /* we don't cover this */
1815 gtk_tree_path_free (real_path);
1819 elt = bsearch_elt_with_offset (level->array,
1820 gtk_tree_path_get_indices (real_path)[i],
1823 if (!elt || !elt->children)
1825 /* parent is filtered out, so no level */
1826 gtk_tree_path_free (real_path);
1830 level = elt->children;
1835 offset = gtk_tree_path_get_indices (real_path)[gtk_tree_path_get_depth (real_path) - 1];
1836 gtk_tree_path_free (real_path);
1841 /* decrease offset of all nodes following the deleted node */
1842 for (i = 0; i < level->array->len; i++)
1844 elt = &g_array_index (level->array, FilterElt, i);
1845 if (elt->offset > offset)
1848 elt->children->parent_elt = elt;
1854 /* a node was deleted, which was in our cache */
1855 gtk_tree_model_filter_get_iter_full (GTK_TREE_MODEL (data), &iter, path);
1857 level = FILTER_LEVEL (iter.user_data);
1858 elt = FILTER_ELT (iter.user_data2);
1859 offset = elt->offset;
1863 /* get a path taking only visible nodes into account */
1864 gtk_tree_path_free (path);
1865 path = gtk_tree_model_get_path (GTK_TREE_MODEL (filter), &iter);
1867 level->visible_nodes--;
1869 if (level->visible_nodes == 0)
1871 emit_child_toggled = TRUE;
1872 parent_level = level->parent_level;
1873 parent = level->parent_elt;
1876 /* emit row_deleted */
1877 gtk_tree_model_filter_increment_stamp (filter);
1878 gtk_tree_model_row_deleted (GTK_TREE_MODEL (data), path);
1879 iter.stamp = filter->priv->stamp;
1882 /* The filter model's reference on the child node is released
1885 while (elt->ref_count > 1)
1886 gtk_tree_model_filter_real_unref_node (GTK_TREE_MODEL (data), &iter,
1889 if (level->array->len == 1)
1892 gtk_tree_model_filter_free_level (filter, level);
1898 /* release the filter model's reference on the node */
1899 if (level->parent_level || filter->priv->virtual_root)
1900 gtk_tree_model_filter_unref_node (GTK_TREE_MODEL (filter), &iter);
1901 else if (elt->ref_count > 0)
1902 gtk_tree_model_filter_real_unref_node (GTK_TREE_MODEL (data), &iter,
1905 /* remove the row */
1906 tmp = bsearch_elt_with_offset (level->array, elt->offset, &i);
1908 offset = tmp->offset;
1909 g_array_remove_index (level->array, i);
1912 for (i = MAX (i, 0); i < level->array->len; i++)
1914 elt = &g_array_index (level->array, FilterElt, i);
1915 if (elt->offset > offset)
1918 elt->children->parent_elt = elt;
1922 if (emit_child_toggled && parent_level)
1927 iter.stamp = filter->priv->stamp;
1928 iter.user_data = parent_level;
1929 iter.user_data2 = parent;
1931 /* We set in_row_deleted to TRUE to avoid a level build triggered
1932 * by row-has-child-toggled (parent model could call iter_has_child
1935 filter->priv->in_row_deleted = TRUE;
1936 path = gtk_tree_model_get_path (GTK_TREE_MODEL (filter), &iter);
1937 gtk_tree_model_row_has_child_toggled (GTK_TREE_MODEL (filter),
1939 gtk_tree_path_free (path);
1940 filter->priv->in_row_deleted = FALSE;
1943 gtk_tree_path_free (path);
1947 gtk_tree_model_filter_rows_reordered (GtkTreeModel *c_model,
1948 GtkTreePath *c_path,
1949 GtkTreeIter *c_iter,
1955 GtkTreeModelFilter *filter = GTK_TREE_MODEL_FILTER (data);
1961 gint i, j, elt_count;
1966 g_return_if_fail (new_order != NULL);
1968 if (c_path == NULL || gtk_tree_path_get_depth (c_path) == 0)
1970 length = gtk_tree_model_iter_n_children (c_model, NULL);
1972 if (filter->priv->virtual_root)
1976 /* reorder root level of path */
1977 for (i = 0; i < length; i++)
1978 if (new_order[i] == gtk_tree_path_get_indices (filter->priv->virtual_root)[0])
1984 gtk_tree_path_get_indices (filter->priv->virtual_root)[0] = new_pos;
1988 path = gtk_tree_path_new ();
1989 level = FILTER_LEVEL (filter->priv->root);
1993 GtkTreeIter child_iter;
1995 /* virtual root anchor reordering */
1996 if (filter->priv->virtual_root &&
1997 gtk_tree_path_is_ancestor (c_path, filter->priv->virtual_root))
2002 GtkTreeIter real_c_iter;
2004 level = gtk_tree_path_get_depth (c_path);
2007 real_c_iter = *c_iter;
2009 gtk_tree_model_get_iter (c_model, &real_c_iter, c_path);
2011 length = gtk_tree_model_iter_n_children (c_model, &real_c_iter);
2013 for (i = 0; i < length; i++)
2014 if (new_order[i] == gtk_tree_path_get_indices (filter->priv->virtual_root)[level])
2020 gtk_tree_path_get_indices (filter->priv->virtual_root)[level] = new_pos;
2024 path = gtk_real_tree_model_filter_convert_child_path_to_path (filter,
2029 if (!path && filter->priv->virtual_root &&
2030 gtk_tree_path_compare (c_path, filter->priv->virtual_root))
2033 if (!path && !filter->priv->virtual_root)
2038 /* root level mode */
2040 gtk_tree_model_get_iter (c_model, c_iter, c_path);
2041 length = gtk_tree_model_iter_n_children (c_model, c_iter);
2042 path = gtk_tree_path_new ();
2043 level = FILTER_LEVEL (filter->priv->root);
2047 gtk_tree_model_filter_get_iter_full (GTK_TREE_MODEL (data),
2050 level = FILTER_LEVEL (iter.user_data);
2051 elt = FILTER_ELT (iter.user_data2);
2055 gtk_tree_path_free (path);
2059 level = elt->children;
2061 gtk_tree_model_filter_convert_iter_to_child_iter (GTK_TREE_MODEL_FILTER (filter), &child_iter, &iter);
2062 length = gtk_tree_model_iter_n_children (c_model, &child_iter);
2066 if (!level || level->array->len < 1)
2068 gtk_tree_path_free (path);
2072 /* NOTE: we do not bail out here if level->array->len < 2 like
2073 * GtkTreeModelSort does. This because we do some special tricky
2077 /* construct a new array */
2078 new_array = g_array_sized_new (FALSE, FALSE, sizeof (FilterElt),
2080 tmp_array = g_new (gint, level->array->len);
2082 for (i = 0, elt_count = 0; i < length; i++)
2084 FilterElt *e = NULL;
2085 gint old_offset = -1;
2087 for (j = 0; j < level->array->len; j++)
2088 if (g_array_index (level->array, FilterElt, j).offset == new_order[i])
2090 e = &g_array_index (level->array, FilterElt, j);
2098 tmp_array[elt_count] = old_offset;
2099 g_array_append_val (new_array, *e);
2100 g_array_index (new_array, FilterElt, elt_count).offset = i;
2104 g_array_free (level->array, TRUE);
2105 level->array = new_array;
2108 for (i = 0; i < level->array->len; i++)
2110 FilterElt *e = &g_array_index (level->array, FilterElt, i);
2112 e->children->parent_elt = e;
2115 /* emit rows_reordered */
2116 if (!gtk_tree_path_get_indices (path))
2117 gtk_tree_model_rows_reordered (GTK_TREE_MODEL (data), path, NULL,
2121 /* get a path taking only visible nodes into account */
2122 gtk_tree_path_free (path);
2123 path = gtk_tree_model_get_path (GTK_TREE_MODEL (data), &iter);
2125 gtk_tree_model_rows_reordered (GTK_TREE_MODEL (data), path, &iter,
2131 gtk_tree_path_free (path);
2134 /* TreeModelIface implementation */
2135 static GtkTreeModelFlags
2136 gtk_tree_model_filter_get_flags (GtkTreeModel *model)
2138 GtkTreeModelFlags flags;
2140 g_return_val_if_fail (GTK_IS_TREE_MODEL_FILTER (model), 0);
2141 g_return_val_if_fail (GTK_TREE_MODEL_FILTER (model)->priv->child_model != NULL, 0);
2143 flags = gtk_tree_model_get_flags (GTK_TREE_MODEL_FILTER (model)->priv->child_model);
2145 if ((flags & GTK_TREE_MODEL_LIST_ONLY) == GTK_TREE_MODEL_LIST_ONLY)
2146 return GTK_TREE_MODEL_LIST_ONLY;
2152 gtk_tree_model_filter_get_n_columns (GtkTreeModel *model)
2154 GtkTreeModelFilter *filter = (GtkTreeModelFilter *)model;
2156 g_return_val_if_fail (GTK_IS_TREE_MODEL_FILTER (model), 0);
2157 g_return_val_if_fail (filter->priv->child_model != NULL, 0);
2159 if (filter->priv->child_model == NULL)
2162 /* so we can't modify the modify func after this ... */
2163 filter->priv->modify_func_set = TRUE;
2165 if (filter->priv->modify_n_columns > 0)
2166 return filter->priv->modify_n_columns;
2168 return gtk_tree_model_get_n_columns (filter->priv->child_model);
2172 gtk_tree_model_filter_get_column_type (GtkTreeModel *model,
2175 GtkTreeModelFilter *filter = (GtkTreeModelFilter *)model;
2177 g_return_val_if_fail (GTK_IS_TREE_MODEL_FILTER (model), G_TYPE_INVALID);
2178 g_return_val_if_fail (filter->priv->child_model != NULL, G_TYPE_INVALID);
2180 /* so we can't modify the modify func after this ... */
2181 filter->priv->modify_func_set = TRUE;
2183 if (filter->priv->modify_types)
2185 g_return_val_if_fail (index < filter->priv->modify_n_columns, G_TYPE_INVALID);
2187 return filter->priv->modify_types[index];
2190 return gtk_tree_model_get_column_type (filter->priv->child_model, index);
2193 /* A special case of _get_iter; this function can also get iters which
2194 * are not visible. These iters should ONLY be passed internally, never
2195 * pass those along with a signal emission.
2198 gtk_tree_model_filter_get_iter_full (GtkTreeModel *model,
2202 GtkTreeModelFilter *filter = (GtkTreeModelFilter *)model;
2207 g_return_val_if_fail (GTK_IS_TREE_MODEL_FILTER (model), FALSE);
2208 g_return_val_if_fail (filter->priv->child_model != NULL, FALSE);
2210 indices = gtk_tree_path_get_indices (path);
2212 if (filter->priv->root == NULL)
2213 gtk_tree_model_filter_build_level (filter, NULL, NULL, FALSE);
2214 level = FILTER_LEVEL (filter->priv->root);
2216 depth = gtk_tree_path_get_depth (path);
2223 for (i = 0; i < depth - 1; i++)
2225 if (!level || indices[i] >= level->array->len)
2230 elt = gtk_tree_model_filter_get_nth (filter, level, indices[i]);
2233 gtk_tree_model_filter_build_level (filter, level, elt, FALSE);
2234 level = elt->children;
2237 if (!level || indices[i] >= level->array->len)
2243 iter->stamp = filter->priv->stamp;
2244 iter->user_data = level;
2246 elt = gtk_tree_model_filter_get_nth (filter, level, indices[depth - 1]);
2247 iter->user_data2 = elt;
2253 gtk_tree_model_filter_get_iter (GtkTreeModel *model,
2257 GtkTreeModelFilter *filter = (GtkTreeModelFilter *)model;
2262 g_return_val_if_fail (GTK_IS_TREE_MODEL_FILTER (model), FALSE);
2263 g_return_val_if_fail (filter->priv->child_model != NULL, FALSE);
2265 indices = gtk_tree_path_get_indices (path);
2267 if (filter->priv->root == NULL)
2268 gtk_tree_model_filter_build_level (filter, NULL, NULL, FALSE);
2269 level = FILTER_LEVEL (filter->priv->root);
2271 depth = gtk_tree_path_get_depth (path);
2278 for (i = 0; i < depth - 1; i++)
2280 if (!level || indices[i] >= level->visible_nodes)
2285 elt = gtk_tree_model_filter_get_nth_visible (filter, level, indices[i]);
2288 gtk_tree_model_filter_build_level (filter, level, elt, FALSE);
2289 level = elt->children;
2292 if (!level || indices[i] >= level->visible_nodes)
2298 iter->stamp = filter->priv->stamp;
2299 iter->user_data = level;
2301 elt = gtk_tree_model_filter_get_nth_visible (filter, level,
2302 indices[depth - 1]);
2303 iter->user_data2 = elt;
2308 static GtkTreePath *
2309 gtk_tree_model_filter_get_path (GtkTreeModel *model,
2312 GtkTreePath *retval;
2316 g_return_val_if_fail (GTK_IS_TREE_MODEL_FILTER (model), NULL);
2317 g_return_val_if_fail (GTK_TREE_MODEL_FILTER (model)->priv->child_model != NULL, NULL);
2318 g_return_val_if_fail (GTK_TREE_MODEL_FILTER (model)->priv->stamp == iter->stamp, NULL);
2320 level = iter->user_data;
2321 elt = iter->user_data2;
2326 retval = gtk_tree_path_new ();
2330 int i = 0, index = 0;
2332 while (&g_array_index (level->array, FilterElt, i) != elt)
2334 if (g_array_index (level->array, FilterElt, i).visible)
2338 g_assert (i < level->array->len);
2341 gtk_tree_path_prepend_index (retval, index);
2342 elt = level->parent_elt;
2343 level = level->parent_level;
2350 gtk_tree_model_filter_get_value (GtkTreeModel *model,
2355 GtkTreeIter child_iter;
2356 GtkTreeModelFilter *filter = GTK_TREE_MODEL_FILTER (model);
2358 g_return_if_fail (GTK_IS_TREE_MODEL_FILTER (model));
2359 g_return_if_fail (GTK_TREE_MODEL_FILTER (model)->priv->child_model != NULL);
2360 g_return_if_fail (GTK_TREE_MODEL_FILTER (model)->priv->stamp == iter->stamp);
2362 if (filter->priv->modify_func)
2364 g_return_if_fail (column < filter->priv->modify_n_columns);
2366 g_value_init (value, filter->priv->modify_types[column]);
2367 filter->priv->modify_func (model,
2371 filter->priv->modify_data);
2376 gtk_tree_model_filter_convert_iter_to_child_iter (GTK_TREE_MODEL_FILTER (model), &child_iter, iter);
2377 gtk_tree_model_get_value (GTK_TREE_MODEL_FILTER (model)->priv->child_model,
2378 &child_iter, column, value);
2382 gtk_tree_model_filter_iter_next (GtkTreeModel *model,
2389 g_return_val_if_fail (GTK_IS_TREE_MODEL_FILTER (model), FALSE);
2390 g_return_val_if_fail (GTK_TREE_MODEL_FILTER (model)->priv->child_model != NULL, FALSE);
2391 g_return_val_if_fail (GTK_TREE_MODEL_FILTER (model)->priv->stamp == iter->stamp, FALSE);
2393 level = iter->user_data;
2394 elt = iter->user_data2;
2396 i = elt - FILTER_ELT (level->array->data);
2398 while (i < level->array->len - 1)
2405 iter->user_data2 = elt;
2410 /* no next visible iter */
2417 gtk_tree_model_filter_iter_children (GtkTreeModel *model,
2419 GtkTreeIter *parent)
2421 GtkTreeModelFilter *filter = (GtkTreeModelFilter *)model;
2425 g_return_val_if_fail (GTK_IS_TREE_MODEL_FILTER (model), FALSE);
2426 g_return_val_if_fail (filter->priv->child_model != NULL, FALSE);
2428 g_return_val_if_fail (filter->priv->stamp == parent->stamp, FALSE);
2434 if (!filter->priv->root)
2435 gtk_tree_model_filter_build_level (filter, NULL, NULL, FALSE);
2436 if (!filter->priv->root)
2439 level = filter->priv->root;
2441 if (!level->visible_nodes)
2444 iter->stamp = filter->priv->stamp;
2445 iter->user_data = level;
2447 while (i < level->array->len)
2449 if (!g_array_index (level->array, FilterElt, i).visible)
2455 iter->user_data2 = &g_array_index (level->array, FilterElt, i);
2466 if (FILTER_ELT (parent->user_data2)->children == NULL)
2467 gtk_tree_model_filter_build_level (filter,
2468 FILTER_LEVEL (parent->user_data),
2469 FILTER_ELT (parent->user_data2),
2471 if (FILTER_ELT (parent->user_data2)->children == NULL)
2474 if (FILTER_ELT (parent->user_data2)->children->visible_nodes <= 0)
2477 iter->stamp = filter->priv->stamp;
2478 iter->user_data = FILTER_ELT (parent->user_data2)->children;
2480 level = FILTER_LEVEL (iter->user_data);
2482 while (i < level->array->len)
2484 if (!g_array_index (level->array, FilterElt, i).visible)
2490 iter->user_data2 = &g_array_index (level->array, FilterElt, i);
2503 gtk_tree_model_filter_iter_has_child (GtkTreeModel *model,
2506 GtkTreeIter child_iter;
2507 GtkTreeModelFilter *filter = (GtkTreeModelFilter *)model;
2510 g_return_val_if_fail (GTK_IS_TREE_MODEL_FILTER (model), FALSE);
2511 g_return_val_if_fail (filter->priv->child_model != NULL, FALSE);
2512 g_return_val_if_fail (filter->priv->stamp == iter->stamp, FALSE);
2514 filter = GTK_TREE_MODEL_FILTER (model);
2516 gtk_tree_model_filter_convert_iter_to_child_iter (GTK_TREE_MODEL_FILTER (model), &child_iter, iter);
2517 elt = FILTER_ELT (iter->user_data2);
2522 /* we need to build the level to check if not all children are filtered
2526 && gtk_tree_model_iter_has_child (filter->priv->child_model, &child_iter))
2527 gtk_tree_model_filter_build_level (filter, FILTER_LEVEL (iter->user_data),
2530 if (elt->children && elt->children->visible_nodes > 0)
2537 gtk_tree_model_filter_iter_n_children (GtkTreeModel *model,
2540 GtkTreeIter child_iter;
2541 GtkTreeModelFilter *filter = (GtkTreeModelFilter *)model;
2544 g_return_val_if_fail (GTK_IS_TREE_MODEL_FILTER (model), 0);
2545 g_return_val_if_fail (filter->priv->child_model != NULL, 0);
2547 g_return_val_if_fail (filter->priv->stamp == iter->stamp, 0);
2551 if (!filter->priv->root)
2552 gtk_tree_model_filter_build_level (filter, NULL, NULL, FALSE);
2554 if (filter->priv->root)
2555 return FILTER_LEVEL (filter->priv->root)->visible_nodes;
2560 elt = FILTER_ELT (iter->user_data2);
2565 gtk_tree_model_filter_convert_iter_to_child_iter (GTK_TREE_MODEL_FILTER (model), &child_iter, iter);
2567 if (!elt->children &&
2568 gtk_tree_model_iter_has_child (filter->priv->child_model, &child_iter))
2569 gtk_tree_model_filter_build_level (filter,
2570 FILTER_LEVEL (iter->user_data),
2574 return elt->children->visible_nodes;
2580 gtk_tree_model_filter_iter_nth_child (GtkTreeModel *model,
2582 GtkTreeIter *parent,
2587 GtkTreeIter children;
2589 g_return_val_if_fail (GTK_IS_TREE_MODEL_FILTER (model), FALSE);
2591 g_return_val_if_fail (GTK_TREE_MODEL_FILTER (model)->priv->stamp == parent->stamp, FALSE);
2593 /* use this instead of has_child to force us to build the level, if needed */
2594 if (gtk_tree_model_filter_iter_children (model, &children, parent) == FALSE)
2600 level = children.user_data;
2601 elt = FILTER_ELT (level->array->data);
2603 if (n >= level->visible_nodes)
2609 elt = gtk_tree_model_filter_get_nth_visible (GTK_TREE_MODEL_FILTER (model),
2612 iter->stamp = GTK_TREE_MODEL_FILTER (model)->priv->stamp;
2613 iter->user_data = level;
2614 iter->user_data2 = elt;
2620 gtk_tree_model_filter_iter_parent (GtkTreeModel *model,
2627 g_return_val_if_fail (GTK_IS_TREE_MODEL_FILTER (model), FALSE);
2628 g_return_val_if_fail (GTK_TREE_MODEL_FILTER (model)->priv->child_model != NULL, FALSE);
2629 g_return_val_if_fail (GTK_TREE_MODEL_FILTER (model)->priv->stamp == child->stamp, FALSE);
2631 level = child->user_data;
2633 if (level->parent_level)
2635 iter->stamp = GTK_TREE_MODEL_FILTER (model)->priv->stamp;
2636 iter->user_data = level->parent_level;
2637 iter->user_data2 = level->parent_elt;
2646 gtk_tree_model_filter_ref_node (GtkTreeModel *model,
2649 GtkTreeModelFilter *filter = (GtkTreeModelFilter *)model;
2650 GtkTreeIter child_iter;
2654 g_return_if_fail (GTK_IS_TREE_MODEL_FILTER (model));
2655 g_return_if_fail (GTK_TREE_MODEL_FILTER (model)->priv->child_model != NULL);
2656 g_return_if_fail (GTK_TREE_MODEL_FILTER (model)->priv->stamp == iter->stamp);
2658 gtk_tree_model_filter_convert_iter_to_child_iter (GTK_TREE_MODEL_FILTER (model), &child_iter, iter);
2660 gtk_tree_model_ref_node (filter->priv->child_model, &child_iter);
2662 level = iter->user_data;
2663 elt = iter->user_data2;
2667 if (level->ref_count == 1)
2669 FilterLevel *parent_level = level->parent_level;
2670 FilterElt *parent_elt = level->parent_elt;
2672 /* we were at zero -- time to decrease the zero_ref_count val */
2673 while (parent_level)
2675 parent_elt->zero_ref_count--;
2677 parent_elt = parent_level->parent_elt;
2678 parent_level = parent_level->parent_level;
2681 if (filter->priv->root != level)
2682 filter->priv->zero_ref_count--;
2687 gtk_tree_model_filter_unref_node (GtkTreeModel *model,
2690 gtk_tree_model_filter_real_unref_node (model, iter, TRUE);
2694 gtk_tree_model_filter_real_unref_node (GtkTreeModel *model,
2696 gboolean propagate_unref)
2698 GtkTreeModelFilter *filter = (GtkTreeModelFilter *)model;
2702 g_return_if_fail (GTK_IS_TREE_MODEL_FILTER (model));
2703 g_return_if_fail (filter->priv->child_model != NULL);
2704 g_return_if_fail (filter->priv->stamp == iter->stamp);
2706 if (propagate_unref)
2708 GtkTreeIter child_iter;
2709 gtk_tree_model_filter_convert_iter_to_child_iter (GTK_TREE_MODEL_FILTER (model), &child_iter, iter);
2710 gtk_tree_model_unref_node (filter->priv->child_model, &child_iter);
2713 level = iter->user_data;
2714 elt = iter->user_data2;
2716 g_return_if_fail (elt->ref_count > 0);
2720 if (level->ref_count == 0)
2722 FilterLevel *parent_level = level->parent_level;
2723 FilterElt *parent_elt = level->parent_elt;
2725 /* we are at zero -- time to increase the zero_ref_count val */
2726 while (parent_level)
2728 parent_elt->zero_ref_count++;
2730 parent_elt = parent_level->parent_elt;
2731 parent_level = parent_level->parent_level;
2734 if (filter->priv->root != level)
2735 filter->priv->zero_ref_count++;
2739 /* TreeDragSource interface implementation */
2741 gtk_tree_model_filter_row_draggable (GtkTreeDragSource *drag_source,
2744 GtkTreeModelFilter *tree_model_filter = (GtkTreeModelFilter *)drag_source;
2745 GtkTreePath *child_path;
2748 g_return_val_if_fail (GTK_IS_TREE_MODEL_FILTER (drag_source), FALSE);
2749 g_return_val_if_fail (path != NULL, FALSE);
2751 child_path = gtk_tree_model_filter_convert_path_to_child_path (tree_model_filter, path);
2752 draggable = gtk_tree_drag_source_row_draggable (GTK_TREE_DRAG_SOURCE (tree_model_filter->priv->child_model), child_path);
2753 gtk_tree_path_free (child_path);
2759 gtk_tree_model_filter_drag_data_get (GtkTreeDragSource *drag_source,
2761 GtkSelectionData *selection_data)
2763 GtkTreeModelFilter *tree_model_filter = (GtkTreeModelFilter *)drag_source;
2764 GtkTreePath *child_path;
2767 g_return_val_if_fail (GTK_IS_TREE_MODEL_FILTER (drag_source), FALSE);
2768 g_return_val_if_fail (path != NULL, FALSE);
2770 child_path = gtk_tree_model_filter_convert_path_to_child_path (tree_model_filter, path);
2771 gotten = gtk_tree_drag_source_drag_data_get (GTK_TREE_DRAG_SOURCE (tree_model_filter->priv->child_model), child_path, selection_data);
2772 gtk_tree_path_free (child_path);
2778 gtk_tree_model_filter_drag_data_delete (GtkTreeDragSource *drag_source,
2781 GtkTreeModelFilter *tree_model_filter = (GtkTreeModelFilter *)drag_source;
2782 GtkTreePath *child_path;
2785 g_return_val_if_fail (GTK_IS_TREE_MODEL_FILTER (drag_source), FALSE);
2786 g_return_val_if_fail (path != NULL, FALSE);
2788 child_path = gtk_tree_model_filter_convert_path_to_child_path (tree_model_filter, path);
2789 deleted = gtk_tree_drag_source_drag_data_delete (GTK_TREE_DRAG_SOURCE (tree_model_filter->priv->child_model), child_path);
2790 gtk_tree_path_free (child_path);
2795 /* bits and pieces */
2797 gtk_tree_model_filter_set_model (GtkTreeModelFilter *filter,
2798 GtkTreeModel *child_model)
2800 g_return_if_fail (GTK_IS_TREE_MODEL_FILTER (filter));
2802 if (filter->priv->child_model)
2804 g_signal_handler_disconnect (filter->priv->child_model,
2805 filter->priv->changed_id);
2806 g_signal_handler_disconnect (filter->priv->child_model,
2807 filter->priv->inserted_id);
2808 g_signal_handler_disconnect (filter->priv->child_model,
2809 filter->priv->has_child_toggled_id);
2810 g_signal_handler_disconnect (filter->priv->child_model,
2811 filter->priv->deleted_id);
2812 g_signal_handler_disconnect (filter->priv->child_model,
2813 filter->priv->reordered_id);
2815 /* reset our state */
2816 if (filter->priv->root)
2817 gtk_tree_model_filter_free_level (filter, filter->priv->root);
2819 filter->priv->root = NULL;
2820 g_object_unref (filter->priv->child_model);
2821 filter->priv->visible_column = -1;
2823 /* FIXME: do we need to destroy more here? */
2826 filter->priv->child_model = child_model;
2830 g_object_ref (filter->priv->child_model);
2831 filter->priv->changed_id =
2832 g_signal_connect (child_model, "row-changed",
2833 G_CALLBACK (gtk_tree_model_filter_row_changed),
2835 filter->priv->inserted_id =
2836 g_signal_connect (child_model, "row-inserted",
2837 G_CALLBACK (gtk_tree_model_filter_row_inserted),
2839 filter->priv->has_child_toggled_id =
2840 g_signal_connect (child_model, "row-has-child-toggled",
2841 G_CALLBACK (gtk_tree_model_filter_row_has_child_toggled),
2843 filter->priv->deleted_id =
2844 g_signal_connect (child_model, "row-deleted",
2845 G_CALLBACK (gtk_tree_model_filter_row_deleted),
2847 filter->priv->reordered_id =
2848 g_signal_connect (child_model, "rows-reordered",
2849 G_CALLBACK (gtk_tree_model_filter_rows_reordered),
2852 filter->priv->child_flags = gtk_tree_model_get_flags (child_model);
2853 filter->priv->stamp = g_random_int ();
2858 gtk_tree_model_filter_ref_path (GtkTreeModelFilter *filter,
2864 len = gtk_tree_path_get_depth (path);
2865 p = gtk_tree_path_copy (path);
2870 gtk_tree_model_get_iter (GTK_TREE_MODEL (filter->priv->child_model), &iter, p);
2871 gtk_tree_model_ref_node (GTK_TREE_MODEL (filter->priv->child_model), &iter);
2872 gtk_tree_path_up (p);
2875 gtk_tree_path_free (p);
2879 gtk_tree_model_filter_unref_path (GtkTreeModelFilter *filter,
2885 len = gtk_tree_path_get_depth (path);
2886 p = gtk_tree_path_copy (path);
2891 gtk_tree_model_get_iter (GTK_TREE_MODEL (filter->priv->child_model), &iter, p);
2892 gtk_tree_model_unref_node (GTK_TREE_MODEL (filter->priv->child_model), &iter);
2893 gtk_tree_path_up (p);
2896 gtk_tree_path_free (p);
2900 gtk_tree_model_filter_set_root (GtkTreeModelFilter *filter,
2903 g_return_if_fail (GTK_IS_TREE_MODEL_FILTER (filter));
2906 filter->priv->virtual_root = NULL;
2908 filter->priv->virtual_root = gtk_tree_path_copy (root);
2914 * gtk_tree_model_filter_new:
2915 * @child_model: A #GtkTreeModel.
2916 * @root: A #GtkTreePath or %NULL.
2918 * Creates a new #GtkTreeModel, with @child_model as the child_model
2919 * and @root as the virtual root.
2921 * Return value: A new #GtkTreeModel.
2926 gtk_tree_model_filter_new (GtkTreeModel *child_model,
2929 GtkTreeModel *retval;
2930 GtkTreeModelFilter *filter;
2932 g_return_val_if_fail (GTK_IS_TREE_MODEL (child_model), NULL);
2934 retval = g_object_new (GTK_TYPE_TREE_MODEL_FILTER,
2935 "child-model", child_model,
2936 "virtual-root", root,
2939 filter = GTK_TREE_MODEL_FILTER (retval);
2940 if (filter->priv->virtual_root)
2942 gtk_tree_model_filter_ref_path (filter, filter->priv->virtual_root);
2943 filter->priv->virtual_root_deleted = FALSE;
2950 * gtk_tree_model_filter_get_model:
2951 * @filter: A #GtkTreeModelFilter.
2953 * Returns a pointer to the child model of @filter.
2955 * Return value: A pointer to a #GtkTreeModel.
2960 gtk_tree_model_filter_get_model (GtkTreeModelFilter *filter)
2962 g_return_val_if_fail (GTK_IS_TREE_MODEL_FILTER (filter), NULL);
2964 return filter->priv->child_model;
2968 * gtk_tree_model_filter_set_visible_func:
2969 * @filter: A #GtkTreeModelFilter.
2970 * @func: A #GtkTreeModelFilterVisibleFunc, the visible function.
2971 * @data: User data to pass to the visible function, or %NULL.
2972 * @destroy: Destroy notifier of @data, or %NULL.
2974 * Sets the visible function used when filtering the @filter to be @func. The
2975 * function should return %TRUE if the given row should be visible and
2978 * If the condition calculated by the function changes over time (e.g. because
2979 * it depends on some global parameters), you must call
2980 * gtk_tree_model_filter_refilter() to keep the visibility information of
2981 * the model uptodate.
2983 * Note that @func is called whenever a row is inserted, when it may still be
2984 * empty. The visible function should therefore take special care of empty
2985 * rows, like in the example below.
2987 * <informalexample><programlisting>
2989 * visible_func (GtkTreeModel *model,
2990 * GtkTreeIter *iter,
2993 * /* Visible if row is non-empty and first column is "HI" */
2995 * gboolean visible = FALSE;
2997 * gtk_tree_model_get (model, iter, 0, &str, -1);
2998 * if (str && strcmp (str, "HI") == 0)
3004 * </programlisting></informalexample>
3009 gtk_tree_model_filter_set_visible_func (GtkTreeModelFilter *filter,
3010 GtkTreeModelFilterVisibleFunc func,
3012 GDestroyNotify destroy)
3014 g_return_if_fail (GTK_IS_TREE_MODEL_FILTER (filter));
3015 g_return_if_fail (func != NULL);
3016 g_return_if_fail (filter->priv->visible_method_set == FALSE);
3018 if (filter->priv->visible_func)
3020 GDestroyNotify d = filter->priv->visible_destroy;
3022 filter->priv->visible_destroy = NULL;
3023 d (filter->priv->visible_data);
3026 filter->priv->visible_func = func;
3027 filter->priv->visible_data = data;
3028 filter->priv->visible_destroy = destroy;
3030 filter->priv->visible_method_set = TRUE;
3034 * gtk_tree_model_filter_set_modify_func:
3035 * @filter: A #GtkTreeModelFilter.
3036 * @n_columns: The number of columns in the filter model.
3037 * @types: The #GType<!-- -->s of the columns.
3038 * @func: A #GtkTreeModelFilterModifyFunc
3039 * @data: User data to pass to the modify function, or %NULL.
3040 * @destroy: Destroy notifier of @data, or %NULL.
3042 * With the @n_columns and @types parameters, you give an array of column
3043 * types for this model (which will be exposed to the parent model/view).
3044 * The @func, @data and @destroy parameters are for specifying the modify
3045 * function. The modify function will get called for <emphasis>each</emphasis>
3046 * data access, the goal of the modify function is to return the data which
3047 * should be displayed at the location specified using the parameters of the
3053 gtk_tree_model_filter_set_modify_func (GtkTreeModelFilter *filter,
3056 GtkTreeModelFilterModifyFunc func,
3058 GDestroyNotify destroy)
3060 g_return_if_fail (GTK_IS_TREE_MODEL_FILTER (filter));
3061 g_return_if_fail (func != NULL);
3062 g_return_if_fail (filter->priv->modify_func_set == FALSE);
3064 if (filter->priv->modify_destroy)
3066 GDestroyNotify d = filter->priv->modify_destroy;
3068 filter->priv->modify_destroy = NULL;
3069 d (filter->priv->modify_data);
3072 filter->priv->modify_n_columns = n_columns;
3073 filter->priv->modify_types = g_new0 (GType, n_columns);
3074 memcpy (filter->priv->modify_types, types, sizeof (GType) * n_columns);
3075 filter->priv->modify_func = func;
3076 filter->priv->modify_data = data;
3077 filter->priv->modify_destroy = destroy;
3079 filter->priv->modify_func_set = TRUE;
3083 * gtk_tree_model_filter_set_visible_column:
3084 * @filter: A #GtkTreeModelFilter.
3085 * @column: A #gint which is the column containing the visible information.
3087 * Sets @column of the child_model to be the column where @filter should
3088 * look for visibility information. @columns should be a column of type
3089 * %G_TYPE_BOOLEAN, where %TRUE means that a row is visible, and %FALSE
3095 gtk_tree_model_filter_set_visible_column (GtkTreeModelFilter *filter,
3098 g_return_if_fail (GTK_IS_TREE_MODEL_FILTER (filter));
3099 g_return_if_fail (column >= 0);
3100 g_return_if_fail (filter->priv->visible_method_set == FALSE);
3102 filter->priv->visible_column = column;
3104 filter->priv->visible_method_set = TRUE;
3110 * gtk_tree_model_filter_convert_child_iter_to_iter:
3111 * @filter: A #GtkTreeModelFilter.
3112 * @filter_iter: An uninitialized #GtkTreeIter.
3113 * @child_iter: A valid #GtkTreeIter pointing to a row on the child model.
3115 * Sets @filter_iter to point to the row in @filter that corresponds to the
3116 * row pointed at by @child_iter. If @filter_iter was not set, %FALSE is
3119 * Return value: %TRUE, if @filter_iter was set, i.e. if @child_iter is a
3120 * valid iterator pointing to a visible row in child model.
3125 gtk_tree_model_filter_convert_child_iter_to_iter (GtkTreeModelFilter *filter,
3126 GtkTreeIter *filter_iter,
3127 GtkTreeIter *child_iter)
3130 GtkTreePath *child_path, *path;
3132 g_return_val_if_fail (GTK_IS_TREE_MODEL_FILTER (filter), FALSE);
3133 g_return_val_if_fail (filter->priv->child_model != NULL, FALSE);
3134 g_return_val_if_fail (filter_iter != NULL, FALSE);
3135 g_return_val_if_fail (child_iter != NULL, FALSE);
3136 g_return_val_if_fail (filter_iter != child_iter, FALSE);
3138 filter_iter->stamp = 0;
3140 child_path = gtk_tree_model_get_path (filter->priv->child_model, child_iter);
3141 g_return_val_if_fail (child_path != NULL, FALSE);
3143 path = gtk_tree_model_filter_convert_child_path_to_path (filter,
3145 gtk_tree_path_free (child_path);
3150 ret = gtk_tree_model_get_iter (GTK_TREE_MODEL (filter), filter_iter, path);
3151 gtk_tree_path_free (path);
3157 * gtk_tree_model_filter_convert_iter_to_child_iter:
3158 * @filter: A #GtkTreeModelFilter.
3159 * @child_iter: An uninitialized #GtkTreeIter.
3160 * @filter_iter: A valid #GtkTreeIter pointing to a row on @filter.
3162 * Sets @child_iter to point to the row pointed to by @filter_iter.
3167 gtk_tree_model_filter_convert_iter_to_child_iter (GtkTreeModelFilter *filter,
3168 GtkTreeIter *child_iter,
3169 GtkTreeIter *filter_iter)
3171 g_return_if_fail (GTK_IS_TREE_MODEL_FILTER (filter));
3172 g_return_if_fail (filter->priv->child_model != NULL);
3173 g_return_if_fail (child_iter != NULL);
3174 g_return_if_fail (filter_iter != NULL);
3175 g_return_if_fail (filter_iter->stamp == filter->priv->stamp);
3176 g_return_if_fail (filter_iter != child_iter);
3178 if (GTK_TREE_MODEL_FILTER_CACHE_CHILD_ITERS (filter))
3180 *child_iter = FILTER_ELT (filter_iter->user_data2)->iter;
3186 path = gtk_tree_model_filter_elt_get_path (filter_iter->user_data,
3187 filter_iter->user_data2,
3188 filter->priv->virtual_root);
3189 gtk_tree_model_get_iter (filter->priv->child_model, child_iter, path);
3190 gtk_tree_path_free (path);
3194 /* The path returned can only be used internally in the filter model. */
3195 static GtkTreePath *
3196 gtk_real_tree_model_filter_convert_child_path_to_path (GtkTreeModelFilter *filter,
3197 GtkTreePath *child_path,
3198 gboolean build_levels,
3199 gboolean fetch_children)
3201 gint *child_indices;
3202 GtkTreePath *retval;
3203 GtkTreePath *real_path;
3208 g_return_val_if_fail (GTK_IS_TREE_MODEL_FILTER (filter), NULL);
3209 g_return_val_if_fail (filter->priv->child_model != NULL, NULL);
3210 g_return_val_if_fail (child_path != NULL, NULL);
3212 if (!filter->priv->virtual_root)
3213 real_path = gtk_tree_path_copy (child_path);
3215 real_path = gtk_tree_model_filter_remove_root (child_path,
3216 filter->priv->virtual_root);
3221 retval = gtk_tree_path_new ();
3222 child_indices = gtk_tree_path_get_indices (real_path);
3224 if (filter->priv->root == NULL && build_levels)
3225 gtk_tree_model_filter_build_level (filter, NULL, NULL, FALSE);
3226 level = FILTER_LEVEL (filter->priv->root);
3228 for (i = 0; i < gtk_tree_path_get_depth (real_path); i++)
3231 gboolean found_child = FALSE;
3235 gtk_tree_path_free (real_path);
3236 gtk_tree_path_free (retval);
3240 tmp = bsearch_elt_with_offset (level->array, child_indices[i], &j);
3243 gtk_tree_path_append_index (retval, j);
3244 if (!tmp->children && build_levels)
3245 gtk_tree_model_filter_build_level (filter, level, tmp, FALSE);
3246 level = tmp->children;
3250 if (!found_child && fetch_children)
3252 tmp = gtk_tree_model_filter_fetch_child (filter, level,
3256 /* didn't find the child, let's try to bring it back */
3257 if (!tmp || tmp->offset != child_indices[i])
3260 gtk_tree_path_free (real_path);
3261 gtk_tree_path_free (retval);
3265 gtk_tree_path_append_index (retval, j);
3266 if (!tmp->children && build_levels)
3267 gtk_tree_model_filter_build_level (filter, level, tmp, FALSE);
3268 level = tmp->children;
3271 else if (!found_child && !fetch_children)
3274 gtk_tree_path_free (real_path);
3275 gtk_tree_path_free (retval);
3280 gtk_tree_path_free (real_path);
3285 * gtk_tree_model_filter_convert_child_path_to_path:
3286 * @filter: A #GtkTreeModelFilter.
3287 * @child_path: A #GtkTreePath to convert.
3289 * Converts @child_path to a path relative to @filter. That is, @child_path
3290 * points to a path in the child model. The rerturned path will point to the
3291 * same row in the filtered model. If @child_path isn't a valid path on the
3292 * child model or points to a row which is not visible in @filter, then %NULL
3295 * Return value: A newly allocated #GtkTreePath, or %NULL.
3300 gtk_tree_model_filter_convert_child_path_to_path (GtkTreeModelFilter *filter,
3301 GtkTreePath *child_path)
3306 /* this function does the sanity checks */
3307 path = gtk_real_tree_model_filter_convert_child_path_to_path (filter,
3315 /* get a new path which only takes visible nodes into account.
3316 * -- if this gives any performance issues, we can write a special
3317 * version of convert_child_path_to_path immediately returning
3318 * a visible-nodes-only path.
3320 gtk_tree_model_filter_get_iter_full (GTK_TREE_MODEL (filter), &iter, path);
3322 gtk_tree_path_free (path);
3323 path = gtk_tree_model_get_path (GTK_TREE_MODEL (filter), &iter);
3329 * gtk_tree_model_filter_convert_path_to_child_path:
3330 * @filter: A #GtkTreeModelFilter.
3331 * @filter_path: A #GtkTreePath to convert.
3333 * Converts @filter_path to a path on the child model of @filter. That is,
3334 * @filter_path points to a location in @filter. The returned path will
3335 * point to the same location in the model not being filtered. If @filter_path
3336 * does not point to a location in the child model, %NULL is returned.
3338 * Return value: A newly allocated #GtkTreePath, or %NULL.
3343 gtk_tree_model_filter_convert_path_to_child_path (GtkTreeModelFilter *filter,
3344 GtkTreePath *filter_path)
3346 gint *filter_indices;
3347 GtkTreePath *retval;
3351 g_return_val_if_fail (GTK_IS_TREE_MODEL_FILTER (filter), NULL);
3352 g_return_val_if_fail (filter->priv->child_model != NULL, NULL);
3353 g_return_val_if_fail (filter_path != NULL, NULL);
3356 retval = gtk_tree_path_new ();
3357 filter_indices = gtk_tree_path_get_indices (filter_path);
3358 if (!filter->priv->root)
3359 gtk_tree_model_filter_build_level (filter, NULL, NULL, FALSE);
3360 level = FILTER_LEVEL (filter->priv->root);
3362 for (i = 0; i < gtk_tree_path_get_depth (filter_path); i++)
3366 if (!level || level->visible_nodes <= filter_indices[i])
3368 gtk_tree_path_free (retval);
3372 elt = gtk_tree_model_filter_get_nth_visible (filter, level,
3375 if (elt->children == NULL)
3376 gtk_tree_model_filter_build_level (filter, level, elt, FALSE);
3378 if (!level || level->visible_nodes <= filter_indices[i])
3380 gtk_tree_path_free (retval);
3384 gtk_tree_path_append_index (retval, elt->offset);
3385 level = elt->children;
3390 if (filter->priv->virtual_root)
3392 GtkTreePath *real_retval;
3394 real_retval = gtk_tree_model_filter_add_root (retval,
3395 filter->priv->virtual_root);
3396 gtk_tree_path_free (retval);
3405 gtk_tree_model_filter_refilter_helper (GtkTreeModel *model,
3410 /* evil, don't try this at home, but certainly speeds things up */
3411 gtk_tree_model_filter_row_changed (model, path, iter, data);
3417 * gtk_tree_model_filter_refilter:
3418 * @filter: A #GtkTreeModelFilter.
3420 * Emits ::row_changed for each row in the child model, which causes
3421 * the filter to re-evaluate whether a row is visible or not.
3426 gtk_tree_model_filter_refilter (GtkTreeModelFilter *filter)
3428 g_return_if_fail (GTK_IS_TREE_MODEL_FILTER (filter));
3431 gtk_tree_model_foreach (filter->priv->child_model,
3432 gtk_tree_model_filter_refilter_helper,
3437 * gtk_tree_model_filter_clear_cache:
3438 * @filter: A #GtkTreeModelFilter.
3440 * This function should almost never be called. It clears the @filter
3441 * of any cached iterators that haven't been reffed with
3442 * gtk_tree_model_ref_node(). This might be useful if the child model
3443 * being filtered is static (and doesn't change often) and there has been
3444 * a lot of unreffed access to nodes. As a side effect of this function,
3445 * all unreffed iters will be invalid.
3450 gtk_tree_model_filter_clear_cache (GtkTreeModelFilter *filter)
3452 g_return_if_fail (GTK_IS_TREE_MODEL_FILTER (filter));
3454 if (filter->priv->zero_ref_count > 0)
3455 gtk_tree_model_filter_clear_cache_helper (filter,
3456 FILTER_LEVEL (filter->priv->root));
3459 #define __GTK_TREE_MODEL_FILTER_C__
3460 #include "gtkaliasdef.c"