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"
22 #include <gtk/gtkintl.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 struct _GtkTreeModelFilterPrivate
63 GtkTreeModel *child_model;
66 guint root_level_visible;
68 GtkTreePath *virtual_root;
70 GtkTreeModelFilterVisibleFunc visible_func;
71 gpointer visible_data;
72 GtkDestroyNotify visible_destroy;
74 gint modify_n_columns;
76 GtkTreeModelFilterModifyFunc modify_func;
78 gpointer modify_destroy;
82 gboolean visible_method_set;
83 gboolean modify_func_set;
88 guint has_child_toggled_id;
101 #define GTK_TREE_MODEL_FILTER_CACHE_CHILD_ITERS(filter) \
102 (((GtkTreeModelFilter *)filter)->priv->child_flags & GTK_TREE_MODEL_ITERS_PERSIST)
104 #define FILTER_ELT(filter_elt) ((FilterElt *)filter_elt)
105 #define FILTER_LEVEL(filter_level) ((FilterLevel *)filter_level)
107 /* general code (object/interface init, properties, etc) */
108 static void gtk_tree_model_filter_init (GtkTreeModelFilter *filter);
109 static void gtk_tree_model_filter_class_init (GtkTreeModelFilterClass *filter_class);
110 static void gtk_tree_model_filter_tree_model_init (GtkTreeModelIface *iface);
111 static void gtk_tree_model_filter_finalize (GObject *object);
112 static void gtk_tree_model_filter_set_property (GObject *object,
116 static void gtk_tree_model_filter_get_property (GObject *object,
121 /* signal handlers */
122 static void gtk_tree_model_filter_row_changed (GtkTreeModel *c_model,
126 static void gtk_tree_model_filter_row_inserted (GtkTreeModel *c_model,
130 static void gtk_tree_model_filter_row_has_child_toggled (GtkTreeModel *c_model,
134 static void gtk_tree_model_filter_row_deleted (GtkTreeModel *c_model,
137 static void gtk_tree_model_filter_rows_reordered (GtkTreeModel *c_model,
143 /* GtkTreeModel interface */
144 static guint gtk_tree_model_filter_get_flags (GtkTreeModel *model);
145 static gint gtk_tree_model_filter_get_n_columns (GtkTreeModel *model);
146 static GType gtk_tree_model_filter_get_column_type (GtkTreeModel *model,
148 static gboolean gtk_tree_model_filter_get_iter (GtkTreeModel *model,
151 static GtkTreePath *gtk_tree_model_filter_get_path (GtkTreeModel *model,
153 static void gtk_tree_model_filter_get_value (GtkTreeModel *model,
157 static gboolean gtk_tree_model_filter_iter_next (GtkTreeModel *model,
159 static gboolean gtk_tree_model_filter_iter_children (GtkTreeModel *model,
161 GtkTreeIter *parent);
162 static gboolean gtk_tree_model_filter_iter_has_child (GtkTreeModel *model,
164 static gint gtk_tree_model_filter_iter_n_children (GtkTreeModel *model,
166 static gboolean gtk_tree_model_filter_iter_nth_child (GtkTreeModel *model,
170 static gboolean gtk_tree_model_filter_iter_parent (GtkTreeModel *model,
173 static void gtk_tree_model_filter_ref_node (GtkTreeModel *model,
175 static void gtk_tree_model_filter_unref_node (GtkTreeModel *model,
179 /* private functions */
180 static void gtk_tree_model_filter_build_level (GtkTreeModelFilter *filter,
181 FilterLevel *parent_level,
182 FilterElt *parent_elt);
183 static void gtk_tree_model_filter_free_level (GtkTreeModelFilter *filter,
184 FilterLevel *filter_level);
186 static GtkTreePath *gtk_tree_model_filter_elt_get_path (FilterLevel *level,
190 static GtkTreePath *gtk_tree_model_filter_add_root (GtkTreePath *src,
192 static GtkTreePath *gtk_tree_model_filter_remove_root (GtkTreePath *src,
195 static void gtk_tree_model_filter_increment_stamp (GtkTreeModelFilter *filter);
197 static gboolean gtk_tree_model_filter_visible (GtkTreeModelFilter *filter,
198 GtkTreeIter *child_iter);
199 static void gtk_tree_model_filter_clear_cache_helper (GtkTreeModelFilter *filter,
202 static void gtk_tree_model_filter_real_unref_node (GtkTreeModel *model,
204 gboolean propagate_unref);
206 static void gtk_tree_model_filter_set_model (GtkTreeModelFilter *filter,
207 GtkTreeModel *child_model);
208 static void gtk_tree_model_filter_set_root (GtkTreeModelFilter *filter,
211 static GtkTreePath *gtk_real_tree_model_filter_convert_child_path_to_path (GtkTreeModelFilter *filter,
212 GtkTreePath *child_path,
213 gboolean build_levels,
214 gboolean fetch_childs);
216 static FilterElt *gtk_tree_model_filter_fetch_child (GtkTreeModelFilter *filter,
220 static void gtk_tree_model_filter_remove_node (GtkTreeModelFilter *filter,
222 gboolean emit_signal);
223 static void gtk_tree_model_filter_update_childs (GtkTreeModelFilter *filter,
226 static FilterElt *bsearch_elt_with_offset (GArray *array,
231 static GObjectClass *parent_class = NULL;
234 gtk_tree_model_filter_get_type (void)
236 static GType tree_model_filter_type = 0;
238 if (!tree_model_filter_type)
240 static const GTypeInfo tree_model_filter_info =
242 sizeof (GtkTreeModelFilterClass),
243 NULL, /* base_init */
244 NULL, /* base_finalize */
245 (GClassInitFunc) gtk_tree_model_filter_class_init,
246 NULL, /* class_finalize */
247 NULL, /* class_data */
248 sizeof (GtkTreeModelFilter),
250 (GInstanceInitFunc) gtk_tree_model_filter_init
253 static const GInterfaceInfo tree_model_info =
255 (GInterfaceInitFunc) gtk_tree_model_filter_tree_model_init,
260 tree_model_filter_type = g_type_register_static (G_TYPE_OBJECT,
261 "GtkTreeModelFilter",
262 &tree_model_filter_info, 0);
264 g_type_add_interface_static (tree_model_filter_type,
269 return tree_model_filter_type;
273 gtk_tree_model_filter_init (GtkTreeModelFilter *filter)
275 filter->priv = GTK_TREE_MODEL_FILTER_GET_PRIVATE (filter);
277 filter->priv->visible_column = -1;
278 filter->priv->zero_ref_count = 0;
279 filter->priv->visible_method_set = FALSE;
280 filter->priv->modify_func_set = FALSE;
284 gtk_tree_model_filter_class_init (GtkTreeModelFilterClass *filter_class)
286 GObjectClass *object_class;
288 object_class = (GObjectClass *) filter_class;
289 parent_class = g_type_class_peek_parent (filter_class);
291 object_class->set_property = gtk_tree_model_filter_set_property;
292 object_class->get_property = gtk_tree_model_filter_get_property;
294 object_class->finalize = gtk_tree_model_filter_finalize;
296 /* Properties -- FIXME: disabled translations for now, until I can come up with a
299 g_object_class_install_property (object_class,
301 g_param_spec_object ("child_model",
303 ("The model for the filtermodel to filter"),
305 G_PARAM_READWRITE | G_PARAM_CONSTRUCT_ONLY));
307 g_object_class_install_property (object_class,
309 g_param_spec_boxed ("virtual_root",
310 ("The virtual root"),
311 ("The virtual root (relative to the child model) for this filtermodel"),
313 G_PARAM_READWRITE | G_PARAM_CONSTRUCT_ONLY));
315 g_type_class_add_private (object_class, sizeof (GtkTreeModelFilterPrivate));
319 gtk_tree_model_filter_tree_model_init (GtkTreeModelIface *iface)
321 iface->get_flags = gtk_tree_model_filter_get_flags;
322 iface->get_n_columns = gtk_tree_model_filter_get_n_columns;
323 iface->get_column_type = gtk_tree_model_filter_get_column_type;
324 iface->get_iter = gtk_tree_model_filter_get_iter;
325 iface->get_path = gtk_tree_model_filter_get_path;
326 iface->get_value = gtk_tree_model_filter_get_value;
327 iface->iter_next = gtk_tree_model_filter_iter_next;
328 iface->iter_children = gtk_tree_model_filter_iter_children;
329 iface->iter_has_child = gtk_tree_model_filter_iter_has_child;
330 iface->iter_n_children = gtk_tree_model_filter_iter_n_children;
331 iface->iter_nth_child = gtk_tree_model_filter_iter_nth_child;
332 iface->iter_parent = gtk_tree_model_filter_iter_parent;
333 iface->ref_node = gtk_tree_model_filter_ref_node;
334 iface->unref_node = gtk_tree_model_filter_unref_node;
339 gtk_tree_model_filter_finalize (GObject *object)
341 GtkTreeModelFilter *filter = (GtkTreeModelFilter *) object;
343 gtk_tree_model_filter_set_model (filter, NULL);
345 if (filter->priv->virtual_root)
346 gtk_tree_path_free (filter->priv->virtual_root);
348 if (filter->priv->root)
349 gtk_tree_model_filter_free_level (filter, filter->priv->root);
351 if (filter->priv->modify_types)
352 g_free (filter->priv->modify_types);
355 parent_class->finalize (object);
359 gtk_tree_model_filter_set_property (GObject *object,
364 GtkTreeModelFilter *filter = GTK_TREE_MODEL_FILTER (object);
368 case PROP_CHILD_MODEL:
369 gtk_tree_model_filter_set_model (filter, g_value_get_object (value));
371 case PROP_VIRTUAL_ROOT:
372 gtk_tree_model_filter_set_root (filter, g_value_get_boxed (value));
375 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
381 gtk_tree_model_filter_get_property (GObject *object,
386 GtkTreeModelFilter *filter = GTK_TREE_MODEL_FILTER (object);
390 case PROP_CHILD_MODEL:
391 g_value_set_object (value, filter->priv->child_model);
393 case PROP_VIRTUAL_ROOT:
394 g_value_set_boxed (value, filter->priv->virtual_root);
397 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
405 gtk_tree_model_filter_build_level (GtkTreeModelFilter *filter,
406 FilterLevel *parent_level,
407 FilterElt *parent_elt)
411 FilterLevel *new_level;
415 g_assert (filter->priv->child_model != NULL);
419 if (filter->priv->virtual_root)
421 if (gtk_tree_model_get_iter (filter->priv->child_model, &root, filter->priv->virtual_root) == FALSE)
423 length = gtk_tree_model_iter_n_children (filter->priv->child_model, &root);
425 if (gtk_tree_model_iter_children (filter->priv->child_model, &iter, &root) == FALSE)
430 if (!gtk_tree_model_get_iter_first (filter->priv->child_model, &iter))
432 length = gtk_tree_model_iter_n_children (filter->priv->child_model, NULL);
437 GtkTreeIter parent_iter;
438 GtkTreeIter child_parent_iter;
440 parent_iter.stamp = filter->priv->stamp;
441 parent_iter.user_data = parent_level;
442 parent_iter.user_data2 = parent_elt;
444 gtk_tree_model_filter_convert_iter_to_child_iter (filter,
447 if (gtk_tree_model_iter_children (filter->priv->child_model, &iter, &child_parent_iter) == FALSE)
450 /* stamp may have changed */
451 gtk_tree_model_filter_convert_iter_to_child_iter (filter,
454 length = gtk_tree_model_iter_n_children (filter->priv->child_model, &child_parent_iter);
457 g_return_if_fail (length > 0);
459 new_level = g_new (FilterLevel, 1);
460 new_level->array = g_array_sized_new (FALSE, FALSE,
463 new_level->ref_count = 0;
464 new_level->parent_elt = parent_elt;
465 new_level->parent_level = parent_level;
468 parent_elt->children = new_level;
470 filter->priv->root = new_level;
472 /* increase the count of zero ref_counts */
475 parent_elt->zero_ref_count++;
477 parent_elt = parent_level->parent_elt;
478 parent_level = parent_level->parent_level;
480 filter->priv->zero_ref_count++;
484 if (!new_level->parent_level)
485 filter->priv->root_level_visible = 0;
489 if (gtk_tree_model_filter_visible (filter, &iter))
491 FilterElt filter_elt;
493 filter_elt.offset = i;
494 filter_elt.zero_ref_count = 0;
495 filter_elt.ref_count = 0;
496 filter_elt.children = NULL;
497 filter_elt.visible = TRUE;
499 if (GTK_TREE_MODEL_FILTER_CACHE_CHILD_ITERS (filter))
500 filter_elt.iter = iter;
502 g_array_append_val (new_level->array, filter_elt);
504 if (!new_level->parent_level)
505 filter->priv->root_level_visible++;
509 while (gtk_tree_model_iter_next (filter->priv->child_model, &iter));
513 gtk_tree_model_filter_free_level (GtkTreeModelFilter *filter,
514 FilterLevel *filter_level)
518 g_assert (filter_level);
520 if (filter_level->ref_count == 0)
522 FilterLevel *parent_level = filter_level->parent_level;
523 FilterElt *parent_elt = filter_level->parent_elt;
528 parent_elt->zero_ref_count--;
532 parent_elt = parent_level->parent_elt;
533 parent_level = parent_level->parent_level;
536 while (parent_level);
537 filter->priv->zero_ref_count--;
540 for (i = 0; i < filter_level->array->len; i++)
542 if (g_array_index (filter_level->array, FilterElt, i).children)
543 gtk_tree_model_filter_free_level (filter,
544 FILTER_LEVEL (g_array_index (filter_level->array, FilterElt, i).children));
547 if (!filter_level->parent_level)
548 filter->priv->root_level_visible = 0;
550 if (filter_level->parent_elt)
551 filter_level->parent_elt->children = NULL;
553 filter->priv->root = NULL;
555 g_array_free (filter_level->array, TRUE);
556 filter_level->array = NULL;
558 g_free (filter_level);
563 gtk_tree_model_filter_elt_get_path (FilterLevel *level,
567 FilterLevel *walker = level;
568 FilterElt *walker2 = elt;
570 GtkTreePath *real_path;
572 g_return_val_if_fail (level != NULL, NULL);
573 g_return_val_if_fail (elt != NULL, NULL);
575 path = gtk_tree_path_new ();
579 gtk_tree_path_prepend_index (path, walker2->offset);
581 walker2 = walker->parent_elt;
582 walker = walker->parent_level;
587 real_path = gtk_tree_model_filter_add_root (path, root);
588 gtk_tree_path_free (path);
596 gtk_tree_model_filter_add_root (GtkTreePath *src,
602 retval = gtk_tree_path_copy (root);
604 for (i = 0; i < gtk_tree_path_get_depth (src); i++)
605 gtk_tree_path_append_index (retval, gtk_tree_path_get_indices (src)[i]);
611 gtk_tree_model_filter_remove_root (GtkTreePath *src,
619 if (gtk_tree_path_get_depth (src) <= gtk_tree_path_get_depth (root))
622 depth = gtk_tree_path_get_depth (src);
623 indices = gtk_tree_path_get_indices (src);
625 for (i = 0; i < gtk_tree_path_get_depth (root); i++)
626 if (indices[i] != gtk_tree_path_get_indices (root)[i])
629 retval = gtk_tree_path_new ();
631 for (; i < depth; i++)
632 gtk_tree_path_append_index (retval, indices[i]);
638 gtk_tree_model_filter_increment_stamp (GtkTreeModelFilter *filter)
642 filter->priv->stamp++;
644 while (filter->priv->stamp == 0);
646 gtk_tree_model_filter_clear_cache (filter);
650 gtk_tree_model_filter_visible (GtkTreeModelFilter *filter,
651 GtkTreeIter *child_iter)
653 if (filter->priv->visible_func)
655 return (filter->priv->visible_func (filter->priv->child_model,
657 filter->priv->visible_data));
659 else if (filter->priv->visible_column >= 0)
663 gtk_tree_model_get_value (filter->priv->child_model, child_iter,
664 filter->priv->visible_column, &val);
666 if (g_value_get_boolean (&val))
668 g_value_unset (&val);
672 g_value_unset (&val);
676 /* no filter thing set, so always visible */
681 gtk_tree_model_filter_clear_cache_helper (GtkTreeModelFilter *filter,
688 for (i = 0; i < level->array->len; i++)
690 if (g_array_index (level->array, FilterElt, i).zero_ref_count > 0)
691 gtk_tree_model_filter_clear_cache_helper (filter, g_array_index (level->array, FilterElt, i).children);
694 if (level->ref_count == 0 && level != filter->priv->root)
696 gtk_tree_model_filter_free_level (filter, level);
702 gtk_tree_model_filter_fetch_child (GtkTreeModelFilter *filter,
708 gint start, middle, end;
710 GtkTreePath *c_path = NULL;
712 GtkTreePath *c_parent_path = NULL;
713 GtkTreeIter c_parent_iter;
716 /* check if child exists and is visible */
717 if (level->parent_elt)
720 gtk_tree_model_filter_elt_get_path (level->parent_level,
722 filter->priv->virtual_root);
728 if (filter->priv->virtual_root)
729 c_parent_path = gtk_tree_path_copy (filter->priv->virtual_root);
731 c_parent_path = NULL;
736 gtk_tree_model_get_iter (filter->priv->child_model,
739 len = gtk_tree_model_iter_n_children (filter->priv->child_model,
742 c_path = gtk_tree_path_copy (c_parent_path);
743 gtk_tree_path_free (c_parent_path);
747 len = gtk_tree_model_iter_n_children (filter->priv->child_model, NULL);
748 c_path = gtk_tree_path_new ();
751 gtk_tree_path_append_index (c_path, offset);
752 gtk_tree_model_get_iter (filter->priv->child_model, &c_iter, c_path);
753 gtk_tree_path_free (c_path);
755 if (offset >= len || !gtk_tree_model_filter_visible (filter, &c_iter))
760 elt.zero_ref_count = 0;
763 /* visibility should be FALSE as we don't emit row_inserted */
766 if (GTK_TREE_MODEL_FILTER_CACHE_CHILD_ITERS (filter))
769 /* find index (binary search on offset) */
771 end = level->array->len;
777 middle = (start + end) / 2;
779 if (g_array_index (level->array, FilterElt, middle).offset <= offset)
785 if (g_array_index (level->array, FilterElt, middle).offset <= offset)
793 g_array_insert_val (level->array, i, elt);
796 for (i = MAX (--i, 0); i < level->array->len; i++)
798 FilterElt *e = &(g_array_index (level->array, FilterElt, i));
800 e->children->parent_elt = e;
803 return &g_array_index (level->array, FilterElt, *index);
807 gtk_tree_model_filter_remove_node (GtkTreeModelFilter *filter,
809 gboolean emit_signal)
811 FilterElt *elt, *parent;
812 FilterLevel *level, *parent_level;
813 gint offset, i, length, level_refcount;
815 /* FIXME: this function is very ugly. I need to rethink and
816 * rewrite it someday.
819 level = FILTER_LEVEL (iter->user_data);
820 elt = FILTER_ELT (iter->user_data2);
822 parent = level->parent_elt;
823 parent_level = level->parent_level;
824 length = level->array->len;
825 offset = elt->offset;
828 while (elt->ref_count > 0)
829 gtk_tree_model_filter_real_unref_node (GTK_TREE_MODEL (filter),
832 level_refcount = level->ref_count;
834 /* do the ref counting first! this touches the stamp */
839 path = gtk_tree_model_get_path (GTK_TREE_MODEL (filter), iter);
840 gtk_tree_model_filter_increment_stamp (filter);
841 gtk_tree_model_row_deleted (GTK_TREE_MODEL (filter), path);
842 gtk_tree_path_free (path);
845 if ((length == 1 || level_refcount == 0) &&
846 emit_signal && iter->user_data != filter->priv->root)
848 /* above code destroyed the level */
849 goto emit_has_child_toggled;
855 gtk_tree_model_filter_free_level (filter, level);
857 if (!filter->priv->root)
858 /* we killed the root */
865 /* remove the node */
866 tmp = bsearch_elt_with_offset (level->array, elt->offset, &i);
870 g_array_remove_index (level->array, i);
872 for (i = MAX (--i, 0); i < level->array->len; i++)
874 /* NOTE: here we do *not* decrease offsets, because the node was
875 * not removed from the child model
877 elt = &g_array_index (level->array, FilterElt, i);
879 elt->children->parent_elt = elt;
884 emit_has_child_toggled:
885 /* children are being handled first, so we can check it this way
887 * yes this if-statement is ugly
889 if ((parent && parent->children && parent->children->array->len <= 1) ||
890 (length == 1 && emit_signal && iter->user_data != filter->priv->root))
892 /* latest child has been removed, level has been destroyed */
896 piter.stamp = filter->priv->stamp;
897 piter.user_data = parent_level;
898 piter.user_data2 = parent;
900 ppath = gtk_tree_model_get_path (GTK_TREE_MODEL (filter), &piter);
902 gtk_tree_model_row_has_child_toggled (GTK_TREE_MODEL (filter),
904 gtk_tree_path_free (ppath);
909 gtk_tree_model_filter_update_childs (GtkTreeModelFilter *filter,
919 iter.stamp = filter->priv->stamp;
920 iter.user_data = level;
921 iter.user_data2 = elt;
923 gtk_tree_model_filter_convert_iter_to_child_iter (filter, &c_iter, &iter);
925 if (gtk_tree_model_iter_has_child (filter->priv->child_model, &c_iter))
927 GtkTreePath *path = gtk_tree_model_get_path (GTK_TREE_MODEL (filter),
929 gtk_tree_model_row_has_child_toggled (GTK_TREE_MODEL (filter),
933 gtk_tree_path_free (path);
938 bsearch_elt_with_offset (GArray *array,
942 gint start, middle, end;
953 elt = &g_array_index (array, FilterElt, 0);
955 if (elt->offset == offset)
966 middle = (start + end) / 2;
968 elt = &g_array_index (array, FilterElt, middle);
970 if (elt->offset < offset)
972 else if (elt->offset > offset)
978 if (elt->offset == offset)
987 /* TreeModel signals */
989 gtk_tree_model_filter_row_changed (GtkTreeModel *c_model,
994 GtkTreeModelFilter *filter = GTK_TREE_MODEL_FILTER (data);
997 GtkTreeIter real_c_iter;
998 GtkTreePath *path = NULL;
1003 gboolean requested_state;
1004 gboolean current_state;
1005 gboolean free_c_path = FALSE;
1007 g_return_if_fail (c_path != NULL || c_iter != NULL);
1011 c_path = gtk_tree_model_get_path (c_model, c_iter);
1016 real_c_iter = *c_iter;
1018 gtk_tree_model_get_iter (c_model, &real_c_iter, c_path);
1020 /* is this node above the virtual root? */
1021 if (filter->priv->virtual_root
1022 && (gtk_tree_path_get_depth (filter->priv->virtual_root)
1023 >= gtk_tree_path_get_depth (c_path)))
1026 /* what's the requested state? */
1027 requested_state = gtk_tree_model_filter_visible (filter, &real_c_iter);
1029 /* now, let's see whether the item is there */
1030 path = gtk_real_tree_model_filter_convert_child_path_to_path (filter,
1037 gtk_tree_model_get_iter (GTK_TREE_MODEL (filter), &iter, path);
1038 current_state = FILTER_ELT (iter.user_data2)->visible;
1041 current_state = FALSE;
1043 if (current_state == FALSE && requested_state == FALSE)
1044 /* no changes required */
1047 if (current_state == TRUE && requested_state == FALSE)
1049 /* get rid of this node */
1050 gtk_tree_model_get_iter (GTK_TREE_MODEL (filter), &iter, path);
1051 gtk_tree_model_filter_remove_node (filter, &iter, TRUE);
1053 level = FILTER_LEVEL (iter.user_data);
1055 if (!level->parent_level)
1056 filter->priv->root_level_visible--;
1061 if (current_state == TRUE && requested_state == TRUE)
1063 /* progate the signal */
1064 gtk_tree_model_get_iter (GTK_TREE_MODEL (filter), &iter, path);
1065 gtk_tree_model_row_changed (GTK_TREE_MODEL (filter), path, &iter);
1067 level = FILTER_LEVEL (iter.user_data);
1068 elt = FILTER_ELT (iter.user_data2);
1070 /* and update the childs */
1071 if (gtk_tree_model_iter_children (c_model, &childs, &real_c_iter))
1072 gtk_tree_model_filter_update_childs (filter, level, elt);
1077 /* only current == FALSE and requested == TRUE is left,
1080 g_return_if_fail (current_state == FALSE && requested_state == TRUE);
1082 /* make sure the new item has been pulled in */
1083 if (!filter->priv->root)
1088 gtk_tree_model_filter_build_level (filter, NULL, NULL);
1090 root = FILTER_LEVEL (filter->priv->root);
1094 for (i = 0; i < root->array->len; i++)
1095 g_array_index (root->array, FilterElt, i).visible = FALSE;
1096 filter->priv->root_level_visible = 0;
1101 path = gtk_real_tree_model_filter_convert_child_path_to_path (filter,
1106 g_return_if_fail (path != NULL);
1108 gtk_tree_model_filter_increment_stamp (filter);
1109 gtk_tree_model_get_iter (GTK_TREE_MODEL (filter), &iter, path);
1111 level = FILTER_LEVEL (iter.user_data);
1112 elt = FILTER_ELT (iter.user_data2);
1114 elt->visible = TRUE;
1116 if (!level->parent_level)
1117 filter->priv->root_level_visible++;
1120 gtk_tree_model_row_inserted (GTK_TREE_MODEL (filter), path, &iter);
1122 if (gtk_tree_model_iter_children (c_model, &childs, c_iter))
1123 gtk_tree_model_filter_update_childs (filter, level, elt);
1127 gtk_tree_path_free (path);
1130 gtk_tree_path_free (c_path);
1134 gtk_tree_model_filter_row_inserted (GtkTreeModel *c_model,
1135 GtkTreePath *c_path,
1136 GtkTreeIter *c_iter,
1139 GtkTreeModelFilter *filter = GTK_TREE_MODEL_FILTER (data);
1141 GtkTreePath *real_path;
1144 GtkTreeIter real_c_iter;
1148 FilterLevel *parent_level;
1150 gint i = 0, offset, index = -1;
1152 gboolean free_c_path = FALSE;
1154 g_return_if_fail (c_path != NULL || c_iter != NULL);
1158 c_path = gtk_tree_model_get_path (c_model, c_iter);
1163 real_c_iter = *c_iter;
1165 gtk_tree_model_get_iter (c_model, &real_c_iter, c_path);
1167 /* the row has already been inserted. so we need to fixup the
1168 * virtual root here first
1170 if (filter->priv->virtual_root)
1172 if (gtk_tree_path_get_depth (filter->priv->virtual_root) >=
1173 gtk_tree_path_get_depth (c_path))
1176 gint *v_indices, *c_indices;
1178 level = gtk_tree_path_get_depth (c_path) - 1;
1179 v_indices = gtk_tree_path_get_indices (filter->priv->virtual_root);
1180 c_indices = gtk_tree_path_get_indices (c_path);
1182 if (v_indices[level] >= c_indices[level])
1183 (v_indices[level])++;
1187 if (!filter->priv->root)
1189 gtk_tree_model_filter_build_level (filter, NULL, NULL);
1190 /* that already put the inserted iter in the level */
1195 parent_level = level = FILTER_LEVEL (filter->priv->root);
1197 /* subtract virtual root if necessary */
1198 if (filter->priv->virtual_root)
1200 real_path = gtk_tree_model_filter_remove_root (c_path,
1201 filter->priv->virtual_root);
1207 real_path = gtk_tree_path_copy (c_path);
1209 if (gtk_tree_path_get_depth (real_path) - 1 >= 1)
1211 /* find the parent level */
1212 while (i < gtk_tree_path_get_depth (real_path) - 1)
1217 /* we don't cover this signal */
1220 elt = bsearch_elt_with_offset (level->array,
1221 gtk_tree_path_get_indices (real_path)[i],
1225 /* parent is probably being filtered out */
1230 GtkTreePath *tmppath;
1231 GtkTreeIter tmpiter;
1233 tmpiter.stamp = filter->priv->stamp;
1234 tmpiter.user_data = level;
1235 tmpiter.user_data2 = elt;
1237 tmppath = gtk_tree_model_get_path (GTK_TREE_MODEL (data),
1242 gtk_tree_model_row_has_child_toggled (GTK_TREE_MODEL (data),
1244 gtk_tree_path_free (tmppath);
1247 /* not covering this signal */
1251 level = elt->children;
1252 parent_level = level;
1260 /* let's try to insert the value */
1261 offset = gtk_tree_path_get_indices (real_path)[gtk_tree_path_get_depth (real_path) - 1];
1263 /* update the offsets, yes if we didn't insert the node above, there will
1264 * be a gap here. This will be filled with the node (via fetch_child) when
1265 * it becomes visible
1267 for (i = 0; i < level->array->len; i++)
1269 FilterElt *e = &g_array_index (level->array, FilterElt, i);
1270 if ((e->offset >= offset))
1274 /* only insert when visible */
1275 if (gtk_tree_model_filter_visible (filter, &real_c_iter))
1279 if (GTK_TREE_MODEL_FILTER_CACHE_CHILD_ITERS (filter))
1280 felt.iter = real_c_iter;
1282 felt.offset = offset;
1283 felt.zero_ref_count = 0;
1285 felt.visible = TRUE;
1286 felt.children = NULL;
1288 for (i = 0; i < level->array->len; i++)
1289 if (g_array_index (level->array, FilterElt, i).offset > offset)
1292 g_array_insert_val (level->array, i, felt);
1295 if (!level->parent_level)
1296 filter->priv->root_level_visible++;
1299 /* another iteration to update the references of childs to parents. */
1300 for (i = 0; i < level->array->len; i++)
1302 FilterElt *e = &g_array_index (level->array, FilterElt, i);
1304 e->children->parent_elt = e;
1307 /* don't emit the signal if we aren't visible */
1308 if (!gtk_tree_model_filter_visible (filter, &real_c_iter))
1312 /* NOTE: pass c_path here and NOT real_path. This function does
1313 * root subtraction itself
1315 path = gtk_real_tree_model_filter_convert_child_path_to_path (filter,
1322 gtk_tree_model_filter_increment_stamp (filter);
1324 gtk_tree_model_get_iter (GTK_TREE_MODEL (data), &iter, path);
1325 gtk_tree_model_row_inserted (GTK_TREE_MODEL (data), path, &iter);
1329 gtk_tree_path_free (c_path);
1333 gtk_tree_model_filter_row_has_child_toggled (GtkTreeModel *c_model,
1334 GtkTreePath *c_path,
1335 GtkTreeIter *c_iter,
1338 GtkTreeModelFilter *filter = GTK_TREE_MODEL_FILTER (data);
1342 g_return_if_fail (c_path != NULL && c_iter != NULL);
1344 /* FIXME: does this code work? */
1346 if (!gtk_tree_model_filter_visible (filter, c_iter))
1349 path = gtk_real_tree_model_filter_convert_child_path_to_path (filter,
1356 gtk_tree_model_get_iter (GTK_TREE_MODEL (data), &iter, path);
1357 gtk_tree_model_row_has_child_toggled (GTK_TREE_MODEL (data), path, &iter);
1359 gtk_tree_path_free (path);
1363 gtk_tree_model_filter_row_deleted (GtkTreeModel *c_model,
1364 GtkTreePath *c_path,
1367 GtkTreeModelFilter *filter = GTK_TREE_MODEL_FILTER (data);
1373 gboolean emit_signal = TRUE;
1376 g_return_if_fail (c_path != NULL);
1378 /* special case the deletion of an ancestor of the virtual root */
1379 if (filter->priv->virtual_root &&
1380 (gtk_tree_path_is_ancestor (c_path, filter->priv->virtual_root) ||
1381 !gtk_tree_path_compare (c_path, filter->priv->virtual_root)))
1385 FilterLevel *level = FILTER_LEVEL (filter->priv->root);
1390 /* remove everything in the filter model
1392 * For now, we just iterate over the root level and emit a
1393 * row_deleted for each FilterElt. Not sure if this is correct.
1396 gtk_tree_model_filter_increment_stamp (filter);
1397 path = gtk_tree_path_new ();
1398 gtk_tree_path_append_index (path, 0);
1400 for (i = 0; i < level->array->len; i++)
1401 gtk_tree_model_row_deleted (GTK_TREE_MODEL (data), path);
1403 gtk_tree_path_free (path);
1404 gtk_tree_model_filter_free_level (filter, filter->priv->root);
1409 /* fixup virtual root */
1410 if (filter->priv->virtual_root)
1412 if (gtk_tree_path_get_depth (filter->priv->virtual_root) >=
1413 gtk_tree_path_get_depth (c_path))
1416 gint *v_indices, *c_indices;
1418 level = gtk_tree_path_get_depth (c_path) - 1;
1419 v_indices = gtk_tree_path_get_indices (filter->priv->virtual_root);
1420 c_indices = gtk_tree_path_get_indices (c_path);
1422 if (v_indices[level] > c_indices[level])
1423 (v_indices[level])--;
1427 path = gtk_real_tree_model_filter_convert_child_path_to_path (filter,
1433 path = gtk_real_tree_model_filter_convert_child_path_to_path (filter,
1440 /* fixup the offsets */
1441 GtkTreePath *real_path;
1443 if (!filter->priv->root)
1446 level = FILTER_LEVEL (filter->priv->root);
1448 /* subtract vroot if necessary */
1449 if (filter->priv->virtual_root)
1451 real_path = gtk_tree_model_filter_remove_root (c_path,
1452 filter->priv->virtual_root);
1453 /* we don't handle this */
1458 real_path = gtk_tree_path_copy (c_path);
1461 if (gtk_tree_path_get_depth (real_path) - 1 >= 1)
1463 while (i < gtk_tree_path_get_depth (real_path) - 1)
1469 /* we don't cover this */
1470 gtk_tree_path_free (real_path);
1474 elt = bsearch_elt_with_offset (level->array,
1475 gtk_tree_path_get_indices (real_path)[i],
1478 if (!elt || !elt->children)
1480 /* parent is filtered out, so no level */
1481 gtk_tree_path_free (real_path);
1485 level = elt->children;
1490 offset = gtk_tree_path_get_indices (real_path)[gtk_tree_path_get_depth (real_path) - 1];
1491 gtk_tree_path_free (real_path);
1497 * - the offset of the removed item
1500 for (i = 0; i < level->array->len; i++)
1502 elt = &g_array_index (level->array, FilterElt, i);
1503 if (elt->offset > offset)
1506 elt->children->parent_elt = elt;
1512 emit_signal = FALSE;
1515 gtk_tree_model_get_iter (GTK_TREE_MODEL (data), &iter, path);
1517 level = FILTER_LEVEL (iter.user_data);
1518 elt = FILTER_ELT (iter.user_data2);
1519 offset = elt->offset;
1521 if (!level->parent_level && elt->visible)
1522 filter->priv->root_level_visible--;
1526 if (level->ref_count == 0 && level != filter->priv->root)
1528 gtk_tree_model_filter_increment_stamp (filter);
1529 gtk_tree_model_row_deleted (GTK_TREE_MODEL (data), path);
1531 gtk_tree_path_free (path);
1535 gtk_tree_model_filter_increment_stamp (filter);
1536 gtk_tree_model_row_deleted (GTK_TREE_MODEL (data), path);
1537 iter.stamp = filter->priv->stamp;
1539 while (elt->ref_count > 0)
1540 gtk_tree_model_filter_real_unref_node (GTK_TREE_MODEL (data), &iter,
1544 if (level->array->len == 1)
1547 gtk_tree_model_filter_free_level (filter, level);
1553 /* remove the row */
1554 tmp = bsearch_elt_with_offset (level->array, elt->offset, &i);
1556 offset = tmp->offset;
1557 g_array_remove_index (level->array, i);
1559 for (i = MAX (--i, 0); i < level->array->len; i++)
1561 elt = &g_array_index (level->array, FilterElt, i);
1562 if (elt->offset > offset)
1565 elt->children->parent_elt = elt;
1569 gtk_tree_path_free (path);
1573 gtk_tree_model_filter_rows_reordered (GtkTreeModel *c_model,
1574 GtkTreePath *c_path,
1575 GtkTreeIter *c_iter,
1581 GtkTreeModelFilter *filter = GTK_TREE_MODEL_FILTER (data);
1587 gint i, j, elt_count;
1592 g_return_if_fail (new_order != NULL);
1594 if (c_path == NULL || gtk_tree_path_get_indices (c_path) == NULL)
1596 if (!filter->priv->root)
1599 length = gtk_tree_model_iter_n_children (c_model, NULL);
1601 if (filter->priv->virtual_root)
1605 /* reorder root level of path */
1606 for (i = 0; i < length; i++)
1607 if (new_order[i] == gtk_tree_path_get_indices (filter->priv->virtual_root)[0])
1613 gtk_tree_path_get_indices (filter->priv->virtual_root)[0] = new_pos;
1617 path = gtk_tree_path_new ();
1618 level = FILTER_LEVEL (filter->priv->root);
1622 GtkTreeIter child_iter;
1624 /* virtual root anchor reordering */
1625 if (filter->priv->virtual_root &&
1626 gtk_tree_path_get_depth (c_path) <
1627 gtk_tree_path_get_depth (filter->priv->virtual_root))
1632 GtkTreeIter real_c_iter;
1634 level = gtk_tree_path_get_depth (c_path);
1637 real_c_iter = *c_iter;
1639 gtk_tree_model_get_iter (c_model, &real_c_iter, c_path);
1641 length = gtk_tree_model_iter_n_children (c_model, &real_c_iter);
1643 for (i = 0; i < length; i++)
1644 if (new_order[i] == gtk_tree_path_get_indices (filter->priv->virtual_root)[level])
1650 gtk_tree_path_get_indices (filter->priv->virtual_root)[level] = new_pos;
1654 path = gtk_real_tree_model_filter_convert_child_path_to_path (filter,
1658 if (!path && filter->priv->virtual_root &&
1659 gtk_tree_path_compare (c_path, filter->priv->virtual_root))
1662 if (!path && !filter->priv->virtual_root)
1667 /* root level mode */
1669 gtk_tree_model_get_iter (c_model, c_iter, c_path);
1670 length = gtk_tree_model_iter_n_children (c_model, c_iter);
1671 path = gtk_tree_path_new ();
1672 level = FILTER_LEVEL (filter->priv->root);
1676 gtk_tree_model_get_iter (GTK_TREE_MODEL (data), &iter, path);
1678 level = FILTER_LEVEL (iter.user_data);
1679 elt = FILTER_ELT (iter.user_data2);
1683 gtk_tree_path_free (path);
1687 level = elt->children;
1689 gtk_tree_model_filter_convert_iter_to_child_iter (GTK_TREE_MODEL_FILTER (filter), &child_iter, &iter);
1690 length = gtk_tree_model_iter_n_children (c_model, &child_iter);
1694 if (level->array->len < 1)
1697 /* NOTE: we do not bail out here if level->array->len < 2 like
1698 * GtkTreeModelSort does. This because we do some special tricky
1702 /* construct a new array */
1703 new_array = g_array_sized_new (FALSE, FALSE, sizeof (FilterElt),
1705 tmp_array = g_new (gint, level->array->len);
1707 for (i = 0, elt_count = 0; i < length; i++)
1709 FilterElt *e = NULL;
1710 gint old_offset = -1;
1712 for (j = 0; j < level->array->len; j++)
1713 if (g_array_index (level->array, FilterElt, j).offset == new_order[i])
1715 e = &g_array_index (level->array, FilterElt, j);
1723 tmp_array[elt_count] = old_offset;
1724 g_array_append_val (new_array, *e);
1725 g_array_index (new_array, FilterElt, elt_count).offset = i;
1729 g_array_free (level->array, TRUE);
1730 level->array = new_array;
1733 for (i = 0; i < level->array->len; i++)
1735 FilterElt *e = &g_array_index (level->array, FilterElt, i);
1737 e->children->parent_elt = e;
1740 /* emit rows_reordered */
1741 if (!gtk_tree_path_get_indices (path))
1742 gtk_tree_model_rows_reordered (GTK_TREE_MODEL (data), path, NULL,
1745 gtk_tree_model_rows_reordered (GTK_TREE_MODEL (data), path, &iter,
1750 gtk_tree_path_free (path);
1753 /* TreeModelIface implementation */
1755 gtk_tree_model_filter_get_flags (GtkTreeModel *model)
1757 g_return_val_if_fail (GTK_IS_TREE_MODEL_FILTER (model), 0);
1763 gtk_tree_model_filter_get_n_columns (GtkTreeModel *model)
1765 GtkTreeModelFilter *filter = (GtkTreeModelFilter *)model;
1767 g_return_val_if_fail (GTK_IS_TREE_MODEL_FILTER (model), 0);
1768 g_return_val_if_fail (filter->priv->child_model != NULL, 0);
1770 if (filter->priv->child_model == NULL)
1773 /* so we can't modify the modify func after this ... */
1774 filter->priv->modify_func_set = TRUE;
1776 if (filter->priv->modify_n_columns > 0)
1777 return filter->priv->modify_n_columns;
1779 return gtk_tree_model_get_n_columns (filter->priv->child_model);
1783 gtk_tree_model_filter_get_column_type (GtkTreeModel *model,
1786 GtkTreeModelFilter *filter = (GtkTreeModelFilter *)model;
1788 g_return_val_if_fail (GTK_IS_TREE_MODEL_FILTER (model), G_TYPE_INVALID);
1789 g_return_val_if_fail (filter->priv->child_model != NULL, G_TYPE_INVALID);
1791 /* so we can't modify the modify func after this ... */
1792 filter->priv->modify_func_set = TRUE;
1794 if (filter->priv->modify_types)
1796 g_return_val_if_fail (index < filter->priv->modify_n_columns, G_TYPE_INVALID);
1798 return filter->priv->modify_types[index];
1801 return gtk_tree_model_get_column_type (filter->priv->child_model, index);
1805 gtk_tree_model_filter_get_iter (GtkTreeModel *model,
1809 GtkTreeModelFilter *filter = (GtkTreeModelFilter *)model;
1814 g_return_val_if_fail (GTK_IS_TREE_MODEL_FILTER (model), FALSE);
1815 g_return_val_if_fail (filter->priv->child_model != NULL, FALSE);
1817 indices = gtk_tree_path_get_indices (path);
1819 if (filter->priv->root == NULL)
1820 gtk_tree_model_filter_build_level (filter, NULL, NULL);
1821 level = FILTER_LEVEL (filter->priv->root);
1823 depth = gtk_tree_path_get_depth (path);
1830 for (i = 0; i < depth - 1; i++)
1832 if (!level || indices[i] >= level->array->len)
1837 if (!g_array_index (level->array, FilterElt, indices[i]).children)
1838 gtk_tree_model_filter_build_level (filter, level,
1839 &g_array_index (level->array,
1842 level = g_array_index (level->array, FilterElt, indices[i]).children;
1845 if (!level || indices[i] >= level->array->len)
1851 iter->stamp = filter->priv->stamp;
1852 iter->user_data = level;
1853 iter->user_data2 = &g_array_index (level->array, FilterElt,
1854 indices[depth - 1]);
1859 static GtkTreePath *
1860 gtk_tree_model_filter_get_path (GtkTreeModel *model,
1863 GtkTreePath *retval;
1867 g_return_val_if_fail (GTK_IS_TREE_MODEL_FILTER (model), NULL);
1868 g_return_val_if_fail (GTK_TREE_MODEL_FILTER (model)->priv->child_model != NULL, NULL);
1869 g_return_val_if_fail (GTK_TREE_MODEL_FILTER (model)->priv->stamp == iter->stamp, NULL);
1871 retval = gtk_tree_path_new ();
1872 level = iter->user_data;
1873 elt = iter->user_data2;
1877 gtk_tree_path_prepend_index (retval,
1878 elt - FILTER_ELT (level->array->data));
1879 elt = level->parent_elt;
1880 level = level->parent_level;
1887 gtk_tree_model_filter_get_value (GtkTreeModel *model,
1892 GtkTreeIter child_iter;
1893 GtkTreeModelFilter *filter = GTK_TREE_MODEL_FILTER (model);
1895 g_return_if_fail (GTK_IS_TREE_MODEL_FILTER (model));
1896 g_return_if_fail (GTK_TREE_MODEL_FILTER (model)->priv->child_model != NULL);
1897 g_return_if_fail (GTK_TREE_MODEL_FILTER (model)->priv->stamp == iter->stamp);
1899 if (filter->priv->modify_func)
1901 g_return_if_fail (column < filter->priv->modify_n_columns);
1903 g_value_init (value, filter->priv->modify_types[column]);
1904 filter->priv->modify_func (model,
1908 filter->priv->modify_data);
1913 gtk_tree_model_filter_convert_iter_to_child_iter (GTK_TREE_MODEL_FILTER (model), &child_iter, iter);
1914 gtk_tree_model_get_value (GTK_TREE_MODEL_FILTER (model)->priv->child_model,
1915 &child_iter, column, value);
1919 gtk_tree_model_filter_iter_next (GtkTreeModel *model,
1925 g_return_val_if_fail (GTK_IS_TREE_MODEL_FILTER (model), FALSE);
1926 g_return_val_if_fail (GTK_TREE_MODEL_FILTER (model)->priv->child_model != NULL, FALSE);
1927 g_return_val_if_fail (GTK_TREE_MODEL_FILTER (model)->priv->stamp == iter->stamp, FALSE);
1929 level = iter->user_data;
1930 elt = iter->user_data2;
1932 if (elt - FILTER_ELT (level->array->data) >= level->array->len - 1)
1938 iter->user_data2 = elt + 1;
1944 gtk_tree_model_filter_iter_children (GtkTreeModel *model,
1946 GtkTreeIter *parent)
1948 GtkTreeModelFilter *filter = (GtkTreeModelFilter *)model;
1952 g_return_val_if_fail (GTK_IS_TREE_MODEL_FILTER (model), FALSE);
1953 g_return_val_if_fail (filter->priv->child_model != NULL, FALSE);
1955 g_return_val_if_fail (filter->priv->stamp == parent->stamp, FALSE);
1959 if (!filter->priv->root)
1960 gtk_tree_model_filter_build_level (filter, NULL, NULL);
1961 if (!filter->priv->root)
1964 level = filter->priv->root;
1965 iter->stamp = filter->priv->stamp;
1966 iter->user_data = level;
1967 iter->user_data2 = level->array->data;
1971 if (FILTER_ELT (parent->user_data2)->children == NULL)
1972 gtk_tree_model_filter_build_level (filter,
1973 FILTER_LEVEL (parent->user_data),
1974 FILTER_ELT (parent->user_data2));
1975 if (FILTER_ELT (parent->user_data2)->children == NULL)
1979 if (FILTER_ELT (parent->user_data2)->children->array->len <= 0)
1982 iter->stamp = filter->priv->stamp;
1983 iter->user_data = FILTER_ELT (parent->user_data2)->children;
1984 iter->user_data2 = FILTER_LEVEL (iter->user_data)->array->data;
1991 gtk_tree_model_filter_iter_has_child (GtkTreeModel *model,
1994 GtkTreeIter child_iter;
1995 GtkTreeModelFilter *filter = (GtkTreeModelFilter *)model;
1998 g_return_val_if_fail (GTK_IS_TREE_MODEL_FILTER (model), FALSE);
1999 g_return_val_if_fail (filter->priv->child_model != NULL, FALSE);
2000 g_return_val_if_fail (filter->priv->stamp == iter->stamp, FALSE);
2002 filter = GTK_TREE_MODEL_FILTER (model);
2004 gtk_tree_model_filter_convert_iter_to_child_iter (GTK_TREE_MODEL_FILTER (model), &child_iter, iter);
2005 elt = FILTER_ELT (iter->user_data2);
2007 /* we need to build the level to check if not all children are filtered
2011 && gtk_tree_model_iter_has_child (filter->priv->child_model, &child_iter))
2012 gtk_tree_model_filter_build_level (filter, FILTER_LEVEL (iter->user_data),
2015 /* FIXME: we should prolly count the visible nodes here, just like in
2018 if (elt->children && elt->children->array->len > 0)
2025 gtk_tree_model_filter_iter_n_children (GtkTreeModel *model,
2028 GtkTreeIter child_iter;
2029 GtkTreeModelFilter *filter = (GtkTreeModelFilter *)model;
2032 g_return_val_if_fail (GTK_IS_TREE_MODEL_FILTER (model), 0);
2033 g_return_val_if_fail (filter->priv->child_model != NULL, 0);
2035 g_return_val_if_fail (filter->priv->stamp == iter->stamp, 0);
2039 if (!filter->priv->root)
2040 gtk_tree_model_filter_build_level (filter, NULL, NULL);
2042 /* count visible nodes */
2043 return filter->priv->root_level_visible;
2046 elt = FILTER_ELT (iter->user_data2);
2047 gtk_tree_model_filter_convert_iter_to_child_iter (GTK_TREE_MODEL_FILTER (model), &child_iter, iter);
2049 if (!elt->children &&
2050 gtk_tree_model_iter_has_child (filter->priv->child_model, &child_iter))
2051 gtk_tree_model_filter_build_level (filter,
2052 FILTER_LEVEL (iter->user_data),
2055 if (elt->children && elt->children->array->len)
2059 GArray *a = elt->children->array;
2061 /* count visible nodes */
2062 for (i = 0; i < a->len; i++)
2063 if (g_array_index (a, FilterElt, i).visible)
2073 gtk_tree_model_filter_iter_nth_child (GtkTreeModel *model,
2075 GtkTreeIter *parent,
2079 GtkTreeIter children;
2081 g_return_val_if_fail (GTK_IS_TREE_MODEL_FILTER (model), FALSE);
2083 g_return_val_if_fail (GTK_TREE_MODEL_FILTER (model)->priv->stamp == parent->stamp, FALSE);
2085 /* use this instead of has_Child to force us to build the level, if needed */
2086 if (gtk_tree_model_filter_iter_children (model, &children, parent) == FALSE)
2092 level = children.user_data;
2093 if (n >= level->array->len)
2099 iter->stamp = GTK_TREE_MODEL_FILTER (model)->priv->stamp;
2100 iter->user_data = level;
2101 iter->user_data2 = &g_array_index (level->array, FilterElt, n);
2107 gtk_tree_model_filter_iter_parent (GtkTreeModel *model,
2114 g_return_val_if_fail (GTK_IS_TREE_MODEL_FILTER (model), FALSE);
2115 g_return_val_if_fail (GTK_TREE_MODEL_FILTER (model)->priv->child_model != NULL, FALSE);
2116 g_return_val_if_fail (GTK_TREE_MODEL_FILTER (model)->priv->stamp == child->stamp, FALSE);
2118 level = child->user_data;
2120 if (level->parent_level)
2122 iter->stamp = GTK_TREE_MODEL_FILTER (model)->priv->stamp;
2123 iter->user_data = level->parent_level;
2124 iter->user_data2 = level->parent_elt;
2133 gtk_tree_model_filter_ref_node (GtkTreeModel *model,
2136 GtkTreeModelFilter *filter = (GtkTreeModelFilter *)model;
2137 GtkTreeIter child_iter;
2141 g_return_if_fail (GTK_IS_TREE_MODEL_FILTER (model));
2142 g_return_if_fail (GTK_TREE_MODEL_FILTER (model)->priv->child_model != NULL);
2143 g_return_if_fail (GTK_TREE_MODEL_FILTER (model)->priv->stamp == iter->stamp);
2145 gtk_tree_model_filter_convert_iter_to_child_iter (GTK_TREE_MODEL_FILTER (model), &child_iter, iter);
2147 gtk_tree_model_ref_node (filter->priv->child_model, &child_iter);
2149 level = iter->user_data;
2150 elt = iter->user_data2;
2154 if (level->ref_count == 1)
2156 FilterLevel *parent_level = level->parent_level;
2157 FilterElt *parent_elt = level->parent_elt;
2159 /* we were at zero -- time to decrease the zero_ref_count val */
2163 parent_elt->zero_ref_count--;
2167 parent_elt = parent_level->parent_elt;
2168 parent_level = parent_level->parent_level;
2171 while (parent_level);
2172 filter->priv->zero_ref_count--;
2177 gtk_tree_model_filter_unref_node (GtkTreeModel *model,
2180 gtk_tree_model_filter_real_unref_node (model, iter, TRUE);
2184 gtk_tree_model_filter_real_unref_node (GtkTreeModel *model,
2186 gboolean propagate_unref)
2188 GtkTreeModelFilter *filter = (GtkTreeModelFilter *)model;
2192 g_return_if_fail (GTK_IS_TREE_MODEL_FILTER (model));
2193 g_return_if_fail (filter->priv->child_model != NULL);
2194 g_return_if_fail (filter->priv->stamp == iter->stamp);
2196 if (propagate_unref)
2198 GtkTreeIter child_iter;
2199 gtk_tree_model_filter_convert_iter_to_child_iter (GTK_TREE_MODEL_FILTER (model), &child_iter, iter);
2200 gtk_tree_model_unref_node (filter->priv->child_model, &child_iter);
2203 level = iter->user_data;
2204 elt = iter->user_data2;
2206 g_return_if_fail (elt->ref_count > 0);
2210 if (level->ref_count == 0)
2212 FilterLevel *parent_level = level->parent_level;
2213 FilterElt *parent_elt = level->parent_elt;
2215 /* we are at zero -- time to increase the zero_ref_count val */
2216 while (parent_level)
2218 parent_elt->zero_ref_count++;
2220 parent_elt = parent_level->parent_elt;
2221 parent_level = parent_level->parent_level;
2223 filter->priv->zero_ref_count++;
2227 /* bits and pieces */
2229 gtk_tree_model_filter_set_model (GtkTreeModelFilter *filter,
2230 GtkTreeModel *child_model)
2232 g_return_if_fail (GTK_IS_TREE_MODEL_FILTER (filter));
2234 if (filter->priv->child_model)
2236 g_signal_handler_disconnect (G_OBJECT (filter->priv->child_model),
2237 filter->priv->changed_id);
2238 g_signal_handler_disconnect (G_OBJECT (filter->priv->child_model),
2239 filter->priv->inserted_id);
2240 g_signal_handler_disconnect (G_OBJECT (filter->priv->child_model),
2241 filter->priv->has_child_toggled_id);
2242 g_signal_handler_disconnect (G_OBJECT (filter->priv->child_model),
2243 filter->priv->deleted_id);
2244 g_signal_handler_disconnect (G_OBJECT (filter->priv->child_model),
2245 filter->priv->reordered_id);
2247 /* reset our state */
2248 if (filter->priv->root)
2249 gtk_tree_model_filter_free_level (filter, filter->priv->root);
2251 filter->priv->root = NULL;
2252 g_object_unref (G_OBJECT (filter->priv->child_model));
2253 filter->priv->visible_column = -1;
2254 /* FIXME: destroy more crack here? the funcs? */
2257 filter->priv->child_model = child_model;
2261 g_object_ref (G_OBJECT (filter->priv->child_model));
2262 filter->priv->changed_id =
2263 g_signal_connect (child_model, "row_changed",
2264 G_CALLBACK (gtk_tree_model_filter_row_changed),
2266 filter->priv->inserted_id =
2267 g_signal_connect (child_model, "row_inserted",
2268 G_CALLBACK (gtk_tree_model_filter_row_inserted),
2270 filter->priv->has_child_toggled_id =
2271 g_signal_connect (child_model, "row_has_child_toggled",
2272 G_CALLBACK (gtk_tree_model_filter_row_has_child_toggled),
2274 filter->priv->deleted_id =
2275 g_signal_connect (child_model, "row_deleted",
2276 G_CALLBACK (gtk_tree_model_filter_row_deleted),
2278 filter->priv->reordered_id =
2279 g_signal_connect (child_model, "rows_reordered",
2280 G_CALLBACK (gtk_tree_model_filter_rows_reordered),
2283 filter->priv->child_flags = gtk_tree_model_get_flags (child_model);
2284 filter->priv->stamp = g_random_int ();
2289 gtk_tree_model_filter_set_root (GtkTreeModelFilter *filter,
2292 g_return_if_fail (GTK_IS_TREE_MODEL_FILTER (filter));
2295 filter->priv->virtual_root = NULL;
2297 filter->priv->virtual_root = gtk_tree_path_copy (root);
2303 * gtk_tree_model_filter_new:
2304 * @child_model: A #GtkTreeModel.
2305 * @root: A #GtkTreePath or %NULL.
2307 * Creates a new #GtkTreeModel, with @child_model as the child_model
2308 * and @root as the virtual root.
2310 * Return value: A new #GtkTreeModel.
2315 gtk_tree_model_filter_new (GtkTreeModel *child_model,
2318 GtkTreeModel *retval;
2320 g_return_val_if_fail (GTK_IS_TREE_MODEL (child_model), NULL);
2322 retval = GTK_TREE_MODEL (g_object_new (gtk_tree_model_filter_get_type (), NULL));
2324 gtk_tree_model_filter_set_model (GTK_TREE_MODEL_FILTER (retval),
2326 gtk_tree_model_filter_set_root (GTK_TREE_MODEL_FILTER (retval), root);
2332 * gtk_tree_model_filter_get_model:
2333 * @filter: A #GtkTreeModelFilter.
2335 * Returns a pointer to the child model of @filter.
2337 * Return value: A pointer to a #GtkTreeModel.
2342 gtk_tree_model_filter_get_model (GtkTreeModelFilter *filter)
2344 g_return_val_if_fail (GTK_IS_TREE_MODEL_FILTER (filter), NULL);
2346 return filter->priv->child_model;
2350 * gtk_tree_model_filter_set_visible_func:
2351 * @filter: A #GtkTreeModelFilter.
2352 * @func: A #GtkTreeModelFilterVisibleFunc, the visible function.
2353 * @data: User data to pass to the visible function, or %NULL.
2354 * @destroy: Destroy notifier of @data, or %NULL.
2356 * Sets the visible function used when filtering the @filter to be @func. The
2357 * function should return %TRUE if the given row should be visible and
2363 gtk_tree_model_filter_set_visible_func (GtkTreeModelFilter *filter,
2364 GtkTreeModelFilterVisibleFunc func,
2366 GtkDestroyNotify destroy)
2368 g_return_if_fail (GTK_IS_TREE_MODEL_FILTER (filter));
2369 g_return_if_fail (func != NULL);
2370 g_return_if_fail (filter->priv->visible_method_set == FALSE);
2372 if (filter->priv->visible_func)
2374 GtkDestroyNotify d = filter->priv->visible_destroy;
2376 filter->priv->visible_destroy = NULL;
2377 d (filter->priv->visible_data);
2380 filter->priv->visible_func = func;
2381 filter->priv->visible_data = data;
2382 filter->priv->visible_destroy = destroy;
2384 filter->priv->visible_method_set = TRUE;
2388 * gtk_tree_model_filter_set_modify_func:
2389 * @filter: A #GtkTreeModelFilter.
2390 * @n_columns: The number of columns in the filter model.
2391 * @types: The #GType<!-- -->s of the columns.
2392 * @func: A #GtkTreeModelFilterModifyFunc, or %NULL.
2393 * @data: User data to pass to the modify function, or %NULL.
2394 * @destroy: Destroy notifier of @data, or %NULL.
2396 * Sets the @filter to have @n_columns columns with @types. If @func
2397 * is not %NULL, it will set @func to be the modify function of @filter.
2402 gtk_tree_model_filter_set_modify_func (GtkTreeModelFilter *filter,
2405 GtkTreeModelFilterModifyFunc func,
2407 GtkDestroyNotify destroy)
2409 g_return_if_fail (GTK_IS_TREE_MODEL_FILTER (filter));
2410 g_return_if_fail (func != NULL);
2411 g_return_if_fail (filter->priv->modify_func_set == FALSE);
2413 if (filter->priv->modify_destroy)
2415 GtkDestroyNotify d = filter->priv->modify_destroy;
2417 filter->priv->modify_destroy = NULL;
2418 d (filter->priv->modify_data);
2421 filter->priv->modify_n_columns = n_columns;
2422 filter->priv->modify_types = g_new0 (GType, n_columns);
2423 memcpy (filter->priv->modify_types, types, sizeof (GType) * n_columns);
2424 filter->priv->modify_func = func;
2425 filter->priv->modify_data = data;
2426 filter->priv->modify_destroy = destroy;
2428 filter->priv->modify_func_set = TRUE;
2432 * gtk_tree_model_filter_set_visible_column:
2433 * @filter: A #GtkTreeModelFilter.
2434 * @column: A #gint which is the column containing the visible information.
2436 * Sets @column of the child_model to be the column where @filter should
2437 * look for visibility information. @columns should be a column of type
2438 * %G_TYPE_BOOLEAN, where %TRUE means that a row is visible, and %FALSE
2444 gtk_tree_model_filter_set_visible_column (GtkTreeModelFilter *filter,
2447 g_return_if_fail (GTK_IS_TREE_MODEL_FILTER (filter));
2448 g_return_if_fail (column >= 0);
2449 g_return_if_fail (filter->priv->visible_method_set == FALSE);
2451 filter->priv->visible_column = column;
2453 filter->priv->visible_method_set = TRUE;
2459 * gtk_tree_model_filter_convert_child_iter_to_iter:
2460 * @filter: A #GtkTreeModelFilter.
2461 * @filter_iter: An uninitialized #GtkTreeIter.
2462 * @child_iter: A valid #GtkTreeIter pointing to a row on the child model.
2464 * Sets @filter_iter to point to the row in @filter that corresponds to the
2465 * row pointed at by @child_iter.
2470 gtk_tree_model_filter_convert_child_iter_to_iter (GtkTreeModelFilter *filter,
2471 GtkTreeIter *filter_iter,
2472 GtkTreeIter *child_iter)
2474 GtkTreePath *child_path, *path;
2476 g_return_if_fail (GTK_IS_TREE_MODEL_FILTER (filter));
2477 g_return_if_fail (filter->priv->child_model != NULL);
2478 g_return_if_fail (filter_iter != NULL);
2479 g_return_if_fail (child_iter != NULL);
2481 filter_iter->stamp = 0;
2483 child_path = gtk_tree_model_get_path (filter->priv->child_model, child_iter);
2484 g_return_if_fail (child_path != NULL);
2486 path = gtk_tree_model_filter_convert_child_path_to_path (filter,
2488 gtk_tree_path_free (child_path);
2489 g_return_if_fail (path != NULL);
2491 gtk_tree_model_get_iter (GTK_TREE_MODEL (filter), filter_iter, path);
2492 gtk_tree_path_free (path);
2496 * gtk_tree_model_filter_convert_iter_to_child_iter:
2497 * @filter: A #GtkTreeModelFilter.
2498 * @child_iter: An uninitialized #GtkTreeIter.
2499 * @filter_iter: A valid #GtkTreeIter pointing to a row on @filter.
2501 * Sets @child_iter to point to the row pointed to by @filter_iter.
2506 gtk_tree_model_filter_convert_iter_to_child_iter (GtkTreeModelFilter *filter,
2507 GtkTreeIter *child_iter,
2508 GtkTreeIter *filter_iter)
2510 g_return_if_fail (GTK_IS_TREE_MODEL_FILTER (filter));
2511 g_return_if_fail (filter->priv->child_model != NULL);
2512 g_return_if_fail (child_iter != NULL);
2513 g_return_if_fail (filter_iter != NULL);
2514 g_return_if_fail (filter_iter->stamp == filter->priv->stamp);
2516 if (GTK_TREE_MODEL_FILTER_CACHE_CHILD_ITERS (filter))
2518 *child_iter = FILTER_ELT (filter_iter->user_data2)->iter;
2524 path = gtk_tree_model_filter_elt_get_path (filter_iter->user_data,
2525 filter_iter->user_data2,
2526 filter->priv->virtual_root);
2527 gtk_tree_model_get_iter (filter->priv->child_model, child_iter, path);
2528 gtk_tree_path_free (path);
2532 static GtkTreePath *
2533 gtk_real_tree_model_filter_convert_child_path_to_path (GtkTreeModelFilter *filter,
2534 GtkTreePath *child_path,
2535 gboolean build_levels,
2536 gboolean fetch_childs)
2538 gint *child_indices;
2539 GtkTreePath *retval;
2540 GtkTreePath *real_path;
2545 g_return_val_if_fail (GTK_IS_TREE_MODEL_FILTER (filter), NULL);
2546 g_return_val_if_fail (filter->priv->child_model != NULL, NULL);
2547 g_return_val_if_fail (child_path != NULL, NULL);
2549 if (!filter->priv->virtual_root)
2550 real_path = gtk_tree_path_copy (child_path);
2552 real_path = gtk_tree_model_filter_remove_root (child_path,
2553 filter->priv->virtual_root);
2558 retval = gtk_tree_path_new ();
2559 child_indices = gtk_tree_path_get_indices (real_path);
2561 if (filter->priv->root == NULL && build_levels)
2562 gtk_tree_model_filter_build_level (filter, NULL, NULL);
2563 level = FILTER_LEVEL (filter->priv->root);
2565 for (i = 0; i < gtk_tree_path_get_depth (real_path); i++)
2568 gboolean found_child = FALSE;
2572 gtk_tree_path_free (real_path);
2573 gtk_tree_path_free (retval);
2577 tmp = bsearch_elt_with_offset (level->array, child_indices[i], &j);
2580 gtk_tree_path_append_index (retval, j);
2581 if (!tmp->children && build_levels)
2582 gtk_tree_model_filter_build_level (filter, level, tmp);
2583 level = tmp->children;
2587 if (!found_child && fetch_childs)
2589 tmp = gtk_tree_model_filter_fetch_child (filter, level,
2593 /* didn't find the child, let's try to bring it back */
2594 if (!tmp || tmp->offset != child_indices[i])
2597 gtk_tree_path_free (real_path);
2598 gtk_tree_path_free (retval);
2602 gtk_tree_path_append_index (retval, j);
2603 if (!tmp->children && build_levels)
2604 gtk_tree_model_filter_build_level (filter, level, tmp);
2605 level = tmp->children;
2608 else if (!found_child && !fetch_childs)
2611 gtk_tree_path_free (real_path);
2612 gtk_tree_path_free (retval);
2617 gtk_tree_path_free (real_path);
2622 * gtk_tree_model_filter_convert_child_path_to_path:
2623 * @filter: A #GtkTreeModelFilter.
2624 * @child_path: A #GtkTreePath to convert.
2626 * Converts @child_path to a path relative to @filter. That is, @child_path
2627 * points to a path in the child model. The rerturned path will point to the
2628 * same row in the filtered model. If @child_path isn't a valid path on the
2629 * child model, then %NULL is returned.
2631 * Return value: A newly allocated #GtkTreePath, or %NULL.
2636 gtk_tree_model_filter_convert_child_path_to_path (GtkTreeModelFilter *filter,
2637 GtkTreePath *child_path)
2639 /* this function does the sanity checks */
2640 return gtk_real_tree_model_filter_convert_child_path_to_path (filter,
2647 * gtk_tree_model_filter_convert_path_to_child_path:
2648 * @filter: A #GtkTreeModelFilter.
2649 * @filter_path: A #GtkTreePath to convert.
2651 * Converts @filter_path to a path on the child model of @filter. That is,
2652 * @filter_path points to a location in @filter. The returned path will
2653 * point to the same location in the model not being filtered. If @filter_path
2654 * does not point to a location in the child model, %NULL is returned.
2656 * Return value: A newly allocated #GtkTreePath, or %NULL.
2661 gtk_tree_model_filter_convert_path_to_child_path (GtkTreeModelFilter *filter,
2662 GtkTreePath *filter_path)
2664 gint *filter_indices;
2665 GtkTreePath *retval;
2669 g_return_val_if_fail (GTK_IS_TREE_MODEL_FILTER (filter), NULL);
2670 g_return_val_if_fail (filter->priv->child_model != NULL, NULL);
2671 g_return_val_if_fail (filter_path != NULL, NULL);
2674 retval = gtk_tree_path_new ();
2675 filter_indices = gtk_tree_path_get_indices (filter_path);
2676 if (!filter->priv->root)
2677 gtk_tree_model_filter_build_level (filter, NULL, NULL);
2678 level = FILTER_LEVEL (filter->priv->root);
2680 for (i = 0; i < gtk_tree_path_get_depth (filter_path); i++)
2682 gint count = filter_indices[i];
2684 if (!level || level->array->len <= filter_indices[i])
2686 gtk_tree_path_free (retval);
2690 if (g_array_index (level->array, FilterElt, count).children == NULL)
2691 gtk_tree_model_filter_build_level (filter, level, &g_array_index (level->array, FilterElt, count));
2693 if (!level || level->array->len <= filter_indices[i])
2695 gtk_tree_path_free (retval);
2699 gtk_tree_path_append_index (retval, g_array_index (level->array, FilterElt, count).offset);
2700 level = g_array_index (level->array, FilterElt, count).children;
2705 if (filter->priv->virtual_root)
2707 GtkTreePath *real_retval;
2709 real_retval = gtk_tree_model_filter_add_root (retval,
2710 filter->priv->virtual_root);
2711 gtk_tree_path_free (retval);
2720 gtk_tree_model_filter_refilter_helper (GtkTreeModel *model,
2725 /* evil, don't try this at home, but certainly speeds things up */
2726 gtk_tree_model_filter_row_changed (model, path, iter, data);
2732 * gtk_tree_model_filter_refilter:
2733 * @filter: A #GtkTreeModelFilter.
2735 * Emits ::row_changed for each row in the child model, which causes
2736 * the filter to re-evaluate whether a row is visible or not.
2741 gtk_tree_model_filter_refilter (GtkTreeModelFilter *filter)
2743 g_return_if_fail (GTK_IS_TREE_MODEL_FILTER (filter));
2746 gtk_tree_model_foreach (filter->priv->child_model,
2747 gtk_tree_model_filter_refilter_helper,
2752 * gtk_tree_model_filter_clear_cache:
2753 * @filter: A #GtkTreeModelFilter.
2755 * This function should almost never be called. It clears the @filter
2756 * of any cached iterators that haven't been reffed with
2757 * gtk_tree_model_ref_node(). This might be useful if the child model
2758 * being filtered is static (and doesn't change often) and there has been
2759 * a lot of unreffed access to nodes. As a side effect of this function,
2760 * all unreffed itters will be invalid.
2765 gtk_tree_model_filter_clear_cache (GtkTreeModelFilter *filter)
2767 g_return_if_fail (GTK_IS_TREE_MODEL_FILTER (filter));
2769 if (filter->priv->zero_ref_count)
2770 gtk_tree_model_filter_clear_cache_helper (filter,
2771 FILTER_LEVEL (filter->priv->root));