1 /* gtktreemodelfilter.c
2 * Copyright (C) 2000,2001 Red Hat, Inc., Jonathan Blandford <jrb@redhat.com>
3 * Copyright (C) 2001-2003 Kristian Rietveld <kris@gtk.org>
5 * This library is free software; you can redistribute it and/or
6 * modify it under the terms of the GNU Library General Public
7 * License as published by the Free Software Foundation; either
8 * version 2 of the License, or (at your option) any later version.
10 * This library is distributed in the hope that it will be useful,
11 * but WITHOUT ANY WARRANTY; without even the implied warranty of
12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
13 * Library General Public License for more details.
15 * You should have received a copy of the GNU Library General Public
16 * License along with this library; if not, write to the
17 * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
18 * Boston, MA 02111-1307, USA.
22 #include "gtktreemodelfilter.h"
24 #include "gtktreednd.h"
25 #include "gtkprivate.h"
31 * iter->stamp = filter->priv->stamp
32 * iter->user_data = FilterLevel
33 * iter->user_data2 = FilterElt
36 /* all paths, iters, etc prefixed with c_ are paths, iters, etc relative to the
41 * There are three model/views involved, so there are two mappings:
42 * * this model -> child model: mapped via offset in FilterElt.
43 * * this model -> parent model (or view): mapped via the array index
46 * Note that there are two kinds of paths relative to the filter model
47 * (those generated from the array indices): paths taking non-visible
48 * nodes into account, and paths which don't. Paths which take
49 * non-visible nodes into account should only be used internally and
50 * NEVER be passed along with a signal emission.
52 * The filter model has a reference on every node that is not in the root
53 * level and has a parent with ref_count > 1. Exception is a virtual root
54 * level; all nodes in the virtual root level are referenced too.
57 typedef struct _FilterElt FilterElt;
58 typedef struct _FilterLevel FilterLevel;
63 FilterLevel *children;
76 gint parent_elt_index;
77 FilterLevel *parent_level;
80 #define GTK_TREE_MODEL_FILTER_GET_PRIVATE(obj) (G_TYPE_INSTANCE_GET_PRIVATE ((obj), GTK_TYPE_TREE_MODEL_FILTER, GtkTreeModelFilterPrivate))
82 struct _GtkTreeModelFilterPrivate
87 GtkTreeModel *child_model;
90 GtkTreePath *virtual_root;
92 GtkTreeModelFilterVisibleFunc visible_func;
93 gpointer visible_data;
94 GDestroyNotify visible_destroy;
96 gint modify_n_columns;
98 GtkTreeModelFilterModifyFunc modify_func;
100 GDestroyNotify modify_destroy;
104 gboolean visible_method_set;
105 gboolean modify_func_set;
107 gboolean in_row_deleted;
108 gboolean virtual_root_deleted;
113 guint has_child_toggled_id;
126 #define GTK_TREE_MODEL_FILTER_CACHE_CHILD_ITERS(filter) \
127 (((GtkTreeModelFilter *)filter)->priv->child_flags & GTK_TREE_MODEL_ITERS_PERSIST)
129 #define FILTER_ELT(filter_elt) ((FilterElt *)filter_elt)
130 #define FILTER_LEVEL(filter_level) ((FilterLevel *)filter_level)
132 #define FILTER_LEVEL_PARENT_ELT(level) (&g_array_index (FILTER_LEVEL ((level))->parent_level->array, FilterElt, FILTER_LEVEL ((level))->parent_elt_index))
133 #define FILTER_LEVEL_ELT_INDEX(level, elt) (FILTER_ELT ((elt)) - FILTER_ELT (FILTER_LEVEL ((level))->array->data))
135 /* general code (object/interface init, properties, etc) */
136 static void gtk_tree_model_filter_tree_model_init (GtkTreeModelIface *iface);
137 static void gtk_tree_model_filter_drag_source_init (GtkTreeDragSourceIface *iface);
138 static void gtk_tree_model_filter_finalize (GObject *object);
139 static void gtk_tree_model_filter_set_property (GObject *object,
143 static void gtk_tree_model_filter_get_property (GObject *object,
148 /* signal handlers */
149 static void gtk_tree_model_filter_row_changed (GtkTreeModel *c_model,
153 static void gtk_tree_model_filter_row_inserted (GtkTreeModel *c_model,
157 static void gtk_tree_model_filter_row_has_child_toggled (GtkTreeModel *c_model,
161 static void gtk_tree_model_filter_row_deleted (GtkTreeModel *c_model,
164 static void gtk_tree_model_filter_rows_reordered (GtkTreeModel *c_model,
170 /* GtkTreeModel interface */
171 static GtkTreeModelFlags gtk_tree_model_filter_get_flags (GtkTreeModel *model);
172 static gint gtk_tree_model_filter_get_n_columns (GtkTreeModel *model);
173 static GType gtk_tree_model_filter_get_column_type (GtkTreeModel *model,
175 static gboolean gtk_tree_model_filter_get_iter_full (GtkTreeModel *model,
178 static gboolean gtk_tree_model_filter_get_iter (GtkTreeModel *model,
181 static GtkTreePath *gtk_tree_model_filter_get_path (GtkTreeModel *model,
183 static void gtk_tree_model_filter_get_value (GtkTreeModel *model,
187 static gboolean gtk_tree_model_filter_iter_next (GtkTreeModel *model,
189 static gboolean gtk_tree_model_filter_iter_children (GtkTreeModel *model,
191 GtkTreeIter *parent);
192 static gboolean gtk_tree_model_filter_iter_has_child (GtkTreeModel *model,
194 static gint gtk_tree_model_filter_iter_n_children (GtkTreeModel *model,
196 static gboolean gtk_tree_model_filter_iter_nth_child (GtkTreeModel *model,
200 static gboolean gtk_tree_model_filter_iter_parent (GtkTreeModel *model,
203 static void gtk_tree_model_filter_ref_node (GtkTreeModel *model,
205 static void gtk_tree_model_filter_unref_node (GtkTreeModel *model,
208 /* TreeDragSource interface */
209 static gboolean gtk_tree_model_filter_row_draggable (GtkTreeDragSource *drag_source,
211 static gboolean gtk_tree_model_filter_drag_data_get (GtkTreeDragSource *drag_source,
213 GtkSelectionData *selection_data);
214 static gboolean gtk_tree_model_filter_drag_data_delete (GtkTreeDragSource *drag_source,
217 /* private functions */
218 static void gtk_tree_model_filter_build_level (GtkTreeModelFilter *filter,
219 FilterLevel *parent_level,
220 gint parent_elt_index,
221 gboolean emit_inserted);
223 static void gtk_tree_model_filter_free_level (GtkTreeModelFilter *filter,
224 FilterLevel *filter_level);
226 static GtkTreePath *gtk_tree_model_filter_elt_get_path (FilterLevel *level,
230 static GtkTreePath *gtk_tree_model_filter_add_root (GtkTreePath *src,
232 static GtkTreePath *gtk_tree_model_filter_remove_root (GtkTreePath *src,
235 static void gtk_tree_model_filter_increment_stamp (GtkTreeModelFilter *filter);
237 static gboolean gtk_tree_model_filter_visible (GtkTreeModelFilter *filter,
238 GtkTreeIter *child_iter);
239 static void gtk_tree_model_filter_clear_cache_helper (GtkTreeModelFilter *filter,
242 static void gtk_tree_model_filter_real_unref_node (GtkTreeModel *model,
244 gboolean propagate_unref);
246 static void gtk_tree_model_filter_set_model (GtkTreeModelFilter *filter,
247 GtkTreeModel *child_model);
248 static void gtk_tree_model_filter_ref_path (GtkTreeModelFilter *filter,
250 static void gtk_tree_model_filter_unref_path (GtkTreeModelFilter *filter,
252 static void gtk_tree_model_filter_set_root (GtkTreeModelFilter *filter,
255 static GtkTreePath *gtk_real_tree_model_filter_convert_child_path_to_path (GtkTreeModelFilter *filter,
256 GtkTreePath *child_path,
257 gboolean build_levels,
258 gboolean fetch_children);
260 static FilterElt *gtk_tree_model_filter_get_nth (GtkTreeModelFilter *filter,
263 static gboolean gtk_tree_model_filter_elt_is_visible_in_target (FilterLevel *level,
265 static FilterElt *gtk_tree_model_filter_get_nth_visible (GtkTreeModelFilter *filter,
269 static FilterElt *gtk_tree_model_filter_fetch_child (GtkTreeModelFilter *filter,
273 static void gtk_tree_model_filter_remove_node (GtkTreeModelFilter *filter,
275 static void gtk_tree_model_filter_update_children (GtkTreeModelFilter *filter,
278 static FilterElt *bsearch_elt_with_offset (GArray *array,
283 G_DEFINE_TYPE_WITH_CODE (GtkTreeModelFilter, gtk_tree_model_filter, G_TYPE_OBJECT,
284 G_IMPLEMENT_INTERFACE (GTK_TYPE_TREE_MODEL,
285 gtk_tree_model_filter_tree_model_init)
286 G_IMPLEMENT_INTERFACE (GTK_TYPE_TREE_DRAG_SOURCE,
287 gtk_tree_model_filter_drag_source_init))
290 gtk_tree_model_filter_init (GtkTreeModelFilter *filter)
292 filter->priv = GTK_TREE_MODEL_FILTER_GET_PRIVATE (filter);
294 filter->priv->visible_column = -1;
295 filter->priv->zero_ref_count = 0;
296 filter->priv->visible_method_set = FALSE;
297 filter->priv->modify_func_set = FALSE;
298 filter->priv->in_row_deleted = FALSE;
299 filter->priv->virtual_root_deleted = FALSE;
303 gtk_tree_model_filter_class_init (GtkTreeModelFilterClass *filter_class)
305 GObjectClass *object_class;
307 object_class = (GObjectClass *) filter_class;
309 object_class->set_property = gtk_tree_model_filter_set_property;
310 object_class->get_property = gtk_tree_model_filter_get_property;
312 object_class->finalize = gtk_tree_model_filter_finalize;
314 /* Properties -- FIXME: disabled translations for now, until I can come up with a
317 g_object_class_install_property (object_class,
319 g_param_spec_object ("child-model",
321 ("The model for the filtermodel to filter"),
323 GTK_PARAM_READWRITE | G_PARAM_CONSTRUCT_ONLY));
325 g_object_class_install_property (object_class,
327 g_param_spec_boxed ("virtual-root",
328 ("The virtual root"),
329 ("The virtual root (relative to the child model) for this filtermodel"),
331 GTK_PARAM_READWRITE | G_PARAM_CONSTRUCT_ONLY));
333 g_type_class_add_private (object_class, sizeof (GtkTreeModelFilterPrivate));
337 gtk_tree_model_filter_tree_model_init (GtkTreeModelIface *iface)
339 iface->get_flags = gtk_tree_model_filter_get_flags;
340 iface->get_n_columns = gtk_tree_model_filter_get_n_columns;
341 iface->get_column_type = gtk_tree_model_filter_get_column_type;
342 iface->get_iter = gtk_tree_model_filter_get_iter;
343 iface->get_path = gtk_tree_model_filter_get_path;
344 iface->get_value = gtk_tree_model_filter_get_value;
345 iface->iter_next = gtk_tree_model_filter_iter_next;
346 iface->iter_children = gtk_tree_model_filter_iter_children;
347 iface->iter_has_child = gtk_tree_model_filter_iter_has_child;
348 iface->iter_n_children = gtk_tree_model_filter_iter_n_children;
349 iface->iter_nth_child = gtk_tree_model_filter_iter_nth_child;
350 iface->iter_parent = gtk_tree_model_filter_iter_parent;
351 iface->ref_node = gtk_tree_model_filter_ref_node;
352 iface->unref_node = gtk_tree_model_filter_unref_node;
356 gtk_tree_model_filter_drag_source_init (GtkTreeDragSourceIface *iface)
358 iface->row_draggable = gtk_tree_model_filter_row_draggable;
359 iface->drag_data_delete = gtk_tree_model_filter_drag_data_delete;
360 iface->drag_data_get = gtk_tree_model_filter_drag_data_get;
365 gtk_tree_model_filter_finalize (GObject *object)
367 GtkTreeModelFilter *filter = (GtkTreeModelFilter *) object;
369 if (filter->priv->virtual_root && !filter->priv->virtual_root_deleted)
371 gtk_tree_model_filter_unref_path (filter, filter->priv->virtual_root);
372 filter->priv->virtual_root_deleted = TRUE;
375 gtk_tree_model_filter_set_model (filter, NULL);
377 if (filter->priv->virtual_root)
378 gtk_tree_path_free (filter->priv->virtual_root);
380 if (filter->priv->root)
381 gtk_tree_model_filter_free_level (filter, filter->priv->root);
383 g_free (filter->priv->modify_types);
385 if (filter->priv->modify_destroy)
386 filter->priv->modify_destroy (filter->priv->modify_data);
388 if (filter->priv->visible_destroy)
389 filter->priv->visible_destroy (filter->priv->visible_data);
392 G_OBJECT_CLASS (gtk_tree_model_filter_parent_class)->finalize (object);
396 gtk_tree_model_filter_set_property (GObject *object,
401 GtkTreeModelFilter *filter = GTK_TREE_MODEL_FILTER (object);
405 case PROP_CHILD_MODEL:
406 gtk_tree_model_filter_set_model (filter, g_value_get_object (value));
408 case PROP_VIRTUAL_ROOT:
409 gtk_tree_model_filter_set_root (filter, g_value_get_boxed (value));
412 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
418 gtk_tree_model_filter_get_property (GObject *object,
423 GtkTreeModelFilter *filter = GTK_TREE_MODEL_FILTER (object);
427 case PROP_CHILD_MODEL:
428 g_value_set_object (value, filter->priv->child_model);
430 case PROP_VIRTUAL_ROOT:
431 g_value_set_boxed (value, filter->priv->virtual_root);
434 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
442 gtk_tree_model_filter_build_level (GtkTreeModelFilter *filter,
443 FilterLevel *parent_level,
444 gint parent_elt_index,
445 gboolean emit_inserted)
448 GtkTreeIter first_node;
450 FilterElt *parent_elt = NULL;
451 FilterLevel *new_level;
455 g_assert (filter->priv->child_model != NULL);
457 if (filter->priv->in_row_deleted)
462 if (filter->priv->virtual_root)
464 if (gtk_tree_model_get_iter (filter->priv->child_model, &root, filter->priv->virtual_root) == FALSE)
466 length = gtk_tree_model_iter_n_children (filter->priv->child_model, &root);
468 if (gtk_tree_model_iter_children (filter->priv->child_model, &iter, &root) == FALSE)
473 if (!gtk_tree_model_get_iter_first (filter->priv->child_model, &iter))
475 length = gtk_tree_model_iter_n_children (filter->priv->child_model, NULL);
480 GtkTreeIter parent_iter;
481 GtkTreeIter child_parent_iter;
483 parent_elt = &g_array_index (parent_level->array, FilterElt, parent_elt_index);
485 parent_iter.stamp = filter->priv->stamp;
486 parent_iter.user_data = parent_level;
487 parent_iter.user_data2 = parent_elt;
489 gtk_tree_model_filter_convert_iter_to_child_iter (filter,
492 if (gtk_tree_model_iter_children (filter->priv->child_model, &iter, &child_parent_iter) == FALSE)
495 /* stamp may have changed */
496 gtk_tree_model_filter_convert_iter_to_child_iter (filter,
499 length = gtk_tree_model_iter_n_children (filter->priv->child_model, &child_parent_iter);
502 g_return_if_fail (length > 0);
504 new_level = g_new (FilterLevel, 1);
505 new_level->array = g_array_sized_new (FALSE, FALSE,
508 new_level->ref_count = 0;
509 new_level->visible_nodes = 0;
510 new_level->parent_elt_index = parent_elt_index;
511 new_level->parent_level = parent_level;
513 if (parent_elt_index >= 0)
514 parent_elt->children = new_level;
516 filter->priv->root = new_level;
518 /* increase the count of zero ref_counts */
521 g_array_index (parent_level->array, FilterElt, parent_elt_index).zero_ref_count++;
523 parent_elt_index = parent_level->parent_elt_index;
524 parent_level = parent_level->parent_level;
526 if (new_level != filter->priv->root)
527 filter->priv->zero_ref_count++;
535 if (gtk_tree_model_filter_visible (filter, &iter))
538 FilterElt filter_elt;
540 filter_elt.offset = i;
541 filter_elt.zero_ref_count = 0;
542 filter_elt.ref_count = 0;
543 filter_elt.children = NULL;
544 filter_elt.visible = TRUE;
546 if (GTK_TREE_MODEL_FILTER_CACHE_CHILD_ITERS (filter))
547 filter_elt.iter = iter;
549 g_array_append_val (new_level->array, filter_elt);
550 new_level->visible_nodes++;
552 f_iter.stamp = filter->priv->stamp;
553 f_iter.user_data = new_level;
554 f_iter.user_data2 = &(g_array_index (new_level->array, FilterElt, new_level->array->len - 1));
556 if (new_level->parent_level || filter->priv->virtual_root)
557 gtk_tree_model_filter_ref_node (GTK_TREE_MODEL (filter), &f_iter);
562 GtkTreeIter children;
564 f_path = gtk_tree_model_get_path (GTK_TREE_MODEL (filter),
566 gtk_tree_model_row_inserted (GTK_TREE_MODEL (filter),
568 gtk_tree_path_free (f_path);
570 if (gtk_tree_model_iter_children (filter->priv->child_model,
572 gtk_tree_model_filter_update_children (filter,
574 FILTER_ELT (f_iter.user_data2));
579 while (gtk_tree_model_iter_next (filter->priv->child_model, &iter));
581 if (new_level->array->len == 0
582 && (new_level != filter->priv->root || filter->priv->virtual_root))
584 /* If none of the nodes are visible, we will just pull in the
585 * first node of the level and keep a reference on it. We need this
586 * to make sure that we get all signals for this level.
588 FilterElt filter_elt;
591 filter_elt.offset = 0;
592 filter_elt.zero_ref_count = 0;
593 filter_elt.ref_count = 0;
594 filter_elt.children = NULL;
595 filter_elt.visible = FALSE;
597 if (GTK_TREE_MODEL_FILTER_CACHE_CHILD_ITERS (filter))
598 filter_elt.iter = first_node;
600 g_array_append_val (new_level->array, filter_elt);
602 f_iter.stamp = filter->priv->stamp;
603 f_iter.user_data = new_level;
604 f_iter.user_data2 = &(g_array_index (new_level->array, FilterElt, new_level->array->len - 1));
606 gtk_tree_model_filter_ref_node (GTK_TREE_MODEL (filter), &f_iter);
608 else if (new_level->array->len == 0)
609 gtk_tree_model_filter_free_level (filter, new_level);
613 gtk_tree_model_filter_free_level (GtkTreeModelFilter *filter,
614 FilterLevel *filter_level)
618 g_assert (filter_level);
620 for (i = 0; i < filter_level->array->len; i++)
622 if (g_array_index (filter_level->array, FilterElt, i).children)
623 gtk_tree_model_filter_free_level (filter,
624 FILTER_LEVEL (g_array_index (filter_level->array, FilterElt, i).children));
626 if (filter_level->parent_level || filter->priv->virtual_root)
630 f_iter.stamp = filter->priv->stamp;
631 f_iter.user_data = filter_level;
632 f_iter.user_data2 = &(g_array_index (filter_level->array, FilterElt, i));
634 gtk_tree_model_filter_unref_node (GTK_TREE_MODEL (filter), &f_iter);
638 if (filter_level->ref_count == 0)
640 FilterLevel *parent_level = filter_level->parent_level;
641 gint parent_elt_index = filter_level->parent_elt_index;
645 g_array_index (parent_level->array, FilterElt, parent_elt_index).zero_ref_count--;
647 parent_elt_index = parent_level->parent_elt_index;
648 parent_level = parent_level->parent_level;
651 if (filter_level != filter->priv->root)
652 filter->priv->zero_ref_count--;
655 if (filter_level->parent_elt_index >= 0)
656 FILTER_LEVEL_PARENT_ELT (filter_level)->children = NULL;
658 filter->priv->root = NULL;
660 g_array_free (filter_level->array, TRUE);
661 filter_level->array = NULL;
663 g_free (filter_level);
667 /* Creates paths suitable for accessing the child model. */
669 gtk_tree_model_filter_elt_get_path (FilterLevel *level,
673 FilterLevel *walker = level;
674 FilterElt *walker2 = elt;
676 GtkTreePath *real_path;
678 g_return_val_if_fail (level != NULL, NULL);
679 g_return_val_if_fail (elt != NULL, NULL);
681 path = gtk_tree_path_new ();
685 gtk_tree_path_prepend_index (path, walker2->offset);
687 if (!walker->parent_level)
690 walker2 = FILTER_LEVEL_PARENT_ELT (walker);
691 walker = walker->parent_level;
696 real_path = gtk_tree_model_filter_add_root (path, root);
697 gtk_tree_path_free (path);
705 gtk_tree_model_filter_add_root (GtkTreePath *src,
711 retval = gtk_tree_path_copy (root);
713 for (i = 0; i < gtk_tree_path_get_depth (src); i++)
714 gtk_tree_path_append_index (retval, gtk_tree_path_get_indices (src)[i]);
720 gtk_tree_model_filter_remove_root (GtkTreePath *src,
728 if (gtk_tree_path_get_depth (src) <= gtk_tree_path_get_depth (root))
731 depth = gtk_tree_path_get_depth (src);
732 indices = gtk_tree_path_get_indices (src);
734 for (i = 0; i < gtk_tree_path_get_depth (root); i++)
735 if (indices[i] != gtk_tree_path_get_indices (root)[i])
738 retval = gtk_tree_path_new ();
740 for (; i < depth; i++)
741 gtk_tree_path_append_index (retval, indices[i]);
747 gtk_tree_model_filter_increment_stamp (GtkTreeModelFilter *filter)
751 filter->priv->stamp++;
753 while (filter->priv->stamp == 0);
755 gtk_tree_model_filter_clear_cache (filter);
759 gtk_tree_model_filter_visible (GtkTreeModelFilter *filter,
760 GtkTreeIter *child_iter)
762 if (filter->priv->visible_func)
764 return filter->priv->visible_func (filter->priv->child_model,
766 filter->priv->visible_data)
769 else if (filter->priv->visible_column >= 0)
773 gtk_tree_model_get_value (filter->priv->child_model, child_iter,
774 filter->priv->visible_column, &val);
776 if (g_value_get_boolean (&val))
778 g_value_unset (&val);
782 g_value_unset (&val);
786 /* no visible function set, so always visible */
791 gtk_tree_model_filter_clear_cache_helper (GtkTreeModelFilter *filter,
798 for (i = 0; i < level->array->len; i++)
800 if (g_array_index (level->array, FilterElt, i).zero_ref_count > 0)
801 gtk_tree_model_filter_clear_cache_helper (filter, g_array_index (level->array, FilterElt, i).children);
804 if (level->ref_count == 0 && level != filter->priv->root)
806 gtk_tree_model_filter_free_level (filter, level);
812 gtk_tree_model_filter_get_nth (GtkTreeModelFilter *filter,
816 if (level->array->len <= n)
819 return &g_array_index (level->array, FilterElt, n);
823 gtk_tree_model_filter_elt_is_visible_in_target (FilterLevel *level,
831 if (level->parent_elt_index == -1)
836 elt_index = level->parent_elt_index;
837 level = level->parent_level;
840 && !g_array_index (level->array, FilterElt, elt_index).visible)
849 gtk_tree_model_filter_get_nth_visible (GtkTreeModelFilter *filter,
856 if (level->visible_nodes <= n)
859 elt = FILTER_ELT (level->array->data);
860 while (!elt->visible)
870 while (!elt->visible)
877 gtk_tree_model_filter_fetch_child (GtkTreeModelFilter *filter,
883 gint start, middle, end;
885 GtkTreePath *c_path = NULL;
887 GtkTreePath *c_parent_path = NULL;
888 GtkTreeIter c_parent_iter;
891 /* check if child exists and is visible */
892 if (level->parent_elt_index >= 0)
895 gtk_tree_model_filter_elt_get_path (level->parent_level,
896 FILTER_LEVEL_PARENT_ELT (level),
897 filter->priv->virtual_root);
903 if (filter->priv->virtual_root)
904 c_parent_path = gtk_tree_path_copy (filter->priv->virtual_root);
906 c_parent_path = NULL;
911 gtk_tree_model_get_iter (filter->priv->child_model,
914 len = gtk_tree_model_iter_n_children (filter->priv->child_model,
917 c_path = gtk_tree_path_copy (c_parent_path);
918 gtk_tree_path_free (c_parent_path);
922 len = gtk_tree_model_iter_n_children (filter->priv->child_model, NULL);
923 c_path = gtk_tree_path_new ();
926 gtk_tree_path_append_index (c_path, offset);
927 gtk_tree_model_get_iter (filter->priv->child_model, &c_iter, c_path);
928 gtk_tree_path_free (c_path);
930 if (offset >= len || !gtk_tree_model_filter_visible (filter, &c_iter))
935 elt.zero_ref_count = 0;
938 /* visibility should be FALSE as we don't emit row_inserted */
941 if (GTK_TREE_MODEL_FILTER_CACHE_CHILD_ITERS (filter))
944 /* find index (binary search on offset) */
946 end = level->array->len;
952 middle = (start + end) / 2;
954 if (g_array_index (level->array, FilterElt, middle).offset <= offset)
960 if (g_array_index (level->array, FilterElt, middle).offset <= offset)
968 g_array_insert_val (level->array, i, elt);
971 for (i = 0; i < level->array->len; i++)
973 FilterElt *e = &(g_array_index (level->array, FilterElt, i));
975 e->children->parent_elt_index = i;
978 c_iter.stamp = filter->priv->stamp;
979 c_iter.user_data = level;
980 c_iter.user_data2 = &g_array_index (level->array, FilterElt, *index);
982 if (level->parent_level || filter->priv->virtual_root)
983 gtk_tree_model_filter_ref_node (GTK_TREE_MODEL (filter), &c_iter);
985 return &g_array_index (level->array, FilterElt, *index);
989 gtk_tree_model_filter_remove_node (GtkTreeModelFilter *filter,
992 FilterElt *elt, *parent;
993 FilterLevel *level, *parent_level;
994 gint i, length, parent_elt_index;
996 gboolean emit_child_toggled = FALSE;
998 level = FILTER_LEVEL (iter->user_data);
999 elt = FILTER_ELT (iter->user_data2);
1001 parent_elt_index = level->parent_elt_index;
1002 if (parent_elt_index >= 0)
1003 parent = FILTER_LEVEL_PARENT_ELT (level);
1006 parent_level = level->parent_level;
1008 length = level->array->len;
1010 /* we distinguish a couple of cases:
1011 * - root level, length > 1: emit row-deleted and remove.
1012 * - root level, length == 1: emit row-deleted and keep in cache.
1013 * - level, length == 1: parent->ref_count > 1: emit row-deleted and keep.
1014 * - level, length > 1: emit row-deleted and remove.
1015 * - else, remove level.
1017 * if level != root level and visible nodes == 0, emit row-has-child-toggled.
1020 if (level != filter->priv->root
1021 && level->visible_nodes == 0
1024 emit_child_toggled = TRUE;
1031 /* We emit row-deleted, and remove the node from the cache.
1032 * If it has any children, these will be removed here as well.
1036 gtk_tree_model_filter_free_level (filter, elt->children);
1038 path = gtk_tree_model_get_path (GTK_TREE_MODEL (filter), iter);
1039 elt->visible = FALSE;
1040 gtk_tree_model_filter_increment_stamp (filter);
1041 iter->stamp = filter->priv->stamp;
1042 gtk_tree_model_row_deleted (GTK_TREE_MODEL (filter), path);
1043 gtk_tree_path_free (path);
1045 while (elt->ref_count > 1)
1046 gtk_tree_model_filter_real_unref_node (GTK_TREE_MODEL (filter),
1049 if (parent_level || filter->priv->virtual_root)
1050 gtk_tree_model_filter_unref_node (GTK_TREE_MODEL (filter), iter);
1051 else if (elt->ref_count > 0)
1052 gtk_tree_model_filter_real_unref_node (GTK_TREE_MODEL (filter),
1055 /* remove the node */
1056 tmp = bsearch_elt_with_offset (level->array, elt->offset, &i);
1060 g_array_remove_index (level->array, i);
1063 for (i = MAX (i, 0); i < level->array->len; i++)
1065 /* NOTE: here we do *not* decrease offsets, because the node was
1066 * not removed from the child model
1068 elt = &g_array_index (level->array, FilterElt, i);
1070 elt->children->parent_elt_index = i;
1074 else if ((length == 1 && parent && parent->ref_count > 1)
1075 || (length == 1 && level == filter->priv->root))
1079 /* We emit row-deleted, but keep the node in the cache and
1080 * referenced. Its children will be removed.
1085 gtk_tree_model_filter_free_level (filter, elt->children);
1086 elt->children = NULL;
1089 path = gtk_tree_model_get_path (GTK_TREE_MODEL (filter), iter);
1090 elt->visible = FALSE;
1091 gtk_tree_model_filter_increment_stamp (filter);
1092 gtk_tree_model_row_deleted (GTK_TREE_MODEL (filter), path);
1093 gtk_tree_path_free (path);
1099 /* Blow level away, including any child levels */
1101 path = gtk_tree_model_get_path (GTK_TREE_MODEL (filter), iter);
1102 elt->visible = FALSE;
1103 gtk_tree_model_filter_increment_stamp (filter);
1104 iter->stamp = filter->priv->stamp;
1105 gtk_tree_model_row_deleted (GTK_TREE_MODEL (filter), path);
1106 gtk_tree_path_free (path);
1108 while (elt->ref_count > 1)
1109 gtk_tree_model_filter_real_unref_node (GTK_TREE_MODEL (filter),
1112 gtk_tree_model_filter_free_level (filter, level);
1115 if (emit_child_toggled)
1120 piter.stamp = filter->priv->stamp;
1121 piter.user_data = parent_level;
1122 piter.user_data2 = parent;
1124 ppath = gtk_tree_model_get_path (GTK_TREE_MODEL (filter), &piter);
1126 gtk_tree_model_row_has_child_toggled (GTK_TREE_MODEL (filter),
1128 gtk_tree_path_free (ppath);
1133 gtk_tree_model_filter_update_children (GtkTreeModelFilter *filter,
1143 iter.stamp = filter->priv->stamp;
1144 iter.user_data = level;
1145 iter.user_data2 = elt;
1147 gtk_tree_model_filter_convert_iter_to_child_iter (filter, &c_iter, &iter);
1149 if (gtk_tree_model_iter_has_child (filter->priv->child_model, &c_iter))
1151 GtkTreePath *path = gtk_tree_model_get_path (GTK_TREE_MODEL (filter),
1153 gtk_tree_model_row_has_child_toggled (GTK_TREE_MODEL (filter),
1157 gtk_tree_path_free (path);
1162 bsearch_elt_with_offset (GArray *array,
1166 gint start, middle, end;
1177 elt = &g_array_index (array, FilterElt, 0);
1179 if (elt->offset == offset)
1190 middle = (start + end) / 2;
1192 elt = &g_array_index (array, FilterElt, middle);
1194 if (elt->offset < offset)
1196 else if (elt->offset > offset)
1201 while (start != end);
1203 if (elt->offset == offset)
1212 /* TreeModel signals */
1214 gtk_tree_model_filter_row_changed (GtkTreeModel *c_model,
1215 GtkTreePath *c_path,
1216 GtkTreeIter *c_iter,
1219 GtkTreeModelFilter *filter = GTK_TREE_MODEL_FILTER (data);
1221 GtkTreeIter children;
1222 GtkTreeIter real_c_iter;
1223 GtkTreePath *path = NULL;
1228 gboolean requested_state;
1229 gboolean current_state;
1230 gboolean free_c_path = FALSE;
1231 gboolean signals_emitted = FALSE;
1233 g_return_if_fail (c_path != NULL || c_iter != NULL);
1237 c_path = gtk_tree_model_get_path (c_model, c_iter);
1242 real_c_iter = *c_iter;
1244 gtk_tree_model_get_iter (c_model, &real_c_iter, c_path);
1246 /* is this node above the virtual root? */
1247 if (filter->priv->virtual_root
1248 && (gtk_tree_path_get_depth (filter->priv->virtual_root)
1249 >= gtk_tree_path_get_depth (c_path)))
1252 /* what's the requested state? */
1253 requested_state = gtk_tree_model_filter_visible (filter, &real_c_iter);
1255 /* now, let's see whether the item is there */
1256 path = gtk_real_tree_model_filter_convert_child_path_to_path (filter,
1263 gtk_tree_model_filter_get_iter_full (GTK_TREE_MODEL (filter),
1265 current_state = FILTER_ELT (iter.user_data2)->visible;
1268 current_state = FALSE;
1270 if (current_state == FALSE && requested_state == FALSE)
1271 /* no changes required */
1274 if (current_state == TRUE && requested_state == FALSE)
1276 /* get rid of this node */
1277 level = FILTER_LEVEL (iter.user_data);
1278 level->visible_nodes--;
1280 gtk_tree_model_filter_remove_node (filter, &iter);
1285 if (current_state == TRUE && requested_state == TRUE)
1287 /* propagate the signal; also get a path taking only visible
1288 * nodes into account.
1290 gtk_tree_path_free (path);
1291 path = gtk_tree_model_get_path (GTK_TREE_MODEL (filter), &iter);
1293 level = FILTER_LEVEL (iter.user_data);
1294 elt = FILTER_ELT (iter.user_data2);
1296 if (gtk_tree_model_filter_elt_is_visible_in_target (level, elt))
1298 gtk_tree_model_row_changed (GTK_TREE_MODEL (filter), path, &iter);
1300 /* and update the children */
1301 if (gtk_tree_model_iter_children (c_model, &children, &real_c_iter))
1302 gtk_tree_model_filter_update_children (filter, level, elt);
1308 /* only current == FALSE and requested == TRUE is left,
1311 g_return_if_fail (current_state == FALSE && requested_state == TRUE);
1313 /* make sure the new item has been pulled in */
1314 if (!filter->priv->root)
1318 gtk_tree_model_filter_build_level (filter, NULL, -1, TRUE);
1320 /* We will only proceed below if the item is found. If the item
1321 * is found, we can be sure row-inserted has just been emitted
1324 signals_emitted = TRUE;
1326 root = FILTER_LEVEL (filter->priv->root);
1329 gtk_tree_model_filter_increment_stamp (filter);
1331 /* We need to allow to build new levels, because we are then pulling
1332 * in a child in an invisible level. We only want to find path if it
1333 * is in a visible level (and thus has a parent that is visible).
1336 path = gtk_real_tree_model_filter_convert_child_path_to_path (filter,
1342 /* parent is probably being filtered out */
1345 gtk_tree_model_filter_get_iter_full (GTK_TREE_MODEL (filter), &iter, path);
1347 level = FILTER_LEVEL (iter.user_data);
1348 elt = FILTER_ELT (iter.user_data2);
1350 /* elt->visible can be TRUE at this point if it was pulled in above */
1353 elt->visible = TRUE;
1354 level->visible_nodes++;
1357 if (gtk_tree_model_filter_elt_is_visible_in_target (level, elt))
1359 /* visibility changed -- reget path */
1360 gtk_tree_path_free (path);
1361 path = gtk_tree_model_get_path (GTK_TREE_MODEL (filter), &iter);
1363 if (!signals_emitted)
1364 gtk_tree_model_row_inserted (GTK_TREE_MODEL (filter), path, &iter);
1366 if (level->parent_level && level->visible_nodes == 1)
1368 /* We know that this is the first visible node in this level, so
1369 * we need to emit row-has-child-toggled on the parent. This
1370 * does not apply to the root level.
1373 gtk_tree_path_up (path);
1374 gtk_tree_model_get_iter (GTK_TREE_MODEL (filter), &iter, path);
1376 gtk_tree_model_row_has_child_toggled (GTK_TREE_MODEL (filter),
1381 if (!signals_emitted
1382 && gtk_tree_model_iter_children (c_model, &children, c_iter))
1383 gtk_tree_model_filter_update_children (filter, level, elt);
1388 gtk_tree_path_free (path);
1391 gtk_tree_path_free (c_path);
1395 gtk_tree_model_filter_row_inserted (GtkTreeModel *c_model,
1396 GtkTreePath *c_path,
1397 GtkTreeIter *c_iter,
1400 GtkTreeModelFilter *filter = GTK_TREE_MODEL_FILTER (data);
1401 GtkTreePath *path = NULL;
1402 GtkTreePath *real_path = NULL;
1405 GtkTreeIter real_c_iter;
1409 FilterLevel *parent_level;
1413 gboolean free_c_path = FALSE;
1415 g_return_if_fail (c_path != NULL || c_iter != NULL);
1419 c_path = gtk_tree_model_get_path (c_model, c_iter);
1424 real_c_iter = *c_iter;
1426 gtk_tree_model_get_iter (c_model, &real_c_iter, c_path);
1428 /* the row has already been inserted. so we need to fixup the
1429 * virtual root here first
1431 if (filter->priv->virtual_root)
1433 if (gtk_tree_path_get_depth (filter->priv->virtual_root) >=
1434 gtk_tree_path_get_depth (c_path))
1437 gint *v_indices, *c_indices;
1438 gboolean common_prefix = TRUE;
1440 level = gtk_tree_path_get_depth (c_path) - 1;
1441 v_indices = gtk_tree_path_get_indices (filter->priv->virtual_root);
1442 c_indices = gtk_tree_path_get_indices (c_path);
1444 for (i = 0; i < level; i++)
1445 if (v_indices[i] != c_indices[i])
1447 common_prefix = FALSE;
1451 if (common_prefix && v_indices[level] >= c_indices[level])
1452 (v_indices[level])++;
1456 if (!filter->priv->root)
1458 /* No point in building the level if this node is not visible. */
1459 if (!filter->priv->virtual_root
1460 && !gtk_tree_model_filter_visible (filter, c_iter))
1463 /* build level will pull in the new child */
1464 gtk_tree_model_filter_build_level (filter, NULL, -1, FALSE);
1466 if (filter->priv->root
1467 && FILTER_LEVEL (filter->priv->root)->visible_nodes)
1473 parent_level = level = FILTER_LEVEL (filter->priv->root);
1475 /* subtract virtual root if necessary */
1476 if (filter->priv->virtual_root)
1478 real_path = gtk_tree_model_filter_remove_root (c_path,
1479 filter->priv->virtual_root);
1485 real_path = gtk_tree_path_copy (c_path);
1487 if (gtk_tree_path_get_depth (real_path) - 1 >= 1)
1489 /* find the parent level */
1490 while (i < gtk_tree_path_get_depth (real_path) - 1)
1495 /* we don't cover this signal */
1498 elt = bsearch_elt_with_offset (level->array,
1499 gtk_tree_path_get_indices (real_path)[i],
1503 /* parent is probably being filtered out */
1508 GtkTreePath *tmppath;
1509 GtkTreeIter tmpiter;
1511 tmpiter.stamp = filter->priv->stamp;
1512 tmpiter.user_data = level;
1513 tmpiter.user_data2 = elt;
1515 tmppath = gtk_tree_model_get_path (GTK_TREE_MODEL (data),
1520 gtk_tree_model_row_has_child_toggled (GTK_TREE_MODEL (data),
1522 gtk_tree_path_free (tmppath);
1525 /* not covering this signal */
1529 level = elt->children;
1530 parent_level = level;
1538 /* let's try to insert the value */
1539 offset = gtk_tree_path_get_indices (real_path)[gtk_tree_path_get_depth (real_path) - 1];
1541 /* update the offsets, yes if we didn't insert the node above, there will
1542 * be a gap here. This will be filled with the node (via fetch_child) when
1543 * it becomes visible
1545 for (i = 0; i < level->array->len; i++)
1547 FilterElt *e = &g_array_index (level->array, FilterElt, i);
1548 if ((e->offset >= offset))
1552 /* only insert when visible */
1553 if (gtk_tree_model_filter_visible (filter, &real_c_iter))
1557 if (GTK_TREE_MODEL_FILTER_CACHE_CHILD_ITERS (filter))
1558 felt.iter = real_c_iter;
1560 felt.offset = offset;
1561 felt.zero_ref_count = 0;
1563 felt.visible = TRUE;
1564 felt.children = NULL;
1566 for (i = 0; i < level->array->len; i++)
1567 if (g_array_index (level->array, FilterElt, i).offset > offset)
1570 level->visible_nodes++;
1572 g_array_insert_val (level->array, i, felt);
1574 if (level->parent_level || filter->priv->virtual_root)
1578 f_iter.stamp = filter->priv->stamp;
1579 f_iter.user_data = level;
1580 f_iter.user_data2 = &g_array_index (level->array, FilterElt, i);
1582 gtk_tree_model_filter_ref_node (GTK_TREE_MODEL (filter), &f_iter);
1586 /* another iteration to update the references of children to parents. */
1587 for (i = 0; i < level->array->len; i++)
1589 FilterElt *e = &g_array_index (level->array, FilterElt, i);
1591 e->children->parent_elt_index = i;
1594 /* don't emit the signal if we aren't visible */
1595 if (!gtk_tree_model_filter_visible (filter, &real_c_iter))
1599 /* NOTE: pass c_path here and NOT real_path. This function does
1600 * root subtraction itself
1602 path = gtk_real_tree_model_filter_convert_child_path_to_path (filter,
1609 gtk_tree_model_filter_increment_stamp (filter);
1611 gtk_tree_model_filter_get_iter_full (GTK_TREE_MODEL (data), &iter, path);
1613 /* get a path taking only visible nodes into account */
1614 gtk_tree_path_free (path);
1615 path = gtk_tree_model_get_path (GTK_TREE_MODEL (data), &iter);
1617 gtk_tree_model_row_inserted (GTK_TREE_MODEL (data), path, &iter);
1619 gtk_tree_path_free (path);
1623 gtk_tree_path_free (real_path);
1626 gtk_tree_path_free (c_path);
1630 gtk_tree_model_filter_row_has_child_toggled (GtkTreeModel *c_model,
1631 GtkTreePath *c_path,
1632 GtkTreeIter *c_iter,
1635 GtkTreeModelFilter *filter = GTK_TREE_MODEL_FILTER (data);
1640 gboolean requested_state;
1642 g_return_if_fail (c_path != NULL && c_iter != NULL);
1644 /* If we get row-has-child-toggled on the virtual root, and there is
1645 * no root level; try to build it now.
1647 if (filter->priv->virtual_root && !filter->priv->root
1648 && !gtk_tree_path_compare (c_path, filter->priv->virtual_root))
1650 gtk_tree_model_filter_build_level (filter, NULL, -1, TRUE);
1654 /* For all other levels, there is a chance that the visibility state
1655 * of the parent has changed now.
1658 path = gtk_real_tree_model_filter_convert_child_path_to_path (filter,
1665 gtk_tree_model_filter_get_iter_full (GTK_TREE_MODEL (data), &iter, path);
1667 level = FILTER_LEVEL (iter.user_data);
1668 elt = FILTER_ELT (iter.user_data2);
1670 gtk_tree_path_free (path);
1672 requested_state = gtk_tree_model_filter_visible (filter, c_iter);
1674 if (!elt->visible && !requested_state)
1676 /* The parent node currently is not visible and will not become
1677 * visible, so we will not pass on the row-has-child-toggled event.
1681 else if (elt->visible && !requested_state)
1683 /* The node is no longer visible, so it has to be removed.
1684 * _remove_node() takes care of emitting row-has-child-toggled
1687 level->visible_nodes--;
1689 gtk_tree_model_filter_remove_node (filter, &iter);
1693 else if (!elt->visible && requested_state)
1695 elt->visible = TRUE;
1696 level->visible_nodes++;
1698 /* Only insert if the parent is visible in the target */
1699 if (gtk_tree_model_filter_elt_is_visible_in_target (level, elt))
1701 path = gtk_tree_model_get_path (GTK_TREE_MODEL (filter), &iter);
1702 gtk_tree_model_row_inserted (GTK_TREE_MODEL (filter), path, &iter);
1703 gtk_tree_path_free (path);
1705 /* We do not update children now, because that will happen
1710 /* For the remaining possibility, elt->visible && requested_state
1711 * no action is required.
1714 /* If this node is referenced and has children, build the level so we
1715 * can monitor it for changes.
1717 if (elt->ref_count > 1 && gtk_tree_model_iter_has_child (c_model, c_iter))
1718 gtk_tree_model_filter_build_level (filter, level,
1719 FILTER_LEVEL_ELT_INDEX (level, elt),
1722 /* get a path taking only visible nodes into account */
1723 path = gtk_tree_model_get_path (GTK_TREE_MODEL (data), &iter);
1724 gtk_tree_model_row_has_child_toggled (GTK_TREE_MODEL (data), path, &iter);
1725 gtk_tree_path_free (path);
1729 gtk_tree_model_filter_row_deleted (GtkTreeModel *c_model,
1730 GtkTreePath *c_path,
1733 GtkTreeModelFilter *filter = GTK_TREE_MODEL_FILTER (data);
1737 FilterLevel *level, *parent_level = NULL;
1738 gboolean emit_child_toggled = FALSE;
1741 gint parent_elt_index = -1;
1743 g_return_if_fail (c_path != NULL);
1745 /* special case the deletion of an ancestor of the virtual root */
1746 if (filter->priv->virtual_root &&
1747 (gtk_tree_path_is_ancestor (c_path, filter->priv->virtual_root) ||
1748 !gtk_tree_path_compare (c_path, filter->priv->virtual_root)))
1752 FilterLevel *level = FILTER_LEVEL (filter->priv->root);
1754 gtk_tree_model_filter_unref_path (filter, filter->priv->virtual_root);
1755 filter->priv->virtual_root_deleted = TRUE;
1760 /* remove everything in the filter model
1762 * For now, we just iterate over the root level and emit a
1763 * row_deleted for each FilterElt. Not sure if this is correct.
1766 gtk_tree_model_filter_increment_stamp (filter);
1767 path = gtk_tree_path_new ();
1768 gtk_tree_path_append_index (path, 0);
1770 for (i = 0; i < level->visible_nodes; i++)
1771 gtk_tree_model_row_deleted (GTK_TREE_MODEL (data), path);
1773 gtk_tree_path_free (path);
1774 gtk_tree_model_filter_free_level (filter, filter->priv->root);
1779 /* fixup virtual root */
1780 if (filter->priv->virtual_root)
1782 if (gtk_tree_path_get_depth (filter->priv->virtual_root) >=
1783 gtk_tree_path_get_depth (c_path))
1786 gint *v_indices, *c_indices;
1787 gboolean common_prefix = TRUE;
1789 level = gtk_tree_path_get_depth (c_path) - 1;
1790 v_indices = gtk_tree_path_get_indices (filter->priv->virtual_root);
1791 c_indices = gtk_tree_path_get_indices (c_path);
1793 for (i = 0; i < level; i++)
1794 if (v_indices[i] != c_indices[i])
1796 common_prefix = FALSE;
1800 if (common_prefix && v_indices[level] > c_indices[level])
1801 (v_indices[level])--;
1805 path = gtk_real_tree_model_filter_convert_child_path_to_path (filter,
1812 /* The node deleted in the child model is not visible in the
1813 * filter model. We will not emit a signal, just fixup the offsets
1814 * of the other nodes.
1816 GtkTreePath *real_path;
1818 if (!filter->priv->root)
1821 level = FILTER_LEVEL (filter->priv->root);
1823 /* subtract vroot if necessary */
1824 if (filter->priv->virtual_root)
1826 real_path = gtk_tree_model_filter_remove_root (c_path,
1827 filter->priv->virtual_root);
1828 /* we don't handle this */
1833 real_path = gtk_tree_path_copy (c_path);
1836 if (gtk_tree_path_get_depth (real_path) - 1 >= 1)
1838 /* find the level where the deletion occurred */
1839 while (i < gtk_tree_path_get_depth (real_path) - 1)
1845 /* we don't cover this */
1846 gtk_tree_path_free (real_path);
1850 elt = bsearch_elt_with_offset (level->array,
1851 gtk_tree_path_get_indices (real_path)[i],
1854 if (!elt || !elt->children)
1856 /* parent is filtered out, so no level */
1857 gtk_tree_path_free (real_path);
1861 level = elt->children;
1866 offset = gtk_tree_path_get_indices (real_path)[gtk_tree_path_get_depth (real_path) - 1];
1867 gtk_tree_path_free (real_path);
1872 /* decrease offset of all nodes following the deleted node */
1873 for (i = 0; i < level->array->len; i++)
1875 elt = &g_array_index (level->array, FilterElt, i);
1876 if (elt->offset > offset)
1879 elt->children->parent_elt_index = i;
1885 /* a node was deleted, which was in our cache */
1886 gtk_tree_model_filter_get_iter_full (GTK_TREE_MODEL (data), &iter, path);
1888 level = FILTER_LEVEL (iter.user_data);
1889 elt = FILTER_ELT (iter.user_data2);
1890 offset = elt->offset;
1894 /* get a path taking only visible nodes into account */
1895 gtk_tree_path_free (path);
1896 path = gtk_tree_model_get_path (GTK_TREE_MODEL (filter), &iter);
1898 level->visible_nodes--;
1900 if (level->visible_nodes == 0)
1902 emit_child_toggled = TRUE;
1903 parent_level = level->parent_level;
1904 parent_elt_index = level->parent_elt_index;
1907 /* emit row_deleted */
1908 gtk_tree_model_filter_increment_stamp (filter);
1909 gtk_tree_model_row_deleted (GTK_TREE_MODEL (data), path);
1910 iter.stamp = filter->priv->stamp;
1913 /* The filter model's reference on the child node is released
1916 while (elt->ref_count > 1)
1917 gtk_tree_model_filter_real_unref_node (GTK_TREE_MODEL (data), &iter,
1920 if (level->array->len == 1)
1923 gtk_tree_model_filter_free_level (filter, level);
1929 /* release the filter model's reference on the node */
1930 if (level->parent_level || filter->priv->virtual_root)
1931 gtk_tree_model_filter_unref_node (GTK_TREE_MODEL (filter), &iter);
1932 else if (elt->ref_count > 0)
1933 gtk_tree_model_filter_real_unref_node (GTK_TREE_MODEL (data), &iter,
1936 /* remove the row */
1937 tmp = bsearch_elt_with_offset (level->array, elt->offset, &i);
1939 offset = tmp->offset;
1940 g_array_remove_index (level->array, i);
1943 for (i = MAX (i, 0); i < level->array->len; i++)
1945 elt = &g_array_index (level->array, FilterElt, i);
1946 if (elt->offset > offset)
1949 elt->children->parent_elt_index = i;
1953 if (emit_child_toggled && parent_level)
1958 iter.stamp = filter->priv->stamp;
1959 iter.user_data = parent_level;
1960 iter.user_data2 = &g_array_index (parent_level->array, FilterElt, parent_elt_index);
1962 /* We set in_row_deleted to TRUE to avoid a level build triggered
1963 * by row-has-child-toggled (parent model could call iter_has_child
1966 filter->priv->in_row_deleted = TRUE;
1967 path = gtk_tree_model_get_path (GTK_TREE_MODEL (filter), &iter);
1968 gtk_tree_model_row_has_child_toggled (GTK_TREE_MODEL (filter),
1970 gtk_tree_path_free (path);
1971 filter->priv->in_row_deleted = FALSE;
1974 gtk_tree_path_free (path);
1978 gtk_tree_model_filter_rows_reordered (GtkTreeModel *c_model,
1979 GtkTreePath *c_path,
1980 GtkTreeIter *c_iter,
1986 GtkTreeModelFilter *filter = GTK_TREE_MODEL_FILTER (data);
1992 gint i, j, elt_count;
1997 g_return_if_fail (new_order != NULL);
1999 if (c_path == NULL || gtk_tree_path_get_depth (c_path) == 0)
2001 length = gtk_tree_model_iter_n_children (c_model, NULL);
2003 if (filter->priv->virtual_root)
2007 /* reorder root level of path */
2008 for (i = 0; i < length; i++)
2009 if (new_order[i] == gtk_tree_path_get_indices (filter->priv->virtual_root)[0])
2015 gtk_tree_path_get_indices (filter->priv->virtual_root)[0] = new_pos;
2019 path = gtk_tree_path_new ();
2020 level = FILTER_LEVEL (filter->priv->root);
2024 GtkTreeIter child_iter;
2026 /* virtual root anchor reordering */
2027 if (filter->priv->virtual_root &&
2028 gtk_tree_path_is_ancestor (c_path, filter->priv->virtual_root))
2033 GtkTreeIter real_c_iter;
2035 level = gtk_tree_path_get_depth (c_path);
2038 real_c_iter = *c_iter;
2040 gtk_tree_model_get_iter (c_model, &real_c_iter, c_path);
2042 length = gtk_tree_model_iter_n_children (c_model, &real_c_iter);
2044 for (i = 0; i < length; i++)
2045 if (new_order[i] == gtk_tree_path_get_indices (filter->priv->virtual_root)[level])
2051 gtk_tree_path_get_indices (filter->priv->virtual_root)[level] = new_pos;
2055 path = gtk_real_tree_model_filter_convert_child_path_to_path (filter,
2060 if (!path && filter->priv->virtual_root &&
2061 gtk_tree_path_compare (c_path, filter->priv->virtual_root))
2064 if (!path && !filter->priv->virtual_root)
2069 /* root level mode */
2071 gtk_tree_model_get_iter (c_model, c_iter, c_path);
2072 length = gtk_tree_model_iter_n_children (c_model, c_iter);
2073 path = gtk_tree_path_new ();
2074 level = FILTER_LEVEL (filter->priv->root);
2078 gtk_tree_model_filter_get_iter_full (GTK_TREE_MODEL (data),
2081 level = FILTER_LEVEL (iter.user_data);
2082 elt = FILTER_ELT (iter.user_data2);
2086 gtk_tree_path_free (path);
2090 level = elt->children;
2092 gtk_tree_model_filter_convert_iter_to_child_iter (GTK_TREE_MODEL_FILTER (filter), &child_iter, &iter);
2093 length = gtk_tree_model_iter_n_children (c_model, &child_iter);
2097 if (!level || level->array->len < 1)
2099 gtk_tree_path_free (path);
2103 /* NOTE: we do not bail out here if level->array->len < 2 like
2104 * GtkTreeModelSort does. This because we do some special tricky
2108 /* construct a new array */
2109 new_array = g_array_sized_new (FALSE, FALSE, sizeof (FilterElt),
2111 tmp_array = g_new (gint, level->array->len);
2113 for (i = 0, elt_count = 0; i < length; i++)
2115 FilterElt *e = NULL;
2116 gint old_offset = -1;
2118 for (j = 0; j < level->array->len; j++)
2119 if (g_array_index (level->array, FilterElt, j).offset == new_order[i])
2121 e = &g_array_index (level->array, FilterElt, j);
2129 tmp_array[elt_count] = old_offset;
2130 g_array_append_val (new_array, *e);
2131 g_array_index (new_array, FilterElt, elt_count).offset = i;
2135 g_array_free (level->array, TRUE);
2136 level->array = new_array;
2139 for (i = 0; i < level->array->len; i++)
2141 FilterElt *e = &g_array_index (level->array, FilterElt, i);
2143 e->children->parent_elt_index = i;
2146 /* emit rows_reordered */
2147 if (!gtk_tree_path_get_indices (path))
2148 gtk_tree_model_rows_reordered (GTK_TREE_MODEL (data), path, NULL,
2152 /* get a path taking only visible nodes into account */
2153 gtk_tree_path_free (path);
2154 path = gtk_tree_model_get_path (GTK_TREE_MODEL (data), &iter);
2156 gtk_tree_model_rows_reordered (GTK_TREE_MODEL (data), path, &iter,
2162 gtk_tree_path_free (path);
2165 /* TreeModelIface implementation */
2166 static GtkTreeModelFlags
2167 gtk_tree_model_filter_get_flags (GtkTreeModel *model)
2169 GtkTreeModelFlags flags;
2171 g_return_val_if_fail (GTK_IS_TREE_MODEL_FILTER (model), 0);
2172 g_return_val_if_fail (GTK_TREE_MODEL_FILTER (model)->priv->child_model != NULL, 0);
2174 flags = gtk_tree_model_get_flags (GTK_TREE_MODEL_FILTER (model)->priv->child_model);
2176 if ((flags & GTK_TREE_MODEL_LIST_ONLY) == GTK_TREE_MODEL_LIST_ONLY)
2177 return GTK_TREE_MODEL_LIST_ONLY;
2183 gtk_tree_model_filter_get_n_columns (GtkTreeModel *model)
2185 GtkTreeModelFilter *filter = (GtkTreeModelFilter *)model;
2187 g_return_val_if_fail (GTK_IS_TREE_MODEL_FILTER (model), 0);
2188 g_return_val_if_fail (filter->priv->child_model != NULL, 0);
2190 if (filter->priv->child_model == NULL)
2193 /* so we can't modify the modify func after this ... */
2194 filter->priv->modify_func_set = TRUE;
2196 if (filter->priv->modify_n_columns > 0)
2197 return filter->priv->modify_n_columns;
2199 return gtk_tree_model_get_n_columns (filter->priv->child_model);
2203 gtk_tree_model_filter_get_column_type (GtkTreeModel *model,
2206 GtkTreeModelFilter *filter = (GtkTreeModelFilter *)model;
2208 g_return_val_if_fail (GTK_IS_TREE_MODEL_FILTER (model), G_TYPE_INVALID);
2209 g_return_val_if_fail (filter->priv->child_model != NULL, G_TYPE_INVALID);
2211 /* so we can't modify the modify func after this ... */
2212 filter->priv->modify_func_set = TRUE;
2214 if (filter->priv->modify_types)
2216 g_return_val_if_fail (index < filter->priv->modify_n_columns, G_TYPE_INVALID);
2218 return filter->priv->modify_types[index];
2221 return gtk_tree_model_get_column_type (filter->priv->child_model, index);
2224 /* A special case of _get_iter; this function can also get iters which
2225 * are not visible. These iters should ONLY be passed internally, never
2226 * pass those along with a signal emission.
2229 gtk_tree_model_filter_get_iter_full (GtkTreeModel *model,
2233 GtkTreeModelFilter *filter = (GtkTreeModelFilter *)model;
2238 g_return_val_if_fail (GTK_IS_TREE_MODEL_FILTER (model), FALSE);
2239 g_return_val_if_fail (filter->priv->child_model != NULL, FALSE);
2241 indices = gtk_tree_path_get_indices (path);
2243 if (filter->priv->root == NULL)
2244 gtk_tree_model_filter_build_level (filter, NULL, -1, FALSE);
2245 level = FILTER_LEVEL (filter->priv->root);
2247 depth = gtk_tree_path_get_depth (path);
2254 for (i = 0; i < depth - 1; i++)
2256 if (!level || indices[i] >= level->array->len)
2261 elt = gtk_tree_model_filter_get_nth (filter, level, indices[i]);
2264 gtk_tree_model_filter_build_level (filter, level,
2265 FILTER_LEVEL_ELT_INDEX (level, elt),
2267 level = elt->children;
2270 if (!level || indices[i] >= level->array->len)
2276 iter->stamp = filter->priv->stamp;
2277 iter->user_data = level;
2279 elt = gtk_tree_model_filter_get_nth (filter, level, indices[depth - 1]);
2280 iter->user_data2 = elt;
2286 gtk_tree_model_filter_get_iter (GtkTreeModel *model,
2290 GtkTreeModelFilter *filter = (GtkTreeModelFilter *)model;
2295 g_return_val_if_fail (GTK_IS_TREE_MODEL_FILTER (model), FALSE);
2296 g_return_val_if_fail (filter->priv->child_model != NULL, FALSE);
2298 indices = gtk_tree_path_get_indices (path);
2300 if (filter->priv->root == NULL)
2301 gtk_tree_model_filter_build_level (filter, NULL, -1, FALSE);
2302 level = FILTER_LEVEL (filter->priv->root);
2304 depth = gtk_tree_path_get_depth (path);
2311 for (i = 0; i < depth - 1; i++)
2313 if (!level || indices[i] >= level->visible_nodes)
2318 elt = gtk_tree_model_filter_get_nth_visible (filter, level, indices[i]);
2321 gtk_tree_model_filter_build_level (filter, level,
2322 FILTER_LEVEL_ELT_INDEX (level, elt),
2324 level = elt->children;
2327 if (!level || indices[i] >= level->visible_nodes)
2333 iter->stamp = filter->priv->stamp;
2334 iter->user_data = level;
2336 elt = gtk_tree_model_filter_get_nth_visible (filter, level,
2337 indices[depth - 1]);
2338 iter->user_data2 = elt;
2343 static GtkTreePath *
2344 gtk_tree_model_filter_get_path (GtkTreeModel *model,
2347 GtkTreePath *retval;
2352 g_return_val_if_fail (GTK_IS_TREE_MODEL_FILTER (model), NULL);
2353 g_return_val_if_fail (GTK_TREE_MODEL_FILTER (model)->priv->child_model != NULL, NULL);
2354 g_return_val_if_fail (GTK_TREE_MODEL_FILTER (model)->priv->stamp == iter->stamp, NULL);
2356 level = iter->user_data;
2357 elt = iter->user_data2;
2358 elt_index = FILTER_LEVEL_ELT_INDEX (level, elt);
2363 retval = gtk_tree_path_new ();
2367 int i = 0, index = 0;
2369 while (i < elt_index)
2371 if (g_array_index (level->array, FilterElt, i).visible)
2375 g_assert (i < level->array->len);
2378 gtk_tree_path_prepend_index (retval, index);
2379 elt_index = level->parent_elt_index;
2380 level = level->parent_level;
2387 gtk_tree_model_filter_get_value (GtkTreeModel *model,
2392 GtkTreeIter child_iter;
2393 GtkTreeModelFilter *filter = GTK_TREE_MODEL_FILTER (model);
2395 g_return_if_fail (GTK_IS_TREE_MODEL_FILTER (model));
2396 g_return_if_fail (GTK_TREE_MODEL_FILTER (model)->priv->child_model != NULL);
2397 g_return_if_fail (GTK_TREE_MODEL_FILTER (model)->priv->stamp == iter->stamp);
2399 if (filter->priv->modify_func)
2401 g_return_if_fail (column < filter->priv->modify_n_columns);
2403 g_value_init (value, filter->priv->modify_types[column]);
2404 filter->priv->modify_func (model,
2408 filter->priv->modify_data);
2413 gtk_tree_model_filter_convert_iter_to_child_iter (GTK_TREE_MODEL_FILTER (model), &child_iter, iter);
2414 gtk_tree_model_get_value (GTK_TREE_MODEL_FILTER (model)->priv->child_model,
2415 &child_iter, column, value);
2419 gtk_tree_model_filter_iter_next (GtkTreeModel *model,
2426 g_return_val_if_fail (GTK_IS_TREE_MODEL_FILTER (model), FALSE);
2427 g_return_val_if_fail (GTK_TREE_MODEL_FILTER (model)->priv->child_model != NULL, FALSE);
2428 g_return_val_if_fail (GTK_TREE_MODEL_FILTER (model)->priv->stamp == iter->stamp, FALSE);
2430 level = iter->user_data;
2431 elt = iter->user_data2;
2433 i = elt - FILTER_ELT (level->array->data);
2435 while (i < level->array->len - 1)
2442 iter->user_data2 = elt;
2447 /* no next visible iter */
2454 gtk_tree_model_filter_iter_children (GtkTreeModel *model,
2456 GtkTreeIter *parent)
2458 GtkTreeModelFilter *filter = (GtkTreeModelFilter *)model;
2462 g_return_val_if_fail (GTK_IS_TREE_MODEL_FILTER (model), FALSE);
2463 g_return_val_if_fail (filter->priv->child_model != NULL, FALSE);
2465 g_return_val_if_fail (filter->priv->stamp == parent->stamp, FALSE);
2471 if (!filter->priv->root)
2472 gtk_tree_model_filter_build_level (filter, NULL, -1, FALSE);
2473 if (!filter->priv->root)
2476 level = filter->priv->root;
2478 if (!level->visible_nodes)
2481 iter->stamp = filter->priv->stamp;
2482 iter->user_data = level;
2484 while (i < level->array->len)
2486 if (!g_array_index (level->array, FilterElt, i).visible)
2492 iter->user_data2 = &g_array_index (level->array, FilterElt, i);
2504 elt = FILTER_ELT (parent->user_data2);
2506 if (elt->children == NULL)
2507 gtk_tree_model_filter_build_level (filter,
2508 FILTER_LEVEL (parent->user_data),
2509 FILTER_LEVEL_ELT_INDEX (parent->user_data, elt),
2512 if (elt->children == NULL)
2515 if (elt->children->visible_nodes <= 0)
2518 iter->stamp = filter->priv->stamp;
2519 iter->user_data = elt->children;
2521 level = FILTER_LEVEL (iter->user_data);
2523 while (i < level->array->len)
2525 if (!g_array_index (level->array, FilterElt, i).visible)
2531 iter->user_data2 = &g_array_index (level->array, FilterElt, i);
2544 gtk_tree_model_filter_iter_has_child (GtkTreeModel *model,
2547 GtkTreeIter child_iter;
2548 GtkTreeModelFilter *filter = (GtkTreeModelFilter *)model;
2551 g_return_val_if_fail (GTK_IS_TREE_MODEL_FILTER (model), FALSE);
2552 g_return_val_if_fail (filter->priv->child_model != NULL, FALSE);
2553 g_return_val_if_fail (filter->priv->stamp == iter->stamp, FALSE);
2555 filter = GTK_TREE_MODEL_FILTER (model);
2557 gtk_tree_model_filter_convert_iter_to_child_iter (GTK_TREE_MODEL_FILTER (model), &child_iter, iter);
2558 elt = FILTER_ELT (iter->user_data2);
2563 /* we need to build the level to check if not all children are filtered
2567 && gtk_tree_model_iter_has_child (filter->priv->child_model, &child_iter))
2568 gtk_tree_model_filter_build_level (filter, FILTER_LEVEL (iter->user_data),
2569 FILTER_LEVEL_ELT_INDEX (iter->user_data, elt),
2572 if (elt->children && elt->children->visible_nodes > 0)
2579 gtk_tree_model_filter_iter_n_children (GtkTreeModel *model,
2582 GtkTreeIter child_iter;
2583 GtkTreeModelFilter *filter = (GtkTreeModelFilter *)model;
2586 g_return_val_if_fail (GTK_IS_TREE_MODEL_FILTER (model), 0);
2587 g_return_val_if_fail (filter->priv->child_model != NULL, 0);
2589 g_return_val_if_fail (filter->priv->stamp == iter->stamp, 0);
2593 if (!filter->priv->root)
2594 gtk_tree_model_filter_build_level (filter, NULL, -1, FALSE);
2596 if (filter->priv->root)
2597 return FILTER_LEVEL (filter->priv->root)->visible_nodes;
2602 elt = FILTER_ELT (iter->user_data2);
2607 gtk_tree_model_filter_convert_iter_to_child_iter (GTK_TREE_MODEL_FILTER (model), &child_iter, iter);
2609 if (!elt->children &&
2610 gtk_tree_model_iter_has_child (filter->priv->child_model, &child_iter))
2611 gtk_tree_model_filter_build_level (filter,
2612 FILTER_LEVEL (iter->user_data),
2613 FILTER_LEVEL_ELT_INDEX (iter->user_data, elt),
2617 return elt->children->visible_nodes;
2623 gtk_tree_model_filter_iter_nth_child (GtkTreeModel *model,
2625 GtkTreeIter *parent,
2630 GtkTreeIter children;
2632 g_return_val_if_fail (GTK_IS_TREE_MODEL_FILTER (model), FALSE);
2634 g_return_val_if_fail (GTK_TREE_MODEL_FILTER (model)->priv->stamp == parent->stamp, FALSE);
2636 /* use this instead of has_child to force us to build the level, if needed */
2637 if (gtk_tree_model_filter_iter_children (model, &children, parent) == FALSE)
2643 level = children.user_data;
2644 elt = FILTER_ELT (level->array->data);
2646 if (n >= level->visible_nodes)
2652 elt = gtk_tree_model_filter_get_nth_visible (GTK_TREE_MODEL_FILTER (model),
2655 iter->stamp = GTK_TREE_MODEL_FILTER (model)->priv->stamp;
2656 iter->user_data = level;
2657 iter->user_data2 = elt;
2663 gtk_tree_model_filter_iter_parent (GtkTreeModel *model,
2670 g_return_val_if_fail (GTK_IS_TREE_MODEL_FILTER (model), FALSE);
2671 g_return_val_if_fail (GTK_TREE_MODEL_FILTER (model)->priv->child_model != NULL, FALSE);
2672 g_return_val_if_fail (GTK_TREE_MODEL_FILTER (model)->priv->stamp == child->stamp, FALSE);
2674 level = child->user_data;
2676 if (level->parent_level)
2678 iter->stamp = GTK_TREE_MODEL_FILTER (model)->priv->stamp;
2679 iter->user_data = level->parent_level;
2680 iter->user_data2 = FILTER_LEVEL_PARENT_ELT (level);
2689 gtk_tree_model_filter_ref_node (GtkTreeModel *model,
2692 GtkTreeModelFilter *filter = (GtkTreeModelFilter *)model;
2693 GtkTreeIter child_iter;
2697 g_return_if_fail (GTK_IS_TREE_MODEL_FILTER (model));
2698 g_return_if_fail (GTK_TREE_MODEL_FILTER (model)->priv->child_model != NULL);
2699 g_return_if_fail (GTK_TREE_MODEL_FILTER (model)->priv->stamp == iter->stamp);
2701 gtk_tree_model_filter_convert_iter_to_child_iter (GTK_TREE_MODEL_FILTER (model), &child_iter, iter);
2703 gtk_tree_model_ref_node (filter->priv->child_model, &child_iter);
2705 level = iter->user_data;
2706 elt = iter->user_data2;
2710 if (level->ref_count == 1)
2712 FilterLevel *parent_level = level->parent_level;
2713 gint parent_elt_index = level->parent_elt_index;
2715 /* we were at zero -- time to decrease the zero_ref_count val */
2716 while (parent_level)
2718 g_array_index (parent_level->array, FilterElt, parent_elt_index).zero_ref_count--;
2720 parent_elt_index = parent_level->parent_elt_index;
2721 parent_level = parent_level->parent_level;
2724 if (filter->priv->root != level)
2725 filter->priv->zero_ref_count--;
2730 gtk_tree_model_filter_unref_node (GtkTreeModel *model,
2733 gtk_tree_model_filter_real_unref_node (model, iter, TRUE);
2737 gtk_tree_model_filter_real_unref_node (GtkTreeModel *model,
2739 gboolean propagate_unref)
2741 GtkTreeModelFilter *filter = (GtkTreeModelFilter *)model;
2745 g_return_if_fail (GTK_IS_TREE_MODEL_FILTER (model));
2746 g_return_if_fail (filter->priv->child_model != NULL);
2747 g_return_if_fail (filter->priv->stamp == iter->stamp);
2749 if (propagate_unref)
2751 GtkTreeIter child_iter;
2752 gtk_tree_model_filter_convert_iter_to_child_iter (GTK_TREE_MODEL_FILTER (model), &child_iter, iter);
2753 gtk_tree_model_unref_node (filter->priv->child_model, &child_iter);
2756 level = iter->user_data;
2757 elt = iter->user_data2;
2759 g_return_if_fail (elt->ref_count > 0);
2763 if (level->ref_count == 0)
2765 FilterLevel *parent_level = level->parent_level;
2766 gint parent_elt_index = level->parent_elt_index;
2768 /* we are at zero -- time to increase the zero_ref_count val */
2769 while (parent_level)
2771 g_array_index (parent_level->array, FilterElt, parent_elt_index).zero_ref_count++;
2773 parent_elt_index = parent_level->parent_elt_index;
2774 parent_level = parent_level->parent_level;
2777 if (filter->priv->root != level)
2778 filter->priv->zero_ref_count++;
2782 /* TreeDragSource interface implementation */
2784 gtk_tree_model_filter_row_draggable (GtkTreeDragSource *drag_source,
2787 GtkTreeModelFilter *tree_model_filter = (GtkTreeModelFilter *)drag_source;
2788 GtkTreePath *child_path;
2791 g_return_val_if_fail (GTK_IS_TREE_MODEL_FILTER (drag_source), FALSE);
2792 g_return_val_if_fail (path != NULL, FALSE);
2794 child_path = gtk_tree_model_filter_convert_path_to_child_path (tree_model_filter, path);
2795 draggable = gtk_tree_drag_source_row_draggable (GTK_TREE_DRAG_SOURCE (tree_model_filter->priv->child_model), child_path);
2796 gtk_tree_path_free (child_path);
2802 gtk_tree_model_filter_drag_data_get (GtkTreeDragSource *drag_source,
2804 GtkSelectionData *selection_data)
2806 GtkTreeModelFilter *tree_model_filter = (GtkTreeModelFilter *)drag_source;
2807 GtkTreePath *child_path;
2810 g_return_val_if_fail (GTK_IS_TREE_MODEL_FILTER (drag_source), FALSE);
2811 g_return_val_if_fail (path != NULL, FALSE);
2813 child_path = gtk_tree_model_filter_convert_path_to_child_path (tree_model_filter, path);
2814 gotten = gtk_tree_drag_source_drag_data_get (GTK_TREE_DRAG_SOURCE (tree_model_filter->priv->child_model), child_path, selection_data);
2815 gtk_tree_path_free (child_path);
2821 gtk_tree_model_filter_drag_data_delete (GtkTreeDragSource *drag_source,
2824 GtkTreeModelFilter *tree_model_filter = (GtkTreeModelFilter *)drag_source;
2825 GtkTreePath *child_path;
2828 g_return_val_if_fail (GTK_IS_TREE_MODEL_FILTER (drag_source), FALSE);
2829 g_return_val_if_fail (path != NULL, FALSE);
2831 child_path = gtk_tree_model_filter_convert_path_to_child_path (tree_model_filter, path);
2832 deleted = gtk_tree_drag_source_drag_data_delete (GTK_TREE_DRAG_SOURCE (tree_model_filter->priv->child_model), child_path);
2833 gtk_tree_path_free (child_path);
2838 /* bits and pieces */
2840 gtk_tree_model_filter_set_model (GtkTreeModelFilter *filter,
2841 GtkTreeModel *child_model)
2843 g_return_if_fail (GTK_IS_TREE_MODEL_FILTER (filter));
2845 if (filter->priv->child_model)
2847 g_signal_handler_disconnect (filter->priv->child_model,
2848 filter->priv->changed_id);
2849 g_signal_handler_disconnect (filter->priv->child_model,
2850 filter->priv->inserted_id);
2851 g_signal_handler_disconnect (filter->priv->child_model,
2852 filter->priv->has_child_toggled_id);
2853 g_signal_handler_disconnect (filter->priv->child_model,
2854 filter->priv->deleted_id);
2855 g_signal_handler_disconnect (filter->priv->child_model,
2856 filter->priv->reordered_id);
2858 /* reset our state */
2859 if (filter->priv->root)
2860 gtk_tree_model_filter_free_level (filter, filter->priv->root);
2862 filter->priv->root = NULL;
2863 g_object_unref (filter->priv->child_model);
2864 filter->priv->visible_column = -1;
2866 /* FIXME: do we need to destroy more here? */
2869 filter->priv->child_model = child_model;
2873 g_object_ref (filter->priv->child_model);
2874 filter->priv->changed_id =
2875 g_signal_connect (child_model, "row-changed",
2876 G_CALLBACK (gtk_tree_model_filter_row_changed),
2878 filter->priv->inserted_id =
2879 g_signal_connect (child_model, "row-inserted",
2880 G_CALLBACK (gtk_tree_model_filter_row_inserted),
2882 filter->priv->has_child_toggled_id =
2883 g_signal_connect (child_model, "row-has-child-toggled",
2884 G_CALLBACK (gtk_tree_model_filter_row_has_child_toggled),
2886 filter->priv->deleted_id =
2887 g_signal_connect (child_model, "row-deleted",
2888 G_CALLBACK (gtk_tree_model_filter_row_deleted),
2890 filter->priv->reordered_id =
2891 g_signal_connect (child_model, "rows-reordered",
2892 G_CALLBACK (gtk_tree_model_filter_rows_reordered),
2895 filter->priv->child_flags = gtk_tree_model_get_flags (child_model);
2896 filter->priv->stamp = g_random_int ();
2901 gtk_tree_model_filter_ref_path (GtkTreeModelFilter *filter,
2907 len = gtk_tree_path_get_depth (path);
2908 p = gtk_tree_path_copy (path);
2913 gtk_tree_model_get_iter (GTK_TREE_MODEL (filter->priv->child_model), &iter, p);
2914 gtk_tree_model_ref_node (GTK_TREE_MODEL (filter->priv->child_model), &iter);
2915 gtk_tree_path_up (p);
2918 gtk_tree_path_free (p);
2922 gtk_tree_model_filter_unref_path (GtkTreeModelFilter *filter,
2928 len = gtk_tree_path_get_depth (path);
2929 p = gtk_tree_path_copy (path);
2934 gtk_tree_model_get_iter (GTK_TREE_MODEL (filter->priv->child_model), &iter, p);
2935 gtk_tree_model_unref_node (GTK_TREE_MODEL (filter->priv->child_model), &iter);
2936 gtk_tree_path_up (p);
2939 gtk_tree_path_free (p);
2943 gtk_tree_model_filter_set_root (GtkTreeModelFilter *filter,
2946 g_return_if_fail (GTK_IS_TREE_MODEL_FILTER (filter));
2949 filter->priv->virtual_root = NULL;
2951 filter->priv->virtual_root = gtk_tree_path_copy (root);
2957 * gtk_tree_model_filter_new:
2958 * @child_model: A #GtkTreeModel.
2959 * @root: A #GtkTreePath or %NULL.
2961 * Creates a new #GtkTreeModel, with @child_model as the child_model
2962 * and @root as the virtual root.
2964 * Return value: A new #GtkTreeModel.
2969 gtk_tree_model_filter_new (GtkTreeModel *child_model,
2972 GtkTreeModel *retval;
2973 GtkTreeModelFilter *filter;
2975 g_return_val_if_fail (GTK_IS_TREE_MODEL (child_model), NULL);
2977 retval = g_object_new (GTK_TYPE_TREE_MODEL_FILTER,
2978 "child-model", child_model,
2979 "virtual-root", root,
2982 filter = GTK_TREE_MODEL_FILTER (retval);
2983 if (filter->priv->virtual_root)
2985 gtk_tree_model_filter_ref_path (filter, filter->priv->virtual_root);
2986 filter->priv->virtual_root_deleted = FALSE;
2993 * gtk_tree_model_filter_get_model:
2994 * @filter: A #GtkTreeModelFilter.
2996 * Returns a pointer to the child model of @filter.
2998 * Return value: A pointer to a #GtkTreeModel.
3003 gtk_tree_model_filter_get_model (GtkTreeModelFilter *filter)
3005 g_return_val_if_fail (GTK_IS_TREE_MODEL_FILTER (filter), NULL);
3007 return filter->priv->child_model;
3011 * gtk_tree_model_filter_set_visible_func:
3012 * @filter: A #GtkTreeModelFilter.
3013 * @func: A #GtkTreeModelFilterVisibleFunc, the visible function.
3014 * @data: User data to pass to the visible function, or %NULL.
3015 * @destroy: Destroy notifier of @data, or %NULL.
3017 * Sets the visible function used when filtering the @filter to be @func. The
3018 * function should return %TRUE if the given row should be visible and
3021 * If the condition calculated by the function changes over time (e.g. because
3022 * it depends on some global parameters), you must call
3023 * gtk_tree_model_filter_refilter() to keep the visibility information of
3024 * the model uptodate.
3026 * Note that @func is called whenever a row is inserted, when it may still be
3027 * empty. The visible function should therefore take special care of empty
3028 * rows, like in the example below.
3030 * <informalexample><programlisting>
3032 * visible_func (GtkTreeModel *model,
3033 * GtkTreeIter *iter,
3036 * /* Visible if row is non-empty and first column is "HI" */
3038 * gboolean visible = FALSE;
3040 * gtk_tree_model_get (model, iter, 0, &str, -1);
3041 * if (str && strcmp (str, "HI") == 0)
3047 * </programlisting></informalexample>
3052 gtk_tree_model_filter_set_visible_func (GtkTreeModelFilter *filter,
3053 GtkTreeModelFilterVisibleFunc func,
3055 GDestroyNotify destroy)
3057 g_return_if_fail (GTK_IS_TREE_MODEL_FILTER (filter));
3058 g_return_if_fail (func != NULL);
3059 g_return_if_fail (filter->priv->visible_method_set == FALSE);
3061 if (filter->priv->visible_func)
3063 GDestroyNotify d = filter->priv->visible_destroy;
3065 filter->priv->visible_destroy = NULL;
3066 d (filter->priv->visible_data);
3069 filter->priv->visible_func = func;
3070 filter->priv->visible_data = data;
3071 filter->priv->visible_destroy = destroy;
3073 filter->priv->visible_method_set = TRUE;
3077 * gtk_tree_model_filter_set_modify_func:
3078 * @filter: A #GtkTreeModelFilter.
3079 * @n_columns: The number of columns in the filter model.
3080 * @types: The #GType<!-- -->s of the columns.
3081 * @func: A #GtkTreeModelFilterModifyFunc
3082 * @data: User data to pass to the modify function, or %NULL.
3083 * @destroy: Destroy notifier of @data, or %NULL.
3085 * With the @n_columns and @types parameters, you give an array of column
3086 * types for this model (which will be exposed to the parent model/view).
3087 * The @func, @data and @destroy parameters are for specifying the modify
3088 * function. The modify function will get called for <emphasis>each</emphasis>
3089 * data access, the goal of the modify function is to return the data which
3090 * should be displayed at the location specified using the parameters of the
3096 gtk_tree_model_filter_set_modify_func (GtkTreeModelFilter *filter,
3099 GtkTreeModelFilterModifyFunc func,
3101 GDestroyNotify destroy)
3103 g_return_if_fail (GTK_IS_TREE_MODEL_FILTER (filter));
3104 g_return_if_fail (func != NULL);
3105 g_return_if_fail (filter->priv->modify_func_set == FALSE);
3107 if (filter->priv->modify_destroy)
3109 GDestroyNotify d = filter->priv->modify_destroy;
3111 filter->priv->modify_destroy = NULL;
3112 d (filter->priv->modify_data);
3115 filter->priv->modify_n_columns = n_columns;
3116 filter->priv->modify_types = g_new0 (GType, n_columns);
3117 memcpy (filter->priv->modify_types, types, sizeof (GType) * n_columns);
3118 filter->priv->modify_func = func;
3119 filter->priv->modify_data = data;
3120 filter->priv->modify_destroy = destroy;
3122 filter->priv->modify_func_set = TRUE;
3126 * gtk_tree_model_filter_set_visible_column:
3127 * @filter: A #GtkTreeModelFilter.
3128 * @column: A #gint which is the column containing the visible information.
3130 * Sets @column of the child_model to be the column where @filter should
3131 * look for visibility information. @columns should be a column of type
3132 * %G_TYPE_BOOLEAN, where %TRUE means that a row is visible, and %FALSE
3138 gtk_tree_model_filter_set_visible_column (GtkTreeModelFilter *filter,
3141 g_return_if_fail (GTK_IS_TREE_MODEL_FILTER (filter));
3142 g_return_if_fail (column >= 0);
3143 g_return_if_fail (filter->priv->visible_method_set == FALSE);
3145 filter->priv->visible_column = column;
3147 filter->priv->visible_method_set = TRUE;
3153 * gtk_tree_model_filter_convert_child_iter_to_iter:
3154 * @filter: A #GtkTreeModelFilter.
3155 * @filter_iter: An uninitialized #GtkTreeIter.
3156 * @child_iter: A valid #GtkTreeIter pointing to a row on the child model.
3158 * Sets @filter_iter to point to the row in @filter that corresponds to the
3159 * row pointed at by @child_iter. If @filter_iter was not set, %FALSE is
3162 * Return value: %TRUE, if @filter_iter was set, i.e. if @child_iter is a
3163 * valid iterator pointing to a visible row in child model.
3168 gtk_tree_model_filter_convert_child_iter_to_iter (GtkTreeModelFilter *filter,
3169 GtkTreeIter *filter_iter,
3170 GtkTreeIter *child_iter)
3173 GtkTreePath *child_path, *path;
3175 g_return_val_if_fail (GTK_IS_TREE_MODEL_FILTER (filter), FALSE);
3176 g_return_val_if_fail (filter->priv->child_model != NULL, FALSE);
3177 g_return_val_if_fail (filter_iter != NULL, FALSE);
3178 g_return_val_if_fail (child_iter != NULL, FALSE);
3179 g_return_val_if_fail (filter_iter != child_iter, FALSE);
3181 filter_iter->stamp = 0;
3183 child_path = gtk_tree_model_get_path (filter->priv->child_model, child_iter);
3184 g_return_val_if_fail (child_path != NULL, FALSE);
3186 path = gtk_tree_model_filter_convert_child_path_to_path (filter,
3188 gtk_tree_path_free (child_path);
3193 ret = gtk_tree_model_get_iter (GTK_TREE_MODEL (filter), filter_iter, path);
3194 gtk_tree_path_free (path);
3200 * gtk_tree_model_filter_convert_iter_to_child_iter:
3201 * @filter: A #GtkTreeModelFilter.
3202 * @child_iter: An uninitialized #GtkTreeIter.
3203 * @filter_iter: A valid #GtkTreeIter pointing to a row on @filter.
3205 * Sets @child_iter to point to the row pointed to by @filter_iter.
3210 gtk_tree_model_filter_convert_iter_to_child_iter (GtkTreeModelFilter *filter,
3211 GtkTreeIter *child_iter,
3212 GtkTreeIter *filter_iter)
3214 g_return_if_fail (GTK_IS_TREE_MODEL_FILTER (filter));
3215 g_return_if_fail (filter->priv->child_model != NULL);
3216 g_return_if_fail (child_iter != NULL);
3217 g_return_if_fail (filter_iter != NULL);
3218 g_return_if_fail (filter_iter->stamp == filter->priv->stamp);
3219 g_return_if_fail (filter_iter != child_iter);
3221 if (GTK_TREE_MODEL_FILTER_CACHE_CHILD_ITERS (filter))
3223 *child_iter = FILTER_ELT (filter_iter->user_data2)->iter;
3229 path = gtk_tree_model_filter_elt_get_path (filter_iter->user_data,
3230 filter_iter->user_data2,
3231 filter->priv->virtual_root);
3232 gtk_tree_model_get_iter (filter->priv->child_model, child_iter, path);
3233 gtk_tree_path_free (path);
3237 /* The path returned can only be used internally in the filter model. */
3238 static GtkTreePath *
3239 gtk_real_tree_model_filter_convert_child_path_to_path (GtkTreeModelFilter *filter,
3240 GtkTreePath *child_path,
3241 gboolean build_levels,
3242 gboolean fetch_children)
3244 gint *child_indices;
3245 GtkTreePath *retval;
3246 GtkTreePath *real_path;
3251 g_return_val_if_fail (GTK_IS_TREE_MODEL_FILTER (filter), NULL);
3252 g_return_val_if_fail (filter->priv->child_model != NULL, NULL);
3253 g_return_val_if_fail (child_path != NULL, NULL);
3255 if (!filter->priv->virtual_root)
3256 real_path = gtk_tree_path_copy (child_path);
3258 real_path = gtk_tree_model_filter_remove_root (child_path,
3259 filter->priv->virtual_root);
3264 retval = gtk_tree_path_new ();
3265 child_indices = gtk_tree_path_get_indices (real_path);
3267 if (filter->priv->root == NULL && build_levels)
3268 gtk_tree_model_filter_build_level (filter, NULL, -1, FALSE);
3269 level = FILTER_LEVEL (filter->priv->root);
3271 for (i = 0; i < gtk_tree_path_get_depth (real_path); i++)
3274 gboolean found_child = FALSE;
3278 gtk_tree_path_free (real_path);
3279 gtk_tree_path_free (retval);
3283 tmp = bsearch_elt_with_offset (level->array, child_indices[i], &j);
3286 gtk_tree_path_append_index (retval, j);
3287 if (!tmp->children && build_levels)
3288 gtk_tree_model_filter_build_level (filter, level,
3289 FILTER_LEVEL_ELT_INDEX (level, tmp),
3291 level = tmp->children;
3295 if (!found_child && fetch_children)
3297 tmp = gtk_tree_model_filter_fetch_child (filter, level,
3301 /* didn't find the child, let's try to bring it back */
3302 if (!tmp || tmp->offset != child_indices[i])
3305 gtk_tree_path_free (real_path);
3306 gtk_tree_path_free (retval);
3310 gtk_tree_path_append_index (retval, j);
3311 if (!tmp->children && build_levels)
3312 gtk_tree_model_filter_build_level (filter, level,
3313 FILTER_LEVEL_ELT_INDEX (level, tmp),
3315 level = tmp->children;
3318 else if (!found_child && !fetch_children)
3321 gtk_tree_path_free (real_path);
3322 gtk_tree_path_free (retval);
3327 gtk_tree_path_free (real_path);
3332 * gtk_tree_model_filter_convert_child_path_to_path:
3333 * @filter: A #GtkTreeModelFilter.
3334 * @child_path: A #GtkTreePath to convert.
3336 * Converts @child_path to a path relative to @filter. That is, @child_path
3337 * points to a path in the child model. The rerturned path will point to the
3338 * same row in the filtered model. If @child_path isn't a valid path on the
3339 * child model or points to a row which is not visible in @filter, then %NULL
3342 * Return value: A newly allocated #GtkTreePath, or %NULL.
3347 gtk_tree_model_filter_convert_child_path_to_path (GtkTreeModelFilter *filter,
3348 GtkTreePath *child_path)
3353 /* this function does the sanity checks */
3354 path = gtk_real_tree_model_filter_convert_child_path_to_path (filter,
3362 /* get a new path which only takes visible nodes into account.
3363 * -- if this gives any performance issues, we can write a special
3364 * version of convert_child_path_to_path immediately returning
3365 * a visible-nodes-only path.
3367 gtk_tree_model_filter_get_iter_full (GTK_TREE_MODEL (filter), &iter, path);
3369 gtk_tree_path_free (path);
3370 path = gtk_tree_model_get_path (GTK_TREE_MODEL (filter), &iter);
3376 * gtk_tree_model_filter_convert_path_to_child_path:
3377 * @filter: A #GtkTreeModelFilter.
3378 * @filter_path: A #GtkTreePath to convert.
3380 * Converts @filter_path to a path on the child model of @filter. That is,
3381 * @filter_path points to a location in @filter. The returned path will
3382 * point to the same location in the model not being filtered. If @filter_path
3383 * does not point to a location in the child model, %NULL is returned.
3385 * Return value: A newly allocated #GtkTreePath, or %NULL.
3390 gtk_tree_model_filter_convert_path_to_child_path (GtkTreeModelFilter *filter,
3391 GtkTreePath *filter_path)
3393 gint *filter_indices;
3394 GtkTreePath *retval;
3398 g_return_val_if_fail (GTK_IS_TREE_MODEL_FILTER (filter), NULL);
3399 g_return_val_if_fail (filter->priv->child_model != NULL, NULL);
3400 g_return_val_if_fail (filter_path != NULL, NULL);
3403 retval = gtk_tree_path_new ();
3404 filter_indices = gtk_tree_path_get_indices (filter_path);
3405 if (!filter->priv->root)
3406 gtk_tree_model_filter_build_level (filter, NULL, -1, FALSE);
3407 level = FILTER_LEVEL (filter->priv->root);
3409 for (i = 0; i < gtk_tree_path_get_depth (filter_path); i++)
3413 if (!level || level->visible_nodes <= filter_indices[i])
3415 gtk_tree_path_free (retval);
3419 elt = gtk_tree_model_filter_get_nth_visible (filter, level,
3422 if (elt->children == NULL)
3423 gtk_tree_model_filter_build_level (filter, level,
3424 FILTER_LEVEL_ELT_INDEX (level, elt),
3427 if (!level || level->visible_nodes <= filter_indices[i])
3429 gtk_tree_path_free (retval);
3433 gtk_tree_path_append_index (retval, elt->offset);
3434 level = elt->children;
3439 if (filter->priv->virtual_root)
3441 GtkTreePath *real_retval;
3443 real_retval = gtk_tree_model_filter_add_root (retval,
3444 filter->priv->virtual_root);
3445 gtk_tree_path_free (retval);
3454 gtk_tree_model_filter_refilter_helper (GtkTreeModel *model,
3459 /* evil, don't try this at home, but certainly speeds things up */
3460 gtk_tree_model_filter_row_changed (model, path, iter, data);
3466 * gtk_tree_model_filter_refilter:
3467 * @filter: A #GtkTreeModelFilter.
3469 * Emits ::row_changed for each row in the child model, which causes
3470 * the filter to re-evaluate whether a row is visible or not.
3475 gtk_tree_model_filter_refilter (GtkTreeModelFilter *filter)
3477 g_return_if_fail (GTK_IS_TREE_MODEL_FILTER (filter));
3480 gtk_tree_model_foreach (filter->priv->child_model,
3481 gtk_tree_model_filter_refilter_helper,
3486 * gtk_tree_model_filter_clear_cache:
3487 * @filter: A #GtkTreeModelFilter.
3489 * This function should almost never be called. It clears the @filter
3490 * of any cached iterators that haven't been reffed with
3491 * gtk_tree_model_ref_node(). This might be useful if the child model
3492 * being filtered is static (and doesn't change often) and there has been
3493 * a lot of unreffed access to nodes. As a side effect of this function,
3494 * all unreffed iters will be invalid.
3499 gtk_tree_model_filter_clear_cache (GtkTreeModelFilter *filter)
3501 g_return_if_fail (GTK_IS_TREE_MODEL_FILTER (filter));
3503 if (filter->priv->zero_ref_count > 0)
3504 gtk_tree_model_filter_clear_cache_helper (filter,
3505 FILTER_LEVEL (filter->priv->root));
3508 #define __GTK_TREE_MODEL_FILTER_C__
3509 #include "gtkaliasdef.c"