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.
1014 path = gtk_tree_model_get_path (GTK_TREE_MODEL (filter), iter);
1015 elt->visible = FALSE;
1016 gtk_tree_model_filter_increment_stamp (filter);
1017 iter->stamp = filter->priv->stamp;
1018 gtk_tree_model_row_deleted (GTK_TREE_MODEL (filter), path);
1019 gtk_tree_path_free (path);
1021 while (elt->ref_count > 1)
1022 gtk_tree_model_filter_real_unref_node (GTK_TREE_MODEL (filter),
1025 if (parent_level || filter->priv->virtual_root)
1026 gtk_tree_model_filter_unref_node (GTK_TREE_MODEL (filter), iter);
1027 else if (elt->ref_count > 0)
1028 gtk_tree_model_filter_real_unref_node (GTK_TREE_MODEL (filter),
1031 /* remove the node */
1032 tmp = bsearch_elt_with_offset (level->array, elt->offset, &i);
1036 g_array_remove_index (level->array, i);
1039 for (i = MAX (i, 0); i < level->array->len; i++)
1041 /* NOTE: here we do *not* decrease offsets, because the node was
1042 * not removed from the child model
1044 elt = &g_array_index (level->array, FilterElt, i);
1046 elt->children->parent_elt = elt;
1050 else if ((length == 1 && parent && parent->ref_count > 1)
1051 || (length == 1 && level == filter->priv->root))
1055 /* we emit row-deleted, but keep the node in the cache and
1059 path = gtk_tree_model_get_path (GTK_TREE_MODEL (filter), iter);
1060 elt->visible = FALSE;
1061 gtk_tree_model_filter_increment_stamp (filter);
1062 gtk_tree_model_row_deleted (GTK_TREE_MODEL (filter), path);
1063 gtk_tree_path_free (path);
1069 /* blow level away */
1071 path = gtk_tree_model_get_path (GTK_TREE_MODEL (filter), iter);
1072 elt->visible = FALSE;
1073 gtk_tree_model_filter_increment_stamp (filter);
1074 iter->stamp = filter->priv->stamp;
1075 gtk_tree_model_row_deleted (GTK_TREE_MODEL (filter), path);
1076 gtk_tree_path_free (path);
1078 while (elt->ref_count > 1)
1079 gtk_tree_model_filter_real_unref_node (GTK_TREE_MODEL (filter),
1082 gtk_tree_model_filter_free_level (filter, level);
1085 if (emit_child_toggled)
1090 piter.stamp = filter->priv->stamp;
1091 piter.user_data = parent_level;
1092 piter.user_data2 = parent;
1094 ppath = gtk_tree_model_get_path (GTK_TREE_MODEL (filter), &piter);
1096 gtk_tree_model_row_has_child_toggled (GTK_TREE_MODEL (filter),
1098 gtk_tree_path_free (ppath);
1103 gtk_tree_model_filter_update_children (GtkTreeModelFilter *filter,
1113 iter.stamp = filter->priv->stamp;
1114 iter.user_data = level;
1115 iter.user_data2 = elt;
1117 gtk_tree_model_filter_convert_iter_to_child_iter (filter, &c_iter, &iter);
1119 if (gtk_tree_model_iter_has_child (filter->priv->child_model, &c_iter))
1121 GtkTreePath *path = gtk_tree_model_get_path (GTK_TREE_MODEL (filter),
1123 gtk_tree_model_row_has_child_toggled (GTK_TREE_MODEL (filter),
1127 gtk_tree_path_free (path);
1132 bsearch_elt_with_offset (GArray *array,
1136 gint start, middle, end;
1147 elt = &g_array_index (array, FilterElt, 0);
1149 if (elt->offset == offset)
1160 middle = (start + end) / 2;
1162 elt = &g_array_index (array, FilterElt, middle);
1164 if (elt->offset < offset)
1166 else if (elt->offset > offset)
1171 while (start != end);
1173 if (elt->offset == offset)
1182 /* TreeModel signals */
1184 gtk_tree_model_filter_row_changed (GtkTreeModel *c_model,
1185 GtkTreePath *c_path,
1186 GtkTreeIter *c_iter,
1189 GtkTreeModelFilter *filter = GTK_TREE_MODEL_FILTER (data);
1191 GtkTreeIter children;
1192 GtkTreeIter real_c_iter;
1193 GtkTreePath *path = NULL;
1198 gboolean requested_state;
1199 gboolean current_state;
1200 gboolean free_c_path = FALSE;
1202 g_return_if_fail (c_path != NULL || c_iter != NULL);
1206 c_path = gtk_tree_model_get_path (c_model, c_iter);
1211 real_c_iter = *c_iter;
1213 gtk_tree_model_get_iter (c_model, &real_c_iter, c_path);
1215 /* is this node above the virtual root? */
1216 if (filter->priv->virtual_root
1217 && (gtk_tree_path_get_depth (filter->priv->virtual_root)
1218 >= gtk_tree_path_get_depth (c_path)))
1221 /* what's the requested state? */
1222 requested_state = gtk_tree_model_filter_visible (filter, &real_c_iter);
1224 /* now, let's see whether the item is there */
1225 path = gtk_real_tree_model_filter_convert_child_path_to_path (filter,
1232 gtk_tree_model_filter_get_iter_full (GTK_TREE_MODEL (filter),
1234 current_state = FILTER_ELT (iter.user_data2)->visible;
1237 current_state = FALSE;
1239 if (current_state == FALSE && requested_state == FALSE)
1240 /* no changes required */
1243 if (current_state == TRUE && requested_state == FALSE)
1245 /* get rid of this node */
1246 level = FILTER_LEVEL (iter.user_data);
1247 level->visible_nodes--;
1249 gtk_tree_model_filter_remove_node (filter, &iter);
1254 if (current_state == TRUE && requested_state == TRUE)
1256 /* propagate the signal; also get a path taking only visible
1257 * nodes into account.
1259 gtk_tree_path_free (path);
1260 path = gtk_tree_model_get_path (GTK_TREE_MODEL (filter), &iter);
1261 gtk_tree_model_row_changed (GTK_TREE_MODEL (filter), path, &iter);
1263 level = FILTER_LEVEL (iter.user_data);
1264 elt = FILTER_ELT (iter.user_data2);
1266 /* and update the children */
1267 if (gtk_tree_model_iter_children (c_model, &children, &real_c_iter))
1268 gtk_tree_model_filter_update_children (filter, level, elt);
1273 /* only current == FALSE and requested == TRUE is left,
1276 g_return_if_fail (current_state == FALSE && requested_state == TRUE);
1278 /* make sure the new item has been pulled in */
1279 if (!filter->priv->root)
1284 gtk_tree_model_filter_build_level (filter, NULL, NULL, FALSE);
1286 root = FILTER_LEVEL (filter->priv->root);
1290 for (i = 0; i < root->array->len; i++)
1291 g_array_index (root->array, FilterElt, i).visible = FALSE;
1292 root->visible_nodes = 0;
1296 gtk_tree_model_filter_increment_stamp (filter);
1299 path = gtk_real_tree_model_filter_convert_child_path_to_path (filter,
1305 /* parent is probably being filtered out */
1308 gtk_tree_model_filter_get_iter_full (GTK_TREE_MODEL (filter), &iter, path);
1310 level = FILTER_LEVEL (iter.user_data);
1311 elt = FILTER_ELT (iter.user_data2);
1313 /* elt->visible can be TRUE at this point if it was pulled in above */
1316 elt->visible = TRUE;
1317 level->visible_nodes++;
1320 if (gtk_tree_model_filter_elt_is_visible_in_target (level, elt))
1322 /* visibility changed -- reget path */
1323 gtk_tree_path_free (path);
1324 path = gtk_tree_model_get_path (GTK_TREE_MODEL (filter), &iter);
1326 gtk_tree_model_row_inserted (GTK_TREE_MODEL (filter), path, &iter);
1328 if (gtk_tree_model_iter_children (c_model, &children, c_iter))
1329 gtk_tree_model_filter_update_children (filter, level, elt);
1334 gtk_tree_path_free (path);
1337 gtk_tree_path_free (c_path);
1341 gtk_tree_model_filter_row_inserted (GtkTreeModel *c_model,
1342 GtkTreePath *c_path,
1343 GtkTreeIter *c_iter,
1346 GtkTreeModelFilter *filter = GTK_TREE_MODEL_FILTER (data);
1347 GtkTreePath *path = NULL;
1348 GtkTreePath *real_path = NULL;
1351 GtkTreeIter real_c_iter;
1355 FilterLevel *parent_level;
1359 gboolean free_c_path = FALSE;
1361 g_return_if_fail (c_path != NULL || c_iter != NULL);
1365 c_path = gtk_tree_model_get_path (c_model, c_iter);
1370 real_c_iter = *c_iter;
1372 gtk_tree_model_get_iter (c_model, &real_c_iter, c_path);
1374 /* the row has already been inserted. so we need to fixup the
1375 * virtual root here first
1377 if (filter->priv->virtual_root)
1379 if (gtk_tree_path_get_depth (filter->priv->virtual_root) >=
1380 gtk_tree_path_get_depth (c_path))
1383 gint *v_indices, *c_indices;
1384 gboolean common_prefix = TRUE;
1386 level = gtk_tree_path_get_depth (c_path) - 1;
1387 v_indices = gtk_tree_path_get_indices (filter->priv->virtual_root);
1388 c_indices = gtk_tree_path_get_indices (c_path);
1390 for (i = 0; i < level; i++)
1391 if (v_indices[i] != c_indices[i])
1393 common_prefix = FALSE;
1397 if (common_prefix && v_indices[level] >= c_indices[level])
1398 (v_indices[level])++;
1402 if (!filter->priv->root)
1404 /* No point in building the level if this node is not visible. */
1405 if (!filter->priv->virtual_root
1406 && !gtk_tree_model_filter_visible (filter, c_iter))
1409 /* build level will pull in the new child */
1410 gtk_tree_model_filter_build_level (filter, NULL, NULL, FALSE);
1412 if (filter->priv->root
1413 && FILTER_LEVEL (filter->priv->root)->visible_nodes)
1419 parent_level = level = FILTER_LEVEL (filter->priv->root);
1421 /* subtract virtual root if necessary */
1422 if (filter->priv->virtual_root)
1424 real_path = gtk_tree_model_filter_remove_root (c_path,
1425 filter->priv->virtual_root);
1431 real_path = gtk_tree_path_copy (c_path);
1433 if (gtk_tree_path_get_depth (real_path) - 1 >= 1)
1435 /* find the parent level */
1436 while (i < gtk_tree_path_get_depth (real_path) - 1)
1441 /* we don't cover this signal */
1444 elt = bsearch_elt_with_offset (level->array,
1445 gtk_tree_path_get_indices (real_path)[i],
1449 /* parent is probably being filtered out */
1454 GtkTreePath *tmppath;
1455 GtkTreeIter tmpiter;
1457 tmpiter.stamp = filter->priv->stamp;
1458 tmpiter.user_data = level;
1459 tmpiter.user_data2 = elt;
1461 tmppath = gtk_tree_model_get_path (GTK_TREE_MODEL (data),
1466 gtk_tree_model_row_has_child_toggled (GTK_TREE_MODEL (data),
1468 gtk_tree_path_free (tmppath);
1471 /* not covering this signal */
1475 level = elt->children;
1476 parent_level = level;
1484 /* let's try to insert the value */
1485 offset = gtk_tree_path_get_indices (real_path)[gtk_tree_path_get_depth (real_path) - 1];
1487 /* update the offsets, yes if we didn't insert the node above, there will
1488 * be a gap here. This will be filled with the node (via fetch_child) when
1489 * it becomes visible
1491 for (i = 0; i < level->array->len; i++)
1493 FilterElt *e = &g_array_index (level->array, FilterElt, i);
1494 if ((e->offset >= offset))
1498 /* only insert when visible */
1499 if (gtk_tree_model_filter_visible (filter, &real_c_iter))
1503 if (GTK_TREE_MODEL_FILTER_CACHE_CHILD_ITERS (filter))
1504 felt.iter = real_c_iter;
1506 felt.offset = offset;
1507 felt.zero_ref_count = 0;
1509 felt.visible = TRUE;
1510 felt.children = NULL;
1512 for (i = 0; i < level->array->len; i++)
1513 if (g_array_index (level->array, FilterElt, i).offset > offset)
1516 level->visible_nodes++;
1518 g_array_insert_val (level->array, i, felt);
1520 if (level->parent_level || filter->priv->virtual_root)
1524 f_iter.stamp = filter->priv->stamp;
1525 f_iter.user_data = level;
1526 f_iter.user_data2 = &g_array_index (level->array, FilterElt, i);
1528 gtk_tree_model_filter_ref_node (GTK_TREE_MODEL (filter), &f_iter);
1532 /* another iteration to update the references of children to parents. */
1533 for (i = 0; i < level->array->len; i++)
1535 FilterElt *e = &g_array_index (level->array, FilterElt, i);
1537 e->children->parent_elt = e;
1540 /* don't emit the signal if we aren't visible */
1541 if (!gtk_tree_model_filter_visible (filter, &real_c_iter))
1545 /* NOTE: pass c_path here and NOT real_path. This function does
1546 * root subtraction itself
1548 path = gtk_real_tree_model_filter_convert_child_path_to_path (filter,
1555 gtk_tree_model_filter_increment_stamp (filter);
1557 gtk_tree_model_filter_get_iter_full (GTK_TREE_MODEL (data), &iter, path);
1559 /* get a path taking only visible nodes into account */
1560 gtk_tree_path_free (path);
1561 path = gtk_tree_model_get_path (GTK_TREE_MODEL (data), &iter);
1563 gtk_tree_model_row_inserted (GTK_TREE_MODEL (data), path, &iter);
1565 gtk_tree_path_free (path);
1569 gtk_tree_path_free (real_path);
1572 gtk_tree_path_free (c_path);
1576 gtk_tree_model_filter_row_has_child_toggled (GtkTreeModel *c_model,
1577 GtkTreePath *c_path,
1578 GtkTreeIter *c_iter,
1581 GtkTreeModelFilter *filter = GTK_TREE_MODEL_FILTER (data);
1587 g_return_if_fail (c_path != NULL && c_iter != NULL);
1589 /* If we get row-has-child-toggled on the virtual root, and there is
1590 * no root level; try to build it now.
1592 if (filter->priv->virtual_root && !filter->priv->root
1593 && !gtk_tree_path_compare (c_path, filter->priv->virtual_root))
1595 gtk_tree_model_filter_build_level (filter, NULL, NULL, TRUE);
1599 if (!gtk_tree_model_filter_visible (filter, c_iter))
1602 path = gtk_real_tree_model_filter_convert_child_path_to_path (filter,
1609 gtk_tree_model_filter_get_iter_full (GTK_TREE_MODEL (data), &iter, path);
1611 gtk_tree_path_free (path);
1613 level = FILTER_LEVEL (iter.user_data);
1614 elt = FILTER_ELT (iter.user_data2);
1616 g_assert (elt->visible);
1618 /* If this node is referenced and has children, build the level so we
1619 * can monitor it for changes.
1621 if (elt->ref_count > 1 && gtk_tree_model_iter_has_child (c_model, c_iter))
1622 gtk_tree_model_filter_build_level (filter, level, elt, TRUE);
1624 /* get a path taking only visible nodes into account */
1625 path = gtk_tree_model_get_path (GTK_TREE_MODEL (data), &iter);
1626 gtk_tree_model_row_has_child_toggled (GTK_TREE_MODEL (data), path, &iter);
1627 gtk_tree_path_free (path);
1631 gtk_tree_model_filter_row_deleted (GtkTreeModel *c_model,
1632 GtkTreePath *c_path,
1635 GtkTreeModelFilter *filter = GTK_TREE_MODEL_FILTER (data);
1638 FilterElt *elt, *parent = NULL;
1639 FilterLevel *level, *parent_level = NULL;
1640 gboolean emit_child_toggled = FALSE;
1644 g_return_if_fail (c_path != NULL);
1646 /* special case the deletion of an ancestor of the virtual root */
1647 if (filter->priv->virtual_root &&
1648 (gtk_tree_path_is_ancestor (c_path, filter->priv->virtual_root) ||
1649 !gtk_tree_path_compare (c_path, filter->priv->virtual_root)))
1653 FilterLevel *level = FILTER_LEVEL (filter->priv->root);
1655 gtk_tree_model_filter_unref_path (filter, filter->priv->virtual_root);
1656 filter->priv->virtual_root_deleted = TRUE;
1661 /* remove everything in the filter model
1663 * For now, we just iterate over the root level and emit a
1664 * row_deleted for each FilterElt. Not sure if this is correct.
1667 gtk_tree_model_filter_increment_stamp (filter);
1668 path = gtk_tree_path_new ();
1669 gtk_tree_path_append_index (path, 0);
1671 for (i = 0; i < level->visible_nodes; i++)
1672 gtk_tree_model_row_deleted (GTK_TREE_MODEL (data), path);
1674 gtk_tree_path_free (path);
1675 gtk_tree_model_filter_free_level (filter, filter->priv->root);
1680 /* fixup virtual root */
1681 if (filter->priv->virtual_root)
1683 if (gtk_tree_path_get_depth (filter->priv->virtual_root) >=
1684 gtk_tree_path_get_depth (c_path))
1687 gint *v_indices, *c_indices;
1688 gboolean common_prefix = TRUE;
1690 level = gtk_tree_path_get_depth (c_path) - 1;
1691 v_indices = gtk_tree_path_get_indices (filter->priv->virtual_root);
1692 c_indices = gtk_tree_path_get_indices (c_path);
1694 for (i = 0; i < level; i++)
1695 if (v_indices[i] != c_indices[i])
1697 common_prefix = FALSE;
1701 if (common_prefix && v_indices[level] > c_indices[level])
1702 (v_indices[level])--;
1706 path = gtk_real_tree_model_filter_convert_child_path_to_path (filter,
1713 /* The node deleted in the child model is not visible in the
1714 * filter model. We will not emit a signal, just fixup the offsets
1715 * of the other nodes.
1717 GtkTreePath *real_path;
1719 if (!filter->priv->root)
1722 level = FILTER_LEVEL (filter->priv->root);
1724 /* subtract vroot if necessary */
1725 if (filter->priv->virtual_root)
1727 real_path = gtk_tree_model_filter_remove_root (c_path,
1728 filter->priv->virtual_root);
1729 /* we don't handle this */
1734 real_path = gtk_tree_path_copy (c_path);
1737 if (gtk_tree_path_get_depth (real_path) - 1 >= 1)
1739 /* find the level where the deletion occurred */
1740 while (i < gtk_tree_path_get_depth (real_path) - 1)
1746 /* we don't cover this */
1747 gtk_tree_path_free (real_path);
1751 elt = bsearch_elt_with_offset (level->array,
1752 gtk_tree_path_get_indices (real_path)[i],
1755 if (!elt || !elt->children)
1757 /* parent is filtered out, so no level */
1758 gtk_tree_path_free (real_path);
1762 level = elt->children;
1767 offset = gtk_tree_path_get_indices (real_path)[gtk_tree_path_get_depth (real_path) - 1];
1768 gtk_tree_path_free (real_path);
1773 /* decrease offset of all nodes following the deleted node */
1774 for (i = 0; i < level->array->len; i++)
1776 elt = &g_array_index (level->array, FilterElt, i);
1777 if (elt->offset > offset)
1780 elt->children->parent_elt = elt;
1786 /* a node was deleted, which was in our cache */
1787 gtk_tree_model_filter_get_iter_full (GTK_TREE_MODEL (data), &iter, path);
1789 level = FILTER_LEVEL (iter.user_data);
1790 elt = FILTER_ELT (iter.user_data2);
1791 offset = elt->offset;
1795 /* get a path taking only visible nodes into account */
1796 gtk_tree_path_free (path);
1797 path = gtk_tree_model_get_path (GTK_TREE_MODEL (filter), &iter);
1799 level->visible_nodes--;
1801 if (level->visible_nodes == 0)
1803 emit_child_toggled = TRUE;
1804 parent_level = level->parent_level;
1805 parent = level->parent_elt;
1808 /* emit row_deleted */
1809 gtk_tree_model_filter_increment_stamp (filter);
1810 gtk_tree_model_row_deleted (GTK_TREE_MODEL (data), path);
1811 iter.stamp = filter->priv->stamp;
1814 /* The filter model's reference on the child node is released
1817 while (elt->ref_count > 1)
1818 gtk_tree_model_filter_real_unref_node (GTK_TREE_MODEL (data), &iter,
1821 if (level->array->len == 1)
1824 gtk_tree_model_filter_free_level (filter, level);
1830 /* release the filter model's reference on the node */
1831 if (level->parent_level || filter->priv->virtual_root)
1832 gtk_tree_model_filter_unref_node (GTK_TREE_MODEL (filter), &iter);
1833 else if (elt->ref_count > 0)
1834 gtk_tree_model_filter_real_unref_node (GTK_TREE_MODEL (data), &iter,
1837 /* remove the row */
1838 tmp = bsearch_elt_with_offset (level->array, elt->offset, &i);
1840 offset = tmp->offset;
1841 g_array_remove_index (level->array, i);
1844 for (i = MAX (i, 0); i < level->array->len; i++)
1846 elt = &g_array_index (level->array, FilterElt, i);
1847 if (elt->offset > offset)
1850 elt->children->parent_elt = elt;
1854 if (emit_child_toggled && parent_level)
1859 iter.stamp = filter->priv->stamp;
1860 iter.user_data = parent_level;
1861 iter.user_data2 = parent;
1863 /* We set in_row_deleted to TRUE to avoid a level build triggered
1864 * by row-has-child-toggled (parent model could call iter_has_child
1867 filter->priv->in_row_deleted = TRUE;
1868 path = gtk_tree_model_get_path (GTK_TREE_MODEL (filter), &iter);
1869 gtk_tree_model_row_has_child_toggled (GTK_TREE_MODEL (filter),
1871 gtk_tree_path_free (path);
1872 filter->priv->in_row_deleted = FALSE;
1875 gtk_tree_path_free (path);
1879 gtk_tree_model_filter_rows_reordered (GtkTreeModel *c_model,
1880 GtkTreePath *c_path,
1881 GtkTreeIter *c_iter,
1887 GtkTreeModelFilter *filter = GTK_TREE_MODEL_FILTER (data);
1893 gint i, j, elt_count;
1898 g_return_if_fail (new_order != NULL);
1900 if (c_path == NULL || gtk_tree_path_get_depth (c_path) == 0)
1902 length = gtk_tree_model_iter_n_children (c_model, NULL);
1904 if (filter->priv->virtual_root)
1908 /* reorder root level of path */
1909 for (i = 0; i < length; i++)
1910 if (new_order[i] == gtk_tree_path_get_indices (filter->priv->virtual_root)[0])
1916 gtk_tree_path_get_indices (filter->priv->virtual_root)[0] = new_pos;
1920 path = gtk_tree_path_new ();
1921 level = FILTER_LEVEL (filter->priv->root);
1925 GtkTreeIter child_iter;
1927 /* virtual root anchor reordering */
1928 if (filter->priv->virtual_root &&
1929 gtk_tree_path_is_ancestor (c_path, filter->priv->virtual_root))
1934 GtkTreeIter real_c_iter;
1936 level = gtk_tree_path_get_depth (c_path);
1939 real_c_iter = *c_iter;
1941 gtk_tree_model_get_iter (c_model, &real_c_iter, c_path);
1943 length = gtk_tree_model_iter_n_children (c_model, &real_c_iter);
1945 for (i = 0; i < length; i++)
1946 if (new_order[i] == gtk_tree_path_get_indices (filter->priv->virtual_root)[level])
1952 gtk_tree_path_get_indices (filter->priv->virtual_root)[level] = new_pos;
1956 path = gtk_real_tree_model_filter_convert_child_path_to_path (filter,
1961 if (!path && filter->priv->virtual_root &&
1962 gtk_tree_path_compare (c_path, filter->priv->virtual_root))
1965 if (!path && !filter->priv->virtual_root)
1970 /* root level mode */
1972 gtk_tree_model_get_iter (c_model, c_iter, c_path);
1973 length = gtk_tree_model_iter_n_children (c_model, c_iter);
1974 path = gtk_tree_path_new ();
1975 level = FILTER_LEVEL (filter->priv->root);
1979 gtk_tree_model_filter_get_iter_full (GTK_TREE_MODEL (data),
1982 level = FILTER_LEVEL (iter.user_data);
1983 elt = FILTER_ELT (iter.user_data2);
1987 gtk_tree_path_free (path);
1991 level = elt->children;
1993 gtk_tree_model_filter_convert_iter_to_child_iter (GTK_TREE_MODEL_FILTER (filter), &child_iter, &iter);
1994 length = gtk_tree_model_iter_n_children (c_model, &child_iter);
1998 if (!level || level->array->len < 1)
2000 gtk_tree_path_free (path);
2004 /* NOTE: we do not bail out here if level->array->len < 2 like
2005 * GtkTreeModelSort does. This because we do some special tricky
2009 /* construct a new array */
2010 new_array = g_array_sized_new (FALSE, FALSE, sizeof (FilterElt),
2012 tmp_array = g_new (gint, level->array->len);
2014 for (i = 0, elt_count = 0; i < length; i++)
2016 FilterElt *e = NULL;
2017 gint old_offset = -1;
2019 for (j = 0; j < level->array->len; j++)
2020 if (g_array_index (level->array, FilterElt, j).offset == new_order[i])
2022 e = &g_array_index (level->array, FilterElt, j);
2030 tmp_array[elt_count] = old_offset;
2031 g_array_append_val (new_array, *e);
2032 g_array_index (new_array, FilterElt, elt_count).offset = i;
2036 g_array_free (level->array, TRUE);
2037 level->array = new_array;
2040 for (i = 0; i < level->array->len; i++)
2042 FilterElt *e = &g_array_index (level->array, FilterElt, i);
2044 e->children->parent_elt = e;
2047 /* emit rows_reordered */
2048 if (!gtk_tree_path_get_indices (path))
2049 gtk_tree_model_rows_reordered (GTK_TREE_MODEL (data), path, NULL,
2053 /* get a path taking only visible nodes into account */
2054 gtk_tree_path_free (path);
2055 path = gtk_tree_model_get_path (GTK_TREE_MODEL (data), &iter);
2057 gtk_tree_model_rows_reordered (GTK_TREE_MODEL (data), path, &iter,
2063 gtk_tree_path_free (path);
2066 /* TreeModelIface implementation */
2067 static GtkTreeModelFlags
2068 gtk_tree_model_filter_get_flags (GtkTreeModel *model)
2070 GtkTreeModelFlags flags;
2072 g_return_val_if_fail (GTK_IS_TREE_MODEL_FILTER (model), 0);
2073 g_return_val_if_fail (GTK_TREE_MODEL_FILTER (model)->priv->child_model != NULL, 0);
2075 flags = gtk_tree_model_get_flags (GTK_TREE_MODEL_FILTER (model)->priv->child_model);
2077 if ((flags & GTK_TREE_MODEL_LIST_ONLY) == GTK_TREE_MODEL_LIST_ONLY)
2078 return GTK_TREE_MODEL_LIST_ONLY;
2084 gtk_tree_model_filter_get_n_columns (GtkTreeModel *model)
2086 GtkTreeModelFilter *filter = (GtkTreeModelFilter *)model;
2088 g_return_val_if_fail (GTK_IS_TREE_MODEL_FILTER (model), 0);
2089 g_return_val_if_fail (filter->priv->child_model != NULL, 0);
2091 if (filter->priv->child_model == NULL)
2094 /* so we can't modify the modify func after this ... */
2095 filter->priv->modify_func_set = TRUE;
2097 if (filter->priv->modify_n_columns > 0)
2098 return filter->priv->modify_n_columns;
2100 return gtk_tree_model_get_n_columns (filter->priv->child_model);
2104 gtk_tree_model_filter_get_column_type (GtkTreeModel *model,
2107 GtkTreeModelFilter *filter = (GtkTreeModelFilter *)model;
2109 g_return_val_if_fail (GTK_IS_TREE_MODEL_FILTER (model), G_TYPE_INVALID);
2110 g_return_val_if_fail (filter->priv->child_model != NULL, G_TYPE_INVALID);
2112 /* so we can't modify the modify func after this ... */
2113 filter->priv->modify_func_set = TRUE;
2115 if (filter->priv->modify_types)
2117 g_return_val_if_fail (index < filter->priv->modify_n_columns, G_TYPE_INVALID);
2119 return filter->priv->modify_types[index];
2122 return gtk_tree_model_get_column_type (filter->priv->child_model, index);
2125 /* A special case of _get_iter; this function can also get iters which
2126 * are not visible. These iters should ONLY be passed internally, never
2127 * pass those along with a signal emission.
2130 gtk_tree_model_filter_get_iter_full (GtkTreeModel *model,
2134 GtkTreeModelFilter *filter = (GtkTreeModelFilter *)model;
2139 g_return_val_if_fail (GTK_IS_TREE_MODEL_FILTER (model), FALSE);
2140 g_return_val_if_fail (filter->priv->child_model != NULL, FALSE);
2142 indices = gtk_tree_path_get_indices (path);
2144 if (filter->priv->root == NULL)
2145 gtk_tree_model_filter_build_level (filter, NULL, NULL, FALSE);
2146 level = FILTER_LEVEL (filter->priv->root);
2148 depth = gtk_tree_path_get_depth (path);
2155 for (i = 0; i < depth - 1; i++)
2157 if (!level || indices[i] >= level->array->len)
2162 elt = gtk_tree_model_filter_get_nth (filter, level, indices[i]);
2165 gtk_tree_model_filter_build_level (filter, level, elt, FALSE);
2166 level = elt->children;
2169 if (!level || indices[i] >= level->array->len)
2175 iter->stamp = filter->priv->stamp;
2176 iter->user_data = level;
2178 elt = gtk_tree_model_filter_get_nth (filter, level, indices[depth - 1]);
2179 iter->user_data2 = elt;
2185 gtk_tree_model_filter_get_iter (GtkTreeModel *model,
2189 GtkTreeModelFilter *filter = (GtkTreeModelFilter *)model;
2194 g_return_val_if_fail (GTK_IS_TREE_MODEL_FILTER (model), FALSE);
2195 g_return_val_if_fail (filter->priv->child_model != NULL, FALSE);
2197 indices = gtk_tree_path_get_indices (path);
2199 if (filter->priv->root == NULL)
2200 gtk_tree_model_filter_build_level (filter, NULL, NULL, FALSE);
2201 level = FILTER_LEVEL (filter->priv->root);
2203 depth = gtk_tree_path_get_depth (path);
2210 for (i = 0; i < depth - 1; i++)
2212 if (!level || indices[i] >= level->visible_nodes)
2217 elt = gtk_tree_model_filter_get_nth_visible (filter, level, indices[i]);
2220 gtk_tree_model_filter_build_level (filter, level, elt, FALSE);
2221 level = elt->children;
2224 if (!level || indices[i] >= level->visible_nodes)
2230 iter->stamp = filter->priv->stamp;
2231 iter->user_data = level;
2233 elt = gtk_tree_model_filter_get_nth_visible (filter, level,
2234 indices[depth - 1]);
2235 iter->user_data2 = elt;
2240 static GtkTreePath *
2241 gtk_tree_model_filter_get_path (GtkTreeModel *model,
2244 GtkTreePath *retval;
2248 g_return_val_if_fail (GTK_IS_TREE_MODEL_FILTER (model), NULL);
2249 g_return_val_if_fail (GTK_TREE_MODEL_FILTER (model)->priv->child_model != NULL, NULL);
2250 g_return_val_if_fail (GTK_TREE_MODEL_FILTER (model)->priv->stamp == iter->stamp, NULL);
2252 level = iter->user_data;
2253 elt = iter->user_data2;
2258 retval = gtk_tree_path_new ();
2262 int i = 0, index = 0;
2264 while (&g_array_index (level->array, FilterElt, i) != elt)
2266 if (g_array_index (level->array, FilterElt, i).visible)
2270 g_assert (i < level->array->len);
2273 gtk_tree_path_prepend_index (retval, index);
2274 elt = level->parent_elt;
2275 level = level->parent_level;
2282 gtk_tree_model_filter_get_value (GtkTreeModel *model,
2287 GtkTreeIter child_iter;
2288 GtkTreeModelFilter *filter = GTK_TREE_MODEL_FILTER (model);
2290 g_return_if_fail (GTK_IS_TREE_MODEL_FILTER (model));
2291 g_return_if_fail (GTK_TREE_MODEL_FILTER (model)->priv->child_model != NULL);
2292 g_return_if_fail (GTK_TREE_MODEL_FILTER (model)->priv->stamp == iter->stamp);
2294 if (filter->priv->modify_func)
2296 g_return_if_fail (column < filter->priv->modify_n_columns);
2298 g_value_init (value, filter->priv->modify_types[column]);
2299 filter->priv->modify_func (model,
2303 filter->priv->modify_data);
2308 gtk_tree_model_filter_convert_iter_to_child_iter (GTK_TREE_MODEL_FILTER (model), &child_iter, iter);
2309 gtk_tree_model_get_value (GTK_TREE_MODEL_FILTER (model)->priv->child_model,
2310 &child_iter, column, value);
2314 gtk_tree_model_filter_iter_next (GtkTreeModel *model,
2321 g_return_val_if_fail (GTK_IS_TREE_MODEL_FILTER (model), FALSE);
2322 g_return_val_if_fail (GTK_TREE_MODEL_FILTER (model)->priv->child_model != NULL, FALSE);
2323 g_return_val_if_fail (GTK_TREE_MODEL_FILTER (model)->priv->stamp == iter->stamp, FALSE);
2325 level = iter->user_data;
2326 elt = iter->user_data2;
2328 i = elt - FILTER_ELT (level->array->data);
2330 while (i < level->array->len - 1)
2337 iter->user_data2 = elt;
2342 /* no next visible iter */
2349 gtk_tree_model_filter_iter_children (GtkTreeModel *model,
2351 GtkTreeIter *parent)
2353 GtkTreeModelFilter *filter = (GtkTreeModelFilter *)model;
2357 g_return_val_if_fail (GTK_IS_TREE_MODEL_FILTER (model), FALSE);
2358 g_return_val_if_fail (filter->priv->child_model != NULL, FALSE);
2360 g_return_val_if_fail (filter->priv->stamp == parent->stamp, FALSE);
2366 if (!filter->priv->root)
2367 gtk_tree_model_filter_build_level (filter, NULL, NULL, FALSE);
2368 if (!filter->priv->root)
2371 level = filter->priv->root;
2373 if (!level->visible_nodes)
2376 iter->stamp = filter->priv->stamp;
2377 iter->user_data = level;
2379 while (i < level->array->len)
2381 if (!g_array_index (level->array, FilterElt, i).visible)
2387 iter->user_data2 = &g_array_index (level->array, FilterElt, i);
2398 if (FILTER_ELT (parent->user_data2)->children == NULL)
2399 gtk_tree_model_filter_build_level (filter,
2400 FILTER_LEVEL (parent->user_data),
2401 FILTER_ELT (parent->user_data2),
2403 if (FILTER_ELT (parent->user_data2)->children == NULL)
2406 if (FILTER_ELT (parent->user_data2)->children->visible_nodes <= 0)
2409 iter->stamp = filter->priv->stamp;
2410 iter->user_data = FILTER_ELT (parent->user_data2)->children;
2412 level = FILTER_LEVEL (iter->user_data);
2414 while (i < level->array->len)
2416 if (!g_array_index (level->array, FilterElt, i).visible)
2422 iter->user_data2 = &g_array_index (level->array, FilterElt, i);
2435 gtk_tree_model_filter_iter_has_child (GtkTreeModel *model,
2438 GtkTreeIter child_iter;
2439 GtkTreeModelFilter *filter = (GtkTreeModelFilter *)model;
2442 g_return_val_if_fail (GTK_IS_TREE_MODEL_FILTER (model), FALSE);
2443 g_return_val_if_fail (filter->priv->child_model != NULL, FALSE);
2444 g_return_val_if_fail (filter->priv->stamp == iter->stamp, FALSE);
2446 filter = GTK_TREE_MODEL_FILTER (model);
2448 gtk_tree_model_filter_convert_iter_to_child_iter (GTK_TREE_MODEL_FILTER (model), &child_iter, iter);
2449 elt = FILTER_ELT (iter->user_data2);
2454 /* we need to build the level to check if not all children are filtered
2458 && gtk_tree_model_iter_has_child (filter->priv->child_model, &child_iter))
2459 gtk_tree_model_filter_build_level (filter, FILTER_LEVEL (iter->user_data),
2462 if (elt->children && elt->children->visible_nodes > 0)
2469 gtk_tree_model_filter_iter_n_children (GtkTreeModel *model,
2472 GtkTreeIter child_iter;
2473 GtkTreeModelFilter *filter = (GtkTreeModelFilter *)model;
2476 g_return_val_if_fail (GTK_IS_TREE_MODEL_FILTER (model), 0);
2477 g_return_val_if_fail (filter->priv->child_model != NULL, 0);
2479 g_return_val_if_fail (filter->priv->stamp == iter->stamp, 0);
2483 if (!filter->priv->root)
2484 gtk_tree_model_filter_build_level (filter, NULL, NULL, FALSE);
2486 if (filter->priv->root)
2487 return FILTER_LEVEL (filter->priv->root)->visible_nodes;
2492 elt = FILTER_ELT (iter->user_data2);
2497 gtk_tree_model_filter_convert_iter_to_child_iter (GTK_TREE_MODEL_FILTER (model), &child_iter, iter);
2499 if (!elt->children &&
2500 gtk_tree_model_iter_has_child (filter->priv->child_model, &child_iter))
2501 gtk_tree_model_filter_build_level (filter,
2502 FILTER_LEVEL (iter->user_data),
2506 return elt->children->visible_nodes;
2512 gtk_tree_model_filter_iter_nth_child (GtkTreeModel *model,
2514 GtkTreeIter *parent,
2519 GtkTreeIter children;
2521 g_return_val_if_fail (GTK_IS_TREE_MODEL_FILTER (model), FALSE);
2523 g_return_val_if_fail (GTK_TREE_MODEL_FILTER (model)->priv->stamp == parent->stamp, FALSE);
2525 /* use this instead of has_child to force us to build the level, if needed */
2526 if (gtk_tree_model_filter_iter_children (model, &children, parent) == FALSE)
2532 level = children.user_data;
2533 elt = FILTER_ELT (level->array->data);
2535 if (n >= level->visible_nodes)
2541 elt = gtk_tree_model_filter_get_nth_visible (GTK_TREE_MODEL_FILTER (model),
2544 iter->stamp = GTK_TREE_MODEL_FILTER (model)->priv->stamp;
2545 iter->user_data = level;
2546 iter->user_data2 = elt;
2552 gtk_tree_model_filter_iter_parent (GtkTreeModel *model,
2559 g_return_val_if_fail (GTK_IS_TREE_MODEL_FILTER (model), FALSE);
2560 g_return_val_if_fail (GTK_TREE_MODEL_FILTER (model)->priv->child_model != NULL, FALSE);
2561 g_return_val_if_fail (GTK_TREE_MODEL_FILTER (model)->priv->stamp == child->stamp, FALSE);
2563 level = child->user_data;
2565 if (level->parent_level)
2567 iter->stamp = GTK_TREE_MODEL_FILTER (model)->priv->stamp;
2568 iter->user_data = level->parent_level;
2569 iter->user_data2 = level->parent_elt;
2578 gtk_tree_model_filter_ref_node (GtkTreeModel *model,
2581 GtkTreeModelFilter *filter = (GtkTreeModelFilter *)model;
2582 GtkTreeIter child_iter;
2586 g_return_if_fail (GTK_IS_TREE_MODEL_FILTER (model));
2587 g_return_if_fail (GTK_TREE_MODEL_FILTER (model)->priv->child_model != NULL);
2588 g_return_if_fail (GTK_TREE_MODEL_FILTER (model)->priv->stamp == iter->stamp);
2590 gtk_tree_model_filter_convert_iter_to_child_iter (GTK_TREE_MODEL_FILTER (model), &child_iter, iter);
2592 gtk_tree_model_ref_node (filter->priv->child_model, &child_iter);
2594 level = iter->user_data;
2595 elt = iter->user_data2;
2599 if (level->ref_count == 1)
2601 FilterLevel *parent_level = level->parent_level;
2602 FilterElt *parent_elt = level->parent_elt;
2604 /* we were at zero -- time to decrease the zero_ref_count val */
2605 while (parent_level)
2607 parent_elt->zero_ref_count--;
2609 parent_elt = parent_level->parent_elt;
2610 parent_level = parent_level->parent_level;
2613 if (filter->priv->root != level)
2614 filter->priv->zero_ref_count--;
2619 gtk_tree_model_filter_unref_node (GtkTreeModel *model,
2622 gtk_tree_model_filter_real_unref_node (model, iter, TRUE);
2626 gtk_tree_model_filter_real_unref_node (GtkTreeModel *model,
2628 gboolean propagate_unref)
2630 GtkTreeModelFilter *filter = (GtkTreeModelFilter *)model;
2634 g_return_if_fail (GTK_IS_TREE_MODEL_FILTER (model));
2635 g_return_if_fail (filter->priv->child_model != NULL);
2636 g_return_if_fail (filter->priv->stamp == iter->stamp);
2638 if (propagate_unref)
2640 GtkTreeIter child_iter;
2641 gtk_tree_model_filter_convert_iter_to_child_iter (GTK_TREE_MODEL_FILTER (model), &child_iter, iter);
2642 gtk_tree_model_unref_node (filter->priv->child_model, &child_iter);
2645 level = iter->user_data;
2646 elt = iter->user_data2;
2648 g_return_if_fail (elt->ref_count > 0);
2652 if (level->ref_count == 0)
2654 FilterLevel *parent_level = level->parent_level;
2655 FilterElt *parent_elt = level->parent_elt;
2657 /* we are at zero -- time to increase 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++;
2671 /* TreeDragSource interface implementation */
2673 gtk_tree_model_filter_row_draggable (GtkTreeDragSource *drag_source,
2676 GtkTreeModelFilter *tree_model_filter = (GtkTreeModelFilter *)drag_source;
2677 GtkTreePath *child_path;
2680 g_return_val_if_fail (GTK_IS_TREE_MODEL_FILTER (drag_source), FALSE);
2681 g_return_val_if_fail (path != NULL, FALSE);
2683 child_path = gtk_tree_model_filter_convert_path_to_child_path (tree_model_filter, path);
2684 draggable = gtk_tree_drag_source_row_draggable (GTK_TREE_DRAG_SOURCE (tree_model_filter->priv->child_model), child_path);
2685 gtk_tree_path_free (child_path);
2691 gtk_tree_model_filter_drag_data_get (GtkTreeDragSource *drag_source,
2693 GtkSelectionData *selection_data)
2695 GtkTreeModelFilter *tree_model_filter = (GtkTreeModelFilter *)drag_source;
2696 GtkTreePath *child_path;
2699 g_return_val_if_fail (GTK_IS_TREE_MODEL_FILTER (drag_source), FALSE);
2700 g_return_val_if_fail (path != NULL, FALSE);
2702 child_path = gtk_tree_model_filter_convert_path_to_child_path (tree_model_filter, path);
2703 gotten = gtk_tree_drag_source_drag_data_get (GTK_TREE_DRAG_SOURCE (tree_model_filter->priv->child_model), child_path, selection_data);
2704 gtk_tree_path_free (child_path);
2710 gtk_tree_model_filter_drag_data_delete (GtkTreeDragSource *drag_source,
2713 GtkTreeModelFilter *tree_model_filter = (GtkTreeModelFilter *)drag_source;
2714 GtkTreePath *child_path;
2717 g_return_val_if_fail (GTK_IS_TREE_MODEL_FILTER (drag_source), FALSE);
2718 g_return_val_if_fail (path != NULL, FALSE);
2720 child_path = gtk_tree_model_filter_convert_path_to_child_path (tree_model_filter, path);
2721 deleted = gtk_tree_drag_source_drag_data_delete (GTK_TREE_DRAG_SOURCE (tree_model_filter->priv->child_model), child_path);
2722 gtk_tree_path_free (child_path);
2727 /* bits and pieces */
2729 gtk_tree_model_filter_set_model (GtkTreeModelFilter *filter,
2730 GtkTreeModel *child_model)
2732 g_return_if_fail (GTK_IS_TREE_MODEL_FILTER (filter));
2734 if (filter->priv->child_model)
2736 g_signal_handler_disconnect (filter->priv->child_model,
2737 filter->priv->changed_id);
2738 g_signal_handler_disconnect (filter->priv->child_model,
2739 filter->priv->inserted_id);
2740 g_signal_handler_disconnect (filter->priv->child_model,
2741 filter->priv->has_child_toggled_id);
2742 g_signal_handler_disconnect (filter->priv->child_model,
2743 filter->priv->deleted_id);
2744 g_signal_handler_disconnect (filter->priv->child_model,
2745 filter->priv->reordered_id);
2747 /* reset our state */
2748 if (filter->priv->root)
2749 gtk_tree_model_filter_free_level (filter, filter->priv->root);
2751 filter->priv->root = NULL;
2752 g_object_unref (filter->priv->child_model);
2753 filter->priv->visible_column = -1;
2755 /* FIXME: do we need to destroy more here? */
2758 filter->priv->child_model = child_model;
2762 g_object_ref (filter->priv->child_model);
2763 filter->priv->changed_id =
2764 g_signal_connect (child_model, "row-changed",
2765 G_CALLBACK (gtk_tree_model_filter_row_changed),
2767 filter->priv->inserted_id =
2768 g_signal_connect (child_model, "row-inserted",
2769 G_CALLBACK (gtk_tree_model_filter_row_inserted),
2771 filter->priv->has_child_toggled_id =
2772 g_signal_connect (child_model, "row-has-child-toggled",
2773 G_CALLBACK (gtk_tree_model_filter_row_has_child_toggled),
2775 filter->priv->deleted_id =
2776 g_signal_connect (child_model, "row-deleted",
2777 G_CALLBACK (gtk_tree_model_filter_row_deleted),
2779 filter->priv->reordered_id =
2780 g_signal_connect (child_model, "rows-reordered",
2781 G_CALLBACK (gtk_tree_model_filter_rows_reordered),
2784 filter->priv->child_flags = gtk_tree_model_get_flags (child_model);
2785 filter->priv->stamp = g_random_int ();
2790 gtk_tree_model_filter_ref_path (GtkTreeModelFilter *filter,
2796 len = gtk_tree_path_get_depth (path);
2797 p = gtk_tree_path_copy (path);
2802 gtk_tree_model_get_iter (GTK_TREE_MODEL (filter->priv->child_model), &iter, p);
2803 gtk_tree_model_ref_node (GTK_TREE_MODEL (filter->priv->child_model), &iter);
2804 gtk_tree_path_up (p);
2807 gtk_tree_path_free (p);
2811 gtk_tree_model_filter_unref_path (GtkTreeModelFilter *filter,
2817 len = gtk_tree_path_get_depth (path);
2818 p = gtk_tree_path_copy (path);
2823 gtk_tree_model_get_iter (GTK_TREE_MODEL (filter->priv->child_model), &iter, p);
2824 gtk_tree_model_unref_node (GTK_TREE_MODEL (filter->priv->child_model), &iter);
2825 gtk_tree_path_up (p);
2828 gtk_tree_path_free (p);
2832 gtk_tree_model_filter_set_root (GtkTreeModelFilter *filter,
2835 g_return_if_fail (GTK_IS_TREE_MODEL_FILTER (filter));
2838 filter->priv->virtual_root = NULL;
2840 filter->priv->virtual_root = gtk_tree_path_copy (root);
2846 * gtk_tree_model_filter_new:
2847 * @child_model: A #GtkTreeModel.
2848 * @root: A #GtkTreePath or %NULL.
2850 * Creates a new #GtkTreeModel, with @child_model as the child_model
2851 * and @root as the virtual root.
2853 * Return value: A new #GtkTreeModel.
2858 gtk_tree_model_filter_new (GtkTreeModel *child_model,
2861 GtkTreeModel *retval;
2862 GtkTreeModelFilter *filter;
2864 g_return_val_if_fail (GTK_IS_TREE_MODEL (child_model), NULL);
2866 retval = g_object_new (GTK_TYPE_TREE_MODEL_FILTER,
2867 "child-model", child_model,
2868 "virtual-root", root,
2871 filter = GTK_TREE_MODEL_FILTER (retval);
2872 if (filter->priv->virtual_root)
2874 gtk_tree_model_filter_ref_path (filter, filter->priv->virtual_root);
2875 filter->priv->virtual_root_deleted = FALSE;
2882 * gtk_tree_model_filter_get_model:
2883 * @filter: A #GtkTreeModelFilter.
2885 * Returns a pointer to the child model of @filter.
2887 * Return value: A pointer to a #GtkTreeModel.
2892 gtk_tree_model_filter_get_model (GtkTreeModelFilter *filter)
2894 g_return_val_if_fail (GTK_IS_TREE_MODEL_FILTER (filter), NULL);
2896 return filter->priv->child_model;
2900 * gtk_tree_model_filter_set_visible_func:
2901 * @filter: A #GtkTreeModelFilter.
2902 * @func: A #GtkTreeModelFilterVisibleFunc, the visible function.
2903 * @data: User data to pass to the visible function, or %NULL.
2904 * @destroy: Destroy notifier of @data, or %NULL.
2906 * Sets the visible function used when filtering the @filter to be @func. The
2907 * function should return %TRUE if the given row should be visible and
2910 * If the condition calculated by the function changes over time (e.g. because
2911 * it depends on some global parameters), you must call
2912 * gtk_tree_model_filter_refilter() to keep the visibility information of
2913 * the model uptodate.
2915 * Note that @func is called whenever a row is inserted, when it may still be
2916 * empty. The visible function should therefore take special care of empty
2917 * rows, like in the example below.
2919 * <informalexample><programlisting>
2921 * visible_func (GtkTreeModel *model,
2922 * GtkTreeIter *iter,
2925 * /* Visible if row is non-empty and first column is "HI" */
2927 * gboolean visible = FALSE;
2929 * gtk_tree_model_get (model, iter, 0, &str, -1);
2930 * if (str && strcmp (str, "HI") == 0)
2936 * </programlisting></informalexample>
2941 gtk_tree_model_filter_set_visible_func (GtkTreeModelFilter *filter,
2942 GtkTreeModelFilterVisibleFunc func,
2944 GDestroyNotify destroy)
2946 g_return_if_fail (GTK_IS_TREE_MODEL_FILTER (filter));
2947 g_return_if_fail (func != NULL);
2948 g_return_if_fail (filter->priv->visible_method_set == FALSE);
2950 if (filter->priv->visible_func)
2952 GDestroyNotify d = filter->priv->visible_destroy;
2954 filter->priv->visible_destroy = NULL;
2955 d (filter->priv->visible_data);
2958 filter->priv->visible_func = func;
2959 filter->priv->visible_data = data;
2960 filter->priv->visible_destroy = destroy;
2962 filter->priv->visible_method_set = TRUE;
2966 * gtk_tree_model_filter_set_modify_func:
2967 * @filter: A #GtkTreeModelFilter.
2968 * @n_columns: The number of columns in the filter model.
2969 * @types: The #GType<!-- -->s of the columns.
2970 * @func: A #GtkTreeModelFilterModifyFunc
2971 * @data: User data to pass to the modify function, or %NULL.
2972 * @destroy: Destroy notifier of @data, or %NULL.
2974 * With the @n_columns and @types parameters, you give an array of column
2975 * types for this model (which will be exposed to the parent model/view).
2976 * The @func, @data and @destroy parameters are for specifying the modify
2977 * function. The modify function will get called for <emphasis>each</emphasis>
2978 * data access, the goal of the modify function is to return the data which
2979 * should be displayed at the location specified using the parameters of the
2985 gtk_tree_model_filter_set_modify_func (GtkTreeModelFilter *filter,
2988 GtkTreeModelFilterModifyFunc func,
2990 GDestroyNotify destroy)
2992 g_return_if_fail (GTK_IS_TREE_MODEL_FILTER (filter));
2993 g_return_if_fail (func != NULL);
2994 g_return_if_fail (filter->priv->modify_func_set == FALSE);
2996 if (filter->priv->modify_destroy)
2998 GDestroyNotify d = filter->priv->modify_destroy;
3000 filter->priv->modify_destroy = NULL;
3001 d (filter->priv->modify_data);
3004 filter->priv->modify_n_columns = n_columns;
3005 filter->priv->modify_types = g_new0 (GType, n_columns);
3006 memcpy (filter->priv->modify_types, types, sizeof (GType) * n_columns);
3007 filter->priv->modify_func = func;
3008 filter->priv->modify_data = data;
3009 filter->priv->modify_destroy = destroy;
3011 filter->priv->modify_func_set = TRUE;
3015 * gtk_tree_model_filter_set_visible_column:
3016 * @filter: A #GtkTreeModelFilter.
3017 * @column: A #gint which is the column containing the visible information.
3019 * Sets @column of the child_model to be the column where @filter should
3020 * look for visibility information. @columns should be a column of type
3021 * %G_TYPE_BOOLEAN, where %TRUE means that a row is visible, and %FALSE
3027 gtk_tree_model_filter_set_visible_column (GtkTreeModelFilter *filter,
3030 g_return_if_fail (GTK_IS_TREE_MODEL_FILTER (filter));
3031 g_return_if_fail (column >= 0);
3032 g_return_if_fail (filter->priv->visible_method_set == FALSE);
3034 filter->priv->visible_column = column;
3036 filter->priv->visible_method_set = TRUE;
3042 * gtk_tree_model_filter_convert_child_iter_to_iter:
3043 * @filter: A #GtkTreeModelFilter.
3044 * @filter_iter: An uninitialized #GtkTreeIter.
3045 * @child_iter: A valid #GtkTreeIter pointing to a row on the child model.
3047 * Sets @filter_iter to point to the row in @filter that corresponds to the
3048 * row pointed at by @child_iter. If @filter_iter was not set, %FALSE is
3051 * Return value: %TRUE, if @filter_iter was set, i.e. if @child_iter is a
3052 * valid iterator pointing to a visible row in child model.
3057 gtk_tree_model_filter_convert_child_iter_to_iter (GtkTreeModelFilter *filter,
3058 GtkTreeIter *filter_iter,
3059 GtkTreeIter *child_iter)
3062 GtkTreePath *child_path, *path;
3064 g_return_val_if_fail (GTK_IS_TREE_MODEL_FILTER (filter), FALSE);
3065 g_return_val_if_fail (filter->priv->child_model != NULL, FALSE);
3066 g_return_val_if_fail (filter_iter != NULL, FALSE);
3067 g_return_val_if_fail (child_iter != NULL, FALSE);
3068 g_return_val_if_fail (filter_iter != child_iter, FALSE);
3070 filter_iter->stamp = 0;
3072 child_path = gtk_tree_model_get_path (filter->priv->child_model, child_iter);
3073 g_return_val_if_fail (child_path != NULL, FALSE);
3075 path = gtk_tree_model_filter_convert_child_path_to_path (filter,
3077 gtk_tree_path_free (child_path);
3082 ret = gtk_tree_model_get_iter (GTK_TREE_MODEL (filter), filter_iter, path);
3083 gtk_tree_path_free (path);
3089 * gtk_tree_model_filter_convert_iter_to_child_iter:
3090 * @filter: A #GtkTreeModelFilter.
3091 * @child_iter: An uninitialized #GtkTreeIter.
3092 * @filter_iter: A valid #GtkTreeIter pointing to a row on @filter.
3094 * Sets @child_iter to point to the row pointed to by @filter_iter.
3099 gtk_tree_model_filter_convert_iter_to_child_iter (GtkTreeModelFilter *filter,
3100 GtkTreeIter *child_iter,
3101 GtkTreeIter *filter_iter)
3103 g_return_if_fail (GTK_IS_TREE_MODEL_FILTER (filter));
3104 g_return_if_fail (filter->priv->child_model != NULL);
3105 g_return_if_fail (child_iter != NULL);
3106 g_return_if_fail (filter_iter != NULL);
3107 g_return_if_fail (filter_iter->stamp == filter->priv->stamp);
3108 g_return_if_fail (filter_iter != child_iter);
3110 if (GTK_TREE_MODEL_FILTER_CACHE_CHILD_ITERS (filter))
3112 *child_iter = FILTER_ELT (filter_iter->user_data2)->iter;
3118 path = gtk_tree_model_filter_elt_get_path (filter_iter->user_data,
3119 filter_iter->user_data2,
3120 filter->priv->virtual_root);
3121 gtk_tree_model_get_iter (filter->priv->child_model, child_iter, path);
3122 gtk_tree_path_free (path);
3126 /* The path returned can only be used internally in the filter model. */
3127 static GtkTreePath *
3128 gtk_real_tree_model_filter_convert_child_path_to_path (GtkTreeModelFilter *filter,
3129 GtkTreePath *child_path,
3130 gboolean build_levels,
3131 gboolean fetch_children)
3133 gint *child_indices;
3134 GtkTreePath *retval;
3135 GtkTreePath *real_path;
3140 g_return_val_if_fail (GTK_IS_TREE_MODEL_FILTER (filter), NULL);
3141 g_return_val_if_fail (filter->priv->child_model != NULL, NULL);
3142 g_return_val_if_fail (child_path != NULL, NULL);
3144 if (!filter->priv->virtual_root)
3145 real_path = gtk_tree_path_copy (child_path);
3147 real_path = gtk_tree_model_filter_remove_root (child_path,
3148 filter->priv->virtual_root);
3153 retval = gtk_tree_path_new ();
3154 child_indices = gtk_tree_path_get_indices (real_path);
3156 if (filter->priv->root == NULL && build_levels)
3157 gtk_tree_model_filter_build_level (filter, NULL, NULL, FALSE);
3158 level = FILTER_LEVEL (filter->priv->root);
3160 for (i = 0; i < gtk_tree_path_get_depth (real_path); i++)
3163 gboolean found_child = FALSE;
3167 gtk_tree_path_free (real_path);
3168 gtk_tree_path_free (retval);
3172 tmp = bsearch_elt_with_offset (level->array, child_indices[i], &j);
3175 gtk_tree_path_append_index (retval, j);
3176 if (!tmp->children && build_levels)
3177 gtk_tree_model_filter_build_level (filter, level, tmp, FALSE);
3178 level = tmp->children;
3182 if (!found_child && fetch_children)
3184 tmp = gtk_tree_model_filter_fetch_child (filter, level,
3188 /* didn't find the child, let's try to bring it back */
3189 if (!tmp || tmp->offset != child_indices[i])
3192 gtk_tree_path_free (real_path);
3193 gtk_tree_path_free (retval);
3197 gtk_tree_path_append_index (retval, j);
3198 if (!tmp->children && build_levels)
3199 gtk_tree_model_filter_build_level (filter, level, tmp, FALSE);
3200 level = tmp->children;
3203 else if (!found_child && !fetch_children)
3206 gtk_tree_path_free (real_path);
3207 gtk_tree_path_free (retval);
3212 gtk_tree_path_free (real_path);
3217 * gtk_tree_model_filter_convert_child_path_to_path:
3218 * @filter: A #GtkTreeModelFilter.
3219 * @child_path: A #GtkTreePath to convert.
3221 * Converts @child_path to a path relative to @filter. That is, @child_path
3222 * points to a path in the child model. The rerturned path will point to the
3223 * same row in the filtered model. If @child_path isn't a valid path on the
3224 * child model or points to a row which is not visible in @filter, then %NULL
3227 * Return value: A newly allocated #GtkTreePath, or %NULL.
3232 gtk_tree_model_filter_convert_child_path_to_path (GtkTreeModelFilter *filter,
3233 GtkTreePath *child_path)
3238 /* this function does the sanity checks */
3239 path = gtk_real_tree_model_filter_convert_child_path_to_path (filter,
3247 /* get a new path which only takes visible nodes into account.
3248 * -- if this gives any performance issues, we can write a special
3249 * version of convert_child_path_to_path immediately returning
3250 * a visible-nodes-only path.
3252 gtk_tree_model_filter_get_iter_full (GTK_TREE_MODEL (filter), &iter, path);
3254 gtk_tree_path_free (path);
3255 path = gtk_tree_model_get_path (GTK_TREE_MODEL (filter), &iter);
3261 * gtk_tree_model_filter_convert_path_to_child_path:
3262 * @filter: A #GtkTreeModelFilter.
3263 * @filter_path: A #GtkTreePath to convert.
3265 * Converts @filter_path to a path on the child model of @filter. That is,
3266 * @filter_path points to a location in @filter. The returned path will
3267 * point to the same location in the model not being filtered. If @filter_path
3268 * does not point to a location in the child model, %NULL is returned.
3270 * Return value: A newly allocated #GtkTreePath, or %NULL.
3275 gtk_tree_model_filter_convert_path_to_child_path (GtkTreeModelFilter *filter,
3276 GtkTreePath *filter_path)
3278 gint *filter_indices;
3279 GtkTreePath *retval;
3283 g_return_val_if_fail (GTK_IS_TREE_MODEL_FILTER (filter), NULL);
3284 g_return_val_if_fail (filter->priv->child_model != NULL, NULL);
3285 g_return_val_if_fail (filter_path != NULL, NULL);
3288 retval = gtk_tree_path_new ();
3289 filter_indices = gtk_tree_path_get_indices (filter_path);
3290 if (!filter->priv->root)
3291 gtk_tree_model_filter_build_level (filter, NULL, NULL, FALSE);
3292 level = FILTER_LEVEL (filter->priv->root);
3294 for (i = 0; i < gtk_tree_path_get_depth (filter_path); i++)
3298 if (!level || level->visible_nodes <= filter_indices[i])
3300 gtk_tree_path_free (retval);
3304 elt = gtk_tree_model_filter_get_nth_visible (filter, level,
3307 if (elt->children == NULL)
3308 gtk_tree_model_filter_build_level (filter, level, elt, FALSE);
3310 if (!level || level->visible_nodes <= filter_indices[i])
3312 gtk_tree_path_free (retval);
3316 gtk_tree_path_append_index (retval, elt->offset);
3317 level = elt->children;
3322 if (filter->priv->virtual_root)
3324 GtkTreePath *real_retval;
3326 real_retval = gtk_tree_model_filter_add_root (retval,
3327 filter->priv->virtual_root);
3328 gtk_tree_path_free (retval);
3337 gtk_tree_model_filter_refilter_helper (GtkTreeModel *model,
3342 /* evil, don't try this at home, but certainly speeds things up */
3343 gtk_tree_model_filter_row_changed (model, path, iter, data);
3349 * gtk_tree_model_filter_refilter:
3350 * @filter: A #GtkTreeModelFilter.
3352 * Emits ::row_changed for each row in the child model, which causes
3353 * the filter to re-evaluate whether a row is visible or not.
3358 gtk_tree_model_filter_refilter (GtkTreeModelFilter *filter)
3360 g_return_if_fail (GTK_IS_TREE_MODEL_FILTER (filter));
3363 gtk_tree_model_foreach (filter->priv->child_model,
3364 gtk_tree_model_filter_refilter_helper,
3369 * gtk_tree_model_filter_clear_cache:
3370 * @filter: A #GtkTreeModelFilter.
3372 * This function should almost never be called. It clears the @filter
3373 * of any cached iterators that haven't been reffed with
3374 * gtk_tree_model_ref_node(). This might be useful if the child model
3375 * being filtered is static (and doesn't change often) and there has been
3376 * a lot of unreffed access to nodes. As a side effect of this function,
3377 * all unreffed iters will be invalid.
3382 gtk_tree_model_filter_clear_cache (GtkTreeModelFilter *filter)
3384 g_return_if_fail (GTK_IS_TREE_MODEL_FILTER (filter));
3386 if (filter->priv->zero_ref_count > 0)
3387 gtk_tree_model_filter_clear_cache_helper (filter,
3388 FILTER_LEVEL (filter->priv->root));
3391 #define __GTK_TREE_MODEL_FILTER_C__
3392 #include "gtkaliasdef.c"