1 /* gtktreemodelfilter.c
2 * Copyright (C) 2000,2001 Red Hat, Inc., Jonathan Blandford <jrb@redhat.com>
3 * Copyright (C) 2001-2003 Kristian Rietveld <kris@gtk.org>
5 * This library is free software; you can redistribute it and/or
6 * modify it under the terms of the GNU Library General Public
7 * License as published by the Free Software Foundation; either
8 * version 2 of the License, or (at your option) any later version.
10 * This library is distributed in the hope that it will be useful,
11 * but WITHOUT ANY WARRANTY; without even the implied warranty of
12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
13 * Library General Public License for more details.
15 * You should have received a copy of the GNU Library General Public
16 * License along with this library; if not, write to the
17 * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
18 * Boston, MA 02111-1307, USA.
22 #include "gtktreemodelfilter.h"
24 #include "gtktreednd.h"
25 #include "gtkprivate.h"
30 * SECTION:gtktreemodelfilter
31 * @Short_description: A GtkTreeModel which hides parts of an underlying tree model
32 * @Title: GtkTreeModelFilter
33 * @See_also:#GtkTreeModelSort
35 * A #GtkTreeModelFilter is a tree model which wraps another tree model,
36 * and can do the following things:
39 * Filter specific rows, based on data from a "visible column", a column
40 * storing booleans indicating whether the row should be filtered or not,
41 * or based on the return value of a "visible function", which gets a
42 * model, iter and user_data and returns a boolean indicating whether the
43 * row should be filtered or not.
46 * Modify the "appearance" of the model, using a modify function.
47 * This is extremely powerful and allows for just changing
48 * some values and also for creating a completely different model based on
49 * the given child model.
52 * Set a different root node, also known as a "virtual root". You can pass in
53 * a #GtkTreePath indicating the root node for the filter at construction time.
57 * The basic API is similar to #GtkTreeModelSort. For an example on its usage,
58 * see the section on #GtkTreeModelSort.
60 * When using #GtkTreeModelFilter, it is important to realize that
61 * #GtkTreeModelFilter maintains an internal cache of all nodes which are
62 * visible in its clients. The cache is likely to be a subtree of the tree
63 * exposed by the child model. #GtkTreeModelFilter will not cache the entire
64 * child model when unnecessary to not compromise the caching mechanism
65 * that is exposed by the reference counting scheme. If the child model
66 * implements reference counting, unnecessary signals may not be emitted
67 * because of reference counting rule 3, see the #GtkTreeModel
68 * documentation. (Note that e.g. #GtkTreeStore does not implement
69 * reference counting and will always emit all signals, even when
70 * the receiving node is not visible).
72 * Because of this, limitations for possible visible functions do apply.
73 * In general, visible functions should only use data or properties from
74 * the node for which the visibility state must be determined, its siblings
75 * or its parents. Usually, having a dependency on the state of any child
76 * node is not possible, unless references are taken on these explicitly.
77 * When no such reference exists, no signals may be received for these child
78 * nodes (see reference couting rule number 3 in the #GtkTreeModel section).
80 * Determining the visibility state of a given node based on the state
81 * of its child nodes is a frequently occurring use case. Therefore,
82 * #GtkTreeModelFilter explicitly supports this. For example, when a node
83 * does not have any children, you might not want the node to be visible.
84 * As soon as the first row is added to the node's child level (or the
85 * last row removed), the node's visibility should be updated.
87 * This introduces a dependency from the node on its child nodes. In order
88 * to accommodate this, #GtkTreeModelFilter must make sure the necesary
89 * signals are received from the child model. This is achieved by building,
90 * for all nodes which are exposed as visible nodes to #GtkTreeModelFilter's
91 * clients, the child level (if any) and take a reference on the first node
92 * in this level. Furthermore, for every row-inserted, row-changed or
93 * row-deleted signal (also these which were not handled because the node
94 * was not cached), #GtkTreeModelFilter will check if the visibility state
95 * of any parent node has changed.
97 * Beware, however, that this explicit support is limited to these two
98 * cases. For example, if you want a node to be visible only if two nodes
99 * in a child's child level (2 levels deeper) are visible, you are on your
100 * own. In this case, either rely on #GtkTreeStore to emit all signals
101 * because it does not implement reference counting, or for models that
102 * do implement reference counting, obtain references on these child levels
106 /* Notes on this implementation of GtkTreeModelFilter
107 * ==================================================
112 * In this code there is a potential for confusion as to whether an iter,
113 * path or value refers to the GtkTreeModelFilter model, or to the child
114 * model that has been set. As a convention, variables referencing the
115 * child model will have a c_ prefix before them (ie. c_iter, c_value,
116 * c_path). In case the c_ prefixed names are already in use, an f_
117 * prefix is used. Conversion of iterators and paths between
118 * GtkTreeModelFilter and the child model is done through the various
119 * gtk_tree_model_filter_convert_* functions.
121 * Even though the GtkTreeModelSort and GtkTreeModelFilter have very
122 * similar data structures, many assumptions made in the GtkTreeModelSort
123 * code do *not* apply in the GtkTreeModelFilter case. Reference counting
124 * in particular is more complicated in GtkTreeModelFilter, because
125 * we explicitly support reliance on the state of a node's children as
126 * outlined in the public API documentation. Because of these differences,
127 * you are strongly recommended to first read through these notes before
128 * making any modification to the code.
133 * The iterator format of iterators handed out by GtkTreeModelFilter is
136 * iter->stamp = filter->priv->stamp
137 * iter->user_data = FilterLevel
138 * iter->user_data2 = FilterElt
140 * Internal data structure
141 * -----------------------
143 * Using FilterLevel and FilterElt, GtkTreeModelFilter maintains a "cache"
144 * of the mapping from GtkTreeModelFilter nodes to nodes in the child model.
145 * This is to avoid re-creating a level each time (which involves computing
146 * visibility for each node in that level) an operation is requested on
147 * GtkTreeModelFilter, such as get iter, get path and get value.
149 * A FilterElt corresponds to a single node. The FilterElt can either be
150 * visible or invisible in the model that is exposed to the clients of this
151 * GtkTreeModelFilter. The visibility state is stored in the "visible_siter"
152 * field, which is NULL when the node is not visible. The FilterLevel keeps
153 * a reference to the parent FilterElt and its FilterLevel (if any). The
154 * FilterElt can have a "children" pointer set, which points at a child
155 * level (a sub level).
157 * In a FilterLevel, two separate GSequences are maintained. One contains
158 * all nodes of this FilterLevel, regardless of the visibility state of
159 * the node. Another contains only visible nodes. A visible FilterElt
160 * is thus present in both the full and the visible GSequence. The
161 * GSequence allows for fast access, addition and removal of nodes.
163 * It is important to recognize the two different mappings that play
164 * a part in this code:
165 * I. The mapping from the client to this model. The order in which
166 * nodes are stored in the *visible* GSequence is the order in
167 * which the nodes are exposed to clients of the GtkTreeModelFilter.
168 * II. The mapping from this model to its child model. Each FilterElt
169 * contains an "offset" field which is the offset of the
170 * corresponding node in the child model.
172 * Throughout the code, two kinds of paths relative to the GtkTreeModelFilter
173 * (those generated from the sequence positions) are used. There are paths
174 * which take non-visible nodes into account (generated from the full
175 * sequences) and paths which don't (generated from the visible sequences).
176 * Paths which have been generated from the full sequences should only be
177 * used internally and NEVER be passed along with a signal emisson.
182 * GtkTreeModelFilter forwards all reference and unreference operations
183 * to the corresponding node in the child model. In addition,
184 * GtkTreeModelFilter will also add references of its own. The full reference
185 * count of each node (i.e. all forwarded references and these by the
186 * filter model) is maintained internally in the "ref_count" fields in
187 * FilterElt and FilterLevel. Because there is a need to determine whether
188 * a node should be visible for the client, the reference count of only
189 * the forwarded references is maintained as well, in the "ext_ref_count"
192 * In a few cases, GtkTreeModelFilter takes additional references on
193 * nodes. The first case is that a reference is taken on the parent
194 * (if any) of each level. This happens in gtk_tree_model_filter_build_level()
195 * and the reference is released again in gtk_tree_model_filter_free_level().
196 * This ensures that for all references which are taken by the filter
197 * model, all parent nodes are referenced according to reference counting
198 * rule 1 in the GtkTreeModel documentation.
200 * A second case is required to support visible functions which depend on
201 * the state of a node's children (see the public API documentation for
202 * GtkTreeModelFilter above). We build the child level of each node that
203 * could be visible in the client (i.e. the level has an ext_ref_count > 0;
204 * not the elt, because the elt might be invisible and thus unreferenced
205 * by the client). For each node that becomes visible, due to insertion or
206 * changes in visibility state, it is checked whether node has children, if
207 * so the child level is built.
209 * A reference is taken on the first node of each level so that the child
210 * model will emit all signals for this level, due to reference counting
211 * rule 3 in the GtkTreeModel documentation. If due to changes in the level,
212 * another node becomes the first node (e.g. due to insertion or reordering),
213 * this reference is transferred from the old to the new first node.
215 * When a level has an *external* reference count of zero (which means that
216 * none of the nodes in the level is referenced by the clients), the level
217 * has a "zero ref count" on all its parents. As soon as the level reaches
218 * an *external* reference count of zero, the zero ref count value is
219 * incremented by one for all parents of this level. Due to the additional
220 * references taken by the filter model, it is important to base the
221 * zero ref count on the external reference count instead of on the full
222 * reference count of the node.
224 * The zero ref count value aids in determining which portions of the
225 * cache are possibly unused and could be removed. If a FilterElt has
226 * a zero ref count of one, then its child level is unused. However, the
227 * child level can only be removed from the cache if the FilterElt's
228 * parent level has an external ref count of zero. (Not the parent elt,
229 * because an invisible parent elt with external ref count == 0 might still
230 * become visible because of a state change in its child level!). Otherwise,
231 * monitoring this level is necessary to possibly update the visibility state
232 * of the parent. This is an important difference from GtkTreeModelSort!
234 * Signals are only required for levels with an external ref count > 0.
235 * This due to reference counting rule 3, see the GtkTreeModel
236 * documentation. In the GtkTreeModelFilter we try hard to stick to this
237 * rule and not emit redundant signals (though redundant emissions of
238 * row-has-child-toggled could appear frequently; it does happen that
239 * we simply forward the signal emitted by e.g. GtkTreeStore but also
240 * emit our own copy).
244 typedef struct _FilterElt FilterElt;
245 typedef struct _FilterLevel FilterLevel;
250 FilterLevel *children;
255 GSequenceIter *visible_siter; /* iter into visible_seq */
261 GSequence *visible_seq;
265 FilterElt *parent_elt;
266 FilterLevel *parent_level;
270 struct _GtkTreeModelFilterPrivate
272 GtkTreeModel *child_model;
274 GtkTreePath *virtual_root;
281 GtkTreeModelFilterVisibleFunc visible_func;
282 gpointer visible_data;
283 GDestroyNotify visible_destroy;
286 GtkTreeModelFilterModifyFunc modify_func;
287 gpointer modify_data;
288 GDestroyNotify modify_destroy;
289 gint modify_n_columns;
291 guint visible_method_set : 1;
292 guint modify_func_set : 1;
294 guint in_row_deleted : 1;
295 guint virtual_root_deleted : 1;
300 gulong has_child_toggled_id;
313 /* Set this to 0 to disable caching of child iterators. This
314 * allows for more stringent testing. It is recommended to set this
315 * to one when refactoring this code and running the unit tests to
319 # define GTK_TREE_MODEL_FILTER_CACHE_CHILD_ITERS(filter) \
320 (((GtkTreeModelFilter *)filter)->priv->child_flags & GTK_TREE_MODEL_ITERS_PERSIST)
322 # define GTK_TREE_MODEL_FILTER_CACHE_CHILD_ITERS(filter) (FALSE)
325 /* Defining this constant enables more assertions, which will be
326 * helpful when debugging the code.
328 #undef MODEL_FILTER_DEBUG
330 #define FILTER_ELT(filter_elt) ((FilterElt *)filter_elt)
331 #define FILTER_LEVEL(filter_level) ((FilterLevel *)filter_level)
332 #define GET_ELT(siter) ((FilterElt*) (siter ? g_sequence_get (siter) : NULL))
334 /* general code (object/interface init, properties, etc) */
335 static void gtk_tree_model_filter_tree_model_init (GtkTreeModelIface *iface);
336 static void gtk_tree_model_filter_drag_source_init (GtkTreeDragSourceIface *iface);
337 static void gtk_tree_model_filter_finalize (GObject *object);
338 static void gtk_tree_model_filter_set_property (GObject *object,
342 static void gtk_tree_model_filter_get_property (GObject *object,
347 /* signal handlers */
348 static void gtk_tree_model_filter_row_changed (GtkTreeModel *c_model,
352 static void gtk_tree_model_filter_row_inserted (GtkTreeModel *c_model,
356 static void gtk_tree_model_filter_row_has_child_toggled (GtkTreeModel *c_model,
360 static void gtk_tree_model_filter_row_deleted (GtkTreeModel *c_model,
363 static void gtk_tree_model_filter_rows_reordered (GtkTreeModel *c_model,
369 /* GtkTreeModel interface */
370 static GtkTreeModelFlags gtk_tree_model_filter_get_flags (GtkTreeModel *model);
371 static gint gtk_tree_model_filter_get_n_columns (GtkTreeModel *model);
372 static GType gtk_tree_model_filter_get_column_type (GtkTreeModel *model,
374 static gboolean gtk_tree_model_filter_get_iter_full (GtkTreeModel *model,
377 static gboolean gtk_tree_model_filter_get_iter (GtkTreeModel *model,
380 static GtkTreePath *gtk_tree_model_filter_get_path (GtkTreeModel *model,
382 static void gtk_tree_model_filter_get_value (GtkTreeModel *model,
386 static gboolean gtk_tree_model_filter_iter_next (GtkTreeModel *model,
388 static gboolean gtk_tree_model_filter_iter_previous (GtkTreeModel *model,
390 static gboolean gtk_tree_model_filter_iter_children (GtkTreeModel *model,
392 GtkTreeIter *parent);
393 static gboolean gtk_tree_model_filter_iter_has_child (GtkTreeModel *model,
395 static gint gtk_tree_model_filter_iter_n_children (GtkTreeModel *model,
397 static gboolean gtk_tree_model_filter_iter_nth_child (GtkTreeModel *model,
401 static gboolean gtk_tree_model_filter_iter_parent (GtkTreeModel *model,
404 static void gtk_tree_model_filter_ref_node (GtkTreeModel *model,
406 static void gtk_tree_model_filter_unref_node (GtkTreeModel *model,
409 /* TreeDragSource interface */
410 static gboolean gtk_tree_model_filter_row_draggable (GtkTreeDragSource *drag_source,
412 static gboolean gtk_tree_model_filter_drag_data_get (GtkTreeDragSource *drag_source,
414 GtkSelectionData *selection_data);
415 static gboolean gtk_tree_model_filter_drag_data_delete (GtkTreeDragSource *drag_source,
418 /* private functions */
419 static void gtk_tree_model_filter_build_level (GtkTreeModelFilter *filter,
420 FilterLevel *parent_level,
421 FilterElt *parent_elt,
422 gboolean emit_inserted);
424 static void gtk_tree_model_filter_free_level (GtkTreeModelFilter *filter,
425 FilterLevel *filter_level,
427 gboolean unref_external);
429 static GtkTreePath *gtk_tree_model_filter_elt_get_path (FilterLevel *level,
433 static GtkTreePath *gtk_tree_model_filter_add_root (GtkTreePath *src,
435 static GtkTreePath *gtk_tree_model_filter_remove_root (GtkTreePath *src,
438 static void gtk_tree_model_filter_increment_stamp (GtkTreeModelFilter *filter);
440 static void gtk_tree_model_filter_real_modify (GtkTreeModelFilter *self,
441 GtkTreeModel *child_model,
445 static gboolean gtk_tree_model_filter_real_visible (GtkTreeModelFilter *filter,
446 GtkTreeModel *child_model,
447 GtkTreeIter *child_iter);
448 static gboolean gtk_tree_model_filter_visible (GtkTreeModelFilter *filter,
449 GtkTreeIter *child_iter);
450 static void gtk_tree_model_filter_clear_cache_helper (GtkTreeModelFilter *filter,
453 static void gtk_tree_model_filter_real_ref_node (GtkTreeModel *model,
456 static void gtk_tree_model_filter_real_unref_node (GtkTreeModel *model,
459 gboolean propagate_unref);
461 static void gtk_tree_model_filter_set_model (GtkTreeModelFilter *filter,
462 GtkTreeModel *child_model);
463 static void gtk_tree_model_filter_ref_path (GtkTreeModelFilter *filter,
465 static void gtk_tree_model_filter_unref_path (GtkTreeModelFilter *filter,
468 static void gtk_tree_model_filter_set_root (GtkTreeModelFilter *filter,
471 static GtkTreePath *gtk_real_tree_model_filter_convert_child_path_to_path (GtkTreeModelFilter *filter,
472 GtkTreePath *child_path,
473 gboolean build_levels,
474 gboolean fetch_children);
476 static gboolean gtk_tree_model_filter_elt_is_visible_in_target (FilterLevel *level,
479 static FilterElt *gtk_tree_model_filter_insert_elt_in_level (GtkTreeModelFilter *filter,
484 static FilterElt *gtk_tree_model_filter_fetch_child (GtkTreeModelFilter *filter,
488 static void gtk_tree_model_filter_remove_elt_from_level (GtkTreeModelFilter *filter,
491 static void gtk_tree_model_filter_update_children (GtkTreeModelFilter *filter,
494 static void gtk_tree_model_filter_emit_row_inserted_for_path (GtkTreeModelFilter *filter,
495 GtkTreeModel *c_model,
497 GtkTreeIter *c_iter);
500 G_DEFINE_TYPE_WITH_CODE (GtkTreeModelFilter, gtk_tree_model_filter, G_TYPE_OBJECT,
501 G_IMPLEMENT_INTERFACE (GTK_TYPE_TREE_MODEL,
502 gtk_tree_model_filter_tree_model_init)
503 G_IMPLEMENT_INTERFACE (GTK_TYPE_TREE_DRAG_SOURCE,
504 gtk_tree_model_filter_drag_source_init))
507 gtk_tree_model_filter_init (GtkTreeModelFilter *filter)
509 filter->priv = G_TYPE_INSTANCE_GET_PRIVATE (filter,
510 GTK_TYPE_TREE_MODEL_FILTER,
511 GtkTreeModelFilterPrivate);
513 filter->priv->visible_column = -1;
514 filter->priv->zero_ref_count = 0;
515 filter->priv->visible_method_set = FALSE;
516 filter->priv->modify_func_set = FALSE;
517 filter->priv->in_row_deleted = FALSE;
518 filter->priv->virtual_root_deleted = FALSE;
522 gtk_tree_model_filter_class_init (GtkTreeModelFilterClass *filter_class)
524 GObjectClass *object_class;
526 object_class = (GObjectClass *) filter_class;
528 object_class->set_property = gtk_tree_model_filter_set_property;
529 object_class->get_property = gtk_tree_model_filter_get_property;
531 object_class->finalize = gtk_tree_model_filter_finalize;
533 filter_class->visible = gtk_tree_model_filter_real_visible;
534 filter_class->modify = gtk_tree_model_filter_real_modify;
536 /* Properties -- FIXME: disabled translations for now, until I can come up with a
539 g_object_class_install_property (object_class,
541 g_param_spec_object ("child-model",
543 ("The model for the filtermodel to filter"),
545 GTK_PARAM_READWRITE | G_PARAM_CONSTRUCT_ONLY));
547 g_object_class_install_property (object_class,
549 g_param_spec_boxed ("virtual-root",
550 ("The virtual root"),
551 ("The virtual root (relative to the child model) for this filtermodel"),
553 GTK_PARAM_READWRITE | G_PARAM_CONSTRUCT_ONLY));
555 g_type_class_add_private (object_class, sizeof (GtkTreeModelFilterPrivate));
559 gtk_tree_model_filter_tree_model_init (GtkTreeModelIface *iface)
561 iface->get_flags = gtk_tree_model_filter_get_flags;
562 iface->get_n_columns = gtk_tree_model_filter_get_n_columns;
563 iface->get_column_type = gtk_tree_model_filter_get_column_type;
564 iface->get_iter = gtk_tree_model_filter_get_iter;
565 iface->get_path = gtk_tree_model_filter_get_path;
566 iface->get_value = gtk_tree_model_filter_get_value;
567 iface->iter_next = gtk_tree_model_filter_iter_next;
568 iface->iter_previous = gtk_tree_model_filter_iter_previous;
569 iface->iter_children = gtk_tree_model_filter_iter_children;
570 iface->iter_has_child = gtk_tree_model_filter_iter_has_child;
571 iface->iter_n_children = gtk_tree_model_filter_iter_n_children;
572 iface->iter_nth_child = gtk_tree_model_filter_iter_nth_child;
573 iface->iter_parent = gtk_tree_model_filter_iter_parent;
574 iface->ref_node = gtk_tree_model_filter_ref_node;
575 iface->unref_node = gtk_tree_model_filter_unref_node;
579 gtk_tree_model_filter_drag_source_init (GtkTreeDragSourceIface *iface)
581 iface->row_draggable = gtk_tree_model_filter_row_draggable;
582 iface->drag_data_delete = gtk_tree_model_filter_drag_data_delete;
583 iface->drag_data_get = gtk_tree_model_filter_drag_data_get;
588 gtk_tree_model_filter_finalize (GObject *object)
590 GtkTreeModelFilter *filter = (GtkTreeModelFilter *) object;
592 if (filter->priv->virtual_root && !filter->priv->virtual_root_deleted)
594 gtk_tree_model_filter_unref_path (filter, filter->priv->virtual_root,
596 filter->priv->virtual_root_deleted = TRUE;
599 gtk_tree_model_filter_set_model (filter, NULL);
601 if (filter->priv->virtual_root)
602 gtk_tree_path_free (filter->priv->virtual_root);
604 if (filter->priv->root)
605 gtk_tree_model_filter_free_level (filter, filter->priv->root, TRUE, FALSE);
607 g_free (filter->priv->modify_types);
609 if (filter->priv->modify_destroy)
610 filter->priv->modify_destroy (filter->priv->modify_data);
612 if (filter->priv->visible_destroy)
613 filter->priv->visible_destroy (filter->priv->visible_data);
616 G_OBJECT_CLASS (gtk_tree_model_filter_parent_class)->finalize (object);
620 gtk_tree_model_filter_set_property (GObject *object,
625 GtkTreeModelFilter *filter = GTK_TREE_MODEL_FILTER (object);
629 case PROP_CHILD_MODEL:
630 gtk_tree_model_filter_set_model (filter, g_value_get_object (value));
632 case PROP_VIRTUAL_ROOT:
633 gtk_tree_model_filter_set_root (filter, g_value_get_boxed (value));
636 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
642 gtk_tree_model_filter_get_property (GObject *object,
647 GtkTreeModelFilter *filter = GTK_TREE_MODEL_FILTER (object);
651 case PROP_CHILD_MODEL:
652 g_value_set_object (value, filter->priv->child_model);
654 case PROP_VIRTUAL_ROOT:
655 g_value_set_boxed (value, filter->priv->virtual_root);
658 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
666 filter_elt_new (void)
668 return g_slice_new (FilterElt);
672 filter_elt_free (gpointer elt)
674 g_slice_free (FilterElt, elt);
678 filter_elt_cmp (gconstpointer a,
682 const FilterElt *elt_a = a;
683 const FilterElt *elt_b = b;
685 if (elt_a->offset > elt_b->offset)
687 else if (elt_a->offset < elt_b->offset)
694 lookup_elt_with_offset (GSequence *seq,
696 GSequenceIter **ret_siter)
698 GSequenceIter *siter;
701 dummy.offset = offset;
702 siter = g_sequence_lookup (seq, &dummy, filter_elt_cmp, NULL);
707 return GET_ELT (siter);
711 increase_offset_iter (gpointer data,
714 FilterElt *elt = data;
715 gint offset = GPOINTER_TO_INT (user_data);
717 if (elt->offset >= offset)
722 decrease_offset_iter (gpointer data,
725 FilterElt *elt = data;
726 gint offset = GPOINTER_TO_INT (user_data);
728 if (elt->offset > offset)
733 gtk_tree_model_filter_build_level (GtkTreeModelFilter *filter,
734 FilterLevel *parent_level,
735 FilterElt *parent_elt,
736 gboolean emit_inserted)
739 GtkTreeIter first_node;
741 FilterLevel *new_level;
742 FilterLevel *tmp_level;
747 gboolean empty = TRUE;
749 g_assert (filter->priv->child_model != NULL);
751 /* Avoid building a level that already exists */
753 g_assert (parent_elt->children == NULL);
755 g_assert (filter->priv->root == NULL);
757 if (filter->priv->in_row_deleted)
762 if (filter->priv->virtual_root)
764 if (gtk_tree_model_get_iter (filter->priv->child_model, &root, filter->priv->virtual_root) == FALSE)
766 length = gtk_tree_model_iter_n_children (filter->priv->child_model, &root);
768 if (gtk_tree_model_iter_children (filter->priv->child_model, &iter, &root) == FALSE)
773 if (!gtk_tree_model_get_iter_first (filter->priv->child_model, &iter))
775 length = gtk_tree_model_iter_n_children (filter->priv->child_model, NULL);
780 GtkTreeIter parent_iter;
781 GtkTreeIter child_parent_iter;
783 parent_iter.stamp = filter->priv->stamp;
784 parent_iter.user_data = parent_level;
785 parent_iter.user_data2 = parent_elt;
787 gtk_tree_model_filter_convert_iter_to_child_iter (filter,
790 if (gtk_tree_model_iter_children (filter->priv->child_model, &iter, &child_parent_iter) == FALSE)
793 /* stamp may have changed */
794 gtk_tree_model_filter_convert_iter_to_child_iter (filter,
797 length = gtk_tree_model_iter_n_children (filter->priv->child_model, &child_parent_iter);
799 /* Take a reference on the parent */
800 gtk_tree_model_filter_real_ref_node (GTK_TREE_MODEL (filter),
801 &parent_iter, FALSE);
804 g_return_if_fail (length > 0);
806 new_level = g_new (FilterLevel, 1);
807 new_level->seq = g_sequence_new (filter_elt_free);
808 new_level->visible_seq = g_sequence_new (NULL);
809 new_level->ref_count = 0;
810 new_level->ext_ref_count = 0;
811 new_level->parent_elt = parent_elt;
812 new_level->parent_level = parent_level;
815 parent_elt->children = new_level;
817 filter->priv->root = new_level;
819 /* increase the count of zero ref_counts */
820 tmp_level = parent_level;
821 tmp_elt = parent_elt;
825 tmp_elt->zero_ref_count++;
827 tmp_elt = tmp_level->parent_elt;
828 tmp_level = tmp_level->parent_level;
830 if (new_level != filter->priv->root)
831 filter->priv->zero_ref_count++;
839 if (gtk_tree_model_filter_visible (filter, &iter))
841 FilterElt *filter_elt;
843 filter_elt = filter_elt_new ();
844 filter_elt->offset = i;
845 filter_elt->zero_ref_count = 0;
846 filter_elt->ref_count = 0;
847 filter_elt->ext_ref_count = 0;
848 filter_elt->children = NULL;
849 filter_elt->visible_siter = NULL;
851 if (GTK_TREE_MODEL_FILTER_CACHE_CHILD_ITERS (filter))
852 filter_elt->iter = iter;
854 g_sequence_append (new_level->seq, filter_elt);
855 filter_elt->visible_siter = g_sequence_append (new_level->visible_seq, filter_elt);
862 GtkTreeIter children;
864 f_iter.stamp = filter->priv->stamp;
865 f_iter.user_data = new_level;
866 f_iter.user_data2 = filter_elt;
868 f_path = gtk_tree_model_get_path (GTK_TREE_MODEL (filter),
870 gtk_tree_model_row_inserted (GTK_TREE_MODEL (filter),
872 gtk_tree_path_free (f_path);
874 if (gtk_tree_model_iter_children (filter->priv->child_model,
876 gtk_tree_model_filter_update_children (filter,
878 FILTER_ELT (f_iter.user_data2));
883 while (gtk_tree_model_iter_next (filter->priv->child_model, &iter));
885 /* The level does not contain any visible nodes. However, changes in
886 * this level might affect the parent node, which can either be visible
887 * or invisible. Therefore, this level can only be removed again,
888 * if the parent level has an external reference count of zero. That is,
889 * if this level changes state, no signals are required in the parent
893 (parent_level && parent_level->ext_ref_count == 0))
895 gtk_tree_model_filter_free_level (filter, new_level, FALSE, FALSE);
899 /* If none of the nodes are visible, we will just pull in the
900 * first node of the level.
904 FilterElt *filter_elt;
906 filter_elt = filter_elt_new ();
907 filter_elt->offset = 0;
908 filter_elt->zero_ref_count = 0;
909 filter_elt->ref_count = 0;
910 filter_elt->ext_ref_count = 0;
911 filter_elt->children = NULL;
912 filter_elt->visible_siter = NULL;
914 if (GTK_TREE_MODEL_FILTER_CACHE_CHILD_ITERS (filter))
915 filter_elt->iter = first_node;
917 g_sequence_append (new_level->seq, filter_elt);
920 /* Keep a reference on the first node of this level. We need this
921 * to make sure that we get all signals for this level.
923 f_iter.stamp = filter->priv->stamp;
924 f_iter.user_data = new_level;
925 f_iter.user_data2 = g_sequence_get (g_sequence_get_begin_iter (new_level->seq));
927 gtk_tree_model_filter_real_ref_node (GTK_TREE_MODEL (filter), &f_iter,
932 gtk_tree_model_filter_free_level (GtkTreeModelFilter *filter,
933 FilterLevel *filter_level,
935 gboolean unref_external)
937 GSequenceIter *siter;
938 GSequenceIter *end_siter;
940 g_assert (filter_level);
942 end_siter = g_sequence_get_end_iter (filter_level->seq);
943 for (siter = g_sequence_get_begin_iter (filter_level->seq);
945 siter = g_sequence_iter_next (siter))
947 FilterElt *elt = g_sequence_get (siter);
950 gtk_tree_model_filter_free_level (filter,
951 FILTER_LEVEL (elt->children),
952 unref, unref_external);
958 f_iter.stamp = filter->priv->stamp;
959 f_iter.user_data = filter_level;
960 f_iter.user_data2 = elt;
962 while (elt->ext_ref_count > 0)
963 gtk_tree_model_filter_real_unref_node (GTK_TREE_MODEL (filter),
969 /* Release the reference on the first item.
975 f_iter.stamp = filter->priv->stamp;
976 f_iter.user_data = filter_level;
977 f_iter.user_data2 = g_sequence_get (g_sequence_get_begin_iter (filter_level->seq));
979 gtk_tree_model_filter_real_unref_node (GTK_TREE_MODEL (filter),
980 &f_iter, FALSE, TRUE);
983 if (filter_level->ext_ref_count == 0)
985 FilterLevel *parent_level = filter_level->parent_level;
986 FilterElt *parent_elt = filter_level->parent_elt;
990 parent_elt->zero_ref_count--;
992 parent_elt = parent_level->parent_elt;
993 parent_level = parent_level->parent_level;
996 if (filter_level != filter->priv->root)
997 filter->priv->zero_ref_count--;
1000 if (filter_level->parent_elt)
1002 /* Release reference on parent */
1005 GtkTreeIter parent_iter;
1007 parent_iter.stamp = filter->priv->stamp;
1008 parent_iter.user_data = filter_level->parent_level;
1009 parent_iter.user_data2 = filter_level->parent_elt;
1011 gtk_tree_model_filter_real_unref_node (GTK_TREE_MODEL (filter),
1012 &parent_iter, FALSE, TRUE);
1015 filter_level->parent_elt->children = NULL;
1018 filter->priv->root = NULL;
1020 g_sequence_free (filter_level->seq);
1021 g_sequence_free (filter_level->visible_seq);
1022 g_free (filter_level);
1025 /* prune_level() is like free_level(), however instead of being fully
1026 * freed, the level is pruned to a level with only the first node used
1027 * for monitoring. For now it is only being called from
1028 * gtk_tree_model_filter_remove_elt_from_level(), which is the reason
1029 * this function is lacking a "gboolean unref" argument.
1032 gtk_tree_model_filter_prune_level (GtkTreeModelFilter *filter,
1035 GSequenceIter *siter;
1036 GSequenceIter *end_siter;
1040 /* This function is called when the parent of level became invisible.
1041 * All external ref counts of the children need to be dropped.
1042 * All children except the first one can be removed.
1045 /* Any child levels can be freed */
1046 end_siter = g_sequence_get_end_iter (level->seq);
1047 for (siter = g_sequence_get_begin_iter (level->seq);
1049 siter = g_sequence_iter_next (siter))
1051 FilterElt *elt = g_sequence_get (siter);
1054 gtk_tree_model_filter_free_level (filter,
1055 FILTER_LEVEL (elt->children), TRUE,
1059 /* For the first item, only drop the external references */
1060 elt = g_sequence_get (g_sequence_get_begin_iter (level->seq));
1062 f_iter.stamp = filter->priv->stamp;
1063 f_iter.user_data = level;
1064 f_iter.user_data2 = elt;
1066 while (elt->ext_ref_count > 0)
1067 gtk_tree_model_filter_real_unref_node (GTK_TREE_MODEL (filter),
1068 &f_iter, TRUE, TRUE);
1070 if (elt->visible_siter)
1072 g_sequence_remove (elt->visible_siter);
1073 elt->visible_siter = NULL;
1076 /* Remove the other elts */
1077 end_siter = g_sequence_get_end_iter (level->seq);
1078 siter = g_sequence_get_begin_iter (level->seq);
1079 siter = g_sequence_iter_next (siter);
1080 for (; siter != end_siter; siter = g_sequence_iter_next (siter))
1082 elt = g_sequence_get (siter);
1084 f_iter.stamp = filter->priv->stamp;
1085 f_iter.user_data = level;
1086 f_iter.user_data2 = elt;
1088 while (elt->ext_ref_count > 0)
1089 gtk_tree_model_filter_real_unref_node (GTK_TREE_MODEL (filter),
1090 &f_iter, TRUE, TRUE);
1091 /* In this case, we do remove reference counts we've added ourselves,
1092 * since the node will be removed from the data structures.
1094 while (elt->ref_count > 0)
1095 gtk_tree_model_filter_real_unref_node (GTK_TREE_MODEL (filter),
1096 &f_iter, FALSE, TRUE);
1098 if (elt->visible_siter)
1100 g_sequence_remove (elt->visible_siter);
1101 elt->visible_siter = NULL;
1105 /* Remove [begin + 1, end] */
1106 siter = g_sequence_get_begin_iter (level->seq);
1107 siter = g_sequence_iter_next (siter);
1109 g_sequence_remove_range (siter, end_siter);
1111 /* The level must have reached an ext ref count of zero by now, though
1112 * we only assert on this in debugging mode.
1114 #ifdef MODEL_FILTER_DEBUG
1115 g_assert (level->ext_ref_count == 0);
1120 gtk_tree_model_filter_level_transfer_first_ref (GtkTreeModelFilter *filter,
1122 GSequenceIter *from_iter,
1123 GSequenceIter *to_iter)
1127 f_iter.stamp = filter->priv->stamp;
1128 f_iter.user_data = level;
1129 f_iter.user_data2 = g_sequence_get (to_iter);
1131 gtk_tree_model_filter_real_ref_node (GTK_TREE_MODEL (filter),
1134 f_iter.stamp = filter->priv->stamp;
1135 f_iter.user_data = level;
1136 f_iter.user_data2 = g_sequence_get (from_iter);
1138 gtk_tree_model_filter_real_unref_node (GTK_TREE_MODEL (filter),
1139 &f_iter, FALSE, TRUE);
1143 gtk_tree_model_filter_level_transfer_first_ref_with_index (GtkTreeModelFilter *filter,
1148 gtk_tree_model_filter_level_transfer_first_ref (filter, level,
1149 g_sequence_get_iter_at_pos (level->seq, from_index),
1150 g_sequence_get_iter_at_pos (level->seq, to_index));
1153 /* Creates paths suitable for accessing the child model. */
1154 static GtkTreePath *
1155 gtk_tree_model_filter_elt_get_path (FilterLevel *level,
1159 FilterLevel *walker = level;
1160 FilterElt *walker2 = elt;
1162 GtkTreePath *real_path;
1164 g_return_val_if_fail (level != NULL, NULL);
1165 g_return_val_if_fail (elt != NULL, NULL);
1167 path = gtk_tree_path_new ();
1171 gtk_tree_path_prepend_index (path, walker2->offset);
1173 walker2 = walker->parent_elt;
1174 walker = walker->parent_level;
1179 real_path = gtk_tree_model_filter_add_root (path, root);
1180 gtk_tree_path_free (path);
1187 static GtkTreePath *
1188 gtk_tree_model_filter_add_root (GtkTreePath *src,
1191 GtkTreePath *retval;
1194 retval = gtk_tree_path_copy (root);
1196 for (i = 0; i < gtk_tree_path_get_depth (src); i++)
1197 gtk_tree_path_append_index (retval, gtk_tree_path_get_indices (src)[i]);
1202 static GtkTreePath *
1203 gtk_tree_model_filter_remove_root (GtkTreePath *src,
1206 GtkTreePath *retval;
1211 if (gtk_tree_path_get_depth (src) <= gtk_tree_path_get_depth (root))
1214 depth = gtk_tree_path_get_depth (src);
1215 indices = gtk_tree_path_get_indices (src);
1217 for (i = 0; i < gtk_tree_path_get_depth (root); i++)
1218 if (indices[i] != gtk_tree_path_get_indices (root)[i])
1221 retval = gtk_tree_path_new ();
1223 for (; i < depth; i++)
1224 gtk_tree_path_append_index (retval, indices[i]);
1230 gtk_tree_model_filter_increment_stamp (GtkTreeModelFilter *filter)
1234 filter->priv->stamp++;
1236 while (filter->priv->stamp == 0);
1238 gtk_tree_model_filter_clear_cache (filter);
1242 gtk_tree_model_filter_real_visible (GtkTreeModelFilter *filter,
1243 GtkTreeModel *child_model,
1244 GtkTreeIter *child_iter)
1246 if (filter->priv->visible_func)
1248 return filter->priv->visible_func (child_model,
1250 filter->priv->visible_data)
1253 else if (filter->priv->visible_column >= 0)
1257 gtk_tree_model_get_value (child_model, child_iter,
1258 filter->priv->visible_column, &val);
1260 if (g_value_get_boolean (&val))
1262 g_value_unset (&val);
1266 g_value_unset (&val);
1270 /* no visible function set, so always visible */
1275 gtk_tree_model_filter_visible (GtkTreeModelFilter *self,
1276 GtkTreeIter *child_iter)
1278 return GTK_TREE_MODEL_FILTER_GET_CLASS (self)->visible (self,
1279 self->priv->child_model, child_iter);
1283 gtk_tree_model_filter_clear_cache_helper_iter (gpointer data,
1286 GtkTreeModelFilter *filter = user_data;
1287 FilterElt *elt = data;
1289 #ifdef MODEL_FILTER_DEBUG
1290 g_assert (elt->zero_ref_count >= 0);
1293 if (elt->zero_ref_count > 0)
1294 gtk_tree_model_filter_clear_cache_helper (filter, elt->children);
1298 gtk_tree_model_filter_clear_cache_helper (GtkTreeModelFilter *filter,
1303 g_sequence_foreach (level->seq, gtk_tree_model_filter_clear_cache_helper_iter, filter);
1305 /* If the level's ext_ref_count is zero, it means the level is not visible
1306 * and can be removed. But, since we support monitoring a child level
1307 * of a parent for changes (these might affect the parent), we will only
1308 * free the level if the parent level also has an external ref
1309 * count of zero. In that case, changes concerning our parent are
1312 * The root level is always visible, so an exception holds for levels
1313 * with the root level as parent level: these have to remain cached.
1315 if (level->ext_ref_count == 0 && level != filter->priv->root &&
1316 level->parent_level && level->parent_level != filter->priv->root &&
1317 level->parent_level->ext_ref_count == 0)
1319 gtk_tree_model_filter_free_level (filter, level, TRUE, FALSE);
1325 gtk_tree_model_filter_elt_is_visible_in_target (FilterLevel *level,
1328 if (!elt->visible_siter)
1331 if (!level->parent_elt)
1336 elt = level->parent_elt;
1337 level = level->parent_level;
1339 if (elt && !elt->visible_siter)
1347 /* If a change has occurred in path (inserted, changed or deleted),
1348 * then this function is used to check all its ancestors. An ancestor
1349 * could have changed state as a result and this needs to be propagated
1350 * to the objects monitoring the filter model.
1353 gtk_tree_model_filter_check_ancestors (GtkTreeModelFilter *filter,
1357 int *indices = gtk_tree_path_get_indices (path);
1360 GtkTreeIter c_iter, tmp_iter;
1362 level = FILTER_LEVEL (filter->priv->root);
1367 if (filter->priv->virtual_root)
1368 gtk_tree_model_get_iter (filter->priv->child_model, &c_iter,
1369 filter->priv->virtual_root);
1372 gtk_tree_model_iter_nth_child (filter->priv->child_model, &c_iter,
1373 filter->priv->virtual_root ? &tmp_iter : NULL,
1376 while (i < gtk_tree_path_get_depth (path) - 1)
1378 gboolean requested_state;
1380 elt = lookup_elt_with_offset (level->seq,
1381 gtk_tree_path_get_indices (path)[i], NULL);
1383 requested_state = gtk_tree_model_filter_visible (filter, &c_iter);
1388 GtkTreePath *c_path;
1390 if (requested_state == FALSE)
1393 /* The elt does not exist in this level (so it is not
1394 * visible), but should now be visible. We emit the
1395 * row-inserted and row-has-child-toggled signals.
1397 elt = gtk_tree_model_filter_insert_elt_in_level (filter,
1403 /* insert_elt_in_level defaults to FALSE */
1404 elt->visible_siter = g_sequence_insert_sorted (level->visible_seq,
1406 filter_elt_cmp, NULL);
1408 c_path = gtk_tree_model_get_path (filter->priv->child_model,
1411 gtk_tree_model_filter_emit_row_inserted_for_path (filter,
1412 filter->priv->child_model,
1416 gtk_tree_path_free (c_path);
1418 /* We can immediately return, because this node was not visible
1419 * before and its children will be checked for in response to
1420 * the emitted row-has-child-toggled signal.
1424 else if (elt->visible_siter)
1426 if (!requested_state)
1428 /* A node has turned invisible. Remove it from the level
1429 * and emit row-deleted. Since this node is being
1430 * deleted. it makes no sense to look further up the
1433 gtk_tree_model_filter_remove_elt_from_level (filter,
1438 /* Otherwise continue up the chain */
1440 else if (!elt->visible_siter)
1442 if (requested_state)
1444 /* A node is already in the cache, but invisible. This
1445 * is usually a node on which a reference is kept by
1446 * the filter model, or a node fetched on the filter's
1447 * request, and thus not shown. Therefore, we will
1448 * not emit row-inserted for this node. Instead,
1449 * we signal to its parent that a change has occurred.
1451 * Exception: root level, in this case, we must emit
1454 if (level->parent_level)
1457 GtkTreePath *f_path;
1459 elt->visible_siter = g_sequence_insert_sorted (level->visible_seq, elt,
1460 filter_elt_cmp, NULL);
1462 f_iter.stamp = filter->priv->stamp;
1463 f_iter.user_data = level->parent_level;
1464 f_iter.user_data2 = level->parent_elt;
1466 f_path = gtk_tree_model_get_path (GTK_TREE_MODEL (filter),
1468 gtk_tree_model_row_has_child_toggled (GTK_TREE_MODEL (filter),
1470 gtk_tree_path_free (f_path);
1474 GtkTreePath *c_path;
1476 elt->visible_siter = g_sequence_insert_sorted (level->visible_seq, elt,
1477 filter_elt_cmp, NULL);
1479 c_path = gtk_tree_model_get_path (filter->priv->child_model,
1482 gtk_tree_model_filter_emit_row_inserted_for_path (filter,
1483 filter->priv->child_model,
1487 gtk_tree_path_free (c_path);
1490 /* We can immediately return, because this node was not visible
1491 * before and the parent will check its children, including
1492 * this node, in response to the emitted row-has-child-toggled
1498 /* Not visible, so no need to continue. */
1504 /* If an elt does not have children, these are not visible.
1505 * Therefore, any signals emitted for these children will
1506 * be ignored, so we do not have to emit them.
1511 level = elt->children;
1515 gtk_tree_model_iter_nth_child (filter->priv->child_model, &c_iter,
1516 &tmp_iter, indices[i]);
1521 gtk_tree_model_filter_insert_elt_in_level (GtkTreeModelFilter *filter,
1522 GtkTreeIter *c_iter,
1528 GSequenceIter *siter;
1530 elt = filter_elt_new ();
1532 if (GTK_TREE_MODEL_FILTER_CACHE_CHILD_ITERS (filter))
1533 elt->iter = *c_iter;
1535 elt->offset = offset;
1536 elt->zero_ref_count = 0;
1538 elt->ext_ref_count = 0;
1539 elt->children = NULL;
1541 /* Because we don't emit row_inserted, the node is invisible and thus
1542 * not inserted in visible_seq
1544 elt->visible_siter = NULL;
1546 siter = g_sequence_insert_sorted (level->seq, elt, filter_elt_cmp, NULL);
1547 *index = g_sequence_iter_get_position (siter);
1549 /* If the insert location is zero, we need to move our reference
1550 * on the old first node to the new first node.
1553 gtk_tree_model_filter_level_transfer_first_ref_with_index (filter, level,
1560 gtk_tree_model_filter_fetch_child (GtkTreeModelFilter *filter,
1566 GtkTreePath *c_path = NULL;
1568 GtkTreePath *c_parent_path = NULL;
1569 GtkTreeIter c_parent_iter;
1571 /* check if child exists and is visible */
1572 if (level->parent_elt)
1575 gtk_tree_model_filter_elt_get_path (level->parent_level,
1577 filter->priv->virtual_root);
1583 if (filter->priv->virtual_root)
1584 c_parent_path = gtk_tree_path_copy (filter->priv->virtual_root);
1586 c_parent_path = NULL;
1591 gtk_tree_model_get_iter (filter->priv->child_model,
1594 len = gtk_tree_model_iter_n_children (filter->priv->child_model,
1597 c_path = gtk_tree_path_copy (c_parent_path);
1598 gtk_tree_path_free (c_parent_path);
1602 len = gtk_tree_model_iter_n_children (filter->priv->child_model, NULL);
1603 c_path = gtk_tree_path_new ();
1606 gtk_tree_path_append_index (c_path, offset);
1607 gtk_tree_model_get_iter (filter->priv->child_model, &c_iter, c_path);
1608 gtk_tree_path_free (c_path);
1610 if (offset >= len || !gtk_tree_model_filter_visible (filter, &c_iter))
1613 return gtk_tree_model_filter_insert_elt_in_level (filter, &c_iter,
1618 /* Note that this function is never called from the row-deleted handler.
1619 * This means that this function is only used for removing elements
1620 * which are still present in the child model. As a result, we must
1621 * take care to properly release the references the filter model has
1622 * on the child model nodes.
1625 gtk_tree_model_filter_remove_elt_from_level (GtkTreeModelFilter *filter,
1630 FilterLevel *parent_level;
1631 gint length, orig_level_ext_ref_count;
1633 GtkTreePath *path = NULL;
1635 gboolean emit_child_toggled = FALSE;
1637 /* We need to know about the level's ext ref count before removal
1640 orig_level_ext_ref_count = level->ext_ref_count;
1642 iter.stamp = filter->priv->stamp;
1643 iter.user_data = level;
1644 iter.user_data2 = elt;
1646 if (orig_level_ext_ref_count > 0)
1647 path = gtk_tree_model_get_path (GTK_TREE_MODEL (filter), &iter);
1649 /* If the level is not visible, the parent is potentially invisible
1650 * too. Either way, as no signal will be emitted, there is no use
1655 parent = level->parent_elt;
1656 parent_level = level->parent_level;
1658 length = g_sequence_get_length (level->seq);
1660 /* first register the node to be invisible */
1661 g_sequence_remove (elt->visible_siter);
1662 elt->visible_siter = NULL;
1665 * If level != root level and the number of visible nodes is 0 (ie. this
1666 * is the last node to be removed from the level), emit
1667 * row-has-child-toggled.
1670 if (level != filter->priv->root
1671 && g_sequence_get_length (level->visible_seq) == 0
1673 && parent->visible_siter)
1674 emit_child_toggled = TRUE;
1677 * - length > 1: in this case, the node is removed from the level
1678 * and row-deleted is emitted.
1679 * - length == 1: in this case, we need to decide whether to keep
1680 * the level or to free it.
1684 GSequenceIter *siter;
1686 /* We emit row-deleted, and remove the node from the cache.
1687 * If it has any children, these will be removed here as well.
1690 /* FIXME: I am not 100% sure it is always save to fully free the
1691 * level here. Perhaps the state of the parent level, etc. has to
1692 * be checked to make the right decision, like is done below for
1693 * the case length == 1.
1696 gtk_tree_model_filter_free_level (filter, elt->children, TRUE, TRUE);
1698 /* If the first node is being removed, transfer, the reference */
1699 if (elt == g_sequence_get (g_sequence_get_begin_iter (level->seq)))
1701 gtk_tree_model_filter_level_transfer_first_ref_with_index (filter, level,
1705 while (elt->ext_ref_count > 0)
1706 gtk_tree_model_filter_real_unref_node (GTK_TREE_MODEL (filter),
1708 /* In this case, we do remove reference counts we've added ourselves,
1709 * since the node will be removed from the data structures.
1711 while (elt->ref_count > 0)
1712 gtk_tree_model_filter_real_unref_node (GTK_TREE_MODEL (filter),
1713 &iter, FALSE, TRUE);
1715 /* remove the node */
1716 lookup_elt_with_offset (level->seq, elt->offset, &siter);
1717 g_sequence_remove (siter);
1719 gtk_tree_model_filter_increment_stamp (filter);
1721 /* Only if the node is in the root level (parent == NULL) or
1722 * the level is visible, a row-deleted signal is necessary.
1724 if (!parent || orig_level_ext_ref_count > 0)
1725 gtk_tree_model_row_deleted (GTK_TREE_MODEL (filter), path);
1729 /* There is only one node left in this level */
1730 #ifdef MODEL_FILTER_DEBUG
1731 g_assert (length == 1);
1734 /* The row is signalled as deleted to the client. We have to
1735 * drop the remaining external reference count here, the client
1738 * We keep the reference counts we've obtained ourselves.
1740 while (elt->ext_ref_count > 0)
1741 gtk_tree_model_filter_real_unref_node (GTK_TREE_MODEL (filter),
1744 /* This level is still required if:
1745 * - it is the root level
1746 * - its parent level is the root level
1747 * - its parent level has an external ref count > 0
1749 if (! (level == filter->priv->root ||
1750 level->parent_level == filter->priv->root ||
1751 level->parent_level->ext_ref_count > 0))
1753 /* Otherwise, the level can be removed */
1754 gtk_tree_model_filter_free_level (filter, level, TRUE, TRUE);
1758 /* Level is kept, but we turn our attention to a child level.
1760 * If level is not the root level, it is a child level with
1761 * an ext ref count that is now 0. That means that any child level
1762 * of elt can be removed.
1764 if (level != filter->priv->root)
1766 #ifdef MODEL_FILTER_DEBUG
1767 g_assert (level->ext_ref_count == 0);
1770 gtk_tree_model_filter_free_level (filter, elt->children,
1775 /* In this case, we want to keep the level with the first
1776 * node pulled in to monitor for signals.
1779 gtk_tree_model_filter_prune_level (filter, elt->children);
1783 if (!parent || orig_level_ext_ref_count > 0)
1784 gtk_tree_model_row_deleted (GTK_TREE_MODEL (filter), path);
1787 gtk_tree_path_free (path);
1789 if (emit_child_toggled && parent->ext_ref_count > 0)
1794 piter.stamp = filter->priv->stamp;
1795 piter.user_data = parent_level;
1796 piter.user_data2 = parent;
1798 ppath = gtk_tree_model_get_path (GTK_TREE_MODEL (filter), &piter);
1800 gtk_tree_model_row_has_child_toggled (GTK_TREE_MODEL (filter),
1802 gtk_tree_path_free (ppath);
1806 /* This function is called after the given node has become visible.
1807 * When the node has children, we should build the level and
1808 * take a reference on the first child.
1811 gtk_tree_model_filter_update_children (GtkTreeModelFilter *filter,
1818 if (!elt->visible_siter)
1821 iter.stamp = filter->priv->stamp;
1822 iter.user_data = level;
1823 iter.user_data2 = elt;
1825 gtk_tree_model_filter_convert_iter_to_child_iter (filter, &c_iter, &iter);
1827 if ((!level->parent_level || level->parent_level->ext_ref_count > 0) &&
1828 gtk_tree_model_iter_has_child (filter->priv->child_model, &c_iter))
1831 gtk_tree_model_filter_build_level (filter, level, elt, FALSE);
1833 if (elt->ext_ref_count > 0 && elt->children &&
1834 g_sequence_get_length (elt->children->seq))
1837 path = gtk_tree_model_get_path (GTK_TREE_MODEL (filter), &iter);
1838 gtk_tree_model_row_has_child_toggled (GTK_TREE_MODEL (filter),
1842 gtk_tree_path_free (path);
1847 /* Path is relative to the child model (this is on search on elt offset)
1848 * but with the virtual root already removed if necesssary.
1851 find_elt_with_offset (GtkTreeModelFilter *filter,
1853 FilterLevel **level_,
1858 FilterLevel *parent_level = NULL;
1859 FilterElt *elt = NULL;
1861 level = FILTER_LEVEL (filter->priv->root);
1863 while (i < gtk_tree_path_get_depth (path))
1868 elt = lookup_elt_with_offset (level->seq,
1869 gtk_tree_path_get_indices (path)[i],
1875 parent_level = level;
1876 level = elt->children;
1881 *level_ = parent_level;
1889 /* TreeModel signals */
1891 gtk_tree_model_filter_emit_row_inserted_for_path (GtkTreeModelFilter *filter,
1892 GtkTreeModel *c_model,
1893 GtkTreePath *c_path,
1894 GtkTreeIter *c_iter)
1899 GtkTreeIter iter, children;
1900 gboolean signals_emitted = FALSE;
1902 if (!filter->priv->root)
1904 /* The root level has not been exposed to the view yet, so we
1905 * need to emit signals for any node that is being inserted.
1907 gtk_tree_model_filter_build_level (filter, NULL, NULL, TRUE);
1909 /* Check if the root level was built. Then child levels
1910 * that matter have also been built (due to update_children,
1911 * which triggers iter_n_children).
1913 if (filter->priv->root &&
1914 g_sequence_get_length (FILTER_LEVEL (filter->priv->root)->visible_seq) > 0)
1915 signals_emitted = TRUE;
1918 gtk_tree_model_filter_increment_stamp (filter);
1920 /* We need to disallow to build new levels, because we are then pulling
1921 * in a child in an invisible level. We only want to find path if it
1922 * is in a visible level (and thus has a parent that is visible).
1924 path = gtk_real_tree_model_filter_convert_child_path_to_path (filter,
1930 /* parent is probably being filtered out */
1933 gtk_tree_model_filter_get_iter_full (GTK_TREE_MODEL (filter), &iter, path);
1935 level = FILTER_LEVEL (iter.user_data);
1936 elt = FILTER_ELT (iter.user_data2);
1938 /* Make sure elt is visible. elt can already be visible in case
1939 * it was pulled in above, so avoid inserted it into visible_seq twice.
1941 if (!elt->visible_siter)
1943 elt->visible_siter = g_sequence_insert_sorted (level->visible_seq,
1944 elt, filter_elt_cmp,
1948 /* Check whether the node and all of its parents are visible */
1949 if (gtk_tree_model_filter_elt_is_visible_in_target (level, elt))
1951 /* visibility changed -- reget path */
1952 gtk_tree_path_free (path);
1953 path = gtk_tree_model_get_path (GTK_TREE_MODEL (filter), &iter);
1955 if (!signals_emitted &&
1956 (!level->parent_level || level->ext_ref_count > 0))
1957 gtk_tree_model_row_inserted (GTK_TREE_MODEL (filter), path, &iter);
1959 if (level->parent_level && level->parent_elt->ext_ref_count > 0 &&
1960 g_sequence_get_length (level->visible_seq) == 1)
1962 /* We know that this is the first visible node in this level, so
1963 * we need to emit row-has-child-toggled on the parent. This
1964 * does not apply to the root level.
1967 gtk_tree_path_up (path);
1968 gtk_tree_model_get_iter (GTK_TREE_MODEL (filter), &iter, path);
1970 gtk_tree_model_row_has_child_toggled (GTK_TREE_MODEL (filter),
1975 if (!signals_emitted
1976 && gtk_tree_model_iter_children (c_model, &children, c_iter))
1977 gtk_tree_model_filter_update_children (filter, level, elt);
1980 gtk_tree_path_free (path);
1984 gtk_tree_model_filter_row_changed (GtkTreeModel *c_model,
1985 GtkTreePath *c_path,
1986 GtkTreeIter *c_iter,
1989 GtkTreeModelFilter *filter = GTK_TREE_MODEL_FILTER (data);
1991 GtkTreeIter children;
1992 GtkTreeIter real_c_iter;
1993 GtkTreePath *path = NULL;
1994 GtkTreePath *real_path = NULL;
1999 gboolean requested_state;
2000 gboolean current_state;
2001 gboolean free_c_path = FALSE;
2003 g_return_if_fail (c_path != NULL || c_iter != NULL);
2007 c_path = gtk_tree_model_get_path (c_model, c_iter);
2011 if (filter->priv->virtual_root)
2012 real_path = gtk_tree_model_filter_remove_root (c_path,
2013 filter->priv->virtual_root);
2015 real_path = gtk_tree_path_copy (c_path);
2018 real_c_iter = *c_iter;
2020 gtk_tree_model_get_iter (c_model, &real_c_iter, c_path);
2022 /* is this node above the virtual root? */
2023 if (filter->priv->virtual_root &&
2024 (gtk_tree_path_get_depth (filter->priv->virtual_root)
2025 >= gtk_tree_path_get_depth (c_path)))
2028 /* what's the requested state? */
2029 requested_state = gtk_tree_model_filter_visible (filter, &real_c_iter);
2031 /* now, let's see whether the item is there */
2032 path = gtk_real_tree_model_filter_convert_child_path_to_path (filter,
2039 gtk_tree_model_filter_get_iter_full (GTK_TREE_MODEL (filter),
2041 current_state = FILTER_ELT (iter.user_data2)->visible_siter != NULL;
2044 current_state = FALSE;
2046 if (current_state == FALSE && requested_state == FALSE)
2047 /* no changes required */
2050 if (current_state == TRUE && requested_state == FALSE)
2052 gtk_tree_model_filter_remove_elt_from_level (filter,
2053 FILTER_LEVEL (iter.user_data),
2054 FILTER_ELT (iter.user_data2));
2057 gtk_tree_model_filter_check_ancestors (filter, real_path);
2062 if (current_state == TRUE && requested_state == TRUE)
2064 /* propagate the signal; also get a path taking only visible
2065 * nodes into account.
2067 gtk_tree_path_free (path);
2068 path = gtk_tree_model_get_path (GTK_TREE_MODEL (filter), &iter);
2070 level = FILTER_LEVEL (iter.user_data);
2071 elt = FILTER_ELT (iter.user_data2);
2073 if (gtk_tree_model_filter_elt_is_visible_in_target (level, elt))
2075 if (level->ext_ref_count > 0)
2076 gtk_tree_model_row_changed (GTK_TREE_MODEL (filter), path, &iter);
2078 /* and update the children */
2079 if (gtk_tree_model_iter_children (c_model, &children, &real_c_iter))
2080 gtk_tree_model_filter_update_children (filter, level, elt);
2084 gtk_tree_model_filter_check_ancestors (filter, real_path);
2089 /* only current == FALSE and requested == TRUE is left,
2092 g_return_if_fail (current_state == FALSE && requested_state == TRUE);
2095 gtk_tree_model_filter_check_ancestors (filter, real_path);
2097 gtk_tree_model_filter_emit_row_inserted_for_path (filter, c_model,
2102 gtk_tree_path_free (path);
2105 gtk_tree_path_free (real_path);
2108 gtk_tree_path_free (c_path);
2112 gtk_tree_model_filter_row_inserted (GtkTreeModel *c_model,
2113 GtkTreePath *c_path,
2114 GtkTreeIter *c_iter,
2117 GtkTreeModelFilter *filter = GTK_TREE_MODEL_FILTER (data);
2118 GtkTreePath *real_path = NULL;
2120 GtkTreeIter real_c_iter;
2122 FilterElt *elt = NULL;
2123 FilterLevel *level = NULL;
2124 FilterLevel *parent_level = NULL;
2125 GSequenceIter *siter;
2130 gboolean free_c_path = FALSE;
2131 gboolean emit_row_inserted = FALSE;
2133 g_return_if_fail (c_path != NULL || c_iter != NULL);
2137 c_path = gtk_tree_model_get_path (c_model, c_iter);
2142 real_c_iter = *c_iter;
2144 gtk_tree_model_get_iter (c_model, &real_c_iter, c_path);
2146 /* the row has already been inserted. so we need to fixup the
2147 * virtual root here first
2149 if (filter->priv->virtual_root)
2151 if (gtk_tree_path_get_depth (filter->priv->virtual_root) >=
2152 gtk_tree_path_get_depth (c_path))
2155 gint *v_indices, *c_indices;
2156 gboolean common_prefix = TRUE;
2158 level = gtk_tree_path_get_depth (c_path) - 1;
2159 v_indices = gtk_tree_path_get_indices (filter->priv->virtual_root);
2160 c_indices = gtk_tree_path_get_indices (c_path);
2162 for (i = 0; i < level; i++)
2163 if (v_indices[i] != c_indices[i])
2165 common_prefix = FALSE;
2169 if (common_prefix && v_indices[level] >= c_indices[level])
2170 (v_indices[level])++;
2174 /* subtract virtual root if necessary */
2175 if (filter->priv->virtual_root)
2177 real_path = gtk_tree_model_filter_remove_root (c_path,
2178 filter->priv->virtual_root);
2184 real_path = gtk_tree_path_copy (c_path);
2186 if (!filter->priv->root)
2188 /* The root level has not been exposed to the view yet, so we
2189 * need to emit signals for any node that is being inserted.
2191 gtk_tree_model_filter_build_level (filter, NULL, NULL, TRUE);
2193 /* Check if the root level was built. Then child levels
2194 * that matter have also been built (due to update_children,
2195 * which triggers iter_n_children).
2197 if (filter->priv->root)
2199 emit_row_inserted = FALSE;
2204 if (gtk_tree_path_get_depth (real_path) - 1 >= 1)
2206 gboolean found = FALSE;
2207 GtkTreePath *parent = gtk_tree_path_copy (real_path);
2208 gtk_tree_path_up (parent);
2210 found = find_elt_with_offset (filter, parent, &parent_level, &elt);
2212 gtk_tree_path_free (parent);
2215 /* Parent is not in the cache and probably being filtered out */
2218 level = elt->children;
2221 level = FILTER_LEVEL (filter->priv->root);
2225 if (elt && elt->visible_siter)
2227 /* The level in which the new node should be inserted does not
2228 * exist, but the parent, elt, does. If elt is visible, emit
2229 * row-has-child-toggled.
2231 GtkTreePath *tmppath;
2232 GtkTreeIter tmpiter;
2234 tmpiter.stamp = filter->priv->stamp;
2235 tmpiter.user_data = parent_level;
2236 tmpiter.user_data2 = elt;
2238 tmppath = gtk_tree_model_get_path (GTK_TREE_MODEL (filter),
2243 gtk_tree_model_row_has_child_toggled (GTK_TREE_MODEL (filter),
2245 gtk_tree_path_free (tmppath);
2251 /* let's try to insert the value */
2252 offset = gtk_tree_path_get_indices (real_path)[gtk_tree_path_get_depth (real_path) - 1];
2254 /* update the offsets, yes if we didn't insert the node above, there will
2255 * be a gap here. This will be filled with the node (via fetch_child) when
2256 * it becomes visible
2258 dummy.offset = offset;
2259 siter = g_sequence_search (level->seq, &dummy, filter_elt_cmp, NULL);
2260 siter = g_sequence_iter_prev (siter);
2261 g_sequence_foreach_range (siter, g_sequence_get_end_iter (level->seq),
2262 increase_offset_iter, GINT_TO_POINTER (offset));
2264 /* only insert when visible */
2265 if (gtk_tree_model_filter_visible (filter, &real_c_iter))
2269 felt = gtk_tree_model_filter_insert_elt_in_level (filter,
2274 /* insert_elt_in_level defaults to FALSE */
2275 felt->visible_siter = g_sequence_insert_sorted (level->visible_seq,
2277 filter_elt_cmp, NULL);
2278 emit_row_inserted = TRUE;
2282 gtk_tree_model_filter_check_ancestors (filter, real_path);
2284 if (emit_row_inserted)
2285 gtk_tree_model_filter_emit_row_inserted_for_path (filter, c_model,
2289 gtk_tree_path_free (real_path);
2292 gtk_tree_path_free (c_path);
2296 gtk_tree_model_filter_row_has_child_toggled (GtkTreeModel *c_model,
2297 GtkTreePath *c_path,
2298 GtkTreeIter *c_iter,
2301 GtkTreeModelFilter *filter = GTK_TREE_MODEL_FILTER (data);
2306 gboolean requested_state;
2308 g_return_if_fail (c_path != NULL && c_iter != NULL);
2310 /* If we get row-has-child-toggled on the virtual root, and there is
2311 * no root level; try to build it now.
2313 if (filter->priv->virtual_root && !filter->priv->root
2314 && !gtk_tree_path_compare (c_path, filter->priv->virtual_root))
2316 gtk_tree_model_filter_build_level (filter, NULL, NULL, TRUE);
2320 /* For all other levels, there is a chance that the visibility state
2321 * of the parent has changed now.
2324 path = gtk_real_tree_model_filter_convert_child_path_to_path (filter,
2331 gtk_tree_model_filter_get_iter_full (GTK_TREE_MODEL (data), &iter, path);
2333 level = FILTER_LEVEL (iter.user_data);
2334 elt = FILTER_ELT (iter.user_data2);
2336 gtk_tree_path_free (path);
2338 requested_state = gtk_tree_model_filter_visible (filter, c_iter);
2340 if (!elt->visible_siter && !requested_state)
2342 /* The parent node currently is not visible and will not become
2343 * visible, so we will not pass on the row-has-child-toggled event.
2347 else if (elt->visible_siter && !requested_state)
2349 /* The node is no longer visible, so it has to be removed.
2350 * _remove_elt_from_level() takes care of emitting row-has-child-toggled
2353 gtk_tree_model_filter_remove_elt_from_level (filter, level, elt);
2357 else if (!elt->visible_siter && requested_state)
2359 elt->visible_siter = g_sequence_insert_sorted (level->visible_seq,
2360 elt, filter_elt_cmp,
2363 /* Only insert if the parent is visible in the target */
2364 if (gtk_tree_model_filter_elt_is_visible_in_target (level, elt))
2366 path = gtk_tree_model_get_path (GTK_TREE_MODEL (filter), &iter);
2367 gtk_tree_model_row_inserted (GTK_TREE_MODEL (filter), path, &iter);
2368 gtk_tree_path_free (path);
2370 /* We do not update children now, because that will happen
2375 /* For the remaining possibility, elt->visible && requested_state
2376 * no action is required.
2379 /* If this node is referenced and has children, build the level so we
2380 * can monitor it for changes.
2382 if (elt->ref_count > 1 && !elt->children &&
2383 gtk_tree_model_iter_has_child (c_model, c_iter))
2384 gtk_tree_model_filter_build_level (filter, level, elt, FALSE);
2386 /* get a path taking only visible nodes into account */
2387 path = gtk_tree_model_get_path (GTK_TREE_MODEL (data), &iter);
2388 gtk_tree_model_row_has_child_toggled (GTK_TREE_MODEL (data), path, &iter);
2389 gtk_tree_path_free (path);
2393 gtk_tree_model_filter_virtual_root_deleted (GtkTreeModelFilter *filter,
2394 GtkTreePath *c_path)
2398 FilterLevel *level = FILTER_LEVEL (filter->priv->root);
2400 /* The virtual root (or one of its ancestors) has been deleted. This
2401 * means that all content for our model is now gone. We deal with
2402 * this by removing everything in the filter model: we just iterate
2403 * over the root level and emit a row-deleted for each FilterElt.
2404 * (FIXME: Should we emit row-deleted for child nodes as well? This
2405 * has never been fully clear in TreeModel).
2408 /* We unref the path of the virtual root, up to and not including the
2409 * deleted node which can no longer be unreffed.
2411 gtk_tree_model_filter_unref_path (filter, filter->priv->virtual_root,
2412 gtk_tree_path_get_depth (c_path) - 1);
2413 filter->priv->virtual_root_deleted = TRUE;
2418 nodes = g_sequence_get_length (level->visible_seq);
2420 /* We should not propagate the unref here. An unref for any of these
2421 * nodes will fail, since the respective nodes in the child model are
2424 gtk_tree_model_filter_free_level (filter, filter->priv->root, FALSE, FALSE);
2426 gtk_tree_model_filter_increment_stamp (filter);
2428 path = gtk_tree_path_new ();
2429 gtk_tree_path_append_index (path, 0);
2431 for (i = 0; i < nodes; i++)
2432 gtk_tree_model_row_deleted (GTK_TREE_MODEL (filter), path);
2434 gtk_tree_path_free (path);
2438 gtk_tree_model_filter_adjust_virtual_root (GtkTreeModelFilter *filter,
2439 GtkTreePath *c_path)
2443 gint *v_indices, *c_indices;
2444 gboolean common_prefix = TRUE;
2446 level = gtk_tree_path_get_depth (c_path) - 1;
2447 v_indices = gtk_tree_path_get_indices (filter->priv->virtual_root);
2448 c_indices = gtk_tree_path_get_indices (c_path);
2450 for (i = 0; i < level; i++)
2451 if (v_indices[i] != c_indices[i])
2453 common_prefix = FALSE;
2457 if (common_prefix && v_indices[level] > c_indices[level])
2458 (v_indices[level])--;
2462 gtk_tree_model_filter_row_deleted_invisible_node (GtkTreeModelFilter *filter,
2463 GtkTreePath *c_path)
2466 GtkTreePath *real_path;
2470 GSequenceIter *siter;
2472 /* The node deleted in the child model is not visible in the
2473 * filter model. We will not emit a signal, just fixup the offsets
2474 * of the other nodes.
2477 if (!filter->priv->root)
2480 level = FILTER_LEVEL (filter->priv->root);
2482 /* subtract vroot if necessary */
2483 if (filter->priv->virtual_root)
2485 real_path = gtk_tree_model_filter_remove_root (c_path,
2486 filter->priv->virtual_root);
2487 /* we don't handle this */
2492 real_path = gtk_tree_path_copy (c_path);
2494 if (gtk_tree_path_get_depth (real_path) - 1 >= 1)
2496 gboolean found = FALSE;
2497 GtkTreePath *parent = gtk_tree_path_copy (real_path);
2498 gtk_tree_path_up (parent);
2500 found = find_elt_with_offset (filter, parent, &level, &elt);
2502 gtk_tree_path_free (parent);
2506 /* parent is filtered out, so no level */
2507 gtk_tree_path_free (real_path);
2511 level = elt->children;
2514 offset = gtk_tree_path_get_indices (real_path)[gtk_tree_path_get_depth (real_path) - 1];
2515 gtk_tree_path_free (real_path);
2520 /* decrease offset of all nodes following the deleted node */
2521 dummy.offset = offset;
2522 siter = g_sequence_search (level->seq, &dummy, filter_elt_cmp, NULL);
2523 g_sequence_foreach_range (siter, g_sequence_get_end_iter (level->seq),
2524 decrease_offset_iter, GINT_TO_POINTER (offset));
2528 gtk_tree_model_filter_row_deleted (GtkTreeModel *c_model,
2529 GtkTreePath *c_path,
2532 GtkTreeModelFilter *filter = GTK_TREE_MODEL_FILTER (data);
2535 FilterElt *elt, *parent_elt = NULL;
2536 FilterLevel *level, *parent_level = NULL;
2537 GSequenceIter *siter;
2538 gboolean emit_child_toggled = FALSE;
2539 gboolean emit_row_deleted = FALSE;
2541 gint orig_level_ext_ref_count;
2543 g_return_if_fail (c_path != NULL);
2545 /* special case the deletion of an ancestor of the virtual root */
2546 if (filter->priv->virtual_root &&
2547 (gtk_tree_path_is_ancestor (c_path, filter->priv->virtual_root) ||
2548 !gtk_tree_path_compare (c_path, filter->priv->virtual_root)))
2550 gtk_tree_model_filter_virtual_root_deleted (filter, c_path);
2554 /* adjust the virtual root for the deleted row */
2555 if (filter->priv->virtual_root &&
2556 gtk_tree_path_get_depth (filter->priv->virtual_root) >=
2557 gtk_tree_path_get_depth (c_path))
2558 gtk_tree_model_filter_adjust_virtual_root (filter, c_path);
2560 path = gtk_real_tree_model_filter_convert_child_path_to_path (filter,
2567 gtk_tree_model_filter_row_deleted_invisible_node (filter, c_path);
2571 /* a node was deleted, which was in our cache */
2572 gtk_tree_model_filter_get_iter_full (GTK_TREE_MODEL (data), &iter, path);
2574 level = FILTER_LEVEL (iter.user_data);
2575 elt = FILTER_ELT (iter.user_data2);
2576 offset = elt->offset;
2577 orig_level_ext_ref_count = level->ext_ref_count;
2579 if (elt->visible_siter)
2581 /* get a path taking only visible nodes into account */
2582 gtk_tree_path_free (path);
2583 path = gtk_tree_model_get_path (GTK_TREE_MODEL (filter), &iter);
2585 if (g_sequence_get_length (level->visible_seq) == 1)
2587 emit_child_toggled = TRUE;
2588 parent_level = level->parent_level;
2589 parent_elt = level->parent_elt;
2592 emit_row_deleted = TRUE;
2595 /* Release the references on this node, without propagation because
2596 * the node does not exist anymore in the child model. The filter
2597 * model's references on the node in case of level->parent or use
2598 * of a virtual root are automatically destroyed by the child model.
2600 while (elt->ext_ref_count > 0)
2601 gtk_tree_model_filter_real_unref_node (GTK_TREE_MODEL (data), &iter,
2603 while (elt->ref_count > 0)
2604 gtk_tree_model_filter_real_unref_node (GTK_TREE_MODEL (data), &iter,
2607 if (g_sequence_get_length (level->seq) == 1)
2610 gtk_tree_model_filter_free_level (filter, level, FALSE, FALSE);
2617 lookup_elt_with_offset (level->seq, elt->offset, &siter);
2618 is_first = g_sequence_get_begin_iter (level->seq) == siter;
2620 /* remove the row */
2621 g_sequence_remove (elt->visible_siter);
2622 tmp = g_sequence_iter_next (siter);
2623 g_sequence_remove (siter);
2624 g_sequence_foreach_range (tmp, g_sequence_get_end_iter (level->seq),
2625 decrease_offset_iter, GINT_TO_POINTER (offset));
2627 /* Take a reference on the new first node. The first node previously
2628 * keeping this reference has been removed above.
2634 f_iter.stamp = filter->priv->stamp;
2635 f_iter.user_data = level;
2636 f_iter.user_data2 = g_sequence_get (g_sequence_get_begin_iter (level->seq));
2638 gtk_tree_model_filter_real_ref_node (GTK_TREE_MODEL (filter),
2643 if (emit_row_deleted)
2645 /* emit row_deleted */
2646 gtk_tree_model_filter_increment_stamp (filter);
2648 if (!parent_elt || orig_level_ext_ref_count > 0)
2649 gtk_tree_model_row_deleted (GTK_TREE_MODEL (data), path);
2652 if (emit_child_toggled && parent_level)
2657 iter2.stamp = filter->priv->stamp;
2658 iter2.user_data = parent_level;
2659 iter2.user_data2 = parent_elt;
2661 /* We set in_row_deleted to TRUE to avoid a level build triggered
2662 * by row-has-child-toggled (parent model could call iter_has_child
2665 filter->priv->in_row_deleted = TRUE;
2666 path2 = gtk_tree_model_get_path (GTK_TREE_MODEL (filter), &iter2);
2667 gtk_tree_model_row_has_child_toggled (GTK_TREE_MODEL (filter),
2669 gtk_tree_path_free (path2);
2670 filter->priv->in_row_deleted = FALSE;
2673 if (filter->priv->virtual_root)
2675 GtkTreePath *real_path;
2677 real_path = gtk_tree_model_filter_remove_root (c_path,
2678 filter->priv->root);
2681 gtk_tree_model_filter_check_ancestors (filter, real_path);
2682 gtk_tree_path_free (real_path);
2686 gtk_tree_model_filter_check_ancestors (filter, c_path);
2688 gtk_tree_path_free (path);
2692 gtk_tree_model_filter_rows_reordered (GtkTreeModel *c_model,
2693 GtkTreePath *c_path,
2694 GtkTreeIter *c_iter,
2700 GtkTreeModelFilter *filter = GTK_TREE_MODEL_FILTER (data);
2706 GSequenceIter *tmp_end_iter;
2707 GSequenceIter *old_first_siter = NULL;
2712 g_return_if_fail (new_order != NULL);
2714 if (c_path == NULL || gtk_tree_path_get_depth (c_path) == 0)
2716 length = gtk_tree_model_iter_n_children (c_model, NULL);
2718 if (filter->priv->virtual_root)
2722 /* reorder root level of path */
2723 for (i = 0; i < length; i++)
2724 if (new_order[i] == gtk_tree_path_get_indices (filter->priv->virtual_root)[0])
2730 gtk_tree_path_get_indices (filter->priv->virtual_root)[0] = new_pos;
2734 path = gtk_tree_path_new ();
2735 level = FILTER_LEVEL (filter->priv->root);
2739 GtkTreeIter child_iter;
2741 /* virtual root anchor reordering */
2742 if (filter->priv->virtual_root &&
2743 gtk_tree_path_is_ancestor (c_path, filter->priv->virtual_root))
2748 GtkTreeIter real_c_iter;
2750 level = gtk_tree_path_get_depth (c_path);
2753 real_c_iter = *c_iter;
2755 gtk_tree_model_get_iter (c_model, &real_c_iter, c_path);
2757 length = gtk_tree_model_iter_n_children (c_model, &real_c_iter);
2759 for (i = 0; i < length; i++)
2760 if (new_order[i] == gtk_tree_path_get_indices (filter->priv->virtual_root)[level])
2766 gtk_tree_path_get_indices (filter->priv->virtual_root)[level] = new_pos;
2770 path = gtk_real_tree_model_filter_convert_child_path_to_path (filter,
2775 if (!path && filter->priv->virtual_root &&
2776 gtk_tree_path_compare (c_path, filter->priv->virtual_root))
2779 if (!path && !filter->priv->virtual_root)
2784 /* root level mode */
2786 gtk_tree_model_get_iter (c_model, c_iter, c_path);
2787 length = gtk_tree_model_iter_n_children (c_model, c_iter);
2788 path = gtk_tree_path_new ();
2789 level = FILTER_LEVEL (filter->priv->root);
2793 gtk_tree_model_filter_get_iter_full (GTK_TREE_MODEL (data),
2796 elt = FILTER_ELT (iter.user_data2);
2800 gtk_tree_path_free (path);
2804 level = elt->children;
2806 gtk_tree_model_filter_convert_iter_to_child_iter (GTK_TREE_MODEL_FILTER (filter), &child_iter, &iter);
2807 length = gtk_tree_model_iter_n_children (c_model, &child_iter);
2811 if (!level || g_sequence_get_length (level->seq) < 1)
2813 gtk_tree_path_free (path);
2817 /* NOTE: we do not bail out here if level->seq->len < 2 like
2818 * GtkTreeModelSort does. This because we do some special tricky
2822 tmp_seq = g_sequence_new (filter_elt_free);
2823 tmp_end_iter = g_sequence_get_end_iter (tmp_seq);
2824 tmp_array = g_new (gint, g_sequence_get_length (level->visible_seq));
2827 old_first_siter = g_sequence_get_iter_at_pos (level->seq, 0);
2829 for (i = 0; i < length; i++)
2832 GSequenceIter *siter;
2834 elt = lookup_elt_with_offset (level->seq, new_order[i], &siter);
2838 /* Only for visible items an entry should be present in the order array
2841 if (elt->visible_siter)
2842 tmp_array[elt_count++] = g_sequence_iter_get_position (elt->visible_siter);
2844 /* Steal elt from level->seq and append it to tmp_seq */
2845 g_sequence_move (siter, tmp_end_iter);
2849 g_warn_if_fail (g_sequence_get_length (level->seq) == 0);
2850 g_sequence_free (level->seq);
2851 level->seq = tmp_seq;
2852 g_sequence_sort (level->visible_seq, filter_elt_cmp, NULL);
2854 /* Transfer the reference from the old item at position 0 to the
2855 * new item at position 0, unless the old item at position 0 is also
2856 * at position 0 in the new sequence.
2858 if (g_sequence_iter_get_position (old_first_siter) != 0)
2859 gtk_tree_model_filter_level_transfer_first_ref (filter,
2862 g_sequence_get_iter_at_pos (level->seq, 0));
2864 /* emit rows_reordered */
2865 if (g_sequence_get_length (level->visible_seq) > 0)
2867 if (!gtk_tree_path_get_indices (path))
2868 gtk_tree_model_rows_reordered (GTK_TREE_MODEL (data), path, NULL,
2872 /* get a path taking only visible nodes into account */
2873 gtk_tree_path_free (path);
2874 path = gtk_tree_model_get_path (GTK_TREE_MODEL (data), &iter);
2876 gtk_tree_model_rows_reordered (GTK_TREE_MODEL (data), path, &iter,
2883 gtk_tree_path_free (path);
2886 /* TreeModelIface implementation */
2887 static GtkTreeModelFlags
2888 gtk_tree_model_filter_get_flags (GtkTreeModel *model)
2890 GtkTreeModelFlags flags;
2892 g_return_val_if_fail (GTK_IS_TREE_MODEL_FILTER (model), 0);
2893 g_return_val_if_fail (GTK_TREE_MODEL_FILTER (model)->priv->child_model != NULL, 0);
2895 flags = gtk_tree_model_get_flags (GTK_TREE_MODEL_FILTER (model)->priv->child_model);
2897 if ((flags & GTK_TREE_MODEL_LIST_ONLY) == GTK_TREE_MODEL_LIST_ONLY)
2898 return GTK_TREE_MODEL_LIST_ONLY;
2904 gtk_tree_model_filter_get_n_columns (GtkTreeModel *model)
2906 GtkTreeModelFilter *filter = (GtkTreeModelFilter *)model;
2908 g_return_val_if_fail (GTK_IS_TREE_MODEL_FILTER (model), 0);
2909 g_return_val_if_fail (filter->priv->child_model != NULL, 0);
2911 if (filter->priv->child_model == NULL)
2914 /* so we can't modify the modify func after this ... */
2915 filter->priv->modify_func_set = TRUE;
2917 if (filter->priv->modify_n_columns > 0)
2918 return filter->priv->modify_n_columns;
2920 return gtk_tree_model_get_n_columns (filter->priv->child_model);
2924 gtk_tree_model_filter_get_column_type (GtkTreeModel *model,
2927 GtkTreeModelFilter *filter = (GtkTreeModelFilter *)model;
2929 g_return_val_if_fail (GTK_IS_TREE_MODEL_FILTER (model), G_TYPE_INVALID);
2930 g_return_val_if_fail (filter->priv->child_model != NULL, G_TYPE_INVALID);
2932 /* so we can't modify the modify func after this ... */
2933 filter->priv->modify_func_set = TRUE;
2935 if (filter->priv->modify_types)
2937 g_return_val_if_fail (index < filter->priv->modify_n_columns, G_TYPE_INVALID);
2939 return filter->priv->modify_types[index];
2942 return gtk_tree_model_get_column_type (filter->priv->child_model, index);
2945 /* A special case of _get_iter; this function can also get iters which
2946 * are not visible. These iters should ONLY be passed internally, never
2947 * pass those along with a signal emission.
2950 gtk_tree_model_filter_get_iter_full (GtkTreeModel *model,
2954 GtkTreeModelFilter *filter = (GtkTreeModelFilter *)model;
2959 GSequenceIter *siter;
2961 g_return_val_if_fail (GTK_IS_TREE_MODEL_FILTER (model), FALSE);
2962 g_return_val_if_fail (filter->priv->child_model != NULL, FALSE);
2964 indices = gtk_tree_path_get_indices (path);
2966 if (filter->priv->root == NULL)
2967 gtk_tree_model_filter_build_level (filter, NULL, NULL, FALSE);
2968 level = FILTER_LEVEL (filter->priv->root);
2970 depth = gtk_tree_path_get_depth (path);
2977 for (i = 0; i < depth - 1; i++)
2979 if (!level || indices[i] >= g_sequence_get_length (level->seq))
2985 siter = g_sequence_get_iter_at_pos (level->seq, indices[i]);
2986 if (g_sequence_iter_is_end (siter))
2992 elt = GET_ELT (siter);
2995 gtk_tree_model_filter_build_level (filter, level, elt, FALSE);
2996 level = elt->children;
2999 if (!level || indices[i] >= g_sequence_get_length (level->seq))
3005 iter->stamp = filter->priv->stamp;
3006 iter->user_data = level;
3008 siter = g_sequence_get_iter_at_pos (level->seq, indices[depth - 1]);
3009 if (g_sequence_iter_is_end (siter))
3014 iter->user_data2 = GET_ELT (siter);
3020 gtk_tree_model_filter_get_iter (GtkTreeModel *model,
3024 GtkTreeModelFilter *filter = (GtkTreeModelFilter *)model;
3028 GSequenceIter *siter;
3031 g_return_val_if_fail (GTK_IS_TREE_MODEL_FILTER (model), FALSE);
3032 g_return_val_if_fail (filter->priv->child_model != NULL, FALSE);
3034 indices = gtk_tree_path_get_indices (path);
3036 if (filter->priv->root == NULL)
3037 gtk_tree_model_filter_build_level (filter, NULL, NULL, FALSE);
3038 level = FILTER_LEVEL (filter->priv->root);
3040 depth = gtk_tree_path_get_depth (path);
3047 for (i = 0; i < depth - 1; i++)
3049 if (!level || indices[i] >= g_sequence_get_length (level->visible_seq))
3055 siter = g_sequence_get_iter_at_pos (level->visible_seq, indices[i]);
3056 if (g_sequence_iter_is_end (siter))
3062 elt = GET_ELT (siter);
3064 gtk_tree_model_filter_build_level (filter, level, elt, FALSE);
3065 level = elt->children;
3068 if (!level || indices[i] >= g_sequence_get_length (level->visible_seq))
3074 iter->stamp = filter->priv->stamp;
3075 iter->user_data = level;
3077 siter = g_sequence_get_iter_at_pos (level->visible_seq, indices[depth - 1]);
3078 if (g_sequence_iter_is_end (siter))
3083 iter->user_data2 = GET_ELT (siter);
3088 static GtkTreePath *
3089 gtk_tree_model_filter_get_path (GtkTreeModel *model,
3092 GtkTreePath *retval;
3096 g_return_val_if_fail (GTK_IS_TREE_MODEL_FILTER (model), NULL);
3097 g_return_val_if_fail (GTK_TREE_MODEL_FILTER (model)->priv->child_model != NULL, NULL);
3098 g_return_val_if_fail (GTK_TREE_MODEL_FILTER (model)->priv->stamp == iter->stamp, NULL);
3100 level = iter->user_data;
3101 elt = iter->user_data2;
3103 if (!elt->visible_siter)
3106 retval = gtk_tree_path_new ();
3112 index = g_sequence_iter_get_position (elt->visible_siter);
3113 gtk_tree_path_prepend_index (retval, index);
3115 elt = level->parent_elt;
3116 level = level->parent_level;
3123 gtk_tree_model_filter_real_modify (GtkTreeModelFilter *self,
3124 GtkTreeModel *child_model,
3129 if (self->priv->modify_func)
3131 g_return_if_fail (column < self->priv->modify_n_columns);
3133 g_value_init (value, self->priv->modify_types[column]);
3134 self->priv->modify_func (GTK_TREE_MODEL (self),
3138 self->priv->modify_data);
3142 GtkTreeIter child_iter;
3144 gtk_tree_model_filter_convert_iter_to_child_iter (GTK_TREE_MODEL_FILTER (self),
3146 gtk_tree_model_get_value (child_model, &child_iter, column, value);
3151 gtk_tree_model_filter_get_value (GtkTreeModel *model,
3156 GtkTreeModelFilter *filter = GTK_TREE_MODEL_FILTER (model);
3158 g_return_if_fail (GTK_IS_TREE_MODEL_FILTER (model));
3159 g_return_if_fail (GTK_TREE_MODEL_FILTER (model)->priv->child_model != NULL);
3160 g_return_if_fail (GTK_TREE_MODEL_FILTER (model)->priv->stamp == iter->stamp);
3162 GTK_TREE_MODEL_FILTER_GET_CLASS (model)->modify (filter,
3163 filter->priv->child_model, iter, value, column);
3167 gtk_tree_model_filter_iter_next (GtkTreeModel *model,
3172 GSequenceIter *siter;
3174 g_return_val_if_fail (GTK_IS_TREE_MODEL_FILTER (model), FALSE);
3175 g_return_val_if_fail (GTK_TREE_MODEL_FILTER (model)->priv->child_model != NULL, FALSE);
3176 g_return_val_if_fail (GTK_TREE_MODEL_FILTER (model)->priv->stamp == iter->stamp, FALSE);
3178 level = iter->user_data;
3179 elt = iter->user_data2;
3181 siter = g_sequence_iter_next (elt->visible_siter);
3182 if (g_sequence_iter_is_end (siter))
3188 iter->user_data2 = GET_ELT (siter);
3194 gtk_tree_model_filter_iter_previous (GtkTreeModel *model,
3198 GSequenceIter *siter;
3200 g_return_val_if_fail (GTK_IS_TREE_MODEL_FILTER (model), FALSE);
3201 g_return_val_if_fail (GTK_TREE_MODEL_FILTER (model)->priv->child_model != NULL, FALSE);
3202 g_return_val_if_fail (GTK_TREE_MODEL_FILTER (model)->priv->stamp == iter->stamp, FALSE);
3204 elt = iter->user_data2;
3206 siter = g_sequence_iter_prev (elt->visible_siter);
3207 if (g_sequence_iter_is_begin (siter))
3213 iter->user_data2 = GET_ELT (siter);
3219 gtk_tree_model_filter_iter_children (GtkTreeModel *model,
3221 GtkTreeIter *parent)
3223 GtkTreeModelFilter *filter = (GtkTreeModelFilter *)model;
3225 GSequenceIter *siter;
3228 g_return_val_if_fail (GTK_IS_TREE_MODEL_FILTER (model), FALSE);
3229 g_return_val_if_fail (filter->priv->child_model != NULL, FALSE);
3231 g_return_val_if_fail (filter->priv->stamp == parent->stamp, FALSE);
3235 if (!filter->priv->root)
3236 gtk_tree_model_filter_build_level (filter, NULL, NULL, FALSE);
3237 if (!filter->priv->root)
3240 level = filter->priv->root;
3241 siter = g_sequence_get_begin_iter (level->visible_seq);
3242 if (g_sequence_iter_is_end (siter))
3248 iter->stamp = filter->priv->stamp;
3249 iter->user_data = level;
3250 iter->user_data2 = GET_ELT (siter);
3256 if (FILTER_ELT (parent->user_data2)->children == NULL)
3257 gtk_tree_model_filter_build_level (filter,
3258 FILTER_LEVEL (parent->user_data),
3259 FILTER_ELT (parent->user_data2),
3261 if (FILTER_ELT (parent->user_data2)->children == NULL)
3264 level = FILTER_ELT (parent->user_data2)->children;
3265 siter = g_sequence_get_begin_iter (level->visible_seq);
3266 if (g_sequence_iter_is_end (siter))
3272 iter->stamp = filter->priv->stamp;
3273 iter->user_data = level;
3274 iter->user_data2 = GET_ELT (siter);
3284 gtk_tree_model_filter_iter_has_child (GtkTreeModel *model,
3287 GtkTreeIter child_iter;
3288 GtkTreeModelFilter *filter = (GtkTreeModelFilter *)model;
3291 g_return_val_if_fail (GTK_IS_TREE_MODEL_FILTER (model), FALSE);
3292 g_return_val_if_fail (filter->priv->child_model != NULL, FALSE);
3293 g_return_val_if_fail (filter->priv->stamp == iter->stamp, FALSE);
3295 filter = GTK_TREE_MODEL_FILTER (model);
3297 gtk_tree_model_filter_convert_iter_to_child_iter (GTK_TREE_MODEL_FILTER (model), &child_iter, iter);
3298 elt = FILTER_ELT (iter->user_data2);
3300 if (!elt->visible_siter)
3303 /* we need to build the level to check if not all children are filtered
3307 && gtk_tree_model_iter_has_child (filter->priv->child_model, &child_iter))
3308 gtk_tree_model_filter_build_level (filter, FILTER_LEVEL (iter->user_data),
3311 if (elt->children && g_sequence_get_length (elt->children->visible_seq) > 0)
3318 gtk_tree_model_filter_iter_n_children (GtkTreeModel *model,
3321 GtkTreeIter child_iter;
3322 GtkTreeModelFilter *filter = (GtkTreeModelFilter *)model;
3325 g_return_val_if_fail (GTK_IS_TREE_MODEL_FILTER (model), 0);
3326 g_return_val_if_fail (filter->priv->child_model != NULL, 0);
3328 g_return_val_if_fail (filter->priv->stamp == iter->stamp, 0);
3332 if (!filter->priv->root)
3333 gtk_tree_model_filter_build_level (filter, NULL, NULL, FALSE);
3335 if (filter->priv->root)
3336 return g_sequence_get_length (FILTER_LEVEL (filter->priv->root)->visible_seq);
3341 elt = FILTER_ELT (iter->user_data2);
3343 if (!elt->visible_siter)
3346 gtk_tree_model_filter_convert_iter_to_child_iter (GTK_TREE_MODEL_FILTER (model), &child_iter, iter);
3348 if (!elt->children &&
3349 gtk_tree_model_iter_has_child (filter->priv->child_model, &child_iter))
3350 gtk_tree_model_filter_build_level (filter,
3351 FILTER_LEVEL (iter->user_data),
3355 return g_sequence_get_length (elt->children->visible_seq);
3361 gtk_tree_model_filter_iter_nth_child (GtkTreeModel *model,
3363 GtkTreeIter *parent,
3367 GtkTreeIter children;
3368 GSequenceIter *siter;
3370 g_return_val_if_fail (GTK_IS_TREE_MODEL_FILTER (model), FALSE);
3372 g_return_val_if_fail (GTK_TREE_MODEL_FILTER (model)->priv->stamp == parent->stamp, FALSE);
3374 /* use this instead of has_child to force us to build the level, if needed */
3375 if (gtk_tree_model_filter_iter_children (model, &children, parent) == FALSE)
3381 level = children.user_data;
3382 siter = g_sequence_get_iter_at_pos (level->visible_seq, n);
3383 if (g_sequence_iter_is_end (siter))
3386 iter->stamp = GTK_TREE_MODEL_FILTER (model)->priv->stamp;
3387 iter->user_data = level;
3388 iter->user_data2 = GET_ELT (siter);
3394 gtk_tree_model_filter_iter_parent (GtkTreeModel *model,
3401 g_return_val_if_fail (GTK_IS_TREE_MODEL_FILTER (model), FALSE);
3402 g_return_val_if_fail (GTK_TREE_MODEL_FILTER (model)->priv->child_model != NULL, FALSE);
3403 g_return_val_if_fail (GTK_TREE_MODEL_FILTER (model)->priv->stamp == child->stamp, FALSE);
3405 level = child->user_data;
3407 if (level->parent_level)
3409 iter->stamp = GTK_TREE_MODEL_FILTER (model)->priv->stamp;
3410 iter->user_data = level->parent_level;
3411 iter->user_data2 = level->parent_elt;
3420 gtk_tree_model_filter_ref_node (GtkTreeModel *model,
3423 gtk_tree_model_filter_real_ref_node (model, iter, TRUE);
3427 gtk_tree_model_filter_real_ref_node (GtkTreeModel *model,
3431 GtkTreeModelFilter *filter = (GtkTreeModelFilter *)model;
3432 GtkTreeIter child_iter;
3436 g_return_if_fail (GTK_IS_TREE_MODEL_FILTER (model));
3437 g_return_if_fail (GTK_TREE_MODEL_FILTER (model)->priv->child_model != NULL);
3438 g_return_if_fail (GTK_TREE_MODEL_FILTER (model)->priv->stamp == iter->stamp);
3440 gtk_tree_model_filter_convert_iter_to_child_iter (GTK_TREE_MODEL_FILTER (model), &child_iter, iter);
3442 gtk_tree_model_ref_node (filter->priv->child_model, &child_iter);
3444 level = iter->user_data;
3445 elt = iter->user_data2;
3452 elt->ext_ref_count++;
3453 level->ext_ref_count++;
3455 if (level->ext_ref_count == 1)
3457 FilterLevel *parent_level = level->parent_level;
3458 FilterElt *parent_elt = level->parent_elt;
3460 /* we were at zero -- time to decrease the zero_ref_count val */
3461 while (parent_level)
3463 parent_elt->zero_ref_count--;
3465 parent_elt = parent_level->parent_elt;
3466 parent_level = parent_level->parent_level;
3469 if (filter->priv->root != level)
3470 filter->priv->zero_ref_count--;
3472 #ifdef MODEL_FILTER_DEBUG
3473 g_assert (filter->priv->zero_ref_count >= 0);
3478 #ifdef MODEL_FILTER_DEBUG
3479 g_assert (elt->ref_count >= elt->ext_ref_count);
3480 g_assert (elt->ref_count >= 0);
3481 g_assert (elt->ext_ref_count >= 0);
3486 gtk_tree_model_filter_unref_node (GtkTreeModel *model,
3489 gtk_tree_model_filter_real_unref_node (model, iter, TRUE, TRUE);
3493 gtk_tree_model_filter_real_unref_node (GtkTreeModel *model,
3496 gboolean propagate_unref)
3498 GtkTreeModelFilter *filter = (GtkTreeModelFilter *)model;
3502 g_return_if_fail (GTK_IS_TREE_MODEL_FILTER (model));
3503 g_return_if_fail (filter->priv->child_model != NULL);
3504 g_return_if_fail (filter->priv->stamp == iter->stamp);
3506 if (propagate_unref)
3508 GtkTreeIter child_iter;
3509 gtk_tree_model_filter_convert_iter_to_child_iter (GTK_TREE_MODEL_FILTER (model), &child_iter, iter);
3510 gtk_tree_model_unref_node (filter->priv->child_model, &child_iter);
3513 level = iter->user_data;
3514 elt = iter->user_data2;
3516 g_return_if_fail (elt->ref_count > 0);
3517 #ifdef MODEL_FILTER_DEBUG
3518 g_assert (elt->ref_count >= elt->ext_ref_count);
3519 g_assert (elt->ref_count >= 0);
3520 g_assert (elt->ext_ref_count >= 0);
3528 elt->ext_ref_count--;
3529 level->ext_ref_count--;
3531 if (level->ext_ref_count == 0)
3533 FilterLevel *parent_level = level->parent_level;
3534 FilterElt *parent_elt = level->parent_elt;
3536 /* we are at zero -- time to increase the zero_ref_count val */
3537 while (parent_level)
3539 parent_elt->zero_ref_count++;
3541 parent_elt = parent_level->parent_elt;
3542 parent_level = parent_level->parent_level;
3545 if (filter->priv->root != level)
3546 filter->priv->zero_ref_count++;
3548 #ifdef MODEL_FILTER_DEBUG
3549 g_assert (filter->priv->zero_ref_count >= 0);
3554 #ifdef MODEL_FILTER_DEBUG
3555 g_assert (elt->ref_count >= elt->ext_ref_count);
3556 g_assert (elt->ref_count >= 0);
3557 g_assert (elt->ext_ref_count >= 0);
3561 /* TreeDragSource interface implementation */
3563 gtk_tree_model_filter_row_draggable (GtkTreeDragSource *drag_source,
3566 GtkTreeModelFilter *tree_model_filter = (GtkTreeModelFilter *)drag_source;
3567 GtkTreePath *child_path;
3570 g_return_val_if_fail (GTK_IS_TREE_MODEL_FILTER (drag_source), FALSE);
3571 g_return_val_if_fail (path != NULL, FALSE);
3573 child_path = gtk_tree_model_filter_convert_path_to_child_path (tree_model_filter, path);
3574 draggable = gtk_tree_drag_source_row_draggable (GTK_TREE_DRAG_SOURCE (tree_model_filter->priv->child_model), child_path);
3575 gtk_tree_path_free (child_path);
3581 gtk_tree_model_filter_drag_data_get (GtkTreeDragSource *drag_source,
3583 GtkSelectionData *selection_data)
3585 GtkTreeModelFilter *tree_model_filter = (GtkTreeModelFilter *)drag_source;
3586 GtkTreePath *child_path;
3589 g_return_val_if_fail (GTK_IS_TREE_MODEL_FILTER (drag_source), FALSE);
3590 g_return_val_if_fail (path != NULL, FALSE);
3592 child_path = gtk_tree_model_filter_convert_path_to_child_path (tree_model_filter, path);
3593 gotten = gtk_tree_drag_source_drag_data_get (GTK_TREE_DRAG_SOURCE (tree_model_filter->priv->child_model), child_path, selection_data);
3594 gtk_tree_path_free (child_path);
3600 gtk_tree_model_filter_drag_data_delete (GtkTreeDragSource *drag_source,
3603 GtkTreeModelFilter *tree_model_filter = (GtkTreeModelFilter *)drag_source;
3604 GtkTreePath *child_path;
3607 g_return_val_if_fail (GTK_IS_TREE_MODEL_FILTER (drag_source), FALSE);
3608 g_return_val_if_fail (path != NULL, FALSE);
3610 child_path = gtk_tree_model_filter_convert_path_to_child_path (tree_model_filter, path);
3611 deleted = gtk_tree_drag_source_drag_data_delete (GTK_TREE_DRAG_SOURCE (tree_model_filter->priv->child_model), child_path);
3612 gtk_tree_path_free (child_path);
3617 /* bits and pieces */
3619 gtk_tree_model_filter_set_model (GtkTreeModelFilter *filter,
3620 GtkTreeModel *child_model)
3622 g_return_if_fail (GTK_IS_TREE_MODEL_FILTER (filter));
3624 if (filter->priv->child_model)
3626 g_signal_handler_disconnect (filter->priv->child_model,
3627 filter->priv->changed_id);
3628 g_signal_handler_disconnect (filter->priv->child_model,
3629 filter->priv->inserted_id);
3630 g_signal_handler_disconnect (filter->priv->child_model,
3631 filter->priv->has_child_toggled_id);
3632 g_signal_handler_disconnect (filter->priv->child_model,
3633 filter->priv->deleted_id);
3634 g_signal_handler_disconnect (filter->priv->child_model,
3635 filter->priv->reordered_id);
3637 /* reset our state */
3638 if (filter->priv->root)
3639 gtk_tree_model_filter_free_level (filter, filter->priv->root,
3642 filter->priv->root = NULL;
3643 g_object_unref (filter->priv->child_model);
3644 filter->priv->visible_column = -1;
3646 /* FIXME: do we need to destroy more here? */
3649 filter->priv->child_model = child_model;
3653 g_object_ref (filter->priv->child_model);
3654 filter->priv->changed_id =
3655 g_signal_connect (child_model, "row-changed",
3656 G_CALLBACK (gtk_tree_model_filter_row_changed),
3658 filter->priv->inserted_id =
3659 g_signal_connect (child_model, "row-inserted",
3660 G_CALLBACK (gtk_tree_model_filter_row_inserted),
3662 filter->priv->has_child_toggled_id =
3663 g_signal_connect (child_model, "row-has-child-toggled",
3664 G_CALLBACK (gtk_tree_model_filter_row_has_child_toggled),
3666 filter->priv->deleted_id =
3667 g_signal_connect (child_model, "row-deleted",
3668 G_CALLBACK (gtk_tree_model_filter_row_deleted),
3670 filter->priv->reordered_id =
3671 g_signal_connect (child_model, "rows-reordered",
3672 G_CALLBACK (gtk_tree_model_filter_rows_reordered),
3675 filter->priv->child_flags = gtk_tree_model_get_flags (child_model);
3676 filter->priv->stamp = g_random_int ();
3681 gtk_tree_model_filter_ref_path (GtkTreeModelFilter *filter,
3687 len = gtk_tree_path_get_depth (path);
3688 p = gtk_tree_path_copy (path);
3693 gtk_tree_model_get_iter (GTK_TREE_MODEL (filter->priv->child_model), &iter, p);
3694 gtk_tree_model_ref_node (GTK_TREE_MODEL (filter->priv->child_model), &iter);
3695 gtk_tree_path_up (p);
3698 gtk_tree_path_free (p);
3702 gtk_tree_model_filter_unref_path (GtkTreeModelFilter *filter,
3712 len = gtk_tree_path_get_depth (path);
3714 p = gtk_tree_path_copy (path);
3719 gtk_tree_model_get_iter (GTK_TREE_MODEL (filter->priv->child_model), &iter, p);
3720 gtk_tree_model_unref_node (GTK_TREE_MODEL (filter->priv->child_model), &iter);
3721 gtk_tree_path_up (p);
3724 gtk_tree_path_free (p);
3728 gtk_tree_model_filter_set_root (GtkTreeModelFilter *filter,
3731 g_return_if_fail (GTK_IS_TREE_MODEL_FILTER (filter));
3734 filter->priv->virtual_root = NULL;
3736 filter->priv->virtual_root = gtk_tree_path_copy (root);
3742 * gtk_tree_model_filter_new:
3743 * @child_model: A #GtkTreeModel.
3744 * @root: (allow-none): A #GtkTreePath or %NULL.
3746 * Creates a new #GtkTreeModel, with @child_model as the child_model
3747 * and @root as the virtual root.
3749 * Return value: (transfer full): A new #GtkTreeModel.
3754 gtk_tree_model_filter_new (GtkTreeModel *child_model,
3757 GtkTreeModel *retval;
3758 GtkTreeModelFilter *filter;
3760 g_return_val_if_fail (GTK_IS_TREE_MODEL (child_model), NULL);
3762 retval = g_object_new (GTK_TYPE_TREE_MODEL_FILTER,
3763 "child-model", child_model,
3764 "virtual-root", root,
3767 filter = GTK_TREE_MODEL_FILTER (retval);
3768 if (filter->priv->virtual_root)
3770 gtk_tree_model_filter_ref_path (filter, filter->priv->virtual_root);
3771 filter->priv->virtual_root_deleted = FALSE;
3778 * gtk_tree_model_filter_get_model:
3779 * @filter: A #GtkTreeModelFilter.
3781 * Returns a pointer to the child model of @filter.
3783 * Return value: (transfer none): A pointer to a #GtkTreeModel.
3788 gtk_tree_model_filter_get_model (GtkTreeModelFilter *filter)
3790 g_return_val_if_fail (GTK_IS_TREE_MODEL_FILTER (filter), NULL);
3792 return filter->priv->child_model;
3796 * gtk_tree_model_filter_set_visible_func:
3797 * @filter: A #GtkTreeModelFilter.
3798 * @func: A #GtkTreeModelFilterVisibleFunc, the visible function.
3799 * @data: (allow-none): User data to pass to the visible function, or %NULL.
3800 * @destroy: (allow-none): Destroy notifier of @data, or %NULL.
3802 * Sets the visible function used when filtering the @filter to be @func. The
3803 * function should return %TRUE if the given row should be visible and
3806 * If the condition calculated by the function changes over time (e.g. because
3807 * it depends on some global parameters), you must call
3808 * gtk_tree_model_filter_refilter() to keep the visibility information of
3809 * the model uptodate.
3811 * Note that @func is called whenever a row is inserted, when it may still be
3812 * empty. The visible function should therefore take special care of empty
3813 * rows, like in the example below.
3815 * <informalexample><programlisting>
3817 * visible_func (GtkTreeModel *model,
3818 * GtkTreeIter *iter,
3821 * /* Visible if row is non-empty and first column is "HI" */
3823 * gboolean visible = FALSE;
3825 * gtk_tree_model_get (model, iter, 0, &str, -1);
3826 * if (str && strcmp (str, "HI") == 0)
3832 * </programlisting></informalexample>
3837 gtk_tree_model_filter_set_visible_func (GtkTreeModelFilter *filter,
3838 GtkTreeModelFilterVisibleFunc func,
3840 GDestroyNotify destroy)
3842 g_return_if_fail (GTK_IS_TREE_MODEL_FILTER (filter));
3843 g_return_if_fail (func != NULL);
3844 g_return_if_fail (filter->priv->visible_method_set == FALSE);
3846 filter->priv->visible_func = func;
3847 filter->priv->visible_data = data;
3848 filter->priv->visible_destroy = destroy;
3850 filter->priv->visible_method_set = TRUE;
3854 * gtk_tree_model_filter_set_modify_func:
3855 * @filter: A #GtkTreeModelFilter.
3856 * @n_columns: The number of columns in the filter model.
3857 * @types: (array length=n_columns): The #GType<!-- -->s of the columns.
3858 * @func: A #GtkTreeModelFilterModifyFunc
3859 * @data: (allow-none): User data to pass to the modify function, or %NULL.
3860 * @destroy: (allow-none): Destroy notifier of @data, or %NULL.
3862 * With the @n_columns and @types parameters, you give an array of column
3863 * types for this model (which will be exposed to the parent model/view).
3864 * The @func, @data and @destroy parameters are for specifying the modify
3865 * function. The modify function will get called for <emphasis>each</emphasis>
3866 * data access, the goal of the modify function is to return the data which
3867 * should be displayed at the location specified using the parameters of the
3873 gtk_tree_model_filter_set_modify_func (GtkTreeModelFilter *filter,
3876 GtkTreeModelFilterModifyFunc func,
3878 GDestroyNotify destroy)
3880 g_return_if_fail (GTK_IS_TREE_MODEL_FILTER (filter));
3881 g_return_if_fail (func != NULL);
3882 g_return_if_fail (filter->priv->modify_func_set == FALSE);
3884 if (filter->priv->modify_destroy)
3886 GDestroyNotify d = filter->priv->modify_destroy;
3888 filter->priv->modify_destroy = NULL;
3889 d (filter->priv->modify_data);
3892 filter->priv->modify_n_columns = n_columns;
3893 filter->priv->modify_types = g_new0 (GType, n_columns);
3894 memcpy (filter->priv->modify_types, types, sizeof (GType) * n_columns);
3895 filter->priv->modify_func = func;
3896 filter->priv->modify_data = data;
3897 filter->priv->modify_destroy = destroy;
3899 filter->priv->modify_func_set = TRUE;
3903 * gtk_tree_model_filter_set_visible_column:
3904 * @filter: A #GtkTreeModelFilter.
3905 * @column: A #gint which is the column containing the visible information.
3907 * Sets @column of the child_model to be the column where @filter should
3908 * look for visibility information. @columns should be a column of type
3909 * %G_TYPE_BOOLEAN, where %TRUE means that a row is visible, and %FALSE
3915 gtk_tree_model_filter_set_visible_column (GtkTreeModelFilter *filter,
3918 g_return_if_fail (GTK_IS_TREE_MODEL_FILTER (filter));
3919 g_return_if_fail (column >= 0);
3920 g_return_if_fail (filter->priv->visible_method_set == FALSE);
3922 filter->priv->visible_column = column;
3924 filter->priv->visible_method_set = TRUE;
3930 * gtk_tree_model_filter_convert_child_iter_to_iter:
3931 * @filter: A #GtkTreeModelFilter.
3932 * @filter_iter: (out): An uninitialized #GtkTreeIter.
3933 * @child_iter: A valid #GtkTreeIter pointing to a row on the child model.
3935 * Sets @filter_iter to point to the row in @filter that corresponds to the
3936 * row pointed at by @child_iter. If @filter_iter was not set, %FALSE is
3939 * Return value: %TRUE, if @filter_iter was set, i.e. if @child_iter is a
3940 * valid iterator pointing to a visible row in child model.
3945 gtk_tree_model_filter_convert_child_iter_to_iter (GtkTreeModelFilter *filter,
3946 GtkTreeIter *filter_iter,
3947 GtkTreeIter *child_iter)
3950 GtkTreePath *child_path, *path;
3952 g_return_val_if_fail (GTK_IS_TREE_MODEL_FILTER (filter), FALSE);
3953 g_return_val_if_fail (filter->priv->child_model != NULL, FALSE);
3954 g_return_val_if_fail (filter_iter != NULL, FALSE);
3955 g_return_val_if_fail (child_iter != NULL, FALSE);
3956 g_return_val_if_fail (filter_iter != child_iter, FALSE);
3958 filter_iter->stamp = 0;
3960 child_path = gtk_tree_model_get_path (filter->priv->child_model, child_iter);
3961 g_return_val_if_fail (child_path != NULL, FALSE);
3963 path = gtk_tree_model_filter_convert_child_path_to_path (filter,
3965 gtk_tree_path_free (child_path);
3970 ret = gtk_tree_model_get_iter (GTK_TREE_MODEL (filter), filter_iter, path);
3971 gtk_tree_path_free (path);
3977 * gtk_tree_model_filter_convert_iter_to_child_iter:
3978 * @filter: A #GtkTreeModelFilter.
3979 * @child_iter: (out): An uninitialized #GtkTreeIter.
3980 * @filter_iter: A valid #GtkTreeIter pointing to a row on @filter.
3982 * Sets @child_iter to point to the row pointed to by @filter_iter.
3987 gtk_tree_model_filter_convert_iter_to_child_iter (GtkTreeModelFilter *filter,
3988 GtkTreeIter *child_iter,
3989 GtkTreeIter *filter_iter)
3991 g_return_if_fail (GTK_IS_TREE_MODEL_FILTER (filter));
3992 g_return_if_fail (filter->priv->child_model != NULL);
3993 g_return_if_fail (child_iter != NULL);
3994 g_return_if_fail (filter_iter != NULL);
3995 g_return_if_fail (filter_iter->stamp == filter->priv->stamp);
3996 g_return_if_fail (filter_iter != child_iter);
3998 if (GTK_TREE_MODEL_FILTER_CACHE_CHILD_ITERS (filter))
4000 *child_iter = FILTER_ELT (filter_iter->user_data2)->iter;
4005 gboolean valid = FALSE;
4007 path = gtk_tree_model_filter_elt_get_path (filter_iter->user_data,
4008 filter_iter->user_data2,
4009 filter->priv->virtual_root);
4010 valid = gtk_tree_model_get_iter (filter->priv->child_model, child_iter,
4012 gtk_tree_path_free (path);
4014 g_return_if_fail (valid == TRUE);
4018 /* The path returned can only be used internally in the filter model. */
4019 static GtkTreePath *
4020 gtk_real_tree_model_filter_convert_child_path_to_path (GtkTreeModelFilter *filter,
4021 GtkTreePath *child_path,
4022 gboolean build_levels,
4023 gboolean fetch_children)
4025 gint *child_indices;
4026 GtkTreePath *retval;
4027 GtkTreePath *real_path;
4032 g_return_val_if_fail (GTK_IS_TREE_MODEL_FILTER (filter), NULL);
4033 g_return_val_if_fail (filter->priv->child_model != NULL, NULL);
4034 g_return_val_if_fail (child_path != NULL, NULL);
4036 if (!filter->priv->virtual_root)
4037 real_path = gtk_tree_path_copy (child_path);
4039 real_path = gtk_tree_model_filter_remove_root (child_path,
4040 filter->priv->virtual_root);
4045 retval = gtk_tree_path_new ();
4046 child_indices = gtk_tree_path_get_indices (real_path);
4048 if (filter->priv->root == NULL && build_levels)
4049 gtk_tree_model_filter_build_level (filter, NULL, NULL, FALSE);
4050 level = FILTER_LEVEL (filter->priv->root);
4052 for (i = 0; i < gtk_tree_path_get_depth (real_path); i++)
4054 GSequenceIter *siter;
4055 gboolean found_child = FALSE;
4059 gtk_tree_path_free (real_path);
4060 gtk_tree_path_free (retval);
4064 tmp = lookup_elt_with_offset (level->seq, child_indices[i], &siter);
4067 gtk_tree_path_append_index (retval, g_sequence_iter_get_position (siter));
4068 if (!tmp->children && build_levels)
4069 gtk_tree_model_filter_build_level (filter, level, tmp, FALSE);
4070 level = tmp->children;
4074 if (!found_child && fetch_children)
4078 tmp = gtk_tree_model_filter_fetch_child (filter, level,
4082 /* didn't find the child, let's try to bring it back */
4083 if (!tmp || tmp->offset != child_indices[i])
4086 gtk_tree_path_free (real_path);
4087 gtk_tree_path_free (retval);
4091 gtk_tree_path_append_index (retval, j);
4092 if (!tmp->children && build_levels)
4093 gtk_tree_model_filter_build_level (filter, level, tmp, FALSE);
4094 level = tmp->children;
4097 else if (!found_child && !fetch_children)
4100 gtk_tree_path_free (real_path);
4101 gtk_tree_path_free (retval);
4106 gtk_tree_path_free (real_path);
4111 * gtk_tree_model_filter_convert_child_path_to_path:
4112 * @filter: A #GtkTreeModelFilter.
4113 * @child_path: A #GtkTreePath to convert.
4115 * Converts @child_path to a path relative to @filter. That is, @child_path
4116 * points to a path in the child model. The rerturned path will point to the
4117 * same row in the filtered model. If @child_path isn't a valid path on the
4118 * child model or points to a row which is not visible in @filter, then %NULL
4121 * Return value: A newly allocated #GtkTreePath, or %NULL.
4126 gtk_tree_model_filter_convert_child_path_to_path (GtkTreeModelFilter *filter,
4127 GtkTreePath *child_path)
4132 /* this function does the sanity checks */
4133 path = gtk_real_tree_model_filter_convert_child_path_to_path (filter,
4141 /* get a new path which only takes visible nodes into account.
4142 * -- if this gives any performance issues, we can write a special
4143 * version of convert_child_path_to_path immediately returning
4144 * a visible-nodes-only path.
4146 gtk_tree_model_filter_get_iter_full (GTK_TREE_MODEL (filter), &iter, path);
4148 gtk_tree_path_free (path);
4149 path = gtk_tree_model_get_path (GTK_TREE_MODEL (filter), &iter);
4155 * gtk_tree_model_filter_convert_path_to_child_path:
4156 * @filter: A #GtkTreeModelFilter.
4157 * @filter_path: A #GtkTreePath to convert.
4159 * Converts @filter_path to a path on the child model of @filter. That is,
4160 * @filter_path points to a location in @filter. The returned path will
4161 * point to the same location in the model not being filtered. If @filter_path
4162 * does not point to a location in the child model, %NULL is returned.
4164 * Return value: A newly allocated #GtkTreePath, or %NULL.
4169 gtk_tree_model_filter_convert_path_to_child_path (GtkTreeModelFilter *filter,
4170 GtkTreePath *filter_path)
4172 gint *filter_indices;
4173 GtkTreePath *retval;
4177 g_return_val_if_fail (GTK_IS_TREE_MODEL_FILTER (filter), NULL);
4178 g_return_val_if_fail (filter->priv->child_model != NULL, NULL);
4179 g_return_val_if_fail (filter_path != NULL, NULL);
4182 retval = gtk_tree_path_new ();
4183 filter_indices = gtk_tree_path_get_indices (filter_path);
4184 if (!filter->priv->root)
4185 gtk_tree_model_filter_build_level (filter, NULL, NULL, FALSE);
4186 level = FILTER_LEVEL (filter->priv->root);
4188 for (i = 0; i < gtk_tree_path_get_depth (filter_path); i++)
4191 GSequenceIter *siter;
4195 gtk_tree_path_free (retval);
4199 siter = g_sequence_get_iter_at_pos (level->visible_seq, filter_indices[i]);
4200 if (g_sequence_iter_is_end (siter))
4202 gtk_tree_path_free (retval);
4206 elt = GET_ELT (siter);
4207 if (elt->children == NULL)
4208 gtk_tree_model_filter_build_level (filter, level, elt, FALSE);
4210 gtk_tree_path_append_index (retval, elt->offset);
4211 level = elt->children;
4216 if (filter->priv->virtual_root)
4218 GtkTreePath *real_retval;
4220 real_retval = gtk_tree_model_filter_add_root (retval,
4221 filter->priv->virtual_root);
4222 gtk_tree_path_free (retval);
4231 gtk_tree_model_filter_refilter_helper (GtkTreeModel *model,
4236 /* evil, don't try this at home, but certainly speeds things up */
4237 gtk_tree_model_filter_row_changed (model, path, iter, data);
4243 * gtk_tree_model_filter_refilter:
4244 * @filter: A #GtkTreeModelFilter.
4246 * Emits ::row_changed for each row in the child model, which causes
4247 * the filter to re-evaluate whether a row is visible or not.
4252 gtk_tree_model_filter_refilter (GtkTreeModelFilter *filter)
4254 g_return_if_fail (GTK_IS_TREE_MODEL_FILTER (filter));
4257 gtk_tree_model_foreach (filter->priv->child_model,
4258 gtk_tree_model_filter_refilter_helper,
4263 * gtk_tree_model_filter_clear_cache:
4264 * @filter: A #GtkTreeModelFilter.
4266 * This function should almost never be called. It clears the @filter
4267 * of any cached iterators that haven't been reffed with
4268 * gtk_tree_model_ref_node(). This might be useful if the child model
4269 * being filtered is static (and doesn't change often) and there has been
4270 * a lot of unreffed access to nodes. As a side effect of this function,
4271 * all unreffed iters will be invalid.
4276 gtk_tree_model_filter_clear_cache (GtkTreeModelFilter *filter)
4278 g_return_if_fail (GTK_IS_TREE_MODEL_FILTER (filter));
4280 if (filter->priv->zero_ref_count > 0)
4281 gtk_tree_model_filter_clear_cache_helper (filter,
4282 FILTER_LEVEL (filter->priv->root));