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 program is free software; you can redistribute it and/or
6 * modify it under the terms of the GNU General Public License as
7 * published by the Free Software Foundation; either version 2 of the
8 * License, or (at your option) any later version.
10 * This program 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 * General Public License for more details.
15 * You should have received a copy of the GNU General Public
16 * License along with this program; if not, write to the
17 * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
18 * Boston, MA 02111-1307, USA.
21 #include "gtktreemodelfilter.h"
27 * iter->stamp = filter->priv->stamp
28 * iter->user_data = FilterLevel
29 * iter->user_data2 = FilterElt
32 /* all paths, iters, etc prefixed with c_ are paths, iters, etc relative to the
36 typedef struct _FilterElt FilterElt;
37 typedef struct _FilterLevel FilterLevel;
42 FilterLevel *children;
54 FilterElt *parent_elt;
55 FilterLevel *parent_level;
58 #define GTK_TREE_MODEL_FILTER_GET_PRIVATE(obj) (G_TYPE_INSTANCE_GET_PRIVATE ((obj), GTK_TYPE_TREE_MODEL_FILTER, GtkTreeModelFilterPrivate))
60 struct _GtkTreeModelFilterPrivate
65 GtkTreeModel *child_model;
68 guint root_level_visible;
70 GtkTreePath *virtual_root;
72 GtkTreeModelFilterVisibleFunc visible_func;
73 gpointer visible_data;
74 GtkDestroyNotify visible_destroy;
76 gint modify_n_columns;
78 GtkTreeModelFilterModifyFunc modify_func;
80 gpointer modify_destroy;
84 gboolean visible_method_set;
85 gboolean modify_func_set;
90 guint has_child_toggled_id;
103 #define GTK_TREE_MODEL_FILTER_CACHE_CHILD_ITERS(filter) \
104 (((GtkTreeModelFilter *)filter)->priv->child_flags & GTK_TREE_MODEL_ITERS_PERSIST)
106 #define FILTER_ELT(filter_elt) ((FilterElt *)filter_elt)
107 #define FILTER_LEVEL(filter_level) ((FilterLevel *)filter_level)
109 /* general code (object/interface init, properties, etc) */
110 static void gtk_tree_model_filter_init (GtkTreeModelFilter *filter);
111 static void gtk_tree_model_filter_class_init (GtkTreeModelFilterClass *filter_class);
112 static void gtk_tree_model_filter_tree_model_init (GtkTreeModelIface *iface);
113 static void gtk_tree_model_filter_finalize (GObject *object);
114 static void gtk_tree_model_filter_set_property (GObject *object,
118 static void gtk_tree_model_filter_get_property (GObject *object,
123 /* signal handlers */
124 static void gtk_tree_model_filter_row_changed (GtkTreeModel *c_model,
128 static void gtk_tree_model_filter_row_inserted (GtkTreeModel *c_model,
132 static void gtk_tree_model_filter_row_has_child_toggled (GtkTreeModel *c_model,
136 static void gtk_tree_model_filter_row_deleted (GtkTreeModel *c_model,
139 static void gtk_tree_model_filter_rows_reordered (GtkTreeModel *c_model,
145 /* GtkTreeModel interface */
146 static guint gtk_tree_model_filter_get_flags (GtkTreeModel *model);
147 static gint gtk_tree_model_filter_get_n_columns (GtkTreeModel *model);
148 static GType gtk_tree_model_filter_get_column_type (GtkTreeModel *model,
150 static gboolean gtk_tree_model_filter_get_iter (GtkTreeModel *model,
153 static GtkTreePath *gtk_tree_model_filter_get_path (GtkTreeModel *model,
155 static void gtk_tree_model_filter_get_value (GtkTreeModel *model,
159 static gboolean gtk_tree_model_filter_iter_next (GtkTreeModel *model,
161 static gboolean gtk_tree_model_filter_iter_children (GtkTreeModel *model,
163 GtkTreeIter *parent);
164 static gboolean gtk_tree_model_filter_iter_has_child (GtkTreeModel *model,
166 static gint gtk_tree_model_filter_iter_n_children (GtkTreeModel *model,
168 static gboolean gtk_tree_model_filter_iter_nth_child (GtkTreeModel *model,
172 static gboolean gtk_tree_model_filter_iter_parent (GtkTreeModel *model,
175 static void gtk_tree_model_filter_ref_node (GtkTreeModel *model,
177 static void gtk_tree_model_filter_unref_node (GtkTreeModel *model,
181 /* private functions */
182 static void gtk_tree_model_filter_build_level (GtkTreeModelFilter *filter,
183 FilterLevel *parent_level,
184 FilterElt *parent_elt);
185 static void gtk_tree_model_filter_free_level (GtkTreeModelFilter *filter,
186 FilterLevel *filter_level);
188 static GtkTreePath *gtk_tree_model_filter_elt_get_path (FilterLevel *level,
192 static GtkTreePath *gtk_tree_model_filter_add_root (GtkTreePath *src,
194 static GtkTreePath *gtk_tree_model_filter_remove_root (GtkTreePath *src,
197 static void gtk_tree_model_filter_increment_stamp (GtkTreeModelFilter *filter);
199 static gboolean gtk_tree_model_filter_visible (GtkTreeModelFilter *filter,
200 GtkTreeIter *child_iter);
201 static void gtk_tree_model_filter_clear_cache_helper (GtkTreeModelFilter *filter,
204 static void gtk_tree_model_filter_real_unref_node (GtkTreeModel *model,
206 gboolean propagate_unref);
208 static void gtk_tree_model_filter_set_model (GtkTreeModelFilter *filter,
209 GtkTreeModel *child_model);
210 static void gtk_tree_model_filter_set_root (GtkTreeModelFilter *filter,
213 static GtkTreePath *gtk_real_tree_model_filter_convert_child_path_to_path (GtkTreeModelFilter *filter,
214 GtkTreePath *child_path,
215 gboolean build_levels,
216 gboolean fetch_childs);
218 static FilterElt *gtk_tree_model_filter_fetch_child (GtkTreeModelFilter *filter,
222 static void gtk_tree_model_filter_remove_node (GtkTreeModelFilter *filter,
224 gboolean emit_signal);
225 static void gtk_tree_model_filter_update_childs (GtkTreeModelFilter *filter,
228 static FilterElt *bsearch_elt_with_offset (GArray *array,
233 static GObjectClass *parent_class = NULL;
236 gtk_tree_model_filter_get_type (void)
238 static GType tree_model_filter_type = 0;
240 if (!tree_model_filter_type)
242 static const GTypeInfo tree_model_filter_info =
244 sizeof (GtkTreeModelFilterClass),
245 NULL, /* base_init */
246 NULL, /* base_finalize */
247 (GClassInitFunc) gtk_tree_model_filter_class_init,
248 NULL, /* class_finalize */
249 NULL, /* class_data */
250 sizeof (GtkTreeModelFilter),
252 (GInstanceInitFunc) gtk_tree_model_filter_init
255 static const GInterfaceInfo tree_model_info =
257 (GInterfaceInitFunc) gtk_tree_model_filter_tree_model_init,
262 tree_model_filter_type = g_type_register_static (G_TYPE_OBJECT,
263 "GtkTreeModelFilter",
264 &tree_model_filter_info, 0);
266 g_type_add_interface_static (tree_model_filter_type,
271 return tree_model_filter_type;
275 gtk_tree_model_filter_init (GtkTreeModelFilter *filter)
277 filter->priv = GTK_TREE_MODEL_FILTER_GET_PRIVATE (filter);
279 filter->priv->visible_column = -1;
280 filter->priv->zero_ref_count = 0;
281 filter->priv->visible_method_set = FALSE;
282 filter->priv->modify_func_set = FALSE;
286 gtk_tree_model_filter_class_init (GtkTreeModelFilterClass *filter_class)
288 GObjectClass *object_class;
290 object_class = (GObjectClass *) filter_class;
291 parent_class = g_type_class_peek_parent (filter_class);
293 object_class->set_property = gtk_tree_model_filter_set_property;
294 object_class->get_property = gtk_tree_model_filter_get_property;
296 object_class->finalize = gtk_tree_model_filter_finalize;
298 /* Properties -- FIXME: disabled translations for now, until I can come up with a
301 g_object_class_install_property (object_class,
303 g_param_spec_object ("child_model",
305 ("The model for the filtermodel to filter"),
307 G_PARAM_READWRITE | G_PARAM_CONSTRUCT_ONLY));
309 g_object_class_install_property (object_class,
311 g_param_spec_boxed ("virtual_root",
312 ("The virtual root"),
313 ("The virtual root (relative to the child model) for this filtermodel"),
315 G_PARAM_READWRITE | G_PARAM_CONSTRUCT_ONLY));
317 g_type_class_add_private (object_class, sizeof (GtkTreeModelFilterPrivate));
321 gtk_tree_model_filter_tree_model_init (GtkTreeModelIface *iface)
323 iface->get_flags = gtk_tree_model_filter_get_flags;
324 iface->get_n_columns = gtk_tree_model_filter_get_n_columns;
325 iface->get_column_type = gtk_tree_model_filter_get_column_type;
326 iface->get_iter = gtk_tree_model_filter_get_iter;
327 iface->get_path = gtk_tree_model_filter_get_path;
328 iface->get_value = gtk_tree_model_filter_get_value;
329 iface->iter_next = gtk_tree_model_filter_iter_next;
330 iface->iter_children = gtk_tree_model_filter_iter_children;
331 iface->iter_has_child = gtk_tree_model_filter_iter_has_child;
332 iface->iter_n_children = gtk_tree_model_filter_iter_n_children;
333 iface->iter_nth_child = gtk_tree_model_filter_iter_nth_child;
334 iface->iter_parent = gtk_tree_model_filter_iter_parent;
335 iface->ref_node = gtk_tree_model_filter_ref_node;
336 iface->unref_node = gtk_tree_model_filter_unref_node;
341 gtk_tree_model_filter_finalize (GObject *object)
343 GtkTreeModelFilter *filter = (GtkTreeModelFilter *) object;
345 gtk_tree_model_filter_set_model (filter, NULL);
347 if (filter->priv->virtual_root)
348 gtk_tree_path_free (filter->priv->virtual_root);
350 if (filter->priv->root)
351 gtk_tree_model_filter_free_level (filter, filter->priv->root);
353 if (filter->priv->modify_types)
354 g_free (filter->priv->modify_types);
357 parent_class->finalize (object);
361 gtk_tree_model_filter_set_property (GObject *object,
366 GtkTreeModelFilter *filter = GTK_TREE_MODEL_FILTER (object);
370 case PROP_CHILD_MODEL:
371 gtk_tree_model_filter_set_model (filter, g_value_get_object (value));
373 case PROP_VIRTUAL_ROOT:
374 gtk_tree_model_filter_set_root (filter, g_value_get_boxed (value));
377 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
383 gtk_tree_model_filter_get_property (GObject *object,
388 GtkTreeModelFilter *filter = GTK_TREE_MODEL_FILTER (object);
392 case PROP_CHILD_MODEL:
393 g_value_set_object (value, filter->priv->child_model);
395 case PROP_VIRTUAL_ROOT:
396 g_value_set_boxed (value, filter->priv->virtual_root);
399 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
407 gtk_tree_model_filter_build_level (GtkTreeModelFilter *filter,
408 FilterLevel *parent_level,
409 FilterElt *parent_elt)
413 FilterLevel *new_level;
417 g_assert (filter->priv->child_model != NULL);
421 if (filter->priv->virtual_root)
423 if (gtk_tree_model_get_iter (filter->priv->child_model, &root, filter->priv->virtual_root) == FALSE)
425 length = gtk_tree_model_iter_n_children (filter->priv->child_model, &root);
427 if (gtk_tree_model_iter_children (filter->priv->child_model, &iter, &root) == FALSE)
432 if (!gtk_tree_model_get_iter_first (filter->priv->child_model, &iter))
434 length = gtk_tree_model_iter_n_children (filter->priv->child_model, NULL);
439 GtkTreeIter parent_iter;
440 GtkTreeIter child_parent_iter;
442 parent_iter.stamp = filter->priv->stamp;
443 parent_iter.user_data = parent_level;
444 parent_iter.user_data2 = parent_elt;
446 gtk_tree_model_filter_convert_iter_to_child_iter (filter,
449 if (gtk_tree_model_iter_children (filter->priv->child_model, &iter, &child_parent_iter) == FALSE)
452 /* stamp may have changed */
453 gtk_tree_model_filter_convert_iter_to_child_iter (filter,
456 length = gtk_tree_model_iter_n_children (filter->priv->child_model, &child_parent_iter);
459 g_return_if_fail (length > 0);
461 new_level = g_new (FilterLevel, 1);
462 new_level->array = g_array_sized_new (FALSE, FALSE,
465 new_level->ref_count = 0;
466 new_level->parent_elt = parent_elt;
467 new_level->parent_level = parent_level;
470 parent_elt->children = new_level;
472 filter->priv->root = new_level;
474 /* increase the count of zero ref_counts */
477 parent_elt->zero_ref_count++;
479 parent_elt = parent_level->parent_elt;
480 parent_level = parent_level->parent_level;
482 filter->priv->zero_ref_count++;
486 if (!new_level->parent_level)
487 filter->priv->root_level_visible = 0;
491 if (gtk_tree_model_filter_visible (filter, &iter))
493 FilterElt filter_elt;
495 filter_elt.offset = i;
496 filter_elt.zero_ref_count = 0;
497 filter_elt.ref_count = 0;
498 filter_elt.children = NULL;
499 filter_elt.visible = TRUE;
501 if (GTK_TREE_MODEL_FILTER_CACHE_CHILD_ITERS (filter))
502 filter_elt.iter = iter;
504 g_array_append_val (new_level->array, filter_elt);
506 if (!new_level->parent_level)
507 filter->priv->root_level_visible++;
511 while (gtk_tree_model_iter_next (filter->priv->child_model, &iter));
515 gtk_tree_model_filter_free_level (GtkTreeModelFilter *filter,
516 FilterLevel *filter_level)
520 g_assert (filter_level);
522 if (filter_level->ref_count == 0)
524 FilterLevel *parent_level = filter_level->parent_level;
525 FilterElt *parent_elt = filter_level->parent_elt;
530 parent_elt->zero_ref_count--;
534 parent_elt = parent_level->parent_elt;
535 parent_level = parent_level->parent_level;
538 while (parent_level);
539 filter->priv->zero_ref_count--;
542 for (i = 0; i < filter_level->array->len; i++)
544 if (g_array_index (filter_level->array, FilterElt, i).children)
545 gtk_tree_model_filter_free_level (filter,
546 FILTER_LEVEL (g_array_index (filter_level->array, FilterElt, i).children));
549 if (!filter_level->parent_level)
550 filter->priv->root_level_visible = 0;
552 if (filter_level->parent_elt)
553 filter_level->parent_elt->children = NULL;
555 filter->priv->root = NULL;
557 g_array_free (filter_level->array, TRUE);
558 filter_level->array = NULL;
560 g_free (filter_level);
565 gtk_tree_model_filter_elt_get_path (FilterLevel *level,
569 FilterLevel *walker = level;
570 FilterElt *walker2 = elt;
572 GtkTreePath *real_path;
574 g_return_val_if_fail (level != NULL, NULL);
575 g_return_val_if_fail (elt != NULL, NULL);
577 path = gtk_tree_path_new ();
581 gtk_tree_path_prepend_index (path, walker2->offset);
583 walker2 = walker->parent_elt;
584 walker = walker->parent_level;
589 real_path = gtk_tree_model_filter_add_root (path, root);
590 gtk_tree_path_free (path);
598 gtk_tree_model_filter_add_root (GtkTreePath *src,
604 retval = gtk_tree_path_copy (root);
606 for (i = 0; i < gtk_tree_path_get_depth (src); i++)
607 gtk_tree_path_append_index (retval, gtk_tree_path_get_indices (src)[i]);
613 gtk_tree_model_filter_remove_root (GtkTreePath *src,
621 if (gtk_tree_path_get_depth (src) <= gtk_tree_path_get_depth (root))
624 depth = gtk_tree_path_get_depth (src);
625 indices = gtk_tree_path_get_indices (src);
627 for (i = 0; i < gtk_tree_path_get_depth (root); i++)
628 if (indices[i] != gtk_tree_path_get_indices (root)[i])
631 retval = gtk_tree_path_new ();
633 for (; i < depth; i++)
634 gtk_tree_path_append_index (retval, indices[i]);
640 gtk_tree_model_filter_increment_stamp (GtkTreeModelFilter *filter)
644 filter->priv->stamp++;
646 while (filter->priv->stamp == 0);
648 gtk_tree_model_filter_clear_cache (filter);
652 gtk_tree_model_filter_visible (GtkTreeModelFilter *filter,
653 GtkTreeIter *child_iter)
655 if (filter->priv->visible_func)
657 return (filter->priv->visible_func (filter->priv->child_model,
659 filter->priv->visible_data));
661 else if (filter->priv->visible_column >= 0)
665 gtk_tree_model_get_value (filter->priv->child_model, child_iter,
666 filter->priv->visible_column, &val);
668 if (g_value_get_boolean (&val))
670 g_value_unset (&val);
674 g_value_unset (&val);
678 /* no filter thing set, so always visible */
683 gtk_tree_model_filter_clear_cache_helper (GtkTreeModelFilter *filter,
690 for (i = 0; i < level->array->len; i++)
692 if (g_array_index (level->array, FilterElt, i).zero_ref_count > 0)
693 gtk_tree_model_filter_clear_cache_helper (filter, g_array_index (level->array, FilterElt, i).children);
696 if (level->ref_count == 0 && level != filter->priv->root)
698 gtk_tree_model_filter_free_level (filter, level);
704 gtk_tree_model_filter_fetch_child (GtkTreeModelFilter *filter,
710 gint start, middle, end;
712 GtkTreePath *c_path = NULL;
714 GtkTreePath *c_parent_path = NULL;
715 GtkTreeIter c_parent_iter;
718 /* check if child exists and is visible */
719 if (level->parent_elt)
722 gtk_tree_model_filter_elt_get_path (level->parent_level,
724 filter->priv->virtual_root);
730 if (filter->priv->virtual_root)
731 c_parent_path = gtk_tree_path_copy (filter->priv->virtual_root);
733 c_parent_path = NULL;
738 gtk_tree_model_get_iter (filter->priv->child_model,
741 len = gtk_tree_model_iter_n_children (filter->priv->child_model,
744 c_path = gtk_tree_path_copy (c_parent_path);
745 gtk_tree_path_free (c_parent_path);
749 len = gtk_tree_model_iter_n_children (filter->priv->child_model, NULL);
750 c_path = gtk_tree_path_new ();
753 gtk_tree_path_append_index (c_path, offset);
754 gtk_tree_model_get_iter (filter->priv->child_model, &c_iter, c_path);
755 gtk_tree_path_free (c_path);
757 if (offset >= len || !gtk_tree_model_filter_visible (filter, &c_iter))
762 elt.zero_ref_count = 0;
765 /* visibility should be FALSE as we don't emit row_inserted */
768 if (GTK_TREE_MODEL_FILTER_CACHE_CHILD_ITERS (filter))
771 /* find index (binary search on offset) */
773 end = level->array->len;
779 middle = (start + end) / 2;
781 if (g_array_index (level->array, FilterElt, middle).offset <= offset)
787 if (g_array_index (level->array, FilterElt, middle).offset <= offset)
795 g_array_insert_val (level->array, i, elt);
798 for (i = MAX (--i, 0); i < level->array->len; i++)
800 FilterElt *e = &(g_array_index (level->array, FilterElt, i));
802 e->children->parent_elt = e;
805 return &g_array_index (level->array, FilterElt, *index);
809 gtk_tree_model_filter_remove_node (GtkTreeModelFilter *filter,
811 gboolean emit_signal)
813 FilterElt *elt, *parent;
814 FilterLevel *level, *parent_level;
815 gint offset, i, length, level_refcount;
817 /* FIXME: this function is very ugly. I need to rethink and
818 * rewrite it someday.
821 level = FILTER_LEVEL (iter->user_data);
822 elt = FILTER_ELT (iter->user_data2);
824 parent = level->parent_elt;
825 parent_level = level->parent_level;
826 length = level->array->len;
827 offset = elt->offset;
830 while (elt->ref_count > 0)
831 gtk_tree_model_filter_real_unref_node (GTK_TREE_MODEL (filter),
834 level_refcount = level->ref_count;
836 /* do the ref counting first! this touches the stamp */
841 path = gtk_tree_model_get_path (GTK_TREE_MODEL (filter), iter);
842 gtk_tree_model_filter_increment_stamp (filter);
843 gtk_tree_model_row_deleted (GTK_TREE_MODEL (filter), path);
844 gtk_tree_path_free (path);
847 if ((length == 1 || level_refcount == 0) &&
848 emit_signal && iter->user_data != filter->priv->root)
850 /* above code destroyed the level */
851 goto emit_has_child_toggled;
857 gtk_tree_model_filter_free_level (filter, level);
859 if (!filter->priv->root)
860 /* we killed the root */
867 /* remove the node */
868 tmp = bsearch_elt_with_offset (level->array, elt->offset, &i);
872 g_array_remove_index (level->array, i);
874 for (i = MAX (--i, 0); i < level->array->len; i++)
876 /* NOTE: here we do *not* decrease offsets, because the node was
877 * not removed from the child model
879 elt = &g_array_index (level->array, FilterElt, i);
881 elt->children->parent_elt = elt;
886 emit_has_child_toggled:
887 /* children are being handled first, so we can check it this way
889 * yes this if-statement is ugly
891 if ((parent && parent->children && parent->children->array->len <= 1) ||
892 (length == 1 && emit_signal && iter->user_data != filter->priv->root))
894 /* latest child has been removed, level has been destroyed */
898 piter.stamp = filter->priv->stamp;
899 piter.user_data = parent_level;
900 piter.user_data2 = parent;
902 ppath = gtk_tree_model_get_path (GTK_TREE_MODEL (filter), &piter);
904 gtk_tree_model_row_has_child_toggled (GTK_TREE_MODEL (filter),
906 gtk_tree_path_free (ppath);
911 gtk_tree_model_filter_update_childs (GtkTreeModelFilter *filter,
921 iter.stamp = filter->priv->stamp;
922 iter.user_data = level;
923 iter.user_data2 = elt;
925 gtk_tree_model_filter_convert_iter_to_child_iter (filter, &c_iter, &iter);
927 if (gtk_tree_model_iter_has_child (filter->priv->child_model, &c_iter))
929 GtkTreePath *path = gtk_tree_model_get_path (GTK_TREE_MODEL (filter),
931 gtk_tree_model_row_has_child_toggled (GTK_TREE_MODEL (filter),
935 gtk_tree_path_free (path);
940 bsearch_elt_with_offset (GArray *array,
944 gint start, middle, end;
955 elt = &g_array_index (array, FilterElt, 0);
957 if (elt->offset == offset)
968 middle = (start + end) / 2;
970 elt = &g_array_index (array, FilterElt, middle);
972 if (elt->offset < offset)
974 else if (elt->offset > offset)
980 if (elt->offset == offset)
989 /* TreeModel signals */
991 gtk_tree_model_filter_row_changed (GtkTreeModel *c_model,
996 GtkTreeModelFilter *filter = GTK_TREE_MODEL_FILTER (data);
999 GtkTreeIter real_c_iter;
1000 GtkTreePath *path = NULL;
1005 gboolean requested_state;
1006 gboolean current_state;
1007 gboolean free_c_path = FALSE;
1009 g_return_if_fail (c_path != NULL || c_iter != NULL);
1013 c_path = gtk_tree_model_get_path (c_model, c_iter);
1018 real_c_iter = *c_iter;
1020 gtk_tree_model_get_iter (c_model, &real_c_iter, c_path);
1022 /* is this node above the virtual root? */
1023 if (filter->priv->virtual_root
1024 && (gtk_tree_path_get_depth (filter->priv->virtual_root)
1025 >= gtk_tree_path_get_depth (c_path)))
1028 /* what's the requested state? */
1029 requested_state = gtk_tree_model_filter_visible (filter, &real_c_iter);
1031 /* now, let's see whether the item is there */
1032 path = gtk_real_tree_model_filter_convert_child_path_to_path (filter,
1039 gtk_tree_model_get_iter (GTK_TREE_MODEL (filter), &iter, path);
1040 current_state = FILTER_ELT (iter.user_data2)->visible;
1043 current_state = FALSE;
1045 if (current_state == FALSE && requested_state == FALSE)
1046 /* no changes required */
1049 if (current_state == TRUE && requested_state == FALSE)
1051 /* get rid of this node */
1052 gtk_tree_model_get_iter (GTK_TREE_MODEL (filter), &iter, path);
1053 gtk_tree_model_filter_remove_node (filter, &iter, TRUE);
1055 level = FILTER_LEVEL (iter.user_data);
1057 if (!level->parent_level)
1058 filter->priv->root_level_visible--;
1063 if (current_state == TRUE && requested_state == TRUE)
1065 /* progate the signal */
1066 gtk_tree_model_get_iter (GTK_TREE_MODEL (filter), &iter, path);
1067 gtk_tree_model_row_changed (GTK_TREE_MODEL (filter), path, &iter);
1069 level = FILTER_LEVEL (iter.user_data);
1070 elt = FILTER_ELT (iter.user_data2);
1072 /* and update the childs */
1073 if (gtk_tree_model_iter_children (c_model, &childs, &real_c_iter))
1074 gtk_tree_model_filter_update_childs (filter, level, elt);
1079 /* only current == FALSE and requested == TRUE is left,
1082 g_return_if_fail (current_state == FALSE && requested_state == TRUE);
1084 /* make sure the new item has been pulled in */
1085 if (!filter->priv->root)
1090 gtk_tree_model_filter_build_level (filter, NULL, NULL);
1092 root = FILTER_LEVEL (filter->priv->root);
1096 for (i = 0; i < root->array->len; i++)
1097 g_array_index (root->array, FilterElt, i).visible = FALSE;
1098 filter->priv->root_level_visible = 0;
1103 path = gtk_real_tree_model_filter_convert_child_path_to_path (filter,
1108 g_return_if_fail (path != NULL);
1110 gtk_tree_model_filter_increment_stamp (filter);
1111 gtk_tree_model_get_iter (GTK_TREE_MODEL (filter), &iter, path);
1113 level = FILTER_LEVEL (iter.user_data);
1114 elt = FILTER_ELT (iter.user_data2);
1116 elt->visible = TRUE;
1118 if (!level->parent_level)
1119 filter->priv->root_level_visible++;
1122 gtk_tree_model_row_inserted (GTK_TREE_MODEL (filter), path, &iter);
1124 if (gtk_tree_model_iter_children (c_model, &childs, c_iter))
1125 gtk_tree_model_filter_update_childs (filter, level, elt);
1129 gtk_tree_path_free (path);
1132 gtk_tree_path_free (c_path);
1136 gtk_tree_model_filter_row_inserted (GtkTreeModel *c_model,
1137 GtkTreePath *c_path,
1138 GtkTreeIter *c_iter,
1141 GtkTreeModelFilter *filter = GTK_TREE_MODEL_FILTER (data);
1143 GtkTreePath *real_path;
1146 GtkTreeIter real_c_iter;
1150 FilterLevel *parent_level;
1152 gint i = 0, offset, index = -1;
1154 gboolean free_c_path = FALSE;
1156 g_return_if_fail (c_path != NULL || c_iter != NULL);
1160 c_path = gtk_tree_model_get_path (c_model, c_iter);
1165 real_c_iter = *c_iter;
1167 gtk_tree_model_get_iter (c_model, &real_c_iter, c_path);
1169 /* the row has already been inserted. so we need to fixup the
1170 * virtual root here first
1172 if (filter->priv->virtual_root)
1174 if (gtk_tree_path_get_depth (filter->priv->virtual_root) >=
1175 gtk_tree_path_get_depth (c_path))
1178 gint *v_indices, *c_indices;
1180 level = gtk_tree_path_get_depth (c_path) - 1;
1181 v_indices = gtk_tree_path_get_indices (filter->priv->virtual_root);
1182 c_indices = gtk_tree_path_get_indices (c_path);
1184 if (v_indices[level] >= c_indices[level])
1185 (v_indices[level])++;
1189 if (!filter->priv->root)
1191 gtk_tree_model_filter_build_level (filter, NULL, NULL);
1192 /* that already put the inserted iter in the level */
1197 parent_level = level = FILTER_LEVEL (filter->priv->root);
1199 /* subtract virtual root if necessary */
1200 if (filter->priv->virtual_root)
1202 real_path = gtk_tree_model_filter_remove_root (c_path,
1203 filter->priv->virtual_root);
1209 real_path = gtk_tree_path_copy (c_path);
1211 if (gtk_tree_path_get_depth (real_path) - 1 >= 1)
1213 /* find the parent level */
1214 while (i < gtk_tree_path_get_depth (real_path) - 1)
1219 /* we don't cover this signal */
1222 elt = bsearch_elt_with_offset (level->array,
1223 gtk_tree_path_get_indices (real_path)[i],
1227 /* parent is probably being filtered out */
1232 GtkTreePath *tmppath;
1233 GtkTreeIter tmpiter;
1235 tmpiter.stamp = filter->priv->stamp;
1236 tmpiter.user_data = level;
1237 tmpiter.user_data2 = elt;
1239 tmppath = gtk_tree_model_get_path (GTK_TREE_MODEL (data),
1244 gtk_tree_model_row_has_child_toggled (GTK_TREE_MODEL (data),
1246 gtk_tree_path_free (tmppath);
1249 /* not covering this signal */
1253 level = elt->children;
1254 parent_level = level;
1262 /* let's try to insert the value */
1263 offset = gtk_tree_path_get_indices (real_path)[gtk_tree_path_get_depth (real_path) - 1];
1265 /* update the offsets, yes if we didn't insert the node above, there will
1266 * be a gap here. This will be filled with the node (via fetch_child) when
1267 * it becomes visible
1269 for (i = 0; i < level->array->len; i++)
1271 FilterElt *e = &g_array_index (level->array, FilterElt, i);
1272 if ((e->offset >= offset))
1276 /* only insert when visible */
1277 if (gtk_tree_model_filter_visible (filter, &real_c_iter))
1281 if (GTK_TREE_MODEL_FILTER_CACHE_CHILD_ITERS (filter))
1282 felt.iter = real_c_iter;
1284 felt.offset = offset;
1285 felt.zero_ref_count = 0;
1287 felt.visible = TRUE;
1288 felt.children = NULL;
1290 for (i = 0; i < level->array->len; i++)
1291 if (g_array_index (level->array, FilterElt, i).offset > offset)
1294 g_array_insert_val (level->array, i, felt);
1297 if (!level->parent_level)
1298 filter->priv->root_level_visible++;
1301 /* another iteration to update the references of childs to parents. */
1302 for (i = 0; i < level->array->len; i++)
1304 FilterElt *e = &g_array_index (level->array, FilterElt, i);
1306 e->children->parent_elt = e;
1309 /* don't emit the signal if we aren't visible */
1310 if (!gtk_tree_model_filter_visible (filter, &real_c_iter))
1314 /* NOTE: pass c_path here and NOT real_path. This function does
1315 * root subtraction itself
1317 path = gtk_real_tree_model_filter_convert_child_path_to_path (filter,
1324 gtk_tree_model_filter_increment_stamp (filter);
1326 gtk_tree_model_get_iter (GTK_TREE_MODEL (data), &iter, path);
1327 gtk_tree_model_row_inserted (GTK_TREE_MODEL (data), path, &iter);
1331 gtk_tree_path_free (c_path);
1335 gtk_tree_model_filter_row_has_child_toggled (GtkTreeModel *c_model,
1336 GtkTreePath *c_path,
1337 GtkTreeIter *c_iter,
1340 GtkTreeModelFilter *filter = GTK_TREE_MODEL_FILTER (data);
1344 g_return_if_fail (c_path != NULL && c_iter != NULL);
1346 /* FIXME: does this code work? */
1348 if (!gtk_tree_model_filter_visible (filter, c_iter))
1351 path = gtk_real_tree_model_filter_convert_child_path_to_path (filter,
1358 gtk_tree_model_get_iter (GTK_TREE_MODEL (data), &iter, path);
1359 gtk_tree_model_row_has_child_toggled (GTK_TREE_MODEL (data), path, &iter);
1361 gtk_tree_path_free (path);
1365 gtk_tree_model_filter_row_deleted (GtkTreeModel *c_model,
1366 GtkTreePath *c_path,
1369 GtkTreeModelFilter *filter = GTK_TREE_MODEL_FILTER (data);
1375 gboolean emit_signal = TRUE;
1378 g_return_if_fail (c_path != NULL);
1380 /* special case the deletion of an ancestor of the virtual root */
1381 if (filter->priv->virtual_root &&
1382 (gtk_tree_path_is_ancestor (c_path, filter->priv->virtual_root) ||
1383 !gtk_tree_path_compare (c_path, filter->priv->virtual_root)))
1387 FilterLevel *level = FILTER_LEVEL (filter->priv->root);
1392 /* remove everything in the filter model
1394 * For now, we just iterate over the root level and emit a
1395 * row_deleted for each FilterElt. Not sure if this is correct.
1398 gtk_tree_model_filter_increment_stamp (filter);
1399 path = gtk_tree_path_new ();
1400 gtk_tree_path_append_index (path, 0);
1402 for (i = 0; i < level->array->len; i++)
1403 gtk_tree_model_row_deleted (GTK_TREE_MODEL (data), path);
1405 gtk_tree_path_free (path);
1406 gtk_tree_model_filter_free_level (filter, filter->priv->root);
1411 /* fixup virtual root */
1412 if (filter->priv->virtual_root)
1414 if (gtk_tree_path_get_depth (filter->priv->virtual_root) >=
1415 gtk_tree_path_get_depth (c_path))
1418 gint *v_indices, *c_indices;
1420 level = gtk_tree_path_get_depth (c_path) - 1;
1421 v_indices = gtk_tree_path_get_indices (filter->priv->virtual_root);
1422 c_indices = gtk_tree_path_get_indices (c_path);
1424 if (v_indices[level] > c_indices[level])
1425 (v_indices[level])--;
1429 path = gtk_real_tree_model_filter_convert_child_path_to_path (filter,
1435 path = gtk_real_tree_model_filter_convert_child_path_to_path (filter,
1442 /* fixup the offsets */
1443 GtkTreePath *real_path;
1445 if (!filter->priv->root)
1448 level = FILTER_LEVEL (filter->priv->root);
1450 /* subtract vroot if necessary */
1451 if (filter->priv->virtual_root)
1453 real_path = gtk_tree_model_filter_remove_root (c_path,
1454 filter->priv->virtual_root);
1455 /* we don't handle this */
1460 real_path = gtk_tree_path_copy (c_path);
1463 if (gtk_tree_path_get_depth (real_path) - 1 >= 1)
1465 while (i < gtk_tree_path_get_depth (real_path) - 1)
1471 /* we don't cover this */
1472 gtk_tree_path_free (real_path);
1476 elt = bsearch_elt_with_offset (level->array,
1477 gtk_tree_path_get_indices (real_path)[i],
1480 if (!elt || !elt->children)
1482 /* parent is filtered out, so no level */
1483 gtk_tree_path_free (real_path);
1487 level = elt->children;
1492 offset = gtk_tree_path_get_indices (real_path)[gtk_tree_path_get_depth (real_path) - 1];
1493 gtk_tree_path_free (real_path);
1499 * - the offset of the removed item
1502 for (i = 0; i < level->array->len; i++)
1504 elt = &g_array_index (level->array, FilterElt, i);
1505 if (elt->offset > offset)
1508 elt->children->parent_elt = elt;
1514 emit_signal = FALSE;
1517 gtk_tree_model_get_iter (GTK_TREE_MODEL (data), &iter, path);
1519 level = FILTER_LEVEL (iter.user_data);
1520 elt = FILTER_ELT (iter.user_data2);
1521 offset = elt->offset;
1523 if (!level->parent_level && elt->visible)
1524 filter->priv->root_level_visible--;
1528 if (level->ref_count == 0 && level != filter->priv->root)
1530 gtk_tree_model_filter_increment_stamp (filter);
1531 gtk_tree_model_row_deleted (GTK_TREE_MODEL (data), path);
1533 gtk_tree_path_free (path);
1537 gtk_tree_model_filter_increment_stamp (filter);
1538 gtk_tree_model_row_deleted (GTK_TREE_MODEL (data), path);
1539 iter.stamp = filter->priv->stamp;
1541 while (elt->ref_count > 0)
1542 gtk_tree_model_filter_real_unref_node (GTK_TREE_MODEL (data), &iter,
1546 if (level->array->len == 1)
1549 gtk_tree_model_filter_free_level (filter, level);
1555 /* remove the row */
1556 tmp = bsearch_elt_with_offset (level->array, elt->offset, &i);
1558 offset = tmp->offset;
1559 g_array_remove_index (level->array, i);
1561 for (i = MAX (--i, 0); i < level->array->len; i++)
1563 elt = &g_array_index (level->array, FilterElt, i);
1564 if (elt->offset > offset)
1567 elt->children->parent_elt = elt;
1571 gtk_tree_path_free (path);
1575 gtk_tree_model_filter_rows_reordered (GtkTreeModel *c_model,
1576 GtkTreePath *c_path,
1577 GtkTreeIter *c_iter,
1583 GtkTreeModelFilter *filter = GTK_TREE_MODEL_FILTER (data);
1589 gint i, j, elt_count;
1594 g_return_if_fail (new_order != NULL);
1596 if (c_path == NULL || gtk_tree_path_get_indices (c_path) == NULL)
1598 if (!filter->priv->root)
1601 length = gtk_tree_model_iter_n_children (c_model, NULL);
1603 if (filter->priv->virtual_root)
1607 /* reorder root level of path */
1608 for (i = 0; i < length; i++)
1609 if (new_order[i] == gtk_tree_path_get_indices (filter->priv->virtual_root)[0])
1615 gtk_tree_path_get_indices (filter->priv->virtual_root)[0] = new_pos;
1619 path = gtk_tree_path_new ();
1620 level = FILTER_LEVEL (filter->priv->root);
1624 GtkTreeIter child_iter;
1626 /* virtual root anchor reordering */
1627 if (filter->priv->virtual_root &&
1628 gtk_tree_path_get_depth (c_path) <
1629 gtk_tree_path_get_depth (filter->priv->virtual_root))
1634 GtkTreeIter real_c_iter;
1636 level = gtk_tree_path_get_depth (c_path);
1639 real_c_iter = *c_iter;
1641 gtk_tree_model_get_iter (c_model, &real_c_iter, c_path);
1643 length = gtk_tree_model_iter_n_children (c_model, &real_c_iter);
1645 for (i = 0; i < length; i++)
1646 if (new_order[i] == gtk_tree_path_get_indices (filter->priv->virtual_root)[level])
1652 gtk_tree_path_get_indices (filter->priv->virtual_root)[level] = new_pos;
1656 path = gtk_real_tree_model_filter_convert_child_path_to_path (filter,
1660 if (!path && filter->priv->virtual_root &&
1661 gtk_tree_path_compare (c_path, filter->priv->virtual_root))
1664 if (!path && !filter->priv->virtual_root)
1669 /* root level mode */
1671 gtk_tree_model_get_iter (c_model, c_iter, c_path);
1672 length = gtk_tree_model_iter_n_children (c_model, c_iter);
1673 path = gtk_tree_path_new ();
1674 level = FILTER_LEVEL (filter->priv->root);
1678 gtk_tree_model_get_iter (GTK_TREE_MODEL (data), &iter, path);
1680 level = FILTER_LEVEL (iter.user_data);
1681 elt = FILTER_ELT (iter.user_data2);
1685 gtk_tree_path_free (path);
1689 level = elt->children;
1691 gtk_tree_model_filter_convert_iter_to_child_iter (GTK_TREE_MODEL_FILTER (filter), &child_iter, &iter);
1692 length = gtk_tree_model_iter_n_children (c_model, &child_iter);
1696 if (level->array->len < 1)
1699 /* NOTE: we do not bail out here if level->array->len < 2 like
1700 * GtkTreeModelSort does. This because we do some special tricky
1704 /* construct a new array */
1705 new_array = g_array_sized_new (FALSE, FALSE, sizeof (FilterElt),
1707 tmp_array = g_new (gint, level->array->len);
1709 for (i = 0, elt_count = 0; i < length; i++)
1711 FilterElt *e = NULL;
1712 gint old_offset = -1;
1714 for (j = 0; j < level->array->len; j++)
1715 if (g_array_index (level->array, FilterElt, j).offset == new_order[i])
1717 e = &g_array_index (level->array, FilterElt, j);
1725 tmp_array[elt_count] = old_offset;
1726 g_array_append_val (new_array, *e);
1727 g_array_index (new_array, FilterElt, elt_count).offset = i;
1731 g_array_free (level->array, TRUE);
1732 level->array = new_array;
1735 for (i = 0; i < level->array->len; i++)
1737 FilterElt *e = &g_array_index (level->array, FilterElt, i);
1739 e->children->parent_elt = e;
1742 /* emit rows_reordered */
1743 if (!gtk_tree_path_get_indices (path))
1744 gtk_tree_model_rows_reordered (GTK_TREE_MODEL (data), path, NULL,
1747 gtk_tree_model_rows_reordered (GTK_TREE_MODEL (data), path, &iter,
1752 gtk_tree_path_free (path);
1755 /* TreeModelIface implementation */
1757 gtk_tree_model_filter_get_flags (GtkTreeModel *model)
1759 g_return_val_if_fail (GTK_IS_TREE_MODEL_FILTER (model), 0);
1765 gtk_tree_model_filter_get_n_columns (GtkTreeModel *model)
1767 GtkTreeModelFilter *filter = (GtkTreeModelFilter *)model;
1769 g_return_val_if_fail (GTK_IS_TREE_MODEL_FILTER (model), 0);
1770 g_return_val_if_fail (filter->priv->child_model != NULL, 0);
1772 if (filter->priv->child_model == NULL)
1775 /* so we can't modify the modify func after this ... */
1776 filter->priv->modify_func_set = TRUE;
1778 if (filter->priv->modify_n_columns > 0)
1779 return filter->priv->modify_n_columns;
1781 return gtk_tree_model_get_n_columns (filter->priv->child_model);
1785 gtk_tree_model_filter_get_column_type (GtkTreeModel *model,
1788 GtkTreeModelFilter *filter = (GtkTreeModelFilter *)model;
1790 g_return_val_if_fail (GTK_IS_TREE_MODEL_FILTER (model), G_TYPE_INVALID);
1791 g_return_val_if_fail (filter->priv->child_model != NULL, G_TYPE_INVALID);
1793 /* so we can't modify the modify func after this ... */
1794 filter->priv->modify_func_set = TRUE;
1796 if (filter->priv->modify_types)
1798 g_return_val_if_fail (index < filter->priv->modify_n_columns, G_TYPE_INVALID);
1800 return filter->priv->modify_types[index];
1803 return gtk_tree_model_get_column_type (filter->priv->child_model, index);
1807 gtk_tree_model_filter_get_iter (GtkTreeModel *model,
1811 GtkTreeModelFilter *filter = (GtkTreeModelFilter *)model;
1816 g_return_val_if_fail (GTK_IS_TREE_MODEL_FILTER (model), FALSE);
1817 g_return_val_if_fail (filter->priv->child_model != NULL, FALSE);
1819 indices = gtk_tree_path_get_indices (path);
1821 if (filter->priv->root == NULL)
1822 gtk_tree_model_filter_build_level (filter, NULL, NULL);
1823 level = FILTER_LEVEL (filter->priv->root);
1825 depth = gtk_tree_path_get_depth (path);
1832 for (i = 0; i < depth - 1; i++)
1834 if (!level || indices[i] >= level->array->len)
1839 if (!g_array_index (level->array, FilterElt, indices[i]).children)
1840 gtk_tree_model_filter_build_level (filter, level,
1841 &g_array_index (level->array,
1844 level = g_array_index (level->array, FilterElt, indices[i]).children;
1847 if (!level || indices[i] >= level->array->len)
1853 iter->stamp = filter->priv->stamp;
1854 iter->user_data = level;
1855 iter->user_data2 = &g_array_index (level->array, FilterElt,
1856 indices[depth - 1]);
1861 static GtkTreePath *
1862 gtk_tree_model_filter_get_path (GtkTreeModel *model,
1865 GtkTreePath *retval;
1869 g_return_val_if_fail (GTK_IS_TREE_MODEL_FILTER (model), NULL);
1870 g_return_val_if_fail (GTK_TREE_MODEL_FILTER (model)->priv->child_model != NULL, NULL);
1871 g_return_val_if_fail (GTK_TREE_MODEL_FILTER (model)->priv->stamp == iter->stamp, NULL);
1873 retval = gtk_tree_path_new ();
1874 level = iter->user_data;
1875 elt = iter->user_data2;
1879 gtk_tree_path_prepend_index (retval,
1880 elt - FILTER_ELT (level->array->data));
1881 elt = level->parent_elt;
1882 level = level->parent_level;
1889 gtk_tree_model_filter_get_value (GtkTreeModel *model,
1894 GtkTreeIter child_iter;
1895 GtkTreeModelFilter *filter = GTK_TREE_MODEL_FILTER (model);
1897 g_return_if_fail (GTK_IS_TREE_MODEL_FILTER (model));
1898 g_return_if_fail (GTK_TREE_MODEL_FILTER (model)->priv->child_model != NULL);
1899 g_return_if_fail (GTK_TREE_MODEL_FILTER (model)->priv->stamp == iter->stamp);
1901 if (filter->priv->modify_func)
1903 g_return_if_fail (column < filter->priv->modify_n_columns);
1905 g_value_init (value, filter->priv->modify_types[column]);
1906 filter->priv->modify_func (model,
1910 filter->priv->modify_data);
1915 gtk_tree_model_filter_convert_iter_to_child_iter (GTK_TREE_MODEL_FILTER (model), &child_iter, iter);
1916 gtk_tree_model_get_value (GTK_TREE_MODEL_FILTER (model)->priv->child_model,
1917 &child_iter, column, value);
1921 gtk_tree_model_filter_iter_next (GtkTreeModel *model,
1927 g_return_val_if_fail (GTK_IS_TREE_MODEL_FILTER (model), FALSE);
1928 g_return_val_if_fail (GTK_TREE_MODEL_FILTER (model)->priv->child_model != NULL, FALSE);
1929 g_return_val_if_fail (GTK_TREE_MODEL_FILTER (model)->priv->stamp == iter->stamp, FALSE);
1931 level = iter->user_data;
1932 elt = iter->user_data2;
1934 if (elt - FILTER_ELT (level->array->data) >= level->array->len - 1)
1940 iter->user_data2 = elt + 1;
1946 gtk_tree_model_filter_iter_children (GtkTreeModel *model,
1948 GtkTreeIter *parent)
1950 GtkTreeModelFilter *filter = (GtkTreeModelFilter *)model;
1954 g_return_val_if_fail (GTK_IS_TREE_MODEL_FILTER (model), FALSE);
1955 g_return_val_if_fail (filter->priv->child_model != NULL, FALSE);
1957 g_return_val_if_fail (filter->priv->stamp == parent->stamp, FALSE);
1961 if (!filter->priv->root)
1962 gtk_tree_model_filter_build_level (filter, NULL, NULL);
1963 if (!filter->priv->root)
1966 level = filter->priv->root;
1967 iter->stamp = filter->priv->stamp;
1968 iter->user_data = level;
1969 iter->user_data2 = level->array->data;
1973 if (FILTER_ELT (parent->user_data2)->children == NULL)
1974 gtk_tree_model_filter_build_level (filter,
1975 FILTER_LEVEL (parent->user_data),
1976 FILTER_ELT (parent->user_data2));
1977 if (FILTER_ELT (parent->user_data2)->children == NULL)
1981 if (FILTER_ELT (parent->user_data2)->children->array->len <= 0)
1984 iter->stamp = filter->priv->stamp;
1985 iter->user_data = FILTER_ELT (parent->user_data2)->children;
1986 iter->user_data2 = FILTER_LEVEL (iter->user_data)->array->data;
1993 gtk_tree_model_filter_iter_has_child (GtkTreeModel *model,
1996 GtkTreeIter child_iter;
1997 GtkTreeModelFilter *filter = (GtkTreeModelFilter *)model;
2000 g_return_val_if_fail (GTK_IS_TREE_MODEL_FILTER (model), FALSE);
2001 g_return_val_if_fail (filter->priv->child_model != NULL, FALSE);
2002 g_return_val_if_fail (filter->priv->stamp == iter->stamp, FALSE);
2004 filter = GTK_TREE_MODEL_FILTER (model);
2006 gtk_tree_model_filter_convert_iter_to_child_iter (GTK_TREE_MODEL_FILTER (model), &child_iter, iter);
2007 elt = FILTER_ELT (iter->user_data2);
2009 /* we need to build the level to check if not all children are filtered
2013 && gtk_tree_model_iter_has_child (filter->priv->child_model, &child_iter))
2014 gtk_tree_model_filter_build_level (filter, FILTER_LEVEL (iter->user_data),
2017 /* FIXME: we should prolly count the visible nodes here, just like in
2020 if (elt->children && elt->children->array->len > 0)
2027 gtk_tree_model_filter_iter_n_children (GtkTreeModel *model,
2030 GtkTreeIter child_iter;
2031 GtkTreeModelFilter *filter = (GtkTreeModelFilter *)model;
2034 g_return_val_if_fail (GTK_IS_TREE_MODEL_FILTER (model), 0);
2035 g_return_val_if_fail (filter->priv->child_model != NULL, 0);
2037 g_return_val_if_fail (filter->priv->stamp == iter->stamp, 0);
2041 if (!filter->priv->root)
2042 gtk_tree_model_filter_build_level (filter, NULL, NULL);
2044 /* count visible nodes */
2045 return filter->priv->root_level_visible;
2048 elt = FILTER_ELT (iter->user_data2);
2049 gtk_tree_model_filter_convert_iter_to_child_iter (GTK_TREE_MODEL_FILTER (model), &child_iter, iter);
2051 if (!elt->children &&
2052 gtk_tree_model_iter_has_child (filter->priv->child_model, &child_iter))
2053 gtk_tree_model_filter_build_level (filter,
2054 FILTER_LEVEL (iter->user_data),
2057 if (elt->children && elt->children->array->len)
2061 GArray *a = elt->children->array;
2063 /* count visible nodes */
2064 for (i = 0; i < a->len; i++)
2065 if (g_array_index (a, FilterElt, i).visible)
2075 gtk_tree_model_filter_iter_nth_child (GtkTreeModel *model,
2077 GtkTreeIter *parent,
2081 GtkTreeIter children;
2083 g_return_val_if_fail (GTK_IS_TREE_MODEL_FILTER (model), FALSE);
2085 g_return_val_if_fail (GTK_TREE_MODEL_FILTER (model)->priv->stamp == parent->stamp, FALSE);
2087 /* use this instead of has_Child to force us to build the level, if needed */
2088 if (gtk_tree_model_filter_iter_children (model, &children, parent) == FALSE)
2094 level = children.user_data;
2095 if (n >= level->array->len)
2101 iter->stamp = GTK_TREE_MODEL_FILTER (model)->priv->stamp;
2102 iter->user_data = level;
2103 iter->user_data2 = &g_array_index (level->array, FilterElt, n);
2109 gtk_tree_model_filter_iter_parent (GtkTreeModel *model,
2116 g_return_val_if_fail (GTK_IS_TREE_MODEL_FILTER (model), FALSE);
2117 g_return_val_if_fail (GTK_TREE_MODEL_FILTER (model)->priv->child_model != NULL, FALSE);
2118 g_return_val_if_fail (GTK_TREE_MODEL_FILTER (model)->priv->stamp == child->stamp, FALSE);
2120 level = child->user_data;
2122 if (level->parent_level)
2124 iter->stamp = GTK_TREE_MODEL_FILTER (model)->priv->stamp;
2125 iter->user_data = level->parent_level;
2126 iter->user_data2 = level->parent_elt;
2135 gtk_tree_model_filter_ref_node (GtkTreeModel *model,
2138 GtkTreeModelFilter *filter = (GtkTreeModelFilter *)model;
2139 GtkTreeIter child_iter;
2143 g_return_if_fail (GTK_IS_TREE_MODEL_FILTER (model));
2144 g_return_if_fail (GTK_TREE_MODEL_FILTER (model)->priv->child_model != NULL);
2145 g_return_if_fail (GTK_TREE_MODEL_FILTER (model)->priv->stamp == iter->stamp);
2147 gtk_tree_model_filter_convert_iter_to_child_iter (GTK_TREE_MODEL_FILTER (model), &child_iter, iter);
2149 gtk_tree_model_ref_node (filter->priv->child_model, &child_iter);
2151 level = iter->user_data;
2152 elt = iter->user_data2;
2156 if (level->ref_count == 1)
2158 FilterLevel *parent_level = level->parent_level;
2159 FilterElt *parent_elt = level->parent_elt;
2161 /* we were at zero -- time to decrease the zero_ref_count val */
2165 parent_elt->zero_ref_count--;
2169 parent_elt = parent_level->parent_elt;
2170 parent_level = parent_level->parent_level;
2173 while (parent_level);
2174 filter->priv->zero_ref_count--;
2179 gtk_tree_model_filter_unref_node (GtkTreeModel *model,
2182 gtk_tree_model_filter_real_unref_node (model, iter, TRUE);
2186 gtk_tree_model_filter_real_unref_node (GtkTreeModel *model,
2188 gboolean propagate_unref)
2190 GtkTreeModelFilter *filter = (GtkTreeModelFilter *)model;
2194 g_return_if_fail (GTK_IS_TREE_MODEL_FILTER (model));
2195 g_return_if_fail (filter->priv->child_model != NULL);
2196 g_return_if_fail (filter->priv->stamp == iter->stamp);
2198 if (propagate_unref)
2200 GtkTreeIter child_iter;
2201 gtk_tree_model_filter_convert_iter_to_child_iter (GTK_TREE_MODEL_FILTER (model), &child_iter, iter);
2202 gtk_tree_model_unref_node (filter->priv->child_model, &child_iter);
2205 level = iter->user_data;
2206 elt = iter->user_data2;
2208 g_return_if_fail (elt->ref_count > 0);
2212 if (level->ref_count == 0)
2214 FilterLevel *parent_level = level->parent_level;
2215 FilterElt *parent_elt = level->parent_elt;
2217 /* we are at zero -- time to increase the zero_ref_count val */
2218 while (parent_level)
2220 parent_elt->zero_ref_count++;
2222 parent_elt = parent_level->parent_elt;
2223 parent_level = parent_level->parent_level;
2225 filter->priv->zero_ref_count++;
2229 /* bits and pieces */
2231 gtk_tree_model_filter_set_model (GtkTreeModelFilter *filter,
2232 GtkTreeModel *child_model)
2234 g_return_if_fail (GTK_IS_TREE_MODEL_FILTER (filter));
2236 if (filter->priv->child_model)
2238 g_signal_handler_disconnect (G_OBJECT (filter->priv->child_model),
2239 filter->priv->changed_id);
2240 g_signal_handler_disconnect (G_OBJECT (filter->priv->child_model),
2241 filter->priv->inserted_id);
2242 g_signal_handler_disconnect (G_OBJECT (filter->priv->child_model),
2243 filter->priv->has_child_toggled_id);
2244 g_signal_handler_disconnect (G_OBJECT (filter->priv->child_model),
2245 filter->priv->deleted_id);
2246 g_signal_handler_disconnect (G_OBJECT (filter->priv->child_model),
2247 filter->priv->reordered_id);
2249 /* reset our state */
2250 if (filter->priv->root)
2251 gtk_tree_model_filter_free_level (filter, filter->priv->root);
2253 filter->priv->root = NULL;
2254 g_object_unref (G_OBJECT (filter->priv->child_model));
2255 filter->priv->visible_column = -1;
2256 /* FIXME: destroy more crack here? the funcs? */
2259 filter->priv->child_model = child_model;
2263 g_object_ref (G_OBJECT (filter->priv->child_model));
2264 filter->priv->changed_id =
2265 g_signal_connect (child_model, "row_changed",
2266 G_CALLBACK (gtk_tree_model_filter_row_changed),
2268 filter->priv->inserted_id =
2269 g_signal_connect (child_model, "row_inserted",
2270 G_CALLBACK (gtk_tree_model_filter_row_inserted),
2272 filter->priv->has_child_toggled_id =
2273 g_signal_connect (child_model, "row_has_child_toggled",
2274 G_CALLBACK (gtk_tree_model_filter_row_has_child_toggled),
2276 filter->priv->deleted_id =
2277 g_signal_connect (child_model, "row_deleted",
2278 G_CALLBACK (gtk_tree_model_filter_row_deleted),
2280 filter->priv->reordered_id =
2281 g_signal_connect (child_model, "rows_reordered",
2282 G_CALLBACK (gtk_tree_model_filter_rows_reordered),
2285 filter->priv->child_flags = gtk_tree_model_get_flags (child_model);
2286 filter->priv->stamp = g_random_int ();
2291 gtk_tree_model_filter_set_root (GtkTreeModelFilter *filter,
2294 g_return_if_fail (GTK_IS_TREE_MODEL_FILTER (filter));
2297 filter->priv->virtual_root = NULL;
2299 filter->priv->virtual_root = gtk_tree_path_copy (root);
2305 * gtk_tree_model_filter_new:
2306 * @child_model: A #GtkTreeModel.
2307 * @root: A #GtkTreePath or %NULL.
2309 * Creates a new #GtkTreeModel, with @child_model as the child_model
2310 * and @root as the virtual root.
2312 * Return value: A new #GtkTreeModel.
2317 gtk_tree_model_filter_new (GtkTreeModel *child_model,
2320 GtkTreeModel *retval;
2322 g_return_val_if_fail (GTK_IS_TREE_MODEL (child_model), NULL);
2324 retval = GTK_TREE_MODEL (g_object_new (gtk_tree_model_filter_get_type (), NULL));
2326 gtk_tree_model_filter_set_model (GTK_TREE_MODEL_FILTER (retval),
2328 gtk_tree_model_filter_set_root (GTK_TREE_MODEL_FILTER (retval), root);
2334 * gtk_tree_model_filter_get_model:
2335 * @filter: A #GtkTreeModelFilter.
2337 * Returns a pointer to the child model of @filter.
2339 * Return value: A pointer to a #GtkTreeModel.
2344 gtk_tree_model_filter_get_model (GtkTreeModelFilter *filter)
2346 g_return_val_if_fail (GTK_IS_TREE_MODEL_FILTER (filter), NULL);
2348 return filter->priv->child_model;
2352 * gtk_tree_model_filter_set_visible_func:
2353 * @filter: A #GtkTreeModelFilter.
2354 * @func: A #GtkTreeModelFilterVisibleFunc, the visible function.
2355 * @data: User data to pass to the visible function, or %NULL.
2356 * @destroy: Destroy notifier of @data, or %NULL.
2358 * Sets the visible function used when filtering the @filter to be @func. The
2359 * function should return %TRUE if the given row should be visible and
2365 gtk_tree_model_filter_set_visible_func (GtkTreeModelFilter *filter,
2366 GtkTreeModelFilterVisibleFunc func,
2368 GtkDestroyNotify destroy)
2370 g_return_if_fail (GTK_IS_TREE_MODEL_FILTER (filter));
2371 g_return_if_fail (func != NULL);
2372 g_return_if_fail (filter->priv->visible_method_set == FALSE);
2374 if (filter->priv->visible_func)
2376 GtkDestroyNotify d = filter->priv->visible_destroy;
2378 filter->priv->visible_destroy = NULL;
2379 d (filter->priv->visible_data);
2382 filter->priv->visible_func = func;
2383 filter->priv->visible_data = data;
2384 filter->priv->visible_destroy = destroy;
2386 filter->priv->visible_method_set = TRUE;
2390 * gtk_tree_model_filter_set_modify_func:
2391 * @filter: A #GtkTreeModelFilter.
2392 * @n_columns: The number of columns in the filter model.
2393 * @types: The #GType<!-- -->s of the columns.
2394 * @func: A #GtkTreeModelFilterModifyFunc, or %NULL.
2395 * @data: User data to pass to the modify function, or %NULL.
2396 * @destroy: Destroy notifier of @data, or %NULL.
2398 * Sets the @filter to have @n_columns columns with @types. If @func
2399 * is not %NULL, it will set @func to be the modify function of @filter.
2404 gtk_tree_model_filter_set_modify_func (GtkTreeModelFilter *filter,
2407 GtkTreeModelFilterModifyFunc func,
2409 GtkDestroyNotify destroy)
2411 g_return_if_fail (GTK_IS_TREE_MODEL_FILTER (filter));
2412 g_return_if_fail (func != NULL);
2413 g_return_if_fail (filter->priv->modify_func_set == FALSE);
2415 if (filter->priv->modify_destroy)
2417 GtkDestroyNotify d = filter->priv->modify_destroy;
2419 filter->priv->modify_destroy = NULL;
2420 d (filter->priv->modify_data);
2423 filter->priv->modify_n_columns = n_columns;
2424 filter->priv->modify_types = g_new0 (GType, n_columns);
2425 memcpy (filter->priv->modify_types, types, sizeof (GType) * n_columns);
2426 filter->priv->modify_func = func;
2427 filter->priv->modify_data = data;
2428 filter->priv->modify_destroy = destroy;
2430 filter->priv->modify_func_set = TRUE;
2434 * gtk_tree_model_filter_set_visible_column:
2435 * @filter: A #GtkTreeModelFilter.
2436 * @column: A #gint which is the column containing the visible information.
2438 * Sets @column of the child_model to be the column where @filter should
2439 * look for visibility information. @columns should be a column of type
2440 * %G_TYPE_BOOLEAN, where %TRUE means that a row is visible, and %FALSE
2446 gtk_tree_model_filter_set_visible_column (GtkTreeModelFilter *filter,
2449 g_return_if_fail (GTK_IS_TREE_MODEL_FILTER (filter));
2450 g_return_if_fail (column >= 0);
2451 g_return_if_fail (filter->priv->visible_method_set == FALSE);
2453 filter->priv->visible_column = column;
2455 filter->priv->visible_method_set = TRUE;
2461 * gtk_tree_model_filter_convert_child_iter_to_iter:
2462 * @filter: A #GtkTreeModelFilter.
2463 * @filter_iter: An uninitialized #GtkTreeIter.
2464 * @child_iter: A valid #GtkTreeIter pointing to a row on the child model.
2466 * Sets @filter_iter to point to the row in @filter that corresponds to the
2467 * row pointed at by @child_iter.
2472 gtk_tree_model_filter_convert_child_iter_to_iter (GtkTreeModelFilter *filter,
2473 GtkTreeIter *filter_iter,
2474 GtkTreeIter *child_iter)
2476 GtkTreePath *child_path, *path;
2478 g_return_if_fail (GTK_IS_TREE_MODEL_FILTER (filter));
2479 g_return_if_fail (filter->priv->child_model != NULL);
2480 g_return_if_fail (filter_iter != NULL);
2481 g_return_if_fail (child_iter != NULL);
2483 filter_iter->stamp = 0;
2485 child_path = gtk_tree_model_get_path (filter->priv->child_model, child_iter);
2486 g_return_if_fail (child_path != NULL);
2488 path = gtk_tree_model_filter_convert_child_path_to_path (filter,
2490 gtk_tree_path_free (child_path);
2491 g_return_if_fail (path != NULL);
2493 gtk_tree_model_get_iter (GTK_TREE_MODEL (filter), filter_iter, path);
2494 gtk_tree_path_free (path);
2498 * gtk_tree_model_filter_convert_iter_to_child_iter:
2499 * @filter: A #GtkTreeModelFilter.
2500 * @child_iter: An uninitialized #GtkTreeIter.
2501 * @filter_iter: A valid #GtkTreeIter pointing to a row on @filter.
2503 * Sets @child_iter to point to the row pointed to by @filter_iter.
2508 gtk_tree_model_filter_convert_iter_to_child_iter (GtkTreeModelFilter *filter,
2509 GtkTreeIter *child_iter,
2510 GtkTreeIter *filter_iter)
2512 g_return_if_fail (GTK_IS_TREE_MODEL_FILTER (filter));
2513 g_return_if_fail (filter->priv->child_model != NULL);
2514 g_return_if_fail (child_iter != NULL);
2515 g_return_if_fail (filter_iter != NULL);
2516 g_return_if_fail (filter_iter->stamp == filter->priv->stamp);
2518 if (GTK_TREE_MODEL_FILTER_CACHE_CHILD_ITERS (filter))
2520 *child_iter = FILTER_ELT (filter_iter->user_data2)->iter;
2526 path = gtk_tree_model_filter_elt_get_path (filter_iter->user_data,
2527 filter_iter->user_data2,
2528 filter->priv->virtual_root);
2529 gtk_tree_model_get_iter (filter->priv->child_model, child_iter, path);
2530 gtk_tree_path_free (path);
2534 static GtkTreePath *
2535 gtk_real_tree_model_filter_convert_child_path_to_path (GtkTreeModelFilter *filter,
2536 GtkTreePath *child_path,
2537 gboolean build_levels,
2538 gboolean fetch_childs)
2540 gint *child_indices;
2541 GtkTreePath *retval;
2542 GtkTreePath *real_path;
2547 g_return_val_if_fail (GTK_IS_TREE_MODEL_FILTER (filter), NULL);
2548 g_return_val_if_fail (filter->priv->child_model != NULL, NULL);
2549 g_return_val_if_fail (child_path != NULL, NULL);
2551 if (!filter->priv->virtual_root)
2552 real_path = gtk_tree_path_copy (child_path);
2554 real_path = gtk_tree_model_filter_remove_root (child_path,
2555 filter->priv->virtual_root);
2560 retval = gtk_tree_path_new ();
2561 child_indices = gtk_tree_path_get_indices (real_path);
2563 if (filter->priv->root == NULL && build_levels)
2564 gtk_tree_model_filter_build_level (filter, NULL, NULL);
2565 level = FILTER_LEVEL (filter->priv->root);
2567 for (i = 0; i < gtk_tree_path_get_depth (real_path); i++)
2570 gboolean found_child = FALSE;
2574 gtk_tree_path_free (real_path);
2575 gtk_tree_path_free (retval);
2579 tmp = bsearch_elt_with_offset (level->array, child_indices[i], &j);
2582 gtk_tree_path_append_index (retval, j);
2583 if (!tmp->children && build_levels)
2584 gtk_tree_model_filter_build_level (filter, level, tmp);
2585 level = tmp->children;
2589 if (!found_child && fetch_childs)
2591 tmp = gtk_tree_model_filter_fetch_child (filter, level,
2595 /* didn't find the child, let's try to bring it back */
2596 if (!tmp || tmp->offset != child_indices[i])
2599 gtk_tree_path_free (real_path);
2600 gtk_tree_path_free (retval);
2604 gtk_tree_path_append_index (retval, j);
2605 if (!tmp->children && build_levels)
2606 gtk_tree_model_filter_build_level (filter, level, tmp);
2607 level = tmp->children;
2610 else if (!found_child && !fetch_childs)
2613 gtk_tree_path_free (real_path);
2614 gtk_tree_path_free (retval);
2619 gtk_tree_path_free (real_path);
2624 * gtk_tree_model_filter_convert_child_path_to_path:
2625 * @filter: A #GtkTreeModelFilter.
2626 * @child_path: A #GtkTreePath to convert.
2628 * Converts @child_path to a path relative to @filter. That is, @child_path
2629 * points to a path in the child model. The rerturned path will point to the
2630 * same row in the filtered model. If @child_path isn't a valid path on the
2631 * child model, then %NULL is returned.
2633 * Return value: A newly allocated #GtkTreePath, or %NULL.
2638 gtk_tree_model_filter_convert_child_path_to_path (GtkTreeModelFilter *filter,
2639 GtkTreePath *child_path)
2641 /* this function does the sanity checks */
2642 return gtk_real_tree_model_filter_convert_child_path_to_path (filter,
2649 * gtk_tree_model_filter_convert_path_to_child_path:
2650 * @filter: A #GtkTreeModelFilter.
2651 * @filter_path: A #GtkTreePath to convert.
2653 * Converts @filter_path to a path on the child model of @filter. That is,
2654 * @filter_path points to a location in @filter. The returned path will
2655 * point to the same location in the model not being filtered. If @filter_path
2656 * does not point to a location in the child model, %NULL is returned.
2658 * Return value: A newly allocated #GtkTreePath, or %NULL.
2663 gtk_tree_model_filter_convert_path_to_child_path (GtkTreeModelFilter *filter,
2664 GtkTreePath *filter_path)
2666 gint *filter_indices;
2667 GtkTreePath *retval;
2671 g_return_val_if_fail (GTK_IS_TREE_MODEL_FILTER (filter), NULL);
2672 g_return_val_if_fail (filter->priv->child_model != NULL, NULL);
2673 g_return_val_if_fail (filter_path != NULL, NULL);
2676 retval = gtk_tree_path_new ();
2677 filter_indices = gtk_tree_path_get_indices (filter_path);
2678 if (!filter->priv->root)
2679 gtk_tree_model_filter_build_level (filter, NULL, NULL);
2680 level = FILTER_LEVEL (filter->priv->root);
2682 for (i = 0; i < gtk_tree_path_get_depth (filter_path); i++)
2684 gint count = filter_indices[i];
2686 if (!level || level->array->len <= filter_indices[i])
2688 gtk_tree_path_free (retval);
2692 if (g_array_index (level->array, FilterElt, count).children == NULL)
2693 gtk_tree_model_filter_build_level (filter, level, &g_array_index (level->array, FilterElt, count));
2695 if (!level || level->array->len <= filter_indices[i])
2697 gtk_tree_path_free (retval);
2701 gtk_tree_path_append_index (retval, g_array_index (level->array, FilterElt, count).offset);
2702 level = g_array_index (level->array, FilterElt, count).children;
2707 if (filter->priv->virtual_root)
2709 GtkTreePath *real_retval;
2711 real_retval = gtk_tree_model_filter_add_root (retval,
2712 filter->priv->virtual_root);
2713 gtk_tree_path_free (retval);
2722 gtk_tree_model_filter_refilter_helper (GtkTreeModel *model,
2727 /* evil, don't try this at home, but certainly speeds things up */
2728 gtk_tree_model_filter_row_changed (model, path, iter, data);
2734 * gtk_tree_model_filter_refilter:
2735 * @filter: A #GtkTreeModelFilter.
2737 * Emits ::row_changed for each row in the child model, which causes
2738 * the filter to re-evaluate whether a row is visible or not.
2743 gtk_tree_model_filter_refilter (GtkTreeModelFilter *filter)
2745 g_return_if_fail (GTK_IS_TREE_MODEL_FILTER (filter));
2748 gtk_tree_model_foreach (filter->priv->child_model,
2749 gtk_tree_model_filter_refilter_helper,
2754 * gtk_tree_model_filter_clear_cache:
2755 * @filter: A #GtkTreeModelFilter.
2757 * This function should almost never be called. It clears the @filter
2758 * of any cached iterators that haven't been reffed with
2759 * gtk_tree_model_ref_node(). This might be useful if the child model
2760 * being filtered is static (and doesn't change often) and there has been
2761 * a lot of unreffed access to nodes. As a side effect of this function,
2762 * all unreffed itters will be invalid.
2767 gtk_tree_model_filter_clear_cache (GtkTreeModelFilter *filter)
2769 g_return_if_fail (GTK_IS_TREE_MODEL_FILTER (filter));
2771 if (filter->priv->zero_ref_count)
2772 gtk_tree_model_filter_clear_cache_helper (filter,
2773 FILTER_LEVEL (filter->priv->root));