1 /* gtktreemodelfilter.c
2 * Copyright (C) 2000,2001 Red Hat, Inc., Jonathan Blandford <jrb@redhat.com>
3 * Copyright (C) 2001-2003 Kristian Rietveld <kris@gtk.org>
5 * This library is free software; you can redistribute it and/or
6 * modify it under the terms of the GNU Library General Public
7 * License as published by the Free Software Foundation; either
8 * version 2 of the License, or (at your option) any later version.
10 * This library is distributed in the hope that it will be useful,
11 * but WITHOUT ANY WARRANTY; without even the implied warranty of
12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
13 * Library General Public License for more details.
15 * You should have received a copy of the GNU Library General Public
16 * License along with this library; if not, write to the
17 * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
18 * Boston, MA 02111-1307, USA.
22 #include "gtktreemodelfilter.h"
24 #include "gtktreednd.h"
25 #include "gtkprivate.h"
30 * SECTION:gtktreemodelfilter
31 * @Short_description: A GtkTreeModel which hides parts of an underlying tree model
32 * @Title: GtkTreeModelFilter
33 * @See_also:#GtkTreeModelSort
35 * A #GtkTreeModelFilter is a tree model which wraps another tree model,
36 * and can do the following things:
39 * Filter specific rows, based on data from a "visible column", a column
40 * storing booleans indicating whether the row should be filtered or not,
41 * or based on the return value of a "visible function", which gets a
42 * model, iter and user_data and returns a boolean indicating whether the
43 * row should be filtered or not.
46 * Modify the "appearance" of the model, using a modify function.
47 * This is extremely powerful and allows for just changing
48 * some values and also for creating a completely different model based on
49 * the given child model.
52 * Set a different root node, also known as a "virtual root". You can pass in
53 * a #GtkTreePath indicating the root node for the filter at construction time.
61 * iter->stamp = filter->priv->stamp
62 * iter->user_data = FilterLevel
63 * iter->user_data2 = FilterElt
66 /* all paths, iters, etc prefixed with c_ are paths, iters, etc relative to the
71 * There are three model/views involved, so there are two mappings:
72 * * this model -> child model: mapped via offset in FilterElt.
73 * * this model -> parent model (or view): mapped via the array index
76 * Note that there are two kinds of paths relative to the filter model
77 * (those generated from the array indices): paths taking non-visible
78 * nodes into account, and paths which don't. Paths which take
79 * non-visible nodes into account should only be used internally and
80 * NEVER be passed along with a signal emission.
82 * The filter model has a reference on every node that is not in the root
83 * level and has a parent with ref_count > 1. Exception is a virtual root
84 * level; all nodes in the virtual root level are referenced too.
87 typedef struct _FilterElt FilterElt;
88 typedef struct _FilterLevel FilterLevel;
93 FilterLevel *children;
106 gint parent_elt_index;
107 FilterLevel *parent_level;
111 struct _GtkTreeModelFilterPrivate
116 GtkTreeModel *child_model;
119 GtkTreePath *virtual_root;
121 GtkTreeModelFilterVisibleFunc visible_func;
122 gpointer visible_data;
123 GDestroyNotify visible_destroy;
125 gint modify_n_columns;
127 GtkTreeModelFilterModifyFunc modify_func;
128 gpointer modify_data;
129 GDestroyNotify modify_destroy;
133 gboolean visible_method_set;
134 gboolean modify_func_set;
136 gboolean in_row_deleted;
137 gboolean virtual_root_deleted;
142 gulong has_child_toggled_id;
155 #define GTK_TREE_MODEL_FILTER_CACHE_CHILD_ITERS(filter) \
156 (((GtkTreeModelFilter *)filter)->priv->child_flags & GTK_TREE_MODEL_ITERS_PERSIST)
158 #define FILTER_ELT(filter_elt) ((FilterElt *)filter_elt)
159 #define FILTER_LEVEL(filter_level) ((FilterLevel *)filter_level)
161 #define FILTER_LEVEL_PARENT_ELT(level) (&g_array_index (FILTER_LEVEL ((level))->parent_level->array, FilterElt, FILTER_LEVEL ((level))->parent_elt_index))
162 #define FILTER_LEVEL_ELT_INDEX(level, elt) (FILTER_ELT ((elt)) - FILTER_ELT (FILTER_LEVEL ((level))->array->data))
164 /* general code (object/interface init, properties, etc) */
165 static void gtk_tree_model_filter_tree_model_init (GtkTreeModelIface *iface);
166 static void gtk_tree_model_filter_drag_source_init (GtkTreeDragSourceIface *iface);
167 static void gtk_tree_model_filter_finalize (GObject *object);
168 static void gtk_tree_model_filter_set_property (GObject *object,
172 static void gtk_tree_model_filter_get_property (GObject *object,
177 /* signal handlers */
178 static void gtk_tree_model_filter_row_changed (GtkTreeModel *c_model,
182 static void gtk_tree_model_filter_row_inserted (GtkTreeModel *c_model,
186 static void gtk_tree_model_filter_row_has_child_toggled (GtkTreeModel *c_model,
190 static void gtk_tree_model_filter_row_deleted (GtkTreeModel *c_model,
193 static void gtk_tree_model_filter_rows_reordered (GtkTreeModel *c_model,
199 /* GtkTreeModel interface */
200 static GtkTreeModelFlags gtk_tree_model_filter_get_flags (GtkTreeModel *model);
201 static gint gtk_tree_model_filter_get_n_columns (GtkTreeModel *model);
202 static GType gtk_tree_model_filter_get_column_type (GtkTreeModel *model,
204 static gboolean gtk_tree_model_filter_get_iter_full (GtkTreeModel *model,
207 static gboolean gtk_tree_model_filter_get_iter (GtkTreeModel *model,
210 static GtkTreePath *gtk_tree_model_filter_get_path (GtkTreeModel *model,
212 static void gtk_tree_model_filter_get_value (GtkTreeModel *model,
216 static gboolean gtk_tree_model_filter_iter_next (GtkTreeModel *model,
218 static gboolean gtk_tree_model_filter_iter_previous (GtkTreeModel *model,
220 static gboolean gtk_tree_model_filter_iter_children (GtkTreeModel *model,
222 GtkTreeIter *parent);
223 static gboolean gtk_tree_model_filter_iter_has_child (GtkTreeModel *model,
225 static gint gtk_tree_model_filter_iter_n_children (GtkTreeModel *model,
227 static gboolean gtk_tree_model_filter_iter_nth_child (GtkTreeModel *model,
231 static gboolean gtk_tree_model_filter_iter_parent (GtkTreeModel *model,
234 static void gtk_tree_model_filter_ref_node (GtkTreeModel *model,
236 static void gtk_tree_model_filter_unref_node (GtkTreeModel *model,
239 /* TreeDragSource interface */
240 static gboolean gtk_tree_model_filter_row_draggable (GtkTreeDragSource *drag_source,
242 static gboolean gtk_tree_model_filter_drag_data_get (GtkTreeDragSource *drag_source,
244 GtkSelectionData *selection_data);
245 static gboolean gtk_tree_model_filter_drag_data_delete (GtkTreeDragSource *drag_source,
248 /* private functions */
249 static void gtk_tree_model_filter_build_level (GtkTreeModelFilter *filter,
250 FilterLevel *parent_level,
251 gint parent_elt_index,
252 gboolean emit_inserted);
254 static void gtk_tree_model_filter_free_level (GtkTreeModelFilter *filter,
255 FilterLevel *filter_level);
257 static GtkTreePath *gtk_tree_model_filter_elt_get_path (FilterLevel *level,
261 static GtkTreePath *gtk_tree_model_filter_add_root (GtkTreePath *src,
263 static GtkTreePath *gtk_tree_model_filter_remove_root (GtkTreePath *src,
266 static void gtk_tree_model_filter_increment_stamp (GtkTreeModelFilter *filter);
268 static void gtk_tree_model_filter_real_modify (GtkTreeModelFilter *self,
269 GtkTreeModel *child_model,
273 static gboolean gtk_tree_model_filter_real_visible (GtkTreeModelFilter *filter,
274 GtkTreeModel *child_model,
275 GtkTreeIter *child_iter);
276 static gboolean gtk_tree_model_filter_visible (GtkTreeModelFilter *filter,
277 GtkTreeIter *child_iter);
278 static void gtk_tree_model_filter_clear_cache_helper (GtkTreeModelFilter *filter,
281 static void gtk_tree_model_filter_real_unref_node (GtkTreeModel *model,
283 gboolean propagate_unref);
285 static void gtk_tree_model_filter_set_model (GtkTreeModelFilter *filter,
286 GtkTreeModel *child_model);
287 static void gtk_tree_model_filter_ref_path (GtkTreeModelFilter *filter,
289 static void gtk_tree_model_filter_unref_path (GtkTreeModelFilter *filter,
291 static void gtk_tree_model_filter_set_root (GtkTreeModelFilter *filter,
294 static GtkTreePath *gtk_real_tree_model_filter_convert_child_path_to_path (GtkTreeModelFilter *filter,
295 GtkTreePath *child_path,
296 gboolean build_levels,
297 gboolean fetch_children);
299 static FilterElt *gtk_tree_model_filter_get_nth (GtkTreeModelFilter *filter,
302 static gboolean gtk_tree_model_filter_elt_is_visible_in_target (FilterLevel *level,
304 static FilterElt *gtk_tree_model_filter_get_nth_visible (GtkTreeModelFilter *filter,
308 static FilterElt *gtk_tree_model_filter_fetch_child (GtkTreeModelFilter *filter,
312 static void gtk_tree_model_filter_remove_node (GtkTreeModelFilter *filter,
314 static void gtk_tree_model_filter_update_children (GtkTreeModelFilter *filter,
317 static FilterElt *bsearch_elt_with_offset (GArray *array,
322 G_DEFINE_TYPE_WITH_CODE (GtkTreeModelFilter, gtk_tree_model_filter, G_TYPE_OBJECT,
323 G_IMPLEMENT_INTERFACE (GTK_TYPE_TREE_MODEL,
324 gtk_tree_model_filter_tree_model_init)
325 G_IMPLEMENT_INTERFACE (GTK_TYPE_TREE_DRAG_SOURCE,
326 gtk_tree_model_filter_drag_source_init))
329 gtk_tree_model_filter_init (GtkTreeModelFilter *filter)
331 filter->priv = G_TYPE_INSTANCE_GET_PRIVATE (filter,
332 GTK_TYPE_TREE_MODEL_FILTER,
333 GtkTreeModelFilterPrivate);
335 filter->priv->visible_column = -1;
336 filter->priv->zero_ref_count = 0;
337 filter->priv->visible_method_set = FALSE;
338 filter->priv->modify_func_set = FALSE;
339 filter->priv->in_row_deleted = FALSE;
340 filter->priv->virtual_root_deleted = FALSE;
344 gtk_tree_model_filter_class_init (GtkTreeModelFilterClass *filter_class)
346 GObjectClass *object_class;
348 object_class = (GObjectClass *) filter_class;
350 object_class->set_property = gtk_tree_model_filter_set_property;
351 object_class->get_property = gtk_tree_model_filter_get_property;
353 object_class->finalize = gtk_tree_model_filter_finalize;
355 filter_class->visible = gtk_tree_model_filter_real_visible;
356 filter_class->modify = gtk_tree_model_filter_real_modify;
358 /* Properties -- FIXME: disabled translations for now, until I can come up with a
361 g_object_class_install_property (object_class,
363 g_param_spec_object ("child-model",
365 ("The model for the filtermodel to filter"),
367 GTK_PARAM_READWRITE | G_PARAM_CONSTRUCT_ONLY));
369 g_object_class_install_property (object_class,
371 g_param_spec_boxed ("virtual-root",
372 ("The virtual root"),
373 ("The virtual root (relative to the child model) for this filtermodel"),
375 GTK_PARAM_READWRITE | G_PARAM_CONSTRUCT_ONLY));
377 g_type_class_add_private (object_class, sizeof (GtkTreeModelFilterPrivate));
381 gtk_tree_model_filter_tree_model_init (GtkTreeModelIface *iface)
383 iface->get_flags = gtk_tree_model_filter_get_flags;
384 iface->get_n_columns = gtk_tree_model_filter_get_n_columns;
385 iface->get_column_type = gtk_tree_model_filter_get_column_type;
386 iface->get_iter = gtk_tree_model_filter_get_iter;
387 iface->get_path = gtk_tree_model_filter_get_path;
388 iface->get_value = gtk_tree_model_filter_get_value;
389 iface->iter_next = gtk_tree_model_filter_iter_next;
390 iface->iter_previous = gtk_tree_model_filter_iter_previous;
391 iface->iter_children = gtk_tree_model_filter_iter_children;
392 iface->iter_has_child = gtk_tree_model_filter_iter_has_child;
393 iface->iter_n_children = gtk_tree_model_filter_iter_n_children;
394 iface->iter_nth_child = gtk_tree_model_filter_iter_nth_child;
395 iface->iter_parent = gtk_tree_model_filter_iter_parent;
396 iface->ref_node = gtk_tree_model_filter_ref_node;
397 iface->unref_node = gtk_tree_model_filter_unref_node;
401 gtk_tree_model_filter_drag_source_init (GtkTreeDragSourceIface *iface)
403 iface->row_draggable = gtk_tree_model_filter_row_draggable;
404 iface->drag_data_delete = gtk_tree_model_filter_drag_data_delete;
405 iface->drag_data_get = gtk_tree_model_filter_drag_data_get;
410 gtk_tree_model_filter_finalize (GObject *object)
412 GtkTreeModelFilter *filter = (GtkTreeModelFilter *) object;
414 if (filter->priv->virtual_root && !filter->priv->virtual_root_deleted)
416 gtk_tree_model_filter_unref_path (filter, filter->priv->virtual_root);
417 filter->priv->virtual_root_deleted = TRUE;
420 gtk_tree_model_filter_set_model (filter, NULL);
422 if (filter->priv->virtual_root)
423 gtk_tree_path_free (filter->priv->virtual_root);
425 if (filter->priv->root)
426 gtk_tree_model_filter_free_level (filter, filter->priv->root);
428 g_free (filter->priv->modify_types);
430 if (filter->priv->modify_destroy)
431 filter->priv->modify_destroy (filter->priv->modify_data);
433 if (filter->priv->visible_destroy)
434 filter->priv->visible_destroy (filter->priv->visible_data);
437 G_OBJECT_CLASS (gtk_tree_model_filter_parent_class)->finalize (object);
441 gtk_tree_model_filter_set_property (GObject *object,
446 GtkTreeModelFilter *filter = GTK_TREE_MODEL_FILTER (object);
450 case PROP_CHILD_MODEL:
451 gtk_tree_model_filter_set_model (filter, g_value_get_object (value));
453 case PROP_VIRTUAL_ROOT:
454 gtk_tree_model_filter_set_root (filter, g_value_get_boxed (value));
457 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
463 gtk_tree_model_filter_get_property (GObject *object,
468 GtkTreeModelFilter *filter = GTK_TREE_MODEL_FILTER (object);
472 case PROP_CHILD_MODEL:
473 g_value_set_object (value, filter->priv->child_model);
475 case PROP_VIRTUAL_ROOT:
476 g_value_set_boxed (value, filter->priv->virtual_root);
479 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
487 gtk_tree_model_filter_build_level (GtkTreeModelFilter *filter,
488 FilterLevel *parent_level,
489 gint parent_elt_index,
490 gboolean emit_inserted)
493 GtkTreeIter first_node;
495 FilterElt *parent_elt = NULL;
496 FilterLevel *new_level;
500 g_assert (filter->priv->child_model != NULL);
502 if (filter->priv->in_row_deleted)
507 if (filter->priv->virtual_root)
509 if (gtk_tree_model_get_iter (filter->priv->child_model, &root, filter->priv->virtual_root) == FALSE)
511 length = gtk_tree_model_iter_n_children (filter->priv->child_model, &root);
513 if (gtk_tree_model_iter_children (filter->priv->child_model, &iter, &root) == FALSE)
518 if (!gtk_tree_model_get_iter_first (filter->priv->child_model, &iter))
520 length = gtk_tree_model_iter_n_children (filter->priv->child_model, NULL);
525 GtkTreeIter parent_iter;
526 GtkTreeIter child_parent_iter;
528 parent_elt = &g_array_index (parent_level->array, FilterElt, parent_elt_index);
530 parent_iter.stamp = filter->priv->stamp;
531 parent_iter.user_data = parent_level;
532 parent_iter.user_data2 = parent_elt;
534 gtk_tree_model_filter_convert_iter_to_child_iter (filter,
537 if (gtk_tree_model_iter_children (filter->priv->child_model, &iter, &child_parent_iter) == FALSE)
540 /* stamp may have changed */
541 gtk_tree_model_filter_convert_iter_to_child_iter (filter,
544 length = gtk_tree_model_iter_n_children (filter->priv->child_model, &child_parent_iter);
547 g_return_if_fail (length > 0);
549 new_level = g_new (FilterLevel, 1);
550 new_level->array = g_array_sized_new (FALSE, FALSE,
553 new_level->ref_count = 0;
554 new_level->visible_nodes = 0;
555 new_level->parent_elt_index = parent_elt_index;
556 new_level->parent_level = parent_level;
558 if (parent_elt_index >= 0)
559 parent_elt->children = new_level;
561 filter->priv->root = new_level;
563 /* increase the count of zero ref_counts */
566 g_array_index (parent_level->array, FilterElt, parent_elt_index).zero_ref_count++;
568 parent_elt_index = parent_level->parent_elt_index;
569 parent_level = parent_level->parent_level;
571 if (new_level != filter->priv->root)
572 filter->priv->zero_ref_count++;
580 if (gtk_tree_model_filter_visible (filter, &iter))
583 FilterElt filter_elt;
585 filter_elt.offset = i;
586 filter_elt.zero_ref_count = 0;
587 filter_elt.ref_count = 0;
588 filter_elt.children = NULL;
589 filter_elt.visible = TRUE;
591 if (GTK_TREE_MODEL_FILTER_CACHE_CHILD_ITERS (filter))
592 filter_elt.iter = iter;
594 g_array_append_val (new_level->array, filter_elt);
595 new_level->visible_nodes++;
597 f_iter.stamp = filter->priv->stamp;
598 f_iter.user_data = new_level;
599 f_iter.user_data2 = &(g_array_index (new_level->array, FilterElt, new_level->array->len - 1));
601 if (new_level->parent_level || filter->priv->virtual_root)
602 gtk_tree_model_filter_ref_node (GTK_TREE_MODEL (filter), &f_iter);
607 GtkTreeIter children;
609 f_path = gtk_tree_model_get_path (GTK_TREE_MODEL (filter),
611 gtk_tree_model_row_inserted (GTK_TREE_MODEL (filter),
613 gtk_tree_path_free (f_path);
615 if (gtk_tree_model_iter_children (filter->priv->child_model,
617 gtk_tree_model_filter_update_children (filter,
619 FILTER_ELT (f_iter.user_data2));
624 while (gtk_tree_model_iter_next (filter->priv->child_model, &iter));
626 if (new_level->array->len == 0
627 && (new_level != filter->priv->root || filter->priv->virtual_root))
629 /* If none of the nodes are visible, we will just pull in the
630 * first node of the level and keep a reference on it. We need this
631 * to make sure that we get all signals for this level.
633 FilterElt filter_elt;
636 filter_elt.offset = 0;
637 filter_elt.zero_ref_count = 0;
638 filter_elt.ref_count = 0;
639 filter_elt.children = NULL;
640 filter_elt.visible = FALSE;
642 if (GTK_TREE_MODEL_FILTER_CACHE_CHILD_ITERS (filter))
643 filter_elt.iter = first_node;
645 g_array_append_val (new_level->array, filter_elt);
647 f_iter.stamp = filter->priv->stamp;
648 f_iter.user_data = new_level;
649 f_iter.user_data2 = &(g_array_index (new_level->array, FilterElt, new_level->array->len - 1));
651 gtk_tree_model_filter_ref_node (GTK_TREE_MODEL (filter), &f_iter);
653 else if (new_level->array->len == 0)
654 gtk_tree_model_filter_free_level (filter, new_level);
658 gtk_tree_model_filter_free_level (GtkTreeModelFilter *filter,
659 FilterLevel *filter_level)
663 g_assert (filter_level);
665 for (i = 0; i < filter_level->array->len; i++)
667 if (g_array_index (filter_level->array, FilterElt, i).children)
668 gtk_tree_model_filter_free_level (filter,
669 FILTER_LEVEL (g_array_index (filter_level->array, FilterElt, i).children));
671 if (filter_level->parent_level || filter->priv->virtual_root)
675 f_iter.stamp = filter->priv->stamp;
676 f_iter.user_data = filter_level;
677 f_iter.user_data2 = &(g_array_index (filter_level->array, FilterElt, i));
679 gtk_tree_model_filter_unref_node (GTK_TREE_MODEL (filter), &f_iter);
683 if (filter_level->ref_count == 0)
685 FilterLevel *parent_level = filter_level->parent_level;
686 gint parent_elt_index = filter_level->parent_elt_index;
690 g_array_index (parent_level->array, FilterElt, parent_elt_index).zero_ref_count--;
692 parent_elt_index = parent_level->parent_elt_index;
693 parent_level = parent_level->parent_level;
696 if (filter_level != filter->priv->root)
697 filter->priv->zero_ref_count--;
700 if (filter_level->parent_elt_index >= 0)
701 FILTER_LEVEL_PARENT_ELT (filter_level)->children = NULL;
703 filter->priv->root = NULL;
705 g_array_free (filter_level->array, TRUE);
706 filter_level->array = NULL;
708 g_free (filter_level);
712 /* Creates paths suitable for accessing the child model. */
714 gtk_tree_model_filter_elt_get_path (FilterLevel *level,
718 FilterLevel *walker = level;
719 FilterElt *walker2 = elt;
721 GtkTreePath *real_path;
723 g_return_val_if_fail (level != NULL, NULL);
724 g_return_val_if_fail (elt != NULL, NULL);
726 path = gtk_tree_path_new ();
730 gtk_tree_path_prepend_index (path, walker2->offset);
732 if (!walker->parent_level)
735 walker2 = FILTER_LEVEL_PARENT_ELT (walker);
736 walker = walker->parent_level;
741 real_path = gtk_tree_model_filter_add_root (path, root);
742 gtk_tree_path_free (path);
750 gtk_tree_model_filter_add_root (GtkTreePath *src,
756 retval = gtk_tree_path_copy (root);
758 for (i = 0; i < gtk_tree_path_get_depth (src); i++)
759 gtk_tree_path_append_index (retval, gtk_tree_path_get_indices (src)[i]);
765 gtk_tree_model_filter_remove_root (GtkTreePath *src,
773 if (gtk_tree_path_get_depth (src) <= gtk_tree_path_get_depth (root))
776 depth = gtk_tree_path_get_depth (src);
777 indices = gtk_tree_path_get_indices (src);
779 for (i = 0; i < gtk_tree_path_get_depth (root); i++)
780 if (indices[i] != gtk_tree_path_get_indices (root)[i])
783 retval = gtk_tree_path_new ();
785 for (; i < depth; i++)
786 gtk_tree_path_append_index (retval, indices[i]);
792 gtk_tree_model_filter_increment_stamp (GtkTreeModelFilter *filter)
796 filter->priv->stamp++;
798 while (filter->priv->stamp == 0);
800 gtk_tree_model_filter_clear_cache (filter);
804 gtk_tree_model_filter_real_visible (GtkTreeModelFilter *filter,
805 GtkTreeModel *child_model,
806 GtkTreeIter *child_iter)
808 if (filter->priv->visible_func)
810 return filter->priv->visible_func (child_model,
812 filter->priv->visible_data)
815 else if (filter->priv->visible_column >= 0)
819 gtk_tree_model_get_value (child_model, child_iter,
820 filter->priv->visible_column, &val);
822 if (g_value_get_boolean (&val))
824 g_value_unset (&val);
828 g_value_unset (&val);
832 /* no visible function set, so always visible */
837 gtk_tree_model_filter_visible (GtkTreeModelFilter *self,
838 GtkTreeIter *child_iter)
840 return GTK_TREE_MODEL_FILTER_GET_CLASS (self)->visible (self,
841 self->priv->child_model, child_iter);
845 gtk_tree_model_filter_clear_cache_helper (GtkTreeModelFilter *filter,
852 for (i = 0; i < level->array->len; i++)
854 if (g_array_index (level->array, FilterElt, i).zero_ref_count > 0)
855 gtk_tree_model_filter_clear_cache_helper (filter, g_array_index (level->array, FilterElt, i).children);
858 if (level->ref_count == 0 && level != filter->priv->root)
860 gtk_tree_model_filter_free_level (filter, level);
866 gtk_tree_model_filter_get_nth (GtkTreeModelFilter *filter,
870 if (level->array->len <= n)
873 return &g_array_index (level->array, FilterElt, n);
877 gtk_tree_model_filter_elt_is_visible_in_target (FilterLevel *level,
885 if (level->parent_elt_index == -1)
890 elt_index = level->parent_elt_index;
891 level = level->parent_level;
894 && !g_array_index (level->array, FilterElt, elt_index).visible)
903 gtk_tree_model_filter_get_nth_visible (GtkTreeModelFilter *filter,
910 if (level->visible_nodes <= n)
913 elt = FILTER_ELT (level->array->data);
914 while (!elt->visible)
924 while (!elt->visible)
931 gtk_tree_model_filter_fetch_child (GtkTreeModelFilter *filter,
937 gint start, middle, end;
939 GtkTreePath *c_path = NULL;
941 GtkTreePath *c_parent_path = NULL;
942 GtkTreeIter c_parent_iter;
945 /* check if child exists and is visible */
946 if (level->parent_elt_index >= 0)
949 gtk_tree_model_filter_elt_get_path (level->parent_level,
950 FILTER_LEVEL_PARENT_ELT (level),
951 filter->priv->virtual_root);
957 if (filter->priv->virtual_root)
958 c_parent_path = gtk_tree_path_copy (filter->priv->virtual_root);
960 c_parent_path = NULL;
965 gtk_tree_model_get_iter (filter->priv->child_model,
968 len = gtk_tree_model_iter_n_children (filter->priv->child_model,
971 c_path = gtk_tree_path_copy (c_parent_path);
972 gtk_tree_path_free (c_parent_path);
976 len = gtk_tree_model_iter_n_children (filter->priv->child_model, NULL);
977 c_path = gtk_tree_path_new ();
980 gtk_tree_path_append_index (c_path, offset);
981 gtk_tree_model_get_iter (filter->priv->child_model, &c_iter, c_path);
982 gtk_tree_path_free (c_path);
984 if (offset >= len || !gtk_tree_model_filter_visible (filter, &c_iter))
989 elt.zero_ref_count = 0;
992 /* visibility should be FALSE as we don't emit row_inserted */
995 if (GTK_TREE_MODEL_FILTER_CACHE_CHILD_ITERS (filter))
998 /* find index (binary search on offset) */
1000 end = level->array->len;
1004 while (start != end)
1006 middle = (start + end) / 2;
1008 if (g_array_index (level->array, FilterElt, middle).offset <= offset)
1014 if (g_array_index (level->array, FilterElt, middle).offset <= offset)
1022 g_array_insert_val (level->array, i, elt);
1025 for (i = 0; i < level->array->len; i++)
1027 FilterElt *e = &(g_array_index (level->array, FilterElt, i));
1029 e->children->parent_elt_index = i;
1032 c_iter.stamp = filter->priv->stamp;
1033 c_iter.user_data = level;
1034 c_iter.user_data2 = &g_array_index (level->array, FilterElt, *index);
1036 if (level->parent_level || filter->priv->virtual_root)
1037 gtk_tree_model_filter_ref_node (GTK_TREE_MODEL (filter), &c_iter);
1039 return &g_array_index (level->array, FilterElt, *index);
1043 gtk_tree_model_filter_remove_node (GtkTreeModelFilter *filter,
1046 FilterElt *elt, *parent;
1047 FilterLevel *level, *parent_level;
1048 gint i, length, parent_elt_index;
1050 gboolean emit_child_toggled = FALSE;
1052 level = FILTER_LEVEL (iter->user_data);
1053 elt = FILTER_ELT (iter->user_data2);
1055 parent_elt_index = level->parent_elt_index;
1056 if (parent_elt_index >= 0)
1057 parent = FILTER_LEVEL_PARENT_ELT (level);
1060 parent_level = level->parent_level;
1062 length = level->array->len;
1064 /* we distinguish a couple of cases:
1065 * - root level, length > 1: emit row-deleted and remove.
1066 * - root level, length == 1: emit row-deleted and keep in cache.
1067 * - level, length == 1: parent->ref_count > 1: emit row-deleted and keep.
1068 * - level, length > 1: emit row-deleted and remove.
1069 * - else, remove level.
1071 * if level != root level and visible nodes == 0, emit row-has-child-toggled.
1074 if (level != filter->priv->root
1075 && level->visible_nodes == 0
1078 emit_child_toggled = TRUE;
1085 /* We emit row-deleted, and remove the node from the cache.
1086 * If it has any children, these will be removed here as well.
1090 gtk_tree_model_filter_free_level (filter, elt->children);
1092 path = gtk_tree_model_get_path (GTK_TREE_MODEL (filter), iter);
1093 elt->visible = FALSE;
1094 gtk_tree_model_filter_increment_stamp (filter);
1095 iter->stamp = filter->priv->stamp;
1096 gtk_tree_model_row_deleted (GTK_TREE_MODEL (filter), path);
1097 gtk_tree_path_free (path);
1099 while (elt->ref_count > 1)
1100 gtk_tree_model_filter_real_unref_node (GTK_TREE_MODEL (filter),
1103 if (parent_level || filter->priv->virtual_root)
1104 gtk_tree_model_filter_unref_node (GTK_TREE_MODEL (filter), iter);
1105 else if (elt->ref_count > 0)
1106 gtk_tree_model_filter_real_unref_node (GTK_TREE_MODEL (filter),
1109 /* remove the node */
1110 tmp = bsearch_elt_with_offset (level->array, elt->offset, &i);
1114 g_array_remove_index (level->array, i);
1117 for (i = MAX (i, 0); i < level->array->len; i++)
1119 /* NOTE: here we do *not* decrease offsets, because the node was
1120 * not removed from the child model
1122 elt = &g_array_index (level->array, FilterElt, i);
1124 elt->children->parent_elt_index = i;
1128 else if ((length == 1 && parent && parent->ref_count > 1)
1129 || (length == 1 && level == filter->priv->root))
1133 /* We emit row-deleted, but keep the node in the cache and
1134 * referenced. Its children will be removed.
1139 gtk_tree_model_filter_free_level (filter, elt->children);
1140 elt->children = NULL;
1143 path = gtk_tree_model_get_path (GTK_TREE_MODEL (filter), iter);
1144 elt->visible = FALSE;
1145 gtk_tree_model_filter_increment_stamp (filter);
1146 gtk_tree_model_row_deleted (GTK_TREE_MODEL (filter), path);
1147 gtk_tree_path_free (path);
1153 /* Blow level away, including any child levels */
1155 path = gtk_tree_model_get_path (GTK_TREE_MODEL (filter), iter);
1156 elt->visible = FALSE;
1157 gtk_tree_model_filter_increment_stamp (filter);
1158 iter->stamp = filter->priv->stamp;
1159 gtk_tree_model_row_deleted (GTK_TREE_MODEL (filter), path);
1160 gtk_tree_path_free (path);
1162 while (elt->ref_count > 1)
1163 gtk_tree_model_filter_real_unref_node (GTK_TREE_MODEL (filter),
1166 gtk_tree_model_filter_free_level (filter, level);
1169 if (emit_child_toggled)
1174 piter.stamp = filter->priv->stamp;
1175 piter.user_data = parent_level;
1176 piter.user_data2 = parent;
1178 ppath = gtk_tree_model_get_path (GTK_TREE_MODEL (filter), &piter);
1180 gtk_tree_model_row_has_child_toggled (GTK_TREE_MODEL (filter),
1182 gtk_tree_path_free (ppath);
1187 gtk_tree_model_filter_update_children (GtkTreeModelFilter *filter,
1197 iter.stamp = filter->priv->stamp;
1198 iter.user_data = level;
1199 iter.user_data2 = elt;
1201 gtk_tree_model_filter_convert_iter_to_child_iter (filter, &c_iter, &iter);
1203 if (gtk_tree_model_iter_has_child (filter->priv->child_model, &c_iter))
1205 GtkTreePath *path = gtk_tree_model_get_path (GTK_TREE_MODEL (filter),
1207 gtk_tree_model_row_has_child_toggled (GTK_TREE_MODEL (filter),
1211 gtk_tree_path_free (path);
1216 bsearch_elt_with_offset (GArray *array,
1220 gint start, middle, end;
1231 elt = &g_array_index (array, FilterElt, 0);
1233 if (elt->offset == offset)
1244 middle = (start + end) / 2;
1246 elt = &g_array_index (array, FilterElt, middle);
1248 if (elt->offset < offset)
1250 else if (elt->offset > offset)
1255 while (start != end);
1257 if (elt->offset == offset)
1266 /* TreeModel signals */
1268 gtk_tree_model_filter_row_changed (GtkTreeModel *c_model,
1269 GtkTreePath *c_path,
1270 GtkTreeIter *c_iter,
1273 GtkTreeModelFilter *filter = GTK_TREE_MODEL_FILTER (data);
1275 GtkTreeIter children;
1276 GtkTreeIter real_c_iter;
1277 GtkTreePath *path = NULL;
1282 gboolean requested_state;
1283 gboolean current_state;
1284 gboolean free_c_path = FALSE;
1285 gboolean signals_emitted = FALSE;
1287 g_return_if_fail (c_path != NULL || c_iter != NULL);
1291 c_path = gtk_tree_model_get_path (c_model, c_iter);
1296 real_c_iter = *c_iter;
1298 gtk_tree_model_get_iter (c_model, &real_c_iter, c_path);
1300 /* is this node above the virtual root? */
1301 if (filter->priv->virtual_root &&
1302 (gtk_tree_path_get_depth (filter->priv->virtual_root)
1303 >= gtk_tree_path_get_depth (c_path)))
1306 /* what's the requested state? */
1307 requested_state = gtk_tree_model_filter_visible (filter, &real_c_iter);
1309 /* now, let's see whether the item is there */
1310 path = gtk_real_tree_model_filter_convert_child_path_to_path (filter,
1317 gtk_tree_model_filter_get_iter_full (GTK_TREE_MODEL (filter),
1319 current_state = FILTER_ELT (iter.user_data2)->visible;
1322 current_state = FALSE;
1324 if (current_state == FALSE && requested_state == FALSE)
1325 /* no changes required */
1328 if (current_state == TRUE && requested_state == FALSE)
1330 /* get rid of this node */
1331 level = FILTER_LEVEL (iter.user_data);
1332 level->visible_nodes--;
1334 gtk_tree_model_filter_remove_node (filter, &iter);
1339 if (current_state == TRUE && requested_state == TRUE)
1341 /* propagate the signal; also get a path taking only visible
1342 * nodes into account.
1344 gtk_tree_path_free (path);
1345 path = gtk_tree_model_get_path (GTK_TREE_MODEL (filter), &iter);
1347 level = FILTER_LEVEL (iter.user_data);
1348 elt = FILTER_ELT (iter.user_data2);
1350 if (gtk_tree_model_filter_elt_is_visible_in_target (level, elt))
1352 gtk_tree_model_row_changed (GTK_TREE_MODEL (filter), path, &iter);
1354 /* and update the children */
1355 if (gtk_tree_model_iter_children (c_model, &children, &real_c_iter))
1356 gtk_tree_model_filter_update_children (filter, level, elt);
1362 /* only current == FALSE and requested == TRUE is left,
1365 g_return_if_fail (current_state == FALSE && requested_state == TRUE);
1367 /* make sure the new item has been pulled in */
1368 if (!filter->priv->root)
1370 gtk_tree_model_filter_build_level (filter, NULL, -1, TRUE);
1372 /* We will only proceed below if the item is found. If the item
1373 * is found, we can be sure row-inserted has just been emitted
1376 signals_emitted = TRUE;
1379 gtk_tree_model_filter_increment_stamp (filter);
1381 /* We need to allow to build new levels, because we are then pulling
1382 * in a child in an invisible level. We only want to find path if it
1383 * is in a visible level (and thus has a parent that is visible).
1386 path = gtk_real_tree_model_filter_convert_child_path_to_path (filter,
1392 /* parent is probably being filtered out */
1395 gtk_tree_model_filter_get_iter_full (GTK_TREE_MODEL (filter), &iter, path);
1397 level = FILTER_LEVEL (iter.user_data);
1398 elt = FILTER_ELT (iter.user_data2);
1400 /* elt->visible can be TRUE at this point if it was pulled in above */
1403 elt->visible = TRUE;
1404 level->visible_nodes++;
1407 if (gtk_tree_model_filter_elt_is_visible_in_target (level, elt))
1409 /* visibility changed -- reget path */
1410 gtk_tree_path_free (path);
1411 path = gtk_tree_model_get_path (GTK_TREE_MODEL (filter), &iter);
1413 if (!signals_emitted)
1414 gtk_tree_model_row_inserted (GTK_TREE_MODEL (filter), path, &iter);
1416 if (level->parent_level && level->visible_nodes == 1)
1418 /* We know that this is the first visible node in this level, so
1419 * we need to emit row-has-child-toggled on the parent. This
1420 * does not apply to the root level.
1423 gtk_tree_path_up (path);
1424 gtk_tree_model_get_iter (GTK_TREE_MODEL (filter), &iter, path);
1426 gtk_tree_model_row_has_child_toggled (GTK_TREE_MODEL (filter),
1431 if (!signals_emitted
1432 && gtk_tree_model_iter_children (c_model, &children, c_iter))
1433 gtk_tree_model_filter_update_children (filter, level, elt);
1438 gtk_tree_path_free (path);
1441 gtk_tree_path_free (c_path);
1445 gtk_tree_model_filter_row_inserted (GtkTreeModel *c_model,
1446 GtkTreePath *c_path,
1447 GtkTreeIter *c_iter,
1450 GtkTreeModelFilter *filter = GTK_TREE_MODEL_FILTER (data);
1451 GtkTreePath *path = NULL;
1452 GtkTreePath *real_path = NULL;
1455 GtkTreeIter real_c_iter;
1459 FilterLevel *parent_level;
1463 gboolean free_c_path = FALSE;
1465 g_return_if_fail (c_path != NULL || c_iter != NULL);
1469 c_path = gtk_tree_model_get_path (c_model, c_iter);
1474 real_c_iter = *c_iter;
1476 gtk_tree_model_get_iter (c_model, &real_c_iter, c_path);
1478 /* the row has already been inserted. so we need to fixup the
1479 * virtual root here first
1481 if (filter->priv->virtual_root)
1483 if (gtk_tree_path_get_depth (filter->priv->virtual_root) >=
1484 gtk_tree_path_get_depth (c_path))
1487 gint *v_indices, *c_indices;
1488 gboolean common_prefix = TRUE;
1490 level = gtk_tree_path_get_depth (c_path) - 1;
1491 v_indices = gtk_tree_path_get_indices (filter->priv->virtual_root);
1492 c_indices = gtk_tree_path_get_indices (c_path);
1494 for (i = 0; i < level; i++)
1495 if (v_indices[i] != c_indices[i])
1497 common_prefix = FALSE;
1501 if (common_prefix && v_indices[level] >= c_indices[level])
1502 (v_indices[level])++;
1506 if (!filter->priv->root)
1508 /* No point in building the level if this node is not visible. */
1509 if (!filter->priv->virtual_root
1510 && !gtk_tree_model_filter_visible (filter, c_iter))
1513 /* build level will pull in the new child */
1514 gtk_tree_model_filter_build_level (filter, NULL, -1, FALSE);
1516 if (filter->priv->root
1517 && FILTER_LEVEL (filter->priv->root)->visible_nodes)
1523 parent_level = level = FILTER_LEVEL (filter->priv->root);
1525 /* subtract virtual root if necessary */
1526 if (filter->priv->virtual_root)
1528 real_path = gtk_tree_model_filter_remove_root (c_path,
1529 filter->priv->virtual_root);
1535 real_path = gtk_tree_path_copy (c_path);
1537 if (gtk_tree_path_get_depth (real_path) - 1 >= 1)
1539 /* find the parent level */
1540 while (i < gtk_tree_path_get_depth (real_path) - 1)
1545 /* we don't cover this signal */
1548 elt = bsearch_elt_with_offset (level->array,
1549 gtk_tree_path_get_indices (real_path)[i],
1553 /* parent is probably being filtered out */
1558 GtkTreePath *tmppath;
1559 GtkTreeIter tmpiter;
1561 tmpiter.stamp = filter->priv->stamp;
1562 tmpiter.user_data = level;
1563 tmpiter.user_data2 = elt;
1565 tmppath = gtk_tree_model_get_path (GTK_TREE_MODEL (data),
1570 gtk_tree_model_row_has_child_toggled (GTK_TREE_MODEL (data),
1572 gtk_tree_path_free (tmppath);
1575 /* not covering this signal */
1579 level = elt->children;
1580 parent_level = level;
1588 /* let's try to insert the value */
1589 offset = gtk_tree_path_get_indices (real_path)[gtk_tree_path_get_depth (real_path) - 1];
1591 /* update the offsets, yes if we didn't insert the node above, there will
1592 * be a gap here. This will be filled with the node (via fetch_child) when
1593 * it becomes visible
1595 for (i = 0; i < level->array->len; i++)
1597 FilterElt *e = &g_array_index (level->array, FilterElt, i);
1598 if ((e->offset >= offset))
1602 /* only insert when visible */
1603 if (gtk_tree_model_filter_visible (filter, &real_c_iter))
1607 if (GTK_TREE_MODEL_FILTER_CACHE_CHILD_ITERS (filter))
1608 felt.iter = real_c_iter;
1610 felt.offset = offset;
1611 felt.zero_ref_count = 0;
1613 felt.visible = TRUE;
1614 felt.children = NULL;
1616 for (i = 0; i < level->array->len; i++)
1617 if (g_array_index (level->array, FilterElt, i).offset > offset)
1620 level->visible_nodes++;
1622 g_array_insert_val (level->array, i, felt);
1624 if (level->parent_level || filter->priv->virtual_root)
1628 f_iter.stamp = filter->priv->stamp;
1629 f_iter.user_data = level;
1630 f_iter.user_data2 = &g_array_index (level->array, FilterElt, i);
1632 gtk_tree_model_filter_ref_node (GTK_TREE_MODEL (filter), &f_iter);
1636 /* another iteration to update the references of children to parents. */
1637 for (i = 0; i < level->array->len; i++)
1639 FilterElt *e = &g_array_index (level->array, FilterElt, i);
1641 e->children->parent_elt_index = i;
1644 /* don't emit the signal if we aren't visible */
1645 if (!gtk_tree_model_filter_visible (filter, &real_c_iter))
1649 /* NOTE: pass c_path here and NOT real_path. This function does
1650 * root subtraction itself
1652 path = gtk_real_tree_model_filter_convert_child_path_to_path (filter,
1659 gtk_tree_model_filter_increment_stamp (filter);
1661 gtk_tree_model_filter_get_iter_full (GTK_TREE_MODEL (data), &iter, path);
1663 /* get a path taking only visible nodes into account */
1664 gtk_tree_path_free (path);
1665 path = gtk_tree_model_get_path (GTK_TREE_MODEL (data), &iter);
1667 gtk_tree_model_row_inserted (GTK_TREE_MODEL (data), path, &iter);
1669 gtk_tree_path_free (path);
1673 gtk_tree_path_free (real_path);
1676 gtk_tree_path_free (c_path);
1680 gtk_tree_model_filter_row_has_child_toggled (GtkTreeModel *c_model,
1681 GtkTreePath *c_path,
1682 GtkTreeIter *c_iter,
1685 GtkTreeModelFilter *filter = GTK_TREE_MODEL_FILTER (data);
1690 gboolean requested_state;
1692 g_return_if_fail (c_path != NULL && c_iter != NULL);
1694 /* If we get row-has-child-toggled on the virtual root, and there is
1695 * no root level; try to build it now.
1697 if (filter->priv->virtual_root && !filter->priv->root
1698 && !gtk_tree_path_compare (c_path, filter->priv->virtual_root))
1700 gtk_tree_model_filter_build_level (filter, NULL, -1, TRUE);
1704 /* For all other levels, there is a chance that the visibility state
1705 * of the parent has changed now.
1708 path = gtk_real_tree_model_filter_convert_child_path_to_path (filter,
1715 gtk_tree_model_filter_get_iter_full (GTK_TREE_MODEL (data), &iter, path);
1717 level = FILTER_LEVEL (iter.user_data);
1718 elt = FILTER_ELT (iter.user_data2);
1720 gtk_tree_path_free (path);
1722 requested_state = gtk_tree_model_filter_visible (filter, c_iter);
1724 if (!elt->visible && !requested_state)
1726 /* The parent node currently is not visible and will not become
1727 * visible, so we will not pass on the row-has-child-toggled event.
1731 else if (elt->visible && !requested_state)
1733 /* The node is no longer visible, so it has to be removed.
1734 * _remove_node() takes care of emitting row-has-child-toggled
1737 level->visible_nodes--;
1739 gtk_tree_model_filter_remove_node (filter, &iter);
1743 else if (!elt->visible && requested_state)
1745 elt->visible = TRUE;
1746 level->visible_nodes++;
1748 /* Only insert if the parent is visible in the target */
1749 if (gtk_tree_model_filter_elt_is_visible_in_target (level, elt))
1751 path = gtk_tree_model_get_path (GTK_TREE_MODEL (filter), &iter);
1752 gtk_tree_model_row_inserted (GTK_TREE_MODEL (filter), path, &iter);
1753 gtk_tree_path_free (path);
1755 /* We do not update children now, because that will happen
1760 /* For the remaining possibility, elt->visible && requested_state
1761 * no action is required.
1764 /* If this node is referenced and has children, build the level so we
1765 * can monitor it for changes.
1767 if (elt->ref_count > 1 && gtk_tree_model_iter_has_child (c_model, c_iter))
1768 gtk_tree_model_filter_build_level (filter, level,
1769 FILTER_LEVEL_ELT_INDEX (level, elt),
1772 /* get a path taking only visible nodes into account */
1773 path = gtk_tree_model_get_path (GTK_TREE_MODEL (data), &iter);
1774 gtk_tree_model_row_has_child_toggled (GTK_TREE_MODEL (data), path, &iter);
1775 gtk_tree_path_free (path);
1779 gtk_tree_model_filter_row_deleted (GtkTreeModel *c_model,
1780 GtkTreePath *c_path,
1783 GtkTreeModelFilter *filter = GTK_TREE_MODEL_FILTER (data);
1787 FilterLevel *level, *parent_level = NULL;
1788 gboolean emit_child_toggled = FALSE;
1789 gboolean emit_row_deleted = FALSE;
1792 gint parent_elt_index = -1;
1794 g_return_if_fail (c_path != NULL);
1796 /* special case the deletion of an ancestor of the virtual root */
1797 if (filter->priv->virtual_root &&
1798 (gtk_tree_path_is_ancestor (c_path, filter->priv->virtual_root) ||
1799 !gtk_tree_path_compare (c_path, filter->priv->virtual_root)))
1803 FilterLevel *level2 = FILTER_LEVEL (filter->priv->root);
1805 gtk_tree_model_filter_unref_path (filter, filter->priv->virtual_root);
1806 filter->priv->virtual_root_deleted = TRUE;
1811 /* remove everything in the filter model
1813 * For now, we just iterate over the root level and emit a
1814 * row_deleted for each FilterElt. Not sure if this is correct.
1817 gtk_tree_model_filter_increment_stamp (filter);
1818 path2 = gtk_tree_path_new ();
1819 gtk_tree_path_append_index (path2, 0);
1821 for (i = 0; i < level2->visible_nodes; i++)
1822 gtk_tree_model_row_deleted (GTK_TREE_MODEL (data), path2);
1824 gtk_tree_path_free (path2);
1825 gtk_tree_model_filter_free_level (filter, filter->priv->root);
1830 /* fixup virtual root */
1831 if (filter->priv->virtual_root)
1833 if (gtk_tree_path_get_depth (filter->priv->virtual_root) >=
1834 gtk_tree_path_get_depth (c_path))
1837 gint *v_indices, *c_indices;
1838 gboolean common_prefix = TRUE;
1840 level2 = gtk_tree_path_get_depth (c_path) - 1;
1841 v_indices = gtk_tree_path_get_indices (filter->priv->virtual_root);
1842 c_indices = gtk_tree_path_get_indices (c_path);
1844 for (i = 0; i < level2; i++)
1845 if (v_indices[i] != c_indices[i])
1847 common_prefix = FALSE;
1851 if (common_prefix && v_indices[level2] > c_indices[level2])
1852 (v_indices[level2])--;
1856 path = gtk_real_tree_model_filter_convert_child_path_to_path (filter,
1863 /* The node deleted in the child model is not visible in the
1864 * filter model. We will not emit a signal, just fixup the offsets
1865 * of the other nodes.
1867 GtkTreePath *real_path;
1869 if (!filter->priv->root)
1872 level = FILTER_LEVEL (filter->priv->root);
1874 /* subtract vroot if necessary */
1875 if (filter->priv->virtual_root)
1877 real_path = gtk_tree_model_filter_remove_root (c_path,
1878 filter->priv->virtual_root);
1879 /* we don't handle this */
1884 real_path = gtk_tree_path_copy (c_path);
1887 if (gtk_tree_path_get_depth (real_path) - 1 >= 1)
1889 /* find the level where the deletion occurred */
1890 while (i < gtk_tree_path_get_depth (real_path) - 1)
1896 /* we don't cover this */
1897 gtk_tree_path_free (real_path);
1901 elt = bsearch_elt_with_offset (level->array,
1902 gtk_tree_path_get_indices (real_path)[i],
1905 if (!elt || !elt->children)
1907 /* parent is filtered out, so no level */
1908 gtk_tree_path_free (real_path);
1912 level = elt->children;
1917 offset = gtk_tree_path_get_indices (real_path)[gtk_tree_path_get_depth (real_path) - 1];
1918 gtk_tree_path_free (real_path);
1923 /* decrease offset of all nodes following the deleted node */
1924 for (i = 0; i < level->array->len; i++)
1926 elt = &g_array_index (level->array, FilterElt, i);
1927 if (elt->offset > offset)
1930 elt->children->parent_elt_index = i;
1936 /* a node was deleted, which was in our cache */
1937 gtk_tree_model_filter_get_iter_full (GTK_TREE_MODEL (data), &iter, path);
1939 level = FILTER_LEVEL (iter.user_data);
1940 elt = FILTER_ELT (iter.user_data2);
1941 offset = elt->offset;
1945 /* get a path taking only visible nodes into account */
1946 gtk_tree_path_free (path);
1947 path = gtk_tree_model_get_path (GTK_TREE_MODEL (filter), &iter);
1949 level->visible_nodes--;
1951 if (level->visible_nodes == 0)
1953 emit_child_toggled = TRUE;
1954 parent_level = level->parent_level;
1955 parent_elt_index = level->parent_elt_index;
1958 emit_row_deleted = TRUE;
1961 /* The filter model's reference on the child node is released
1964 while (elt->ref_count > 1)
1965 gtk_tree_model_filter_real_unref_node (GTK_TREE_MODEL (data), &iter, FALSE);
1967 if (level->array->len == 1)
1970 gtk_tree_model_filter_free_level (filter, level);
1976 /* release the filter model's reference on the node */
1977 if (level->parent_level || filter->priv->virtual_root)
1978 gtk_tree_model_filter_unref_node (GTK_TREE_MODEL (filter), &iter);
1979 else if (elt->ref_count > 0)
1980 gtk_tree_model_filter_real_unref_node (GTK_TREE_MODEL (data), &iter,
1983 /* remove the row */
1984 tmp = bsearch_elt_with_offset (level->array, elt->offset, &i);
1986 offset = tmp->offset;
1987 g_array_remove_index (level->array, i);
1990 for (i = MAX (i, 0); i < level->array->len; i++)
1992 elt = &g_array_index (level->array, FilterElt, i);
1993 if (elt->offset > offset)
1996 elt->children->parent_elt_index = i;
2000 if (emit_row_deleted)
2002 /* emit row_deleted */
2003 gtk_tree_model_filter_increment_stamp (filter);
2004 gtk_tree_model_row_deleted (GTK_TREE_MODEL (data), path);
2005 iter.stamp = filter->priv->stamp;
2008 if (emit_child_toggled && parent_level)
2013 iter2.stamp = filter->priv->stamp;
2014 iter2.user_data = parent_level;
2015 iter2.user_data2 = &g_array_index (parent_level->array, FilterElt, parent_elt_index);
2017 /* We set in_row_deleted to TRUE to avoid a level build triggered
2018 * by row-has-child-toggled (parent model could call iter_has_child
2021 filter->priv->in_row_deleted = TRUE;
2022 path2 = gtk_tree_model_get_path (GTK_TREE_MODEL (filter), &iter2);
2023 gtk_tree_model_row_has_child_toggled (GTK_TREE_MODEL (filter),
2025 gtk_tree_path_free (path2);
2026 filter->priv->in_row_deleted = FALSE;
2029 gtk_tree_path_free (path);
2033 gtk_tree_model_filter_rows_reordered (GtkTreeModel *c_model,
2034 GtkTreePath *c_path,
2035 GtkTreeIter *c_iter,
2041 GtkTreeModelFilter *filter = GTK_TREE_MODEL_FILTER (data);
2047 gint i, j, elt_count;
2052 g_return_if_fail (new_order != NULL);
2054 if (c_path == NULL || gtk_tree_path_get_depth (c_path) == 0)
2056 length = gtk_tree_model_iter_n_children (c_model, NULL);
2058 if (filter->priv->virtual_root)
2062 /* reorder root level of path */
2063 for (i = 0; i < length; i++)
2064 if (new_order[i] == gtk_tree_path_get_indices (filter->priv->virtual_root)[0])
2070 gtk_tree_path_get_indices (filter->priv->virtual_root)[0] = new_pos;
2074 path = gtk_tree_path_new ();
2075 level = FILTER_LEVEL (filter->priv->root);
2079 GtkTreeIter child_iter;
2081 /* virtual root anchor reordering */
2082 if (filter->priv->virtual_root &&
2083 gtk_tree_path_is_ancestor (c_path, filter->priv->virtual_root))
2088 GtkTreeIter real_c_iter;
2090 level = gtk_tree_path_get_depth (c_path);
2093 real_c_iter = *c_iter;
2095 gtk_tree_model_get_iter (c_model, &real_c_iter, c_path);
2097 length = gtk_tree_model_iter_n_children (c_model, &real_c_iter);
2099 for (i = 0; i < length; i++)
2100 if (new_order[i] == gtk_tree_path_get_indices (filter->priv->virtual_root)[level])
2106 gtk_tree_path_get_indices (filter->priv->virtual_root)[level] = new_pos;
2110 path = gtk_real_tree_model_filter_convert_child_path_to_path (filter,
2115 if (!path && filter->priv->virtual_root &&
2116 gtk_tree_path_compare (c_path, filter->priv->virtual_root))
2119 if (!path && !filter->priv->virtual_root)
2124 /* root level mode */
2126 gtk_tree_model_get_iter (c_model, c_iter, c_path);
2127 length = gtk_tree_model_iter_n_children (c_model, c_iter);
2128 path = gtk_tree_path_new ();
2129 level = FILTER_LEVEL (filter->priv->root);
2133 gtk_tree_model_filter_get_iter_full (GTK_TREE_MODEL (data),
2136 level = FILTER_LEVEL (iter.user_data);
2137 elt = FILTER_ELT (iter.user_data2);
2141 gtk_tree_path_free (path);
2145 level = elt->children;
2147 gtk_tree_model_filter_convert_iter_to_child_iter (GTK_TREE_MODEL_FILTER (filter), &child_iter, &iter);
2148 length = gtk_tree_model_iter_n_children (c_model, &child_iter);
2152 if (!level || level->array->len < 1)
2154 gtk_tree_path_free (path);
2158 /* NOTE: we do not bail out here if level->array->len < 2 like
2159 * GtkTreeModelSort does. This because we do some special tricky
2163 /* construct a new array */
2164 new_array = g_array_sized_new (FALSE, FALSE, sizeof (FilterElt),
2166 tmp_array = g_new (gint, level->array->len);
2168 for (i = 0, elt_count = 0; i < length; i++)
2170 FilterElt *e = NULL;
2171 gint old_offset = -1;
2173 for (j = 0; j < level->array->len; j++)
2174 if (g_array_index (level->array, FilterElt, j).offset == new_order[i])
2176 e = &g_array_index (level->array, FilterElt, j);
2184 tmp_array[elt_count] = old_offset;
2185 g_array_append_val (new_array, *e);
2186 g_array_index (new_array, FilterElt, elt_count).offset = i;
2190 g_array_free (level->array, TRUE);
2191 level->array = new_array;
2194 for (i = 0; i < level->array->len; i++)
2196 FilterElt *e = &g_array_index (level->array, FilterElt, i);
2198 e->children->parent_elt_index = i;
2201 /* emit rows_reordered */
2202 if (!gtk_tree_path_get_indices (path))
2203 gtk_tree_model_rows_reordered (GTK_TREE_MODEL (data), path, NULL,
2207 /* get a path taking only visible nodes into account */
2208 gtk_tree_path_free (path);
2209 path = gtk_tree_model_get_path (GTK_TREE_MODEL (data), &iter);
2211 gtk_tree_model_rows_reordered (GTK_TREE_MODEL (data), path, &iter,
2217 gtk_tree_path_free (path);
2220 /* TreeModelIface implementation */
2221 static GtkTreeModelFlags
2222 gtk_tree_model_filter_get_flags (GtkTreeModel *model)
2224 GtkTreeModelFlags flags;
2226 g_return_val_if_fail (GTK_IS_TREE_MODEL_FILTER (model), 0);
2227 g_return_val_if_fail (GTK_TREE_MODEL_FILTER (model)->priv->child_model != NULL, 0);
2229 flags = gtk_tree_model_get_flags (GTK_TREE_MODEL_FILTER (model)->priv->child_model);
2231 if ((flags & GTK_TREE_MODEL_LIST_ONLY) == GTK_TREE_MODEL_LIST_ONLY)
2232 return GTK_TREE_MODEL_LIST_ONLY;
2238 gtk_tree_model_filter_get_n_columns (GtkTreeModel *model)
2240 GtkTreeModelFilter *filter = (GtkTreeModelFilter *)model;
2242 g_return_val_if_fail (GTK_IS_TREE_MODEL_FILTER (model), 0);
2243 g_return_val_if_fail (filter->priv->child_model != NULL, 0);
2245 if (filter->priv->child_model == NULL)
2248 /* so we can't modify the modify func after this ... */
2249 filter->priv->modify_func_set = TRUE;
2251 if (filter->priv->modify_n_columns > 0)
2252 return filter->priv->modify_n_columns;
2254 return gtk_tree_model_get_n_columns (filter->priv->child_model);
2258 gtk_tree_model_filter_get_column_type (GtkTreeModel *model,
2261 GtkTreeModelFilter *filter = (GtkTreeModelFilter *)model;
2263 g_return_val_if_fail (GTK_IS_TREE_MODEL_FILTER (model), G_TYPE_INVALID);
2264 g_return_val_if_fail (filter->priv->child_model != NULL, G_TYPE_INVALID);
2266 /* so we can't modify the modify func after this ... */
2267 filter->priv->modify_func_set = TRUE;
2269 if (filter->priv->modify_types)
2271 g_return_val_if_fail (index < filter->priv->modify_n_columns, G_TYPE_INVALID);
2273 return filter->priv->modify_types[index];
2276 return gtk_tree_model_get_column_type (filter->priv->child_model, index);
2279 /* A special case of _get_iter; this function can also get iters which
2280 * are not visible. These iters should ONLY be passed internally, never
2281 * pass those along with a signal emission.
2284 gtk_tree_model_filter_get_iter_full (GtkTreeModel *model,
2288 GtkTreeModelFilter *filter = (GtkTreeModelFilter *)model;
2293 g_return_val_if_fail (GTK_IS_TREE_MODEL_FILTER (model), FALSE);
2294 g_return_val_if_fail (filter->priv->child_model != NULL, FALSE);
2296 indices = gtk_tree_path_get_indices (path);
2298 if (filter->priv->root == NULL)
2299 gtk_tree_model_filter_build_level (filter, NULL, -1, FALSE);
2300 level = FILTER_LEVEL (filter->priv->root);
2302 depth = gtk_tree_path_get_depth (path);
2309 for (i = 0; i < depth - 1; i++)
2311 if (!level || indices[i] >= level->array->len)
2316 elt = gtk_tree_model_filter_get_nth (filter, level, indices[i]);
2319 gtk_tree_model_filter_build_level (filter, level,
2320 FILTER_LEVEL_ELT_INDEX (level, elt),
2322 level = elt->children;
2325 if (!level || indices[i] >= level->array->len)
2331 iter->stamp = filter->priv->stamp;
2332 iter->user_data = level;
2334 elt = gtk_tree_model_filter_get_nth (filter, level, indices[depth - 1]);
2335 iter->user_data2 = elt;
2341 gtk_tree_model_filter_get_iter (GtkTreeModel *model,
2345 GtkTreeModelFilter *filter = (GtkTreeModelFilter *)model;
2350 g_return_val_if_fail (GTK_IS_TREE_MODEL_FILTER (model), FALSE);
2351 g_return_val_if_fail (filter->priv->child_model != NULL, FALSE);
2353 indices = gtk_tree_path_get_indices (path);
2355 if (filter->priv->root == NULL)
2356 gtk_tree_model_filter_build_level (filter, NULL, -1, FALSE);
2357 level = FILTER_LEVEL (filter->priv->root);
2359 depth = gtk_tree_path_get_depth (path);
2366 for (i = 0; i < depth - 1; i++)
2368 if (!level || indices[i] >= level->visible_nodes)
2373 elt = gtk_tree_model_filter_get_nth_visible (filter, level, indices[i]);
2376 gtk_tree_model_filter_build_level (filter, level,
2377 FILTER_LEVEL_ELT_INDEX (level, elt),
2379 level = elt->children;
2382 if (!level || indices[i] >= level->visible_nodes)
2388 iter->stamp = filter->priv->stamp;
2389 iter->user_data = level;
2391 elt = gtk_tree_model_filter_get_nth_visible (filter, level,
2392 indices[depth - 1]);
2393 iter->user_data2 = elt;
2398 static GtkTreePath *
2399 gtk_tree_model_filter_get_path (GtkTreeModel *model,
2402 GtkTreePath *retval;
2407 g_return_val_if_fail (GTK_IS_TREE_MODEL_FILTER (model), NULL);
2408 g_return_val_if_fail (GTK_TREE_MODEL_FILTER (model)->priv->child_model != NULL, NULL);
2409 g_return_val_if_fail (GTK_TREE_MODEL_FILTER (model)->priv->stamp == iter->stamp, NULL);
2411 level = iter->user_data;
2412 elt = iter->user_data2;
2413 elt_index = FILTER_LEVEL_ELT_INDEX (level, elt);
2418 retval = gtk_tree_path_new ();
2422 int i = 0, index = 0;
2424 while (i < elt_index)
2426 if (g_array_index (level->array, FilterElt, i).visible)
2430 g_assert (i < level->array->len);
2433 gtk_tree_path_prepend_index (retval, index);
2434 elt_index = level->parent_elt_index;
2435 level = level->parent_level;
2442 gtk_tree_model_filter_real_modify (GtkTreeModelFilter *self,
2443 GtkTreeModel *child_model,
2448 if (self->priv->modify_func)
2450 g_return_if_fail (column < self->priv->modify_n_columns);
2452 g_value_init (value, self->priv->modify_types[column]);
2453 self->priv->modify_func (GTK_TREE_MODEL (self),
2457 self->priv->modify_data);
2461 GtkTreeIter child_iter;
2463 gtk_tree_model_filter_convert_iter_to_child_iter (
2464 GTK_TREE_MODEL_FILTER (self), &child_iter, iter);
2465 gtk_tree_model_get_value (child_model,
2466 &child_iter, column, value);
2471 gtk_tree_model_filter_get_value (GtkTreeModel *model,
2476 GtkTreeModelFilter *filter = GTK_TREE_MODEL_FILTER (model);
2478 g_return_if_fail (GTK_IS_TREE_MODEL_FILTER (model));
2479 g_return_if_fail (GTK_TREE_MODEL_FILTER (model)->priv->child_model != NULL);
2480 g_return_if_fail (GTK_TREE_MODEL_FILTER (model)->priv->stamp == iter->stamp);
2482 GTK_TREE_MODEL_FILTER_GET_CLASS (model)->modify (filter,
2483 filter->priv->child_model, iter, value, column);
2487 gtk_tree_model_filter_iter_next (GtkTreeModel *model,
2494 g_return_val_if_fail (GTK_IS_TREE_MODEL_FILTER (model), FALSE);
2495 g_return_val_if_fail (GTK_TREE_MODEL_FILTER (model)->priv->child_model != NULL, FALSE);
2496 g_return_val_if_fail (GTK_TREE_MODEL_FILTER (model)->priv->stamp == iter->stamp, FALSE);
2498 level = iter->user_data;
2499 elt = iter->user_data2;
2501 i = elt - FILTER_ELT (level->array->data);
2503 while (i < level->array->len - 1)
2510 iter->user_data2 = elt;
2515 /* no next visible iter */
2522 gtk_tree_model_filter_iter_previous (GtkTreeModel *model,
2529 g_return_val_if_fail (GTK_IS_TREE_MODEL_FILTER (model), FALSE);
2530 g_return_val_if_fail (GTK_TREE_MODEL_FILTER (model)->priv->child_model != NULL, FALSE);
2531 g_return_val_if_fail (GTK_TREE_MODEL_FILTER (model)->priv->stamp == iter->stamp, FALSE);
2533 level = iter->user_data;
2534 elt = iter->user_data2;
2536 i = elt - FILTER_ELT (level->array->data);
2545 iter->user_data2 = elt;
2550 /* no previous visible iter */
2557 gtk_tree_model_filter_iter_children (GtkTreeModel *model,
2559 GtkTreeIter *parent)
2561 GtkTreeModelFilter *filter = (GtkTreeModelFilter *)model;
2565 g_return_val_if_fail (GTK_IS_TREE_MODEL_FILTER (model), FALSE);
2566 g_return_val_if_fail (filter->priv->child_model != NULL, FALSE);
2568 g_return_val_if_fail (filter->priv->stamp == parent->stamp, FALSE);
2574 if (!filter->priv->root)
2575 gtk_tree_model_filter_build_level (filter, NULL, -1, FALSE);
2576 if (!filter->priv->root)
2579 level = filter->priv->root;
2581 if (!level->visible_nodes)
2584 iter->stamp = filter->priv->stamp;
2585 iter->user_data = level;
2587 while (i < level->array->len)
2589 if (!g_array_index (level->array, FilterElt, i).visible)
2595 iter->user_data2 = &g_array_index (level->array, FilterElt, i);
2607 elt = FILTER_ELT (parent->user_data2);
2609 if (elt->children == NULL)
2610 gtk_tree_model_filter_build_level (filter,
2611 FILTER_LEVEL (parent->user_data),
2612 FILTER_LEVEL_ELT_INDEX (parent->user_data, elt),
2615 if (elt->children == NULL)
2618 if (elt->children->visible_nodes <= 0)
2621 iter->stamp = filter->priv->stamp;
2622 iter->user_data = elt->children;
2624 level = FILTER_LEVEL (iter->user_data);
2626 while (i < level->array->len)
2628 if (!g_array_index (level->array, FilterElt, i).visible)
2634 iter->user_data2 = &g_array_index (level->array, FilterElt, i);
2647 gtk_tree_model_filter_iter_has_child (GtkTreeModel *model,
2650 GtkTreeIter child_iter;
2651 GtkTreeModelFilter *filter = (GtkTreeModelFilter *)model;
2654 g_return_val_if_fail (GTK_IS_TREE_MODEL_FILTER (model), FALSE);
2655 g_return_val_if_fail (filter->priv->child_model != NULL, FALSE);
2656 g_return_val_if_fail (filter->priv->stamp == iter->stamp, FALSE);
2658 filter = GTK_TREE_MODEL_FILTER (model);
2660 gtk_tree_model_filter_convert_iter_to_child_iter (GTK_TREE_MODEL_FILTER (model), &child_iter, iter);
2661 elt = FILTER_ELT (iter->user_data2);
2666 /* we need to build the level to check if not all children are filtered
2670 && gtk_tree_model_iter_has_child (filter->priv->child_model, &child_iter))
2671 gtk_tree_model_filter_build_level (filter, FILTER_LEVEL (iter->user_data),
2672 FILTER_LEVEL_ELT_INDEX (iter->user_data, elt),
2675 if (elt->children && elt->children->visible_nodes > 0)
2682 gtk_tree_model_filter_iter_n_children (GtkTreeModel *model,
2685 GtkTreeIter child_iter;
2686 GtkTreeModelFilter *filter = (GtkTreeModelFilter *)model;
2689 g_return_val_if_fail (GTK_IS_TREE_MODEL_FILTER (model), 0);
2690 g_return_val_if_fail (filter->priv->child_model != NULL, 0);
2692 g_return_val_if_fail (filter->priv->stamp == iter->stamp, 0);
2696 if (!filter->priv->root)
2697 gtk_tree_model_filter_build_level (filter, NULL, -1, FALSE);
2699 if (filter->priv->root)
2700 return FILTER_LEVEL (filter->priv->root)->visible_nodes;
2705 elt = FILTER_ELT (iter->user_data2);
2710 gtk_tree_model_filter_convert_iter_to_child_iter (GTK_TREE_MODEL_FILTER (model), &child_iter, iter);
2712 if (!elt->children &&
2713 gtk_tree_model_iter_has_child (filter->priv->child_model, &child_iter))
2714 gtk_tree_model_filter_build_level (filter,
2715 FILTER_LEVEL (iter->user_data),
2716 FILTER_LEVEL_ELT_INDEX (iter->user_data, elt),
2720 return elt->children->visible_nodes;
2726 gtk_tree_model_filter_iter_nth_child (GtkTreeModel *model,
2728 GtkTreeIter *parent,
2733 GtkTreeIter children;
2735 g_return_val_if_fail (GTK_IS_TREE_MODEL_FILTER (model), FALSE);
2737 g_return_val_if_fail (GTK_TREE_MODEL_FILTER (model)->priv->stamp == parent->stamp, FALSE);
2739 /* use this instead of has_child to force us to build the level, if needed */
2740 if (gtk_tree_model_filter_iter_children (model, &children, parent) == FALSE)
2746 level = children.user_data;
2747 elt = FILTER_ELT (level->array->data);
2749 if (n >= level->visible_nodes)
2755 elt = gtk_tree_model_filter_get_nth_visible (GTK_TREE_MODEL_FILTER (model),
2758 iter->stamp = GTK_TREE_MODEL_FILTER (model)->priv->stamp;
2759 iter->user_data = level;
2760 iter->user_data2 = elt;
2766 gtk_tree_model_filter_iter_parent (GtkTreeModel *model,
2773 g_return_val_if_fail (GTK_IS_TREE_MODEL_FILTER (model), FALSE);
2774 g_return_val_if_fail (GTK_TREE_MODEL_FILTER (model)->priv->child_model != NULL, FALSE);
2775 g_return_val_if_fail (GTK_TREE_MODEL_FILTER (model)->priv->stamp == child->stamp, FALSE);
2777 level = child->user_data;
2779 if (level->parent_level)
2781 iter->stamp = GTK_TREE_MODEL_FILTER (model)->priv->stamp;
2782 iter->user_data = level->parent_level;
2783 iter->user_data2 = FILTER_LEVEL_PARENT_ELT (level);
2792 gtk_tree_model_filter_ref_node (GtkTreeModel *model,
2795 GtkTreeModelFilter *filter = (GtkTreeModelFilter *)model;
2796 GtkTreeIter child_iter;
2800 g_return_if_fail (GTK_IS_TREE_MODEL_FILTER (model));
2801 g_return_if_fail (GTK_TREE_MODEL_FILTER (model)->priv->child_model != NULL);
2802 g_return_if_fail (GTK_TREE_MODEL_FILTER (model)->priv->stamp == iter->stamp);
2804 gtk_tree_model_filter_convert_iter_to_child_iter (GTK_TREE_MODEL_FILTER (model), &child_iter, iter);
2806 gtk_tree_model_ref_node (filter->priv->child_model, &child_iter);
2808 level = iter->user_data;
2809 elt = iter->user_data2;
2813 if (level->ref_count == 1)
2815 FilterLevel *parent_level = level->parent_level;
2816 gint parent_elt_index = level->parent_elt_index;
2818 /* we were at zero -- time to decrease the zero_ref_count val */
2819 while (parent_level)
2821 g_array_index (parent_level->array, FilterElt, parent_elt_index).zero_ref_count--;
2823 parent_elt_index = parent_level->parent_elt_index;
2824 parent_level = parent_level->parent_level;
2827 if (filter->priv->root != level)
2828 filter->priv->zero_ref_count--;
2833 gtk_tree_model_filter_unref_node (GtkTreeModel *model,
2836 gtk_tree_model_filter_real_unref_node (model, iter, TRUE);
2840 gtk_tree_model_filter_real_unref_node (GtkTreeModel *model,
2842 gboolean propagate_unref)
2844 GtkTreeModelFilter *filter = (GtkTreeModelFilter *)model;
2848 g_return_if_fail (GTK_IS_TREE_MODEL_FILTER (model));
2849 g_return_if_fail (filter->priv->child_model != NULL);
2850 g_return_if_fail (filter->priv->stamp == iter->stamp);
2852 if (propagate_unref)
2854 GtkTreeIter child_iter;
2855 gtk_tree_model_filter_convert_iter_to_child_iter (GTK_TREE_MODEL_FILTER (model), &child_iter, iter);
2856 gtk_tree_model_unref_node (filter->priv->child_model, &child_iter);
2859 level = iter->user_data;
2860 elt = iter->user_data2;
2862 g_return_if_fail (elt->ref_count > 0);
2866 if (level->ref_count == 0)
2868 FilterLevel *parent_level = level->parent_level;
2869 gint parent_elt_index = level->parent_elt_index;
2871 /* we are at zero -- time to increase the zero_ref_count val */
2872 while (parent_level)
2874 g_array_index (parent_level->array, FilterElt, parent_elt_index).zero_ref_count++;
2876 parent_elt_index = parent_level->parent_elt_index;
2877 parent_level = parent_level->parent_level;
2880 if (filter->priv->root != level)
2881 filter->priv->zero_ref_count++;
2885 /* TreeDragSource interface implementation */
2887 gtk_tree_model_filter_row_draggable (GtkTreeDragSource *drag_source,
2890 GtkTreeModelFilter *tree_model_filter = (GtkTreeModelFilter *)drag_source;
2891 GtkTreePath *child_path;
2894 g_return_val_if_fail (GTK_IS_TREE_MODEL_FILTER (drag_source), FALSE);
2895 g_return_val_if_fail (path != NULL, FALSE);
2897 child_path = gtk_tree_model_filter_convert_path_to_child_path (tree_model_filter, path);
2898 draggable = gtk_tree_drag_source_row_draggable (GTK_TREE_DRAG_SOURCE (tree_model_filter->priv->child_model), child_path);
2899 gtk_tree_path_free (child_path);
2905 gtk_tree_model_filter_drag_data_get (GtkTreeDragSource *drag_source,
2907 GtkSelectionData *selection_data)
2909 GtkTreeModelFilter *tree_model_filter = (GtkTreeModelFilter *)drag_source;
2910 GtkTreePath *child_path;
2913 g_return_val_if_fail (GTK_IS_TREE_MODEL_FILTER (drag_source), FALSE);
2914 g_return_val_if_fail (path != NULL, FALSE);
2916 child_path = gtk_tree_model_filter_convert_path_to_child_path (tree_model_filter, path);
2917 gotten = gtk_tree_drag_source_drag_data_get (GTK_TREE_DRAG_SOURCE (tree_model_filter->priv->child_model), child_path, selection_data);
2918 gtk_tree_path_free (child_path);
2924 gtk_tree_model_filter_drag_data_delete (GtkTreeDragSource *drag_source,
2927 GtkTreeModelFilter *tree_model_filter = (GtkTreeModelFilter *)drag_source;
2928 GtkTreePath *child_path;
2931 g_return_val_if_fail (GTK_IS_TREE_MODEL_FILTER (drag_source), FALSE);
2932 g_return_val_if_fail (path != NULL, FALSE);
2934 child_path = gtk_tree_model_filter_convert_path_to_child_path (tree_model_filter, path);
2935 deleted = gtk_tree_drag_source_drag_data_delete (GTK_TREE_DRAG_SOURCE (tree_model_filter->priv->child_model), child_path);
2936 gtk_tree_path_free (child_path);
2941 /* bits and pieces */
2943 gtk_tree_model_filter_set_model (GtkTreeModelFilter *filter,
2944 GtkTreeModel *child_model)
2946 g_return_if_fail (GTK_IS_TREE_MODEL_FILTER (filter));
2948 if (filter->priv->child_model)
2950 g_signal_handler_disconnect (filter->priv->child_model,
2951 filter->priv->changed_id);
2952 g_signal_handler_disconnect (filter->priv->child_model,
2953 filter->priv->inserted_id);
2954 g_signal_handler_disconnect (filter->priv->child_model,
2955 filter->priv->has_child_toggled_id);
2956 g_signal_handler_disconnect (filter->priv->child_model,
2957 filter->priv->deleted_id);
2958 g_signal_handler_disconnect (filter->priv->child_model,
2959 filter->priv->reordered_id);
2961 /* reset our state */
2962 if (filter->priv->root)
2963 gtk_tree_model_filter_free_level (filter, filter->priv->root);
2965 filter->priv->root = NULL;
2966 g_object_unref (filter->priv->child_model);
2967 filter->priv->visible_column = -1;
2969 /* FIXME: do we need to destroy more here? */
2972 filter->priv->child_model = child_model;
2976 g_object_ref (filter->priv->child_model);
2977 filter->priv->changed_id =
2978 g_signal_connect (child_model, "row-changed",
2979 G_CALLBACK (gtk_tree_model_filter_row_changed),
2981 filter->priv->inserted_id =
2982 g_signal_connect (child_model, "row-inserted",
2983 G_CALLBACK (gtk_tree_model_filter_row_inserted),
2985 filter->priv->has_child_toggled_id =
2986 g_signal_connect (child_model, "row-has-child-toggled",
2987 G_CALLBACK (gtk_tree_model_filter_row_has_child_toggled),
2989 filter->priv->deleted_id =
2990 g_signal_connect (child_model, "row-deleted",
2991 G_CALLBACK (gtk_tree_model_filter_row_deleted),
2993 filter->priv->reordered_id =
2994 g_signal_connect (child_model, "rows-reordered",
2995 G_CALLBACK (gtk_tree_model_filter_rows_reordered),
2998 filter->priv->child_flags = gtk_tree_model_get_flags (child_model);
2999 filter->priv->stamp = g_random_int ();
3004 gtk_tree_model_filter_ref_path (GtkTreeModelFilter *filter,
3010 len = gtk_tree_path_get_depth (path);
3011 p = gtk_tree_path_copy (path);
3016 gtk_tree_model_get_iter (GTK_TREE_MODEL (filter->priv->child_model), &iter, p);
3017 gtk_tree_model_ref_node (GTK_TREE_MODEL (filter->priv->child_model), &iter);
3018 gtk_tree_path_up (p);
3021 gtk_tree_path_free (p);
3025 gtk_tree_model_filter_unref_path (GtkTreeModelFilter *filter,
3031 len = gtk_tree_path_get_depth (path);
3032 p = gtk_tree_path_copy (path);
3037 gtk_tree_model_get_iter (GTK_TREE_MODEL (filter->priv->child_model), &iter, p);
3038 gtk_tree_model_unref_node (GTK_TREE_MODEL (filter->priv->child_model), &iter);
3039 gtk_tree_path_up (p);
3042 gtk_tree_path_free (p);
3046 gtk_tree_model_filter_set_root (GtkTreeModelFilter *filter,
3049 g_return_if_fail (GTK_IS_TREE_MODEL_FILTER (filter));
3052 filter->priv->virtual_root = NULL;
3054 filter->priv->virtual_root = gtk_tree_path_copy (root);
3060 * gtk_tree_model_filter_new:
3061 * @child_model: A #GtkTreeModel.
3062 * @root: (allow-none): A #GtkTreePath or %NULL.
3064 * Creates a new #GtkTreeModel, with @child_model as the child_model
3065 * and @root as the virtual root.
3067 * Return value: (transfer full): A new #GtkTreeModel.
3072 gtk_tree_model_filter_new (GtkTreeModel *child_model,
3075 GtkTreeModel *retval;
3076 GtkTreeModelFilter *filter;
3078 g_return_val_if_fail (GTK_IS_TREE_MODEL (child_model), NULL);
3080 retval = g_object_new (GTK_TYPE_TREE_MODEL_FILTER,
3081 "child-model", child_model,
3082 "virtual-root", root,
3085 filter = GTK_TREE_MODEL_FILTER (retval);
3086 if (filter->priv->virtual_root)
3088 gtk_tree_model_filter_ref_path (filter, filter->priv->virtual_root);
3089 filter->priv->virtual_root_deleted = FALSE;
3096 * gtk_tree_model_filter_get_model:
3097 * @filter: A #GtkTreeModelFilter.
3099 * Returns a pointer to the child model of @filter.
3101 * Return value: (transfer none): A pointer to a #GtkTreeModel.
3106 gtk_tree_model_filter_get_model (GtkTreeModelFilter *filter)
3108 g_return_val_if_fail (GTK_IS_TREE_MODEL_FILTER (filter), NULL);
3110 return filter->priv->child_model;
3114 * gtk_tree_model_filter_set_visible_func:
3115 * @filter: A #GtkTreeModelFilter.
3116 * @func: A #GtkTreeModelFilterVisibleFunc, the visible function.
3117 * @data: (allow-none): User data to pass to the visible function, or %NULL.
3118 * @destroy: (allow-none): Destroy notifier of @data, or %NULL.
3120 * Sets the visible function used when filtering the @filter to be @func. The
3121 * function should return %TRUE if the given row should be visible and
3124 * If the condition calculated by the function changes over time (e.g. because
3125 * it depends on some global parameters), you must call
3126 * gtk_tree_model_filter_refilter() to keep the visibility information of
3127 * the model uptodate.
3129 * Note that @func is called whenever a row is inserted, when it may still be
3130 * empty. The visible function should therefore take special care of empty
3131 * rows, like in the example below.
3133 * <informalexample><programlisting>
3135 * visible_func (GtkTreeModel *model,
3136 * GtkTreeIter *iter,
3139 * /* Visible if row is non-empty and first column is "HI" */
3141 * gboolean visible = FALSE;
3143 * gtk_tree_model_get (model, iter, 0, &str, -1);
3144 * if (str && strcmp (str, "HI") == 0)
3150 * </programlisting></informalexample>
3155 gtk_tree_model_filter_set_visible_func (GtkTreeModelFilter *filter,
3156 GtkTreeModelFilterVisibleFunc func,
3158 GDestroyNotify destroy)
3160 g_return_if_fail (GTK_IS_TREE_MODEL_FILTER (filter));
3161 g_return_if_fail (func != NULL);
3162 g_return_if_fail (filter->priv->visible_method_set == FALSE);
3164 filter->priv->visible_func = func;
3165 filter->priv->visible_data = data;
3166 filter->priv->visible_destroy = destroy;
3168 filter->priv->visible_method_set = TRUE;
3172 * gtk_tree_model_filter_set_modify_func:
3173 * @filter: A #GtkTreeModelFilter.
3174 * @n_columns: The number of columns in the filter model.
3175 * @types: (array length=n_columns): The #GType<!-- -->s of the columns.
3176 * @func: A #GtkTreeModelFilterModifyFunc
3177 * @data: (allow-none): User data to pass to the modify function, or %NULL.
3178 * @destroy: (allow-none): Destroy notifier of @data, or %NULL.
3180 * With the @n_columns and @types parameters, you give an array of column
3181 * types for this model (which will be exposed to the parent model/view).
3182 * The @func, @data and @destroy parameters are for specifying the modify
3183 * function. The modify function will get called for <emphasis>each</emphasis>
3184 * data access, the goal of the modify function is to return the data which
3185 * should be displayed at the location specified using the parameters of the
3191 gtk_tree_model_filter_set_modify_func (GtkTreeModelFilter *filter,
3194 GtkTreeModelFilterModifyFunc func,
3196 GDestroyNotify destroy)
3198 g_return_if_fail (GTK_IS_TREE_MODEL_FILTER (filter));
3199 g_return_if_fail (func != NULL);
3200 g_return_if_fail (filter->priv->modify_func_set == FALSE);
3202 if (filter->priv->modify_destroy)
3204 GDestroyNotify d = filter->priv->modify_destroy;
3206 filter->priv->modify_destroy = NULL;
3207 d (filter->priv->modify_data);
3210 filter->priv->modify_n_columns = n_columns;
3211 filter->priv->modify_types = g_new0 (GType, n_columns);
3212 memcpy (filter->priv->modify_types, types, sizeof (GType) * n_columns);
3213 filter->priv->modify_func = func;
3214 filter->priv->modify_data = data;
3215 filter->priv->modify_destroy = destroy;
3217 filter->priv->modify_func_set = TRUE;
3221 * gtk_tree_model_filter_set_visible_column:
3222 * @filter: A #GtkTreeModelFilter.
3223 * @column: A #gint which is the column containing the visible information.
3225 * Sets @column of the child_model to be the column where @filter should
3226 * look for visibility information. @columns should be a column of type
3227 * %G_TYPE_BOOLEAN, where %TRUE means that a row is visible, and %FALSE
3233 gtk_tree_model_filter_set_visible_column (GtkTreeModelFilter *filter,
3236 g_return_if_fail (GTK_IS_TREE_MODEL_FILTER (filter));
3237 g_return_if_fail (column >= 0);
3238 g_return_if_fail (filter->priv->visible_method_set == FALSE);
3240 filter->priv->visible_column = column;
3242 filter->priv->visible_method_set = TRUE;
3248 * gtk_tree_model_filter_convert_child_iter_to_iter:
3249 * @filter: A #GtkTreeModelFilter.
3250 * @filter_iter: (out): An uninitialized #GtkTreeIter.
3251 * @child_iter: A valid #GtkTreeIter pointing to a row on the child model.
3253 * Sets @filter_iter to point to the row in @filter that corresponds to the
3254 * row pointed at by @child_iter. If @filter_iter was not set, %FALSE is
3257 * Return value: %TRUE, if @filter_iter was set, i.e. if @child_iter is a
3258 * valid iterator pointing to a visible row in child model.
3263 gtk_tree_model_filter_convert_child_iter_to_iter (GtkTreeModelFilter *filter,
3264 GtkTreeIter *filter_iter,
3265 GtkTreeIter *child_iter)
3268 GtkTreePath *child_path, *path;
3270 g_return_val_if_fail (GTK_IS_TREE_MODEL_FILTER (filter), FALSE);
3271 g_return_val_if_fail (filter->priv->child_model != NULL, FALSE);
3272 g_return_val_if_fail (filter_iter != NULL, FALSE);
3273 g_return_val_if_fail (child_iter != NULL, FALSE);
3274 g_return_val_if_fail (filter_iter != child_iter, FALSE);
3276 filter_iter->stamp = 0;
3278 child_path = gtk_tree_model_get_path (filter->priv->child_model, child_iter);
3279 g_return_val_if_fail (child_path != NULL, FALSE);
3281 path = gtk_tree_model_filter_convert_child_path_to_path (filter,
3283 gtk_tree_path_free (child_path);
3288 ret = gtk_tree_model_get_iter (GTK_TREE_MODEL (filter), filter_iter, path);
3289 gtk_tree_path_free (path);
3295 * gtk_tree_model_filter_convert_iter_to_child_iter:
3296 * @filter: A #GtkTreeModelFilter.
3297 * @child_iter: (out): An uninitialized #GtkTreeIter.
3298 * @filter_iter: A valid #GtkTreeIter pointing to a row on @filter.
3300 * Sets @child_iter to point to the row pointed to by @filter_iter.
3305 gtk_tree_model_filter_convert_iter_to_child_iter (GtkTreeModelFilter *filter,
3306 GtkTreeIter *child_iter,
3307 GtkTreeIter *filter_iter)
3309 g_return_if_fail (GTK_IS_TREE_MODEL_FILTER (filter));
3310 g_return_if_fail (filter->priv->child_model != NULL);
3311 g_return_if_fail (child_iter != NULL);
3312 g_return_if_fail (filter_iter != NULL);
3313 g_return_if_fail (filter_iter->stamp == filter->priv->stamp);
3314 g_return_if_fail (filter_iter != child_iter);
3316 if (GTK_TREE_MODEL_FILTER_CACHE_CHILD_ITERS (filter))
3318 *child_iter = FILTER_ELT (filter_iter->user_data2)->iter;
3324 path = gtk_tree_model_filter_elt_get_path (filter_iter->user_data,
3325 filter_iter->user_data2,
3326 filter->priv->virtual_root);
3327 gtk_tree_model_get_iter (filter->priv->child_model, child_iter, path);
3328 gtk_tree_path_free (path);
3332 /* The path returned can only be used internally in the filter model. */
3333 static GtkTreePath *
3334 gtk_real_tree_model_filter_convert_child_path_to_path (GtkTreeModelFilter *filter,
3335 GtkTreePath *child_path,
3336 gboolean build_levels,
3337 gboolean fetch_children)
3339 gint *child_indices;
3340 GtkTreePath *retval;
3341 GtkTreePath *real_path;
3346 g_return_val_if_fail (GTK_IS_TREE_MODEL_FILTER (filter), NULL);
3347 g_return_val_if_fail (filter->priv->child_model != NULL, NULL);
3348 g_return_val_if_fail (child_path != NULL, NULL);
3350 if (!filter->priv->virtual_root)
3351 real_path = gtk_tree_path_copy (child_path);
3353 real_path = gtk_tree_model_filter_remove_root (child_path,
3354 filter->priv->virtual_root);
3359 retval = gtk_tree_path_new ();
3360 child_indices = gtk_tree_path_get_indices (real_path);
3362 if (filter->priv->root == NULL && build_levels)
3363 gtk_tree_model_filter_build_level (filter, NULL, -1, FALSE);
3364 level = FILTER_LEVEL (filter->priv->root);
3366 for (i = 0; i < gtk_tree_path_get_depth (real_path); i++)
3369 gboolean found_child = FALSE;
3373 gtk_tree_path_free (real_path);
3374 gtk_tree_path_free (retval);
3378 tmp = bsearch_elt_with_offset (level->array, child_indices[i], &j);
3381 gtk_tree_path_append_index (retval, j);
3382 if (!tmp->children && build_levels)
3383 gtk_tree_model_filter_build_level (filter, level,
3384 FILTER_LEVEL_ELT_INDEX (level, tmp),
3386 level = tmp->children;
3390 if (!found_child && fetch_children)
3392 tmp = gtk_tree_model_filter_fetch_child (filter, level,
3396 /* didn't find the child, let's try to bring it back */
3397 if (!tmp || tmp->offset != child_indices[i])
3400 gtk_tree_path_free (real_path);
3401 gtk_tree_path_free (retval);
3405 gtk_tree_path_append_index (retval, j);
3406 if (!tmp->children && build_levels)
3407 gtk_tree_model_filter_build_level (filter, level,
3408 FILTER_LEVEL_ELT_INDEX (level, tmp),
3410 level = tmp->children;
3413 else if (!found_child && !fetch_children)
3416 gtk_tree_path_free (real_path);
3417 gtk_tree_path_free (retval);
3422 gtk_tree_path_free (real_path);
3427 * gtk_tree_model_filter_convert_child_path_to_path:
3428 * @filter: A #GtkTreeModelFilter.
3429 * @child_path: A #GtkTreePath to convert.
3431 * Converts @child_path to a path relative to @filter. That is, @child_path
3432 * points to a path in the child model. The rerturned path will point to the
3433 * same row in the filtered model. If @child_path isn't a valid path on the
3434 * child model or points to a row which is not visible in @filter, then %NULL
3437 * Return value: A newly allocated #GtkTreePath, or %NULL.
3442 gtk_tree_model_filter_convert_child_path_to_path (GtkTreeModelFilter *filter,
3443 GtkTreePath *child_path)
3448 /* this function does the sanity checks */
3449 path = gtk_real_tree_model_filter_convert_child_path_to_path (filter,
3457 /* get a new path which only takes visible nodes into account.
3458 * -- if this gives any performance issues, we can write a special
3459 * version of convert_child_path_to_path immediately returning
3460 * a visible-nodes-only path.
3462 gtk_tree_model_filter_get_iter_full (GTK_TREE_MODEL (filter), &iter, path);
3464 gtk_tree_path_free (path);
3465 path = gtk_tree_model_get_path (GTK_TREE_MODEL (filter), &iter);
3471 * gtk_tree_model_filter_convert_path_to_child_path:
3472 * @filter: A #GtkTreeModelFilter.
3473 * @filter_path: A #GtkTreePath to convert.
3475 * Converts @filter_path to a path on the child model of @filter. That is,
3476 * @filter_path points to a location in @filter. The returned path will
3477 * point to the same location in the model not being filtered. If @filter_path
3478 * does not point to a location in the child model, %NULL is returned.
3480 * Return value: A newly allocated #GtkTreePath, or %NULL.
3485 gtk_tree_model_filter_convert_path_to_child_path (GtkTreeModelFilter *filter,
3486 GtkTreePath *filter_path)
3488 gint *filter_indices;
3489 GtkTreePath *retval;
3493 g_return_val_if_fail (GTK_IS_TREE_MODEL_FILTER (filter), NULL);
3494 g_return_val_if_fail (filter->priv->child_model != NULL, NULL);
3495 g_return_val_if_fail (filter_path != NULL, NULL);
3498 retval = gtk_tree_path_new ();
3499 filter_indices = gtk_tree_path_get_indices (filter_path);
3500 if (!filter->priv->root)
3501 gtk_tree_model_filter_build_level (filter, NULL, -1, FALSE);
3502 level = FILTER_LEVEL (filter->priv->root);
3504 for (i = 0; i < gtk_tree_path_get_depth (filter_path); i++)
3508 if (!level || level->visible_nodes <= filter_indices[i])
3510 gtk_tree_path_free (retval);
3514 elt = gtk_tree_model_filter_get_nth_visible (filter, level,
3517 if (elt->children == NULL)
3518 gtk_tree_model_filter_build_level (filter, level,
3519 FILTER_LEVEL_ELT_INDEX (level, elt),
3522 if (!level || level->visible_nodes <= filter_indices[i])
3524 gtk_tree_path_free (retval);
3528 gtk_tree_path_append_index (retval, elt->offset);
3529 level = elt->children;
3534 if (filter->priv->virtual_root)
3536 GtkTreePath *real_retval;
3538 real_retval = gtk_tree_model_filter_add_root (retval,
3539 filter->priv->virtual_root);
3540 gtk_tree_path_free (retval);
3549 gtk_tree_model_filter_refilter_helper (GtkTreeModel *model,
3554 /* evil, don't try this at home, but certainly speeds things up */
3555 gtk_tree_model_filter_row_changed (model, path, iter, data);
3561 * gtk_tree_model_filter_refilter:
3562 * @filter: A #GtkTreeModelFilter.
3564 * Emits ::row_changed for each row in the child model, which causes
3565 * the filter to re-evaluate whether a row is visible or not.
3570 gtk_tree_model_filter_refilter (GtkTreeModelFilter *filter)
3572 g_return_if_fail (GTK_IS_TREE_MODEL_FILTER (filter));
3575 gtk_tree_model_foreach (filter->priv->child_model,
3576 gtk_tree_model_filter_refilter_helper,
3581 * gtk_tree_model_filter_clear_cache:
3582 * @filter: A #GtkTreeModelFilter.
3584 * This function should almost never be called. It clears the @filter
3585 * of any cached iterators that haven't been reffed with
3586 * gtk_tree_model_ref_node(). This might be useful if the child model
3587 * being filtered is static (and doesn't change often) and there has been
3588 * a lot of unreffed access to nodes. As a side effect of this function,
3589 * all unreffed iters will be invalid.
3594 gtk_tree_model_filter_clear_cache (GtkTreeModelFilter *filter)
3596 g_return_if_fail (GTK_IS_TREE_MODEL_FILTER (filter));
3598 if (filter->priv->zero_ref_count > 0)
3599 gtk_tree_model_filter_clear_cache_helper (filter,
3600 FILTER_LEVEL (filter->priv->root));