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 (gtk_tree_model_iter_children (c_model, &children, c_iter))
1340 gtk_tree_model_filter_update_children (filter, level, elt);
1345 gtk_tree_path_free (path);
1348 gtk_tree_path_free (c_path);
1352 gtk_tree_model_filter_row_inserted (GtkTreeModel *c_model,
1353 GtkTreePath *c_path,
1354 GtkTreeIter *c_iter,
1357 GtkTreeModelFilter *filter = GTK_TREE_MODEL_FILTER (data);
1358 GtkTreePath *path = NULL;
1359 GtkTreePath *real_path = NULL;
1362 GtkTreeIter real_c_iter;
1366 FilterLevel *parent_level;
1370 gboolean free_c_path = FALSE;
1372 g_return_if_fail (c_path != NULL || c_iter != NULL);
1376 c_path = gtk_tree_model_get_path (c_model, c_iter);
1381 real_c_iter = *c_iter;
1383 gtk_tree_model_get_iter (c_model, &real_c_iter, c_path);
1385 /* the row has already been inserted. so we need to fixup the
1386 * virtual root here first
1388 if (filter->priv->virtual_root)
1390 if (gtk_tree_path_get_depth (filter->priv->virtual_root) >=
1391 gtk_tree_path_get_depth (c_path))
1394 gint *v_indices, *c_indices;
1395 gboolean common_prefix = TRUE;
1397 level = gtk_tree_path_get_depth (c_path) - 1;
1398 v_indices = gtk_tree_path_get_indices (filter->priv->virtual_root);
1399 c_indices = gtk_tree_path_get_indices (c_path);
1401 for (i = 0; i < level; i++)
1402 if (v_indices[i] != c_indices[i])
1404 common_prefix = FALSE;
1408 if (common_prefix && v_indices[level] >= c_indices[level])
1409 (v_indices[level])++;
1413 if (!filter->priv->root)
1415 /* No point in building the level if this node is not visible. */
1416 if (!filter->priv->virtual_root
1417 && !gtk_tree_model_filter_visible (filter, c_iter))
1420 /* build level will pull in the new child */
1421 gtk_tree_model_filter_build_level (filter, NULL, NULL, FALSE);
1423 if (filter->priv->root
1424 && FILTER_LEVEL (filter->priv->root)->visible_nodes)
1430 parent_level = level = FILTER_LEVEL (filter->priv->root);
1432 /* subtract virtual root if necessary */
1433 if (filter->priv->virtual_root)
1435 real_path = gtk_tree_model_filter_remove_root (c_path,
1436 filter->priv->virtual_root);
1442 real_path = gtk_tree_path_copy (c_path);
1444 if (gtk_tree_path_get_depth (real_path) - 1 >= 1)
1446 /* find the parent level */
1447 while (i < gtk_tree_path_get_depth (real_path) - 1)
1452 /* we don't cover this signal */
1455 elt = bsearch_elt_with_offset (level->array,
1456 gtk_tree_path_get_indices (real_path)[i],
1460 /* parent is probably being filtered out */
1465 GtkTreePath *tmppath;
1466 GtkTreeIter tmpiter;
1468 tmpiter.stamp = filter->priv->stamp;
1469 tmpiter.user_data = level;
1470 tmpiter.user_data2 = elt;
1472 tmppath = gtk_tree_model_get_path (GTK_TREE_MODEL (data),
1477 gtk_tree_model_row_has_child_toggled (GTK_TREE_MODEL (data),
1479 gtk_tree_path_free (tmppath);
1482 /* not covering this signal */
1486 level = elt->children;
1487 parent_level = level;
1495 /* let's try to insert the value */
1496 offset = gtk_tree_path_get_indices (real_path)[gtk_tree_path_get_depth (real_path) - 1];
1498 /* update the offsets, yes if we didn't insert the node above, there will
1499 * be a gap here. This will be filled with the node (via fetch_child) when
1500 * it becomes visible
1502 for (i = 0; i < level->array->len; i++)
1504 FilterElt *e = &g_array_index (level->array, FilterElt, i);
1505 if ((e->offset >= offset))
1509 /* only insert when visible */
1510 if (gtk_tree_model_filter_visible (filter, &real_c_iter))
1514 if (GTK_TREE_MODEL_FILTER_CACHE_CHILD_ITERS (filter))
1515 felt.iter = real_c_iter;
1517 felt.offset = offset;
1518 felt.zero_ref_count = 0;
1520 felt.visible = TRUE;
1521 felt.children = NULL;
1523 for (i = 0; i < level->array->len; i++)
1524 if (g_array_index (level->array, FilterElt, i).offset > offset)
1527 level->visible_nodes++;
1529 g_array_insert_val (level->array, i, felt);
1531 if (level->parent_level || filter->priv->virtual_root)
1535 f_iter.stamp = filter->priv->stamp;
1536 f_iter.user_data = level;
1537 f_iter.user_data2 = &g_array_index (level->array, FilterElt, i);
1539 gtk_tree_model_filter_ref_node (GTK_TREE_MODEL (filter), &f_iter);
1543 /* another iteration to update the references of children to parents. */
1544 for (i = 0; i < level->array->len; i++)
1546 FilterElt *e = &g_array_index (level->array, FilterElt, i);
1548 e->children->parent_elt = e;
1551 /* don't emit the signal if we aren't visible */
1552 if (!gtk_tree_model_filter_visible (filter, &real_c_iter))
1556 /* NOTE: pass c_path here and NOT real_path. This function does
1557 * root subtraction itself
1559 path = gtk_real_tree_model_filter_convert_child_path_to_path (filter,
1566 gtk_tree_model_filter_increment_stamp (filter);
1568 gtk_tree_model_filter_get_iter_full (GTK_TREE_MODEL (data), &iter, path);
1570 /* get a path taking only visible nodes into account */
1571 gtk_tree_path_free (path);
1572 path = gtk_tree_model_get_path (GTK_TREE_MODEL (data), &iter);
1574 gtk_tree_model_row_inserted (GTK_TREE_MODEL (data), path, &iter);
1576 gtk_tree_path_free (path);
1580 gtk_tree_path_free (real_path);
1583 gtk_tree_path_free (c_path);
1587 gtk_tree_model_filter_row_has_child_toggled (GtkTreeModel *c_model,
1588 GtkTreePath *c_path,
1589 GtkTreeIter *c_iter,
1592 GtkTreeModelFilter *filter = GTK_TREE_MODEL_FILTER (data);
1597 gboolean requested_state;
1599 g_return_if_fail (c_path != NULL && c_iter != NULL);
1601 /* If we get row-has-child-toggled on the virtual root, and there is
1602 * no root level; try to build it now.
1604 if (filter->priv->virtual_root && !filter->priv->root
1605 && !gtk_tree_path_compare (c_path, filter->priv->virtual_root))
1607 gtk_tree_model_filter_build_level (filter, NULL, NULL, TRUE);
1611 /* For all other levels, there is a chance that the visibility state
1612 * of the parent has changed now.
1615 path = gtk_real_tree_model_filter_convert_child_path_to_path (filter,
1622 gtk_tree_model_filter_get_iter_full (GTK_TREE_MODEL (data), &iter, path);
1624 level = FILTER_LEVEL (iter.user_data);
1625 elt = FILTER_ELT (iter.user_data2);
1627 gtk_tree_path_free (path);
1629 requested_state = gtk_tree_model_filter_visible (filter, c_iter);
1631 if (!elt->visible && !requested_state)
1633 /* The parent node currently is not visible and will not become
1634 * visible, so we will not pass on the row-has-child-toggled event.
1638 else if (elt->visible && !requested_state)
1640 /* The node is no longer visible, so it has to be removed.
1641 * _remove_node() takes care of emitting row-has-child-toggled
1644 level->visible_nodes--;
1646 gtk_tree_model_filter_remove_node (filter, &iter);
1650 else if (!elt->visible && requested_state)
1652 elt->visible = TRUE;
1653 level->visible_nodes++;
1655 /* Only insert if the parent is visible in the target */
1656 if (gtk_tree_model_filter_elt_is_visible_in_target (level, elt))
1658 path = gtk_tree_model_get_path (GTK_TREE_MODEL (filter), &iter);
1659 gtk_tree_model_row_inserted (GTK_TREE_MODEL (filter), path, &iter);
1660 gtk_tree_path_free (path);
1662 /* We do not update children now, because that will happen
1667 /* For the remaining possibility, elt->visible && requested_state
1668 * no action is required.
1671 /* If this node is referenced and has children, build the level so we
1672 * can monitor it for changes.
1674 if (elt->ref_count > 1 && gtk_tree_model_iter_has_child (c_model, c_iter))
1675 gtk_tree_model_filter_build_level (filter, level, elt, TRUE);
1677 /* get a path taking only visible nodes into account */
1678 path = gtk_tree_model_get_path (GTK_TREE_MODEL (data), &iter);
1679 gtk_tree_model_row_has_child_toggled (GTK_TREE_MODEL (data), path, &iter);
1680 gtk_tree_path_free (path);
1684 gtk_tree_model_filter_row_deleted (GtkTreeModel *c_model,
1685 GtkTreePath *c_path,
1688 GtkTreeModelFilter *filter = GTK_TREE_MODEL_FILTER (data);
1691 FilterElt *elt, *parent = NULL;
1692 FilterLevel *level, *parent_level = NULL;
1693 gboolean emit_child_toggled = FALSE;
1697 g_return_if_fail (c_path != NULL);
1699 /* special case the deletion of an ancestor of the virtual root */
1700 if (filter->priv->virtual_root &&
1701 (gtk_tree_path_is_ancestor (c_path, filter->priv->virtual_root) ||
1702 !gtk_tree_path_compare (c_path, filter->priv->virtual_root)))
1706 FilterLevel *level = FILTER_LEVEL (filter->priv->root);
1708 gtk_tree_model_filter_unref_path (filter, filter->priv->virtual_root);
1709 filter->priv->virtual_root_deleted = TRUE;
1714 /* remove everything in the filter model
1716 * For now, we just iterate over the root level and emit a
1717 * row_deleted for each FilterElt. Not sure if this is correct.
1720 gtk_tree_model_filter_increment_stamp (filter);
1721 path = gtk_tree_path_new ();
1722 gtk_tree_path_append_index (path, 0);
1724 for (i = 0; i < level->visible_nodes; i++)
1725 gtk_tree_model_row_deleted (GTK_TREE_MODEL (data), path);
1727 gtk_tree_path_free (path);
1728 gtk_tree_model_filter_free_level (filter, filter->priv->root);
1733 /* fixup virtual root */
1734 if (filter->priv->virtual_root)
1736 if (gtk_tree_path_get_depth (filter->priv->virtual_root) >=
1737 gtk_tree_path_get_depth (c_path))
1740 gint *v_indices, *c_indices;
1741 gboolean common_prefix = TRUE;
1743 level = gtk_tree_path_get_depth (c_path) - 1;
1744 v_indices = gtk_tree_path_get_indices (filter->priv->virtual_root);
1745 c_indices = gtk_tree_path_get_indices (c_path);
1747 for (i = 0; i < level; i++)
1748 if (v_indices[i] != c_indices[i])
1750 common_prefix = FALSE;
1754 if (common_prefix && v_indices[level] > c_indices[level])
1755 (v_indices[level])--;
1759 path = gtk_real_tree_model_filter_convert_child_path_to_path (filter,
1766 /* The node deleted in the child model is not visible in the
1767 * filter model. We will not emit a signal, just fixup the offsets
1768 * of the other nodes.
1770 GtkTreePath *real_path;
1772 if (!filter->priv->root)
1775 level = FILTER_LEVEL (filter->priv->root);
1777 /* subtract vroot if necessary */
1778 if (filter->priv->virtual_root)
1780 real_path = gtk_tree_model_filter_remove_root (c_path,
1781 filter->priv->virtual_root);
1782 /* we don't handle this */
1787 real_path = gtk_tree_path_copy (c_path);
1790 if (gtk_tree_path_get_depth (real_path) - 1 >= 1)
1792 /* find the level where the deletion occurred */
1793 while (i < gtk_tree_path_get_depth (real_path) - 1)
1799 /* we don't cover this */
1800 gtk_tree_path_free (real_path);
1804 elt = bsearch_elt_with_offset (level->array,
1805 gtk_tree_path_get_indices (real_path)[i],
1808 if (!elt || !elt->children)
1810 /* parent is filtered out, so no level */
1811 gtk_tree_path_free (real_path);
1815 level = elt->children;
1820 offset = gtk_tree_path_get_indices (real_path)[gtk_tree_path_get_depth (real_path) - 1];
1821 gtk_tree_path_free (real_path);
1826 /* decrease offset of all nodes following the deleted node */
1827 for (i = 0; i < level->array->len; i++)
1829 elt = &g_array_index (level->array, FilterElt, i);
1830 if (elt->offset > offset)
1833 elt->children->parent_elt = elt;
1839 /* a node was deleted, which was in our cache */
1840 gtk_tree_model_filter_get_iter_full (GTK_TREE_MODEL (data), &iter, path);
1842 level = FILTER_LEVEL (iter.user_data);
1843 elt = FILTER_ELT (iter.user_data2);
1844 offset = elt->offset;
1848 /* get a path taking only visible nodes into account */
1849 gtk_tree_path_free (path);
1850 path = gtk_tree_model_get_path (GTK_TREE_MODEL (filter), &iter);
1852 level->visible_nodes--;
1854 if (level->visible_nodes == 0)
1856 emit_child_toggled = TRUE;
1857 parent_level = level->parent_level;
1858 parent = level->parent_elt;
1861 /* emit row_deleted */
1862 gtk_tree_model_filter_increment_stamp (filter);
1863 gtk_tree_model_row_deleted (GTK_TREE_MODEL (data), path);
1864 iter.stamp = filter->priv->stamp;
1867 /* The filter model's reference on the child node is released
1870 while (elt->ref_count > 1)
1871 gtk_tree_model_filter_real_unref_node (GTK_TREE_MODEL (data), &iter,
1874 if (level->array->len == 1)
1877 gtk_tree_model_filter_free_level (filter, level);
1883 /* release the filter model's reference on the node */
1884 if (level->parent_level || filter->priv->virtual_root)
1885 gtk_tree_model_filter_unref_node (GTK_TREE_MODEL (filter), &iter);
1886 else if (elt->ref_count > 0)
1887 gtk_tree_model_filter_real_unref_node (GTK_TREE_MODEL (data), &iter,
1890 /* remove the row */
1891 tmp = bsearch_elt_with_offset (level->array, elt->offset, &i);
1893 offset = tmp->offset;
1894 g_array_remove_index (level->array, i);
1897 for (i = MAX (i, 0); i < level->array->len; i++)
1899 elt = &g_array_index (level->array, FilterElt, i);
1900 if (elt->offset > offset)
1903 elt->children->parent_elt = elt;
1907 if (emit_child_toggled && parent_level)
1912 iter.stamp = filter->priv->stamp;
1913 iter.user_data = parent_level;
1914 iter.user_data2 = parent;
1916 /* We set in_row_deleted to TRUE to avoid a level build triggered
1917 * by row-has-child-toggled (parent model could call iter_has_child
1920 filter->priv->in_row_deleted = TRUE;
1921 path = gtk_tree_model_get_path (GTK_TREE_MODEL (filter), &iter);
1922 gtk_tree_model_row_has_child_toggled (GTK_TREE_MODEL (filter),
1924 gtk_tree_path_free (path);
1925 filter->priv->in_row_deleted = FALSE;
1928 gtk_tree_path_free (path);
1932 gtk_tree_model_filter_rows_reordered (GtkTreeModel *c_model,
1933 GtkTreePath *c_path,
1934 GtkTreeIter *c_iter,
1940 GtkTreeModelFilter *filter = GTK_TREE_MODEL_FILTER (data);
1946 gint i, j, elt_count;
1951 g_return_if_fail (new_order != NULL);
1953 if (c_path == NULL || gtk_tree_path_get_depth (c_path) == 0)
1955 length = gtk_tree_model_iter_n_children (c_model, NULL);
1957 if (filter->priv->virtual_root)
1961 /* reorder root level of path */
1962 for (i = 0; i < length; i++)
1963 if (new_order[i] == gtk_tree_path_get_indices (filter->priv->virtual_root)[0])
1969 gtk_tree_path_get_indices (filter->priv->virtual_root)[0] = new_pos;
1973 path = gtk_tree_path_new ();
1974 level = FILTER_LEVEL (filter->priv->root);
1978 GtkTreeIter child_iter;
1980 /* virtual root anchor reordering */
1981 if (filter->priv->virtual_root &&
1982 gtk_tree_path_is_ancestor (c_path, filter->priv->virtual_root))
1987 GtkTreeIter real_c_iter;
1989 level = gtk_tree_path_get_depth (c_path);
1992 real_c_iter = *c_iter;
1994 gtk_tree_model_get_iter (c_model, &real_c_iter, c_path);
1996 length = gtk_tree_model_iter_n_children (c_model, &real_c_iter);
1998 for (i = 0; i < length; i++)
1999 if (new_order[i] == gtk_tree_path_get_indices (filter->priv->virtual_root)[level])
2005 gtk_tree_path_get_indices (filter->priv->virtual_root)[level] = new_pos;
2009 path = gtk_real_tree_model_filter_convert_child_path_to_path (filter,
2014 if (!path && filter->priv->virtual_root &&
2015 gtk_tree_path_compare (c_path, filter->priv->virtual_root))
2018 if (!path && !filter->priv->virtual_root)
2023 /* root level mode */
2025 gtk_tree_model_get_iter (c_model, c_iter, c_path);
2026 length = gtk_tree_model_iter_n_children (c_model, c_iter);
2027 path = gtk_tree_path_new ();
2028 level = FILTER_LEVEL (filter->priv->root);
2032 gtk_tree_model_filter_get_iter_full (GTK_TREE_MODEL (data),
2035 level = FILTER_LEVEL (iter.user_data);
2036 elt = FILTER_ELT (iter.user_data2);
2040 gtk_tree_path_free (path);
2044 level = elt->children;
2046 gtk_tree_model_filter_convert_iter_to_child_iter (GTK_TREE_MODEL_FILTER (filter), &child_iter, &iter);
2047 length = gtk_tree_model_iter_n_children (c_model, &child_iter);
2051 if (!level || level->array->len < 1)
2053 gtk_tree_path_free (path);
2057 /* NOTE: we do not bail out here if level->array->len < 2 like
2058 * GtkTreeModelSort does. This because we do some special tricky
2062 /* construct a new array */
2063 new_array = g_array_sized_new (FALSE, FALSE, sizeof (FilterElt),
2065 tmp_array = g_new (gint, level->array->len);
2067 for (i = 0, elt_count = 0; i < length; i++)
2069 FilterElt *e = NULL;
2070 gint old_offset = -1;
2072 for (j = 0; j < level->array->len; j++)
2073 if (g_array_index (level->array, FilterElt, j).offset == new_order[i])
2075 e = &g_array_index (level->array, FilterElt, j);
2083 tmp_array[elt_count] = old_offset;
2084 g_array_append_val (new_array, *e);
2085 g_array_index (new_array, FilterElt, elt_count).offset = i;
2089 g_array_free (level->array, TRUE);
2090 level->array = new_array;
2093 for (i = 0; i < level->array->len; i++)
2095 FilterElt *e = &g_array_index (level->array, FilterElt, i);
2097 e->children->parent_elt = e;
2100 /* emit rows_reordered */
2101 if (!gtk_tree_path_get_indices (path))
2102 gtk_tree_model_rows_reordered (GTK_TREE_MODEL (data), path, NULL,
2106 /* get a path taking only visible nodes into account */
2107 gtk_tree_path_free (path);
2108 path = gtk_tree_model_get_path (GTK_TREE_MODEL (data), &iter);
2110 gtk_tree_model_rows_reordered (GTK_TREE_MODEL (data), path, &iter,
2116 gtk_tree_path_free (path);
2119 /* TreeModelIface implementation */
2120 static GtkTreeModelFlags
2121 gtk_tree_model_filter_get_flags (GtkTreeModel *model)
2123 GtkTreeModelFlags flags;
2125 g_return_val_if_fail (GTK_IS_TREE_MODEL_FILTER (model), 0);
2126 g_return_val_if_fail (GTK_TREE_MODEL_FILTER (model)->priv->child_model != NULL, 0);
2128 flags = gtk_tree_model_get_flags (GTK_TREE_MODEL_FILTER (model)->priv->child_model);
2130 if ((flags & GTK_TREE_MODEL_LIST_ONLY) == GTK_TREE_MODEL_LIST_ONLY)
2131 return GTK_TREE_MODEL_LIST_ONLY;
2137 gtk_tree_model_filter_get_n_columns (GtkTreeModel *model)
2139 GtkTreeModelFilter *filter = (GtkTreeModelFilter *)model;
2141 g_return_val_if_fail (GTK_IS_TREE_MODEL_FILTER (model), 0);
2142 g_return_val_if_fail (filter->priv->child_model != NULL, 0);
2144 if (filter->priv->child_model == NULL)
2147 /* so we can't modify the modify func after this ... */
2148 filter->priv->modify_func_set = TRUE;
2150 if (filter->priv->modify_n_columns > 0)
2151 return filter->priv->modify_n_columns;
2153 return gtk_tree_model_get_n_columns (filter->priv->child_model);
2157 gtk_tree_model_filter_get_column_type (GtkTreeModel *model,
2160 GtkTreeModelFilter *filter = (GtkTreeModelFilter *)model;
2162 g_return_val_if_fail (GTK_IS_TREE_MODEL_FILTER (model), G_TYPE_INVALID);
2163 g_return_val_if_fail (filter->priv->child_model != NULL, G_TYPE_INVALID);
2165 /* so we can't modify the modify func after this ... */
2166 filter->priv->modify_func_set = TRUE;
2168 if (filter->priv->modify_types)
2170 g_return_val_if_fail (index < filter->priv->modify_n_columns, G_TYPE_INVALID);
2172 return filter->priv->modify_types[index];
2175 return gtk_tree_model_get_column_type (filter->priv->child_model, index);
2178 /* A special case of _get_iter; this function can also get iters which
2179 * are not visible. These iters should ONLY be passed internally, never
2180 * pass those along with a signal emission.
2183 gtk_tree_model_filter_get_iter_full (GtkTreeModel *model,
2187 GtkTreeModelFilter *filter = (GtkTreeModelFilter *)model;
2192 g_return_val_if_fail (GTK_IS_TREE_MODEL_FILTER (model), FALSE);
2193 g_return_val_if_fail (filter->priv->child_model != NULL, FALSE);
2195 indices = gtk_tree_path_get_indices (path);
2197 if (filter->priv->root == NULL)
2198 gtk_tree_model_filter_build_level (filter, NULL, NULL, FALSE);
2199 level = FILTER_LEVEL (filter->priv->root);
2201 depth = gtk_tree_path_get_depth (path);
2208 for (i = 0; i < depth - 1; i++)
2210 if (!level || indices[i] >= level->array->len)
2215 elt = gtk_tree_model_filter_get_nth (filter, level, indices[i]);
2218 gtk_tree_model_filter_build_level (filter, level, elt, FALSE);
2219 level = elt->children;
2222 if (!level || indices[i] >= level->array->len)
2228 iter->stamp = filter->priv->stamp;
2229 iter->user_data = level;
2231 elt = gtk_tree_model_filter_get_nth (filter, level, indices[depth - 1]);
2232 iter->user_data2 = elt;
2238 gtk_tree_model_filter_get_iter (GtkTreeModel *model,
2242 GtkTreeModelFilter *filter = (GtkTreeModelFilter *)model;
2247 g_return_val_if_fail (GTK_IS_TREE_MODEL_FILTER (model), FALSE);
2248 g_return_val_if_fail (filter->priv->child_model != NULL, FALSE);
2250 indices = gtk_tree_path_get_indices (path);
2252 if (filter->priv->root == NULL)
2253 gtk_tree_model_filter_build_level (filter, NULL, NULL, FALSE);
2254 level = FILTER_LEVEL (filter->priv->root);
2256 depth = gtk_tree_path_get_depth (path);
2263 for (i = 0; i < depth - 1; i++)
2265 if (!level || indices[i] >= level->visible_nodes)
2270 elt = gtk_tree_model_filter_get_nth_visible (filter, level, indices[i]);
2273 gtk_tree_model_filter_build_level (filter, level, elt, FALSE);
2274 level = elt->children;
2277 if (!level || indices[i] >= level->visible_nodes)
2283 iter->stamp = filter->priv->stamp;
2284 iter->user_data = level;
2286 elt = gtk_tree_model_filter_get_nth_visible (filter, level,
2287 indices[depth - 1]);
2288 iter->user_data2 = elt;
2293 static GtkTreePath *
2294 gtk_tree_model_filter_get_path (GtkTreeModel *model,
2297 GtkTreePath *retval;
2301 g_return_val_if_fail (GTK_IS_TREE_MODEL_FILTER (model), NULL);
2302 g_return_val_if_fail (GTK_TREE_MODEL_FILTER (model)->priv->child_model != NULL, NULL);
2303 g_return_val_if_fail (GTK_TREE_MODEL_FILTER (model)->priv->stamp == iter->stamp, NULL);
2305 level = iter->user_data;
2306 elt = iter->user_data2;
2311 retval = gtk_tree_path_new ();
2315 int i = 0, index = 0;
2317 while (&g_array_index (level->array, FilterElt, i) != elt)
2319 if (g_array_index (level->array, FilterElt, i).visible)
2323 g_assert (i < level->array->len);
2326 gtk_tree_path_prepend_index (retval, index);
2327 elt = level->parent_elt;
2328 level = level->parent_level;
2335 gtk_tree_model_filter_get_value (GtkTreeModel *model,
2340 GtkTreeIter child_iter;
2341 GtkTreeModelFilter *filter = GTK_TREE_MODEL_FILTER (model);
2343 g_return_if_fail (GTK_IS_TREE_MODEL_FILTER (model));
2344 g_return_if_fail (GTK_TREE_MODEL_FILTER (model)->priv->child_model != NULL);
2345 g_return_if_fail (GTK_TREE_MODEL_FILTER (model)->priv->stamp == iter->stamp);
2347 if (filter->priv->modify_func)
2349 g_return_if_fail (column < filter->priv->modify_n_columns);
2351 g_value_init (value, filter->priv->modify_types[column]);
2352 filter->priv->modify_func (model,
2356 filter->priv->modify_data);
2361 gtk_tree_model_filter_convert_iter_to_child_iter (GTK_TREE_MODEL_FILTER (model), &child_iter, iter);
2362 gtk_tree_model_get_value (GTK_TREE_MODEL_FILTER (model)->priv->child_model,
2363 &child_iter, column, value);
2367 gtk_tree_model_filter_iter_next (GtkTreeModel *model,
2374 g_return_val_if_fail (GTK_IS_TREE_MODEL_FILTER (model), FALSE);
2375 g_return_val_if_fail (GTK_TREE_MODEL_FILTER (model)->priv->child_model != NULL, FALSE);
2376 g_return_val_if_fail (GTK_TREE_MODEL_FILTER (model)->priv->stamp == iter->stamp, FALSE);
2378 level = iter->user_data;
2379 elt = iter->user_data2;
2381 i = elt - FILTER_ELT (level->array->data);
2383 while (i < level->array->len - 1)
2390 iter->user_data2 = elt;
2395 /* no next visible iter */
2402 gtk_tree_model_filter_iter_children (GtkTreeModel *model,
2404 GtkTreeIter *parent)
2406 GtkTreeModelFilter *filter = (GtkTreeModelFilter *)model;
2410 g_return_val_if_fail (GTK_IS_TREE_MODEL_FILTER (model), FALSE);
2411 g_return_val_if_fail (filter->priv->child_model != NULL, FALSE);
2413 g_return_val_if_fail (filter->priv->stamp == parent->stamp, FALSE);
2419 if (!filter->priv->root)
2420 gtk_tree_model_filter_build_level (filter, NULL, NULL, FALSE);
2421 if (!filter->priv->root)
2424 level = filter->priv->root;
2426 if (!level->visible_nodes)
2429 iter->stamp = filter->priv->stamp;
2430 iter->user_data = level;
2432 while (i < level->array->len)
2434 if (!g_array_index (level->array, FilterElt, i).visible)
2440 iter->user_data2 = &g_array_index (level->array, FilterElt, i);
2451 if (FILTER_ELT (parent->user_data2)->children == NULL)
2452 gtk_tree_model_filter_build_level (filter,
2453 FILTER_LEVEL (parent->user_data),
2454 FILTER_ELT (parent->user_data2),
2456 if (FILTER_ELT (parent->user_data2)->children == NULL)
2459 if (FILTER_ELT (parent->user_data2)->children->visible_nodes <= 0)
2462 iter->stamp = filter->priv->stamp;
2463 iter->user_data = FILTER_ELT (parent->user_data2)->children;
2465 level = FILTER_LEVEL (iter->user_data);
2467 while (i < level->array->len)
2469 if (!g_array_index (level->array, FilterElt, i).visible)
2475 iter->user_data2 = &g_array_index (level->array, FilterElt, i);
2488 gtk_tree_model_filter_iter_has_child (GtkTreeModel *model,
2491 GtkTreeIter child_iter;
2492 GtkTreeModelFilter *filter = (GtkTreeModelFilter *)model;
2495 g_return_val_if_fail (GTK_IS_TREE_MODEL_FILTER (model), FALSE);
2496 g_return_val_if_fail (filter->priv->child_model != NULL, FALSE);
2497 g_return_val_if_fail (filter->priv->stamp == iter->stamp, FALSE);
2499 filter = GTK_TREE_MODEL_FILTER (model);
2501 gtk_tree_model_filter_convert_iter_to_child_iter (GTK_TREE_MODEL_FILTER (model), &child_iter, iter);
2502 elt = FILTER_ELT (iter->user_data2);
2507 /* we need to build the level to check if not all children are filtered
2511 && gtk_tree_model_iter_has_child (filter->priv->child_model, &child_iter))
2512 gtk_tree_model_filter_build_level (filter, FILTER_LEVEL (iter->user_data),
2515 if (elt->children && elt->children->visible_nodes > 0)
2522 gtk_tree_model_filter_iter_n_children (GtkTreeModel *model,
2525 GtkTreeIter child_iter;
2526 GtkTreeModelFilter *filter = (GtkTreeModelFilter *)model;
2529 g_return_val_if_fail (GTK_IS_TREE_MODEL_FILTER (model), 0);
2530 g_return_val_if_fail (filter->priv->child_model != NULL, 0);
2532 g_return_val_if_fail (filter->priv->stamp == iter->stamp, 0);
2536 if (!filter->priv->root)
2537 gtk_tree_model_filter_build_level (filter, NULL, NULL, FALSE);
2539 if (filter->priv->root)
2540 return FILTER_LEVEL (filter->priv->root)->visible_nodes;
2545 elt = FILTER_ELT (iter->user_data2);
2550 gtk_tree_model_filter_convert_iter_to_child_iter (GTK_TREE_MODEL_FILTER (model), &child_iter, iter);
2552 if (!elt->children &&
2553 gtk_tree_model_iter_has_child (filter->priv->child_model, &child_iter))
2554 gtk_tree_model_filter_build_level (filter,
2555 FILTER_LEVEL (iter->user_data),
2559 return elt->children->visible_nodes;
2565 gtk_tree_model_filter_iter_nth_child (GtkTreeModel *model,
2567 GtkTreeIter *parent,
2572 GtkTreeIter children;
2574 g_return_val_if_fail (GTK_IS_TREE_MODEL_FILTER (model), FALSE);
2576 g_return_val_if_fail (GTK_TREE_MODEL_FILTER (model)->priv->stamp == parent->stamp, FALSE);
2578 /* use this instead of has_child to force us to build the level, if needed */
2579 if (gtk_tree_model_filter_iter_children (model, &children, parent) == FALSE)
2585 level = children.user_data;
2586 elt = FILTER_ELT (level->array->data);
2588 if (n >= level->visible_nodes)
2594 elt = gtk_tree_model_filter_get_nth_visible (GTK_TREE_MODEL_FILTER (model),
2597 iter->stamp = GTK_TREE_MODEL_FILTER (model)->priv->stamp;
2598 iter->user_data = level;
2599 iter->user_data2 = elt;
2605 gtk_tree_model_filter_iter_parent (GtkTreeModel *model,
2612 g_return_val_if_fail (GTK_IS_TREE_MODEL_FILTER (model), FALSE);
2613 g_return_val_if_fail (GTK_TREE_MODEL_FILTER (model)->priv->child_model != NULL, FALSE);
2614 g_return_val_if_fail (GTK_TREE_MODEL_FILTER (model)->priv->stamp == child->stamp, FALSE);
2616 level = child->user_data;
2618 if (level->parent_level)
2620 iter->stamp = GTK_TREE_MODEL_FILTER (model)->priv->stamp;
2621 iter->user_data = level->parent_level;
2622 iter->user_data2 = level->parent_elt;
2631 gtk_tree_model_filter_ref_node (GtkTreeModel *model,
2634 GtkTreeModelFilter *filter = (GtkTreeModelFilter *)model;
2635 GtkTreeIter child_iter;
2639 g_return_if_fail (GTK_IS_TREE_MODEL_FILTER (model));
2640 g_return_if_fail (GTK_TREE_MODEL_FILTER (model)->priv->child_model != NULL);
2641 g_return_if_fail (GTK_TREE_MODEL_FILTER (model)->priv->stamp == iter->stamp);
2643 gtk_tree_model_filter_convert_iter_to_child_iter (GTK_TREE_MODEL_FILTER (model), &child_iter, iter);
2645 gtk_tree_model_ref_node (filter->priv->child_model, &child_iter);
2647 level = iter->user_data;
2648 elt = iter->user_data2;
2652 if (level->ref_count == 1)
2654 FilterLevel *parent_level = level->parent_level;
2655 FilterElt *parent_elt = level->parent_elt;
2657 /* we were at zero -- time to decrease the zero_ref_count val */
2658 while (parent_level)
2660 parent_elt->zero_ref_count--;
2662 parent_elt = parent_level->parent_elt;
2663 parent_level = parent_level->parent_level;
2666 if (filter->priv->root != level)
2667 filter->priv->zero_ref_count--;
2672 gtk_tree_model_filter_unref_node (GtkTreeModel *model,
2675 gtk_tree_model_filter_real_unref_node (model, iter, TRUE);
2679 gtk_tree_model_filter_real_unref_node (GtkTreeModel *model,
2681 gboolean propagate_unref)
2683 GtkTreeModelFilter *filter = (GtkTreeModelFilter *)model;
2687 g_return_if_fail (GTK_IS_TREE_MODEL_FILTER (model));
2688 g_return_if_fail (filter->priv->child_model != NULL);
2689 g_return_if_fail (filter->priv->stamp == iter->stamp);
2691 if (propagate_unref)
2693 GtkTreeIter child_iter;
2694 gtk_tree_model_filter_convert_iter_to_child_iter (GTK_TREE_MODEL_FILTER (model), &child_iter, iter);
2695 gtk_tree_model_unref_node (filter->priv->child_model, &child_iter);
2698 level = iter->user_data;
2699 elt = iter->user_data2;
2701 g_return_if_fail (elt->ref_count > 0);
2705 if (level->ref_count == 0)
2707 FilterLevel *parent_level = level->parent_level;
2708 FilterElt *parent_elt = level->parent_elt;
2710 /* we are at zero -- time to increase the zero_ref_count val */
2711 while (parent_level)
2713 parent_elt->zero_ref_count++;
2715 parent_elt = parent_level->parent_elt;
2716 parent_level = parent_level->parent_level;
2719 if (filter->priv->root != level)
2720 filter->priv->zero_ref_count++;
2724 /* TreeDragSource interface implementation */
2726 gtk_tree_model_filter_row_draggable (GtkTreeDragSource *drag_source,
2729 GtkTreeModelFilter *tree_model_filter = (GtkTreeModelFilter *)drag_source;
2730 GtkTreePath *child_path;
2733 g_return_val_if_fail (GTK_IS_TREE_MODEL_FILTER (drag_source), FALSE);
2734 g_return_val_if_fail (path != NULL, FALSE);
2736 child_path = gtk_tree_model_filter_convert_path_to_child_path (tree_model_filter, path);
2737 draggable = gtk_tree_drag_source_row_draggable (GTK_TREE_DRAG_SOURCE (tree_model_filter->priv->child_model), child_path);
2738 gtk_tree_path_free (child_path);
2744 gtk_tree_model_filter_drag_data_get (GtkTreeDragSource *drag_source,
2746 GtkSelectionData *selection_data)
2748 GtkTreeModelFilter *tree_model_filter = (GtkTreeModelFilter *)drag_source;
2749 GtkTreePath *child_path;
2752 g_return_val_if_fail (GTK_IS_TREE_MODEL_FILTER (drag_source), FALSE);
2753 g_return_val_if_fail (path != NULL, FALSE);
2755 child_path = gtk_tree_model_filter_convert_path_to_child_path (tree_model_filter, path);
2756 gotten = gtk_tree_drag_source_drag_data_get (GTK_TREE_DRAG_SOURCE (tree_model_filter->priv->child_model), child_path, selection_data);
2757 gtk_tree_path_free (child_path);
2763 gtk_tree_model_filter_drag_data_delete (GtkTreeDragSource *drag_source,
2766 GtkTreeModelFilter *tree_model_filter = (GtkTreeModelFilter *)drag_source;
2767 GtkTreePath *child_path;
2770 g_return_val_if_fail (GTK_IS_TREE_MODEL_FILTER (drag_source), FALSE);
2771 g_return_val_if_fail (path != NULL, FALSE);
2773 child_path = gtk_tree_model_filter_convert_path_to_child_path (tree_model_filter, path);
2774 deleted = gtk_tree_drag_source_drag_data_delete (GTK_TREE_DRAG_SOURCE (tree_model_filter->priv->child_model), child_path);
2775 gtk_tree_path_free (child_path);
2780 /* bits and pieces */
2782 gtk_tree_model_filter_set_model (GtkTreeModelFilter *filter,
2783 GtkTreeModel *child_model)
2785 g_return_if_fail (GTK_IS_TREE_MODEL_FILTER (filter));
2787 if (filter->priv->child_model)
2789 g_signal_handler_disconnect (filter->priv->child_model,
2790 filter->priv->changed_id);
2791 g_signal_handler_disconnect (filter->priv->child_model,
2792 filter->priv->inserted_id);
2793 g_signal_handler_disconnect (filter->priv->child_model,
2794 filter->priv->has_child_toggled_id);
2795 g_signal_handler_disconnect (filter->priv->child_model,
2796 filter->priv->deleted_id);
2797 g_signal_handler_disconnect (filter->priv->child_model,
2798 filter->priv->reordered_id);
2800 /* reset our state */
2801 if (filter->priv->root)
2802 gtk_tree_model_filter_free_level (filter, filter->priv->root);
2804 filter->priv->root = NULL;
2805 g_object_unref (filter->priv->child_model);
2806 filter->priv->visible_column = -1;
2808 /* FIXME: do we need to destroy more here? */
2811 filter->priv->child_model = child_model;
2815 g_object_ref (filter->priv->child_model);
2816 filter->priv->changed_id =
2817 g_signal_connect (child_model, "row-changed",
2818 G_CALLBACK (gtk_tree_model_filter_row_changed),
2820 filter->priv->inserted_id =
2821 g_signal_connect (child_model, "row-inserted",
2822 G_CALLBACK (gtk_tree_model_filter_row_inserted),
2824 filter->priv->has_child_toggled_id =
2825 g_signal_connect (child_model, "row-has-child-toggled",
2826 G_CALLBACK (gtk_tree_model_filter_row_has_child_toggled),
2828 filter->priv->deleted_id =
2829 g_signal_connect (child_model, "row-deleted",
2830 G_CALLBACK (gtk_tree_model_filter_row_deleted),
2832 filter->priv->reordered_id =
2833 g_signal_connect (child_model, "rows-reordered",
2834 G_CALLBACK (gtk_tree_model_filter_rows_reordered),
2837 filter->priv->child_flags = gtk_tree_model_get_flags (child_model);
2838 filter->priv->stamp = g_random_int ();
2843 gtk_tree_model_filter_ref_path (GtkTreeModelFilter *filter,
2849 len = gtk_tree_path_get_depth (path);
2850 p = gtk_tree_path_copy (path);
2855 gtk_tree_model_get_iter (GTK_TREE_MODEL (filter->priv->child_model), &iter, p);
2856 gtk_tree_model_ref_node (GTK_TREE_MODEL (filter->priv->child_model), &iter);
2857 gtk_tree_path_up (p);
2860 gtk_tree_path_free (p);
2864 gtk_tree_model_filter_unref_path (GtkTreeModelFilter *filter,
2870 len = gtk_tree_path_get_depth (path);
2871 p = gtk_tree_path_copy (path);
2876 gtk_tree_model_get_iter (GTK_TREE_MODEL (filter->priv->child_model), &iter, p);
2877 gtk_tree_model_unref_node (GTK_TREE_MODEL (filter->priv->child_model), &iter);
2878 gtk_tree_path_up (p);
2881 gtk_tree_path_free (p);
2885 gtk_tree_model_filter_set_root (GtkTreeModelFilter *filter,
2888 g_return_if_fail (GTK_IS_TREE_MODEL_FILTER (filter));
2891 filter->priv->virtual_root = NULL;
2893 filter->priv->virtual_root = gtk_tree_path_copy (root);
2899 * gtk_tree_model_filter_new:
2900 * @child_model: A #GtkTreeModel.
2901 * @root: A #GtkTreePath or %NULL.
2903 * Creates a new #GtkTreeModel, with @child_model as the child_model
2904 * and @root as the virtual root.
2906 * Return value: A new #GtkTreeModel.
2911 gtk_tree_model_filter_new (GtkTreeModel *child_model,
2914 GtkTreeModel *retval;
2915 GtkTreeModelFilter *filter;
2917 g_return_val_if_fail (GTK_IS_TREE_MODEL (child_model), NULL);
2919 retval = g_object_new (GTK_TYPE_TREE_MODEL_FILTER,
2920 "child-model", child_model,
2921 "virtual-root", root,
2924 filter = GTK_TREE_MODEL_FILTER (retval);
2925 if (filter->priv->virtual_root)
2927 gtk_tree_model_filter_ref_path (filter, filter->priv->virtual_root);
2928 filter->priv->virtual_root_deleted = FALSE;
2935 * gtk_tree_model_filter_get_model:
2936 * @filter: A #GtkTreeModelFilter.
2938 * Returns a pointer to the child model of @filter.
2940 * Return value: A pointer to a #GtkTreeModel.
2945 gtk_tree_model_filter_get_model (GtkTreeModelFilter *filter)
2947 g_return_val_if_fail (GTK_IS_TREE_MODEL_FILTER (filter), NULL);
2949 return filter->priv->child_model;
2953 * gtk_tree_model_filter_set_visible_func:
2954 * @filter: A #GtkTreeModelFilter.
2955 * @func: A #GtkTreeModelFilterVisibleFunc, the visible function.
2956 * @data: User data to pass to the visible function, or %NULL.
2957 * @destroy: Destroy notifier of @data, or %NULL.
2959 * Sets the visible function used when filtering the @filter to be @func. The
2960 * function should return %TRUE if the given row should be visible and
2963 * If the condition calculated by the function changes over time (e.g. because
2964 * it depends on some global parameters), you must call
2965 * gtk_tree_model_filter_refilter() to keep the visibility information of
2966 * the model uptodate.
2968 * Note that @func is called whenever a row is inserted, when it may still be
2969 * empty. The visible function should therefore take special care of empty
2970 * rows, like in the example below.
2972 * <informalexample><programlisting>
2974 * visible_func (GtkTreeModel *model,
2975 * GtkTreeIter *iter,
2978 * /* Visible if row is non-empty and first column is "HI" */
2980 * gboolean visible = FALSE;
2982 * gtk_tree_model_get (model, iter, 0, &str, -1);
2983 * if (str && strcmp (str, "HI") == 0)
2989 * </programlisting></informalexample>
2994 gtk_tree_model_filter_set_visible_func (GtkTreeModelFilter *filter,
2995 GtkTreeModelFilterVisibleFunc func,
2997 GDestroyNotify destroy)
2999 g_return_if_fail (GTK_IS_TREE_MODEL_FILTER (filter));
3000 g_return_if_fail (func != NULL);
3001 g_return_if_fail (filter->priv->visible_method_set == FALSE);
3003 if (filter->priv->visible_func)
3005 GDestroyNotify d = filter->priv->visible_destroy;
3007 filter->priv->visible_destroy = NULL;
3008 d (filter->priv->visible_data);
3011 filter->priv->visible_func = func;
3012 filter->priv->visible_data = data;
3013 filter->priv->visible_destroy = destroy;
3015 filter->priv->visible_method_set = TRUE;
3019 * gtk_tree_model_filter_set_modify_func:
3020 * @filter: A #GtkTreeModelFilter.
3021 * @n_columns: The number of columns in the filter model.
3022 * @types: The #GType<!-- -->s of the columns.
3023 * @func: A #GtkTreeModelFilterModifyFunc
3024 * @data: User data to pass to the modify function, or %NULL.
3025 * @destroy: Destroy notifier of @data, or %NULL.
3027 * With the @n_columns and @types parameters, you give an array of column
3028 * types for this model (which will be exposed to the parent model/view).
3029 * The @func, @data and @destroy parameters are for specifying the modify
3030 * function. The modify function will get called for <emphasis>each</emphasis>
3031 * data access, the goal of the modify function is to return the data which
3032 * should be displayed at the location specified using the parameters of the
3038 gtk_tree_model_filter_set_modify_func (GtkTreeModelFilter *filter,
3041 GtkTreeModelFilterModifyFunc func,
3043 GDestroyNotify destroy)
3045 g_return_if_fail (GTK_IS_TREE_MODEL_FILTER (filter));
3046 g_return_if_fail (func != NULL);
3047 g_return_if_fail (filter->priv->modify_func_set == FALSE);
3049 if (filter->priv->modify_destroy)
3051 GDestroyNotify d = filter->priv->modify_destroy;
3053 filter->priv->modify_destroy = NULL;
3054 d (filter->priv->modify_data);
3057 filter->priv->modify_n_columns = n_columns;
3058 filter->priv->modify_types = g_new0 (GType, n_columns);
3059 memcpy (filter->priv->modify_types, types, sizeof (GType) * n_columns);
3060 filter->priv->modify_func = func;
3061 filter->priv->modify_data = data;
3062 filter->priv->modify_destroy = destroy;
3064 filter->priv->modify_func_set = TRUE;
3068 * gtk_tree_model_filter_set_visible_column:
3069 * @filter: A #GtkTreeModelFilter.
3070 * @column: A #gint which is the column containing the visible information.
3072 * Sets @column of the child_model to be the column where @filter should
3073 * look for visibility information. @columns should be a column of type
3074 * %G_TYPE_BOOLEAN, where %TRUE means that a row is visible, and %FALSE
3080 gtk_tree_model_filter_set_visible_column (GtkTreeModelFilter *filter,
3083 g_return_if_fail (GTK_IS_TREE_MODEL_FILTER (filter));
3084 g_return_if_fail (column >= 0);
3085 g_return_if_fail (filter->priv->visible_method_set == FALSE);
3087 filter->priv->visible_column = column;
3089 filter->priv->visible_method_set = TRUE;
3095 * gtk_tree_model_filter_convert_child_iter_to_iter:
3096 * @filter: A #GtkTreeModelFilter.
3097 * @filter_iter: An uninitialized #GtkTreeIter.
3098 * @child_iter: A valid #GtkTreeIter pointing to a row on the child model.
3100 * Sets @filter_iter to point to the row in @filter that corresponds to the
3101 * row pointed at by @child_iter. If @filter_iter was not set, %FALSE is
3104 * Return value: %TRUE, if @filter_iter was set, i.e. if @child_iter is a
3105 * valid iterator pointing to a visible row in child model.
3110 gtk_tree_model_filter_convert_child_iter_to_iter (GtkTreeModelFilter *filter,
3111 GtkTreeIter *filter_iter,
3112 GtkTreeIter *child_iter)
3115 GtkTreePath *child_path, *path;
3117 g_return_val_if_fail (GTK_IS_TREE_MODEL_FILTER (filter), FALSE);
3118 g_return_val_if_fail (filter->priv->child_model != NULL, FALSE);
3119 g_return_val_if_fail (filter_iter != NULL, FALSE);
3120 g_return_val_if_fail (child_iter != NULL, FALSE);
3121 g_return_val_if_fail (filter_iter != child_iter, FALSE);
3123 filter_iter->stamp = 0;
3125 child_path = gtk_tree_model_get_path (filter->priv->child_model, child_iter);
3126 g_return_val_if_fail (child_path != NULL, FALSE);
3128 path = gtk_tree_model_filter_convert_child_path_to_path (filter,
3130 gtk_tree_path_free (child_path);
3135 ret = gtk_tree_model_get_iter (GTK_TREE_MODEL (filter), filter_iter, path);
3136 gtk_tree_path_free (path);
3142 * gtk_tree_model_filter_convert_iter_to_child_iter:
3143 * @filter: A #GtkTreeModelFilter.
3144 * @child_iter: An uninitialized #GtkTreeIter.
3145 * @filter_iter: A valid #GtkTreeIter pointing to a row on @filter.
3147 * Sets @child_iter to point to the row pointed to by @filter_iter.
3152 gtk_tree_model_filter_convert_iter_to_child_iter (GtkTreeModelFilter *filter,
3153 GtkTreeIter *child_iter,
3154 GtkTreeIter *filter_iter)
3156 g_return_if_fail (GTK_IS_TREE_MODEL_FILTER (filter));
3157 g_return_if_fail (filter->priv->child_model != NULL);
3158 g_return_if_fail (child_iter != NULL);
3159 g_return_if_fail (filter_iter != NULL);
3160 g_return_if_fail (filter_iter->stamp == filter->priv->stamp);
3161 g_return_if_fail (filter_iter != child_iter);
3163 if (GTK_TREE_MODEL_FILTER_CACHE_CHILD_ITERS (filter))
3165 *child_iter = FILTER_ELT (filter_iter->user_data2)->iter;
3171 path = gtk_tree_model_filter_elt_get_path (filter_iter->user_data,
3172 filter_iter->user_data2,
3173 filter->priv->virtual_root);
3174 gtk_tree_model_get_iter (filter->priv->child_model, child_iter, path);
3175 gtk_tree_path_free (path);
3179 /* The path returned can only be used internally in the filter model. */
3180 static GtkTreePath *
3181 gtk_real_tree_model_filter_convert_child_path_to_path (GtkTreeModelFilter *filter,
3182 GtkTreePath *child_path,
3183 gboolean build_levels,
3184 gboolean fetch_children)
3186 gint *child_indices;
3187 GtkTreePath *retval;
3188 GtkTreePath *real_path;
3193 g_return_val_if_fail (GTK_IS_TREE_MODEL_FILTER (filter), NULL);
3194 g_return_val_if_fail (filter->priv->child_model != NULL, NULL);
3195 g_return_val_if_fail (child_path != NULL, NULL);
3197 if (!filter->priv->virtual_root)
3198 real_path = gtk_tree_path_copy (child_path);
3200 real_path = gtk_tree_model_filter_remove_root (child_path,
3201 filter->priv->virtual_root);
3206 retval = gtk_tree_path_new ();
3207 child_indices = gtk_tree_path_get_indices (real_path);
3209 if (filter->priv->root == NULL && build_levels)
3210 gtk_tree_model_filter_build_level (filter, NULL, NULL, FALSE);
3211 level = FILTER_LEVEL (filter->priv->root);
3213 for (i = 0; i < gtk_tree_path_get_depth (real_path); i++)
3216 gboolean found_child = FALSE;
3220 gtk_tree_path_free (real_path);
3221 gtk_tree_path_free (retval);
3225 tmp = bsearch_elt_with_offset (level->array, child_indices[i], &j);
3228 gtk_tree_path_append_index (retval, j);
3229 if (!tmp->children && build_levels)
3230 gtk_tree_model_filter_build_level (filter, level, tmp, FALSE);
3231 level = tmp->children;
3235 if (!found_child && fetch_children)
3237 tmp = gtk_tree_model_filter_fetch_child (filter, level,
3241 /* didn't find the child, let's try to bring it back */
3242 if (!tmp || tmp->offset != child_indices[i])
3245 gtk_tree_path_free (real_path);
3246 gtk_tree_path_free (retval);
3250 gtk_tree_path_append_index (retval, j);
3251 if (!tmp->children && build_levels)
3252 gtk_tree_model_filter_build_level (filter, level, tmp, FALSE);
3253 level = tmp->children;
3256 else if (!found_child && !fetch_children)
3259 gtk_tree_path_free (real_path);
3260 gtk_tree_path_free (retval);
3265 gtk_tree_path_free (real_path);
3270 * gtk_tree_model_filter_convert_child_path_to_path:
3271 * @filter: A #GtkTreeModelFilter.
3272 * @child_path: A #GtkTreePath to convert.
3274 * Converts @child_path to a path relative to @filter. That is, @child_path
3275 * points to a path in the child model. The rerturned path will point to the
3276 * same row in the filtered model. If @child_path isn't a valid path on the
3277 * child model or points to a row which is not visible in @filter, then %NULL
3280 * Return value: A newly allocated #GtkTreePath, or %NULL.
3285 gtk_tree_model_filter_convert_child_path_to_path (GtkTreeModelFilter *filter,
3286 GtkTreePath *child_path)
3291 /* this function does the sanity checks */
3292 path = gtk_real_tree_model_filter_convert_child_path_to_path (filter,
3300 /* get a new path which only takes visible nodes into account.
3301 * -- if this gives any performance issues, we can write a special
3302 * version of convert_child_path_to_path immediately returning
3303 * a visible-nodes-only path.
3305 gtk_tree_model_filter_get_iter_full (GTK_TREE_MODEL (filter), &iter, path);
3307 gtk_tree_path_free (path);
3308 path = gtk_tree_model_get_path (GTK_TREE_MODEL (filter), &iter);
3314 * gtk_tree_model_filter_convert_path_to_child_path:
3315 * @filter: A #GtkTreeModelFilter.
3316 * @filter_path: A #GtkTreePath to convert.
3318 * Converts @filter_path to a path on the child model of @filter. That is,
3319 * @filter_path points to a location in @filter. The returned path will
3320 * point to the same location in the model not being filtered. If @filter_path
3321 * does not point to a location in the child model, %NULL is returned.
3323 * Return value: A newly allocated #GtkTreePath, or %NULL.
3328 gtk_tree_model_filter_convert_path_to_child_path (GtkTreeModelFilter *filter,
3329 GtkTreePath *filter_path)
3331 gint *filter_indices;
3332 GtkTreePath *retval;
3336 g_return_val_if_fail (GTK_IS_TREE_MODEL_FILTER (filter), NULL);
3337 g_return_val_if_fail (filter->priv->child_model != NULL, NULL);
3338 g_return_val_if_fail (filter_path != NULL, NULL);
3341 retval = gtk_tree_path_new ();
3342 filter_indices = gtk_tree_path_get_indices (filter_path);
3343 if (!filter->priv->root)
3344 gtk_tree_model_filter_build_level (filter, NULL, NULL, FALSE);
3345 level = FILTER_LEVEL (filter->priv->root);
3347 for (i = 0; i < gtk_tree_path_get_depth (filter_path); i++)
3351 if (!level || level->visible_nodes <= filter_indices[i])
3353 gtk_tree_path_free (retval);
3357 elt = gtk_tree_model_filter_get_nth_visible (filter, level,
3360 if (elt->children == NULL)
3361 gtk_tree_model_filter_build_level (filter, level, elt, FALSE);
3363 if (!level || level->visible_nodes <= filter_indices[i])
3365 gtk_tree_path_free (retval);
3369 gtk_tree_path_append_index (retval, elt->offset);
3370 level = elt->children;
3375 if (filter->priv->virtual_root)
3377 GtkTreePath *real_retval;
3379 real_retval = gtk_tree_model_filter_add_root (retval,
3380 filter->priv->virtual_root);
3381 gtk_tree_path_free (retval);
3390 gtk_tree_model_filter_refilter_helper (GtkTreeModel *model,
3395 /* evil, don't try this at home, but certainly speeds things up */
3396 gtk_tree_model_filter_row_changed (model, path, iter, data);
3402 * gtk_tree_model_filter_refilter:
3403 * @filter: A #GtkTreeModelFilter.
3405 * Emits ::row_changed for each row in the child model, which causes
3406 * the filter to re-evaluate whether a row is visible or not.
3411 gtk_tree_model_filter_refilter (GtkTreeModelFilter *filter)
3413 g_return_if_fail (GTK_IS_TREE_MODEL_FILTER (filter));
3416 gtk_tree_model_foreach (filter->priv->child_model,
3417 gtk_tree_model_filter_refilter_helper,
3422 * gtk_tree_model_filter_clear_cache:
3423 * @filter: A #GtkTreeModelFilter.
3425 * This function should almost never be called. It clears the @filter
3426 * of any cached iterators that haven't been reffed with
3427 * gtk_tree_model_ref_node(). This might be useful if the child model
3428 * being filtered is static (and doesn't change often) and there has been
3429 * a lot of unreffed access to nodes. As a side effect of this function,
3430 * all unreffed iters will be invalid.
3435 gtk_tree_model_filter_clear_cache (GtkTreeModelFilter *filter)
3437 g_return_if_fail (GTK_IS_TREE_MODEL_FILTER (filter));
3439 if (filter->priv->zero_ref_count > 0)
3440 gtk_tree_model_filter_clear_cache_helper (filter,
3441 FILTER_LEVEL (filter->priv->root));
3444 #define __GTK_TREE_MODEL_FILTER_C__
3445 #include "gtkaliasdef.c"