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 has an external ref count of zero. Otherwise, monitoring
229 * this level is necessary to possibly update the visibility state
230 * of the parent. This is an important difference from GtkTreeModelSort!
232 * Signals are only required for levels with an external ref count > 0.
233 * This due to reference counting rule 3, see the GtkTreeModel
234 * documentation. In the GtkTreeModelFilter we try hard to stick to this
235 * rule and not emit redundant signals (though redundant emissions of
236 * row-has-child-toggled could appear frequently; it does happen that
237 * we simply forward the signal emitted by e.g. GtkTreeStore but also
238 * emit our own copy).
242 typedef struct _FilterElt FilterElt;
243 typedef struct _FilterLevel FilterLevel;
248 FilterLevel *children;
253 GSequenceIter *visible_siter; /* iter into visible_seq */
259 GSequence *visible_seq;
263 FilterElt *parent_elt;
264 FilterLevel *parent_level;
268 struct _GtkTreeModelFilterPrivate
270 GtkTreeModel *child_model;
272 GtkTreePath *virtual_root;
279 GtkTreeModelFilterVisibleFunc visible_func;
280 gpointer visible_data;
281 GDestroyNotify visible_destroy;
284 GtkTreeModelFilterModifyFunc modify_func;
285 gpointer modify_data;
286 GDestroyNotify modify_destroy;
287 gint modify_n_columns;
289 guint visible_method_set : 1;
290 guint modify_func_set : 1;
292 guint in_row_deleted : 1;
293 guint virtual_root_deleted : 1;
298 gulong has_child_toggled_id;
311 /* Set this to 0 to disable caching of child iterators. This
312 * allows for more stringent testing. It is recommended to set this
313 * to one when refactoring this code and running the unit tests to
317 # define GTK_TREE_MODEL_FILTER_CACHE_CHILD_ITERS(filter) \
318 (((GtkTreeModelFilter *)filter)->priv->child_flags & GTK_TREE_MODEL_ITERS_PERSIST)
320 # define GTK_TREE_MODEL_FILTER_CACHE_CHILD_ITERS(filter) (FALSE)
323 #define FILTER_ELT(filter_elt) ((FilterElt *)filter_elt)
324 #define FILTER_LEVEL(filter_level) ((FilterLevel *)filter_level)
325 #define GET_ELT(siter) ((FilterElt*) (siter ? g_sequence_get (siter) : NULL))
327 /* general code (object/interface init, properties, etc) */
328 static void gtk_tree_model_filter_tree_model_init (GtkTreeModelIface *iface);
329 static void gtk_tree_model_filter_drag_source_init (GtkTreeDragSourceIface *iface);
330 static void gtk_tree_model_filter_finalize (GObject *object);
331 static void gtk_tree_model_filter_set_property (GObject *object,
335 static void gtk_tree_model_filter_get_property (GObject *object,
340 /* signal handlers */
341 static void gtk_tree_model_filter_row_changed (GtkTreeModel *c_model,
345 static void gtk_tree_model_filter_row_inserted (GtkTreeModel *c_model,
349 static void gtk_tree_model_filter_row_has_child_toggled (GtkTreeModel *c_model,
353 static void gtk_tree_model_filter_row_deleted (GtkTreeModel *c_model,
356 static void gtk_tree_model_filter_rows_reordered (GtkTreeModel *c_model,
362 /* GtkTreeModel interface */
363 static GtkTreeModelFlags gtk_tree_model_filter_get_flags (GtkTreeModel *model);
364 static gint gtk_tree_model_filter_get_n_columns (GtkTreeModel *model);
365 static GType gtk_tree_model_filter_get_column_type (GtkTreeModel *model,
367 static gboolean gtk_tree_model_filter_get_iter_full (GtkTreeModel *model,
370 static gboolean gtk_tree_model_filter_get_iter (GtkTreeModel *model,
373 static GtkTreePath *gtk_tree_model_filter_get_path (GtkTreeModel *model,
375 static void gtk_tree_model_filter_get_value (GtkTreeModel *model,
379 static gboolean gtk_tree_model_filter_iter_next (GtkTreeModel *model,
381 static gboolean gtk_tree_model_filter_iter_previous (GtkTreeModel *model,
383 static gboolean gtk_tree_model_filter_iter_children (GtkTreeModel *model,
385 GtkTreeIter *parent);
386 static gboolean gtk_tree_model_filter_iter_has_child (GtkTreeModel *model,
388 static gint gtk_tree_model_filter_iter_n_children (GtkTreeModel *model,
390 static gboolean gtk_tree_model_filter_iter_nth_child (GtkTreeModel *model,
394 static gboolean gtk_tree_model_filter_iter_parent (GtkTreeModel *model,
397 static void gtk_tree_model_filter_ref_node (GtkTreeModel *model,
399 static void gtk_tree_model_filter_unref_node (GtkTreeModel *model,
402 /* TreeDragSource interface */
403 static gboolean gtk_tree_model_filter_row_draggable (GtkTreeDragSource *drag_source,
405 static gboolean gtk_tree_model_filter_drag_data_get (GtkTreeDragSource *drag_source,
407 GtkSelectionData *selection_data);
408 static gboolean gtk_tree_model_filter_drag_data_delete (GtkTreeDragSource *drag_source,
411 /* private functions */
412 static void gtk_tree_model_filter_build_level (GtkTreeModelFilter *filter,
413 FilterLevel *parent_level,
414 FilterElt *parent_elt,
415 gboolean emit_inserted);
417 static void gtk_tree_model_filter_free_level (GtkTreeModelFilter *filter,
418 FilterLevel *filter_level,
421 static GtkTreePath *gtk_tree_model_filter_elt_get_path (FilterLevel *level,
425 static GtkTreePath *gtk_tree_model_filter_add_root (GtkTreePath *src,
427 static GtkTreePath *gtk_tree_model_filter_remove_root (GtkTreePath *src,
430 static void gtk_tree_model_filter_increment_stamp (GtkTreeModelFilter *filter);
432 static void gtk_tree_model_filter_real_modify (GtkTreeModelFilter *self,
433 GtkTreeModel *child_model,
437 static gboolean gtk_tree_model_filter_real_visible (GtkTreeModelFilter *filter,
438 GtkTreeModel *child_model,
439 GtkTreeIter *child_iter);
440 static gboolean gtk_tree_model_filter_visible (GtkTreeModelFilter *filter,
441 GtkTreeIter *child_iter);
442 static void gtk_tree_model_filter_clear_cache_helper (GtkTreeModelFilter *filter,
445 static void gtk_tree_model_filter_real_ref_node (GtkTreeModel *model,
448 static void gtk_tree_model_filter_real_unref_node (GtkTreeModel *model,
451 gboolean propagate_unref);
453 static void gtk_tree_model_filter_set_model (GtkTreeModelFilter *filter,
454 GtkTreeModel *child_model);
455 static void gtk_tree_model_filter_ref_path (GtkTreeModelFilter *filter,
457 static void gtk_tree_model_filter_unref_path (GtkTreeModelFilter *filter,
460 static void gtk_tree_model_filter_set_root (GtkTreeModelFilter *filter,
463 static GtkTreePath *gtk_real_tree_model_filter_convert_child_path_to_path (GtkTreeModelFilter *filter,
464 GtkTreePath *child_path,
465 gboolean build_levels,
466 gboolean fetch_children);
468 static gboolean gtk_tree_model_filter_elt_is_visible_in_target (FilterLevel *level,
471 static FilterElt *gtk_tree_model_filter_insert_elt_in_level (GtkTreeModelFilter *filter,
476 static FilterElt *gtk_tree_model_filter_fetch_child (GtkTreeModelFilter *filter,
480 static void gtk_tree_model_filter_remove_elt_from_level (GtkTreeModelFilter *filter,
483 static void gtk_tree_model_filter_update_children (GtkTreeModelFilter *filter,
486 static void gtk_tree_model_filter_emit_row_inserted_for_path (GtkTreeModelFilter *filter,
487 GtkTreeModel *c_model,
489 GtkTreeIter *c_iter);
492 G_DEFINE_TYPE_WITH_CODE (GtkTreeModelFilter, gtk_tree_model_filter, G_TYPE_OBJECT,
493 G_IMPLEMENT_INTERFACE (GTK_TYPE_TREE_MODEL,
494 gtk_tree_model_filter_tree_model_init)
495 G_IMPLEMENT_INTERFACE (GTK_TYPE_TREE_DRAG_SOURCE,
496 gtk_tree_model_filter_drag_source_init))
499 gtk_tree_model_filter_init (GtkTreeModelFilter *filter)
501 filter->priv = G_TYPE_INSTANCE_GET_PRIVATE (filter,
502 GTK_TYPE_TREE_MODEL_FILTER,
503 GtkTreeModelFilterPrivate);
505 filter->priv->visible_column = -1;
506 filter->priv->zero_ref_count = 0;
507 filter->priv->visible_method_set = FALSE;
508 filter->priv->modify_func_set = FALSE;
509 filter->priv->in_row_deleted = FALSE;
510 filter->priv->virtual_root_deleted = FALSE;
514 gtk_tree_model_filter_class_init (GtkTreeModelFilterClass *filter_class)
516 GObjectClass *object_class;
518 object_class = (GObjectClass *) filter_class;
520 object_class->set_property = gtk_tree_model_filter_set_property;
521 object_class->get_property = gtk_tree_model_filter_get_property;
523 object_class->finalize = gtk_tree_model_filter_finalize;
525 filter_class->visible = gtk_tree_model_filter_real_visible;
526 filter_class->modify = gtk_tree_model_filter_real_modify;
528 /* Properties -- FIXME: disabled translations for now, until I can come up with a
531 g_object_class_install_property (object_class,
533 g_param_spec_object ("child-model",
535 ("The model for the filtermodel to filter"),
537 GTK_PARAM_READWRITE | G_PARAM_CONSTRUCT_ONLY));
539 g_object_class_install_property (object_class,
541 g_param_spec_boxed ("virtual-root",
542 ("The virtual root"),
543 ("The virtual root (relative to the child model) for this filtermodel"),
545 GTK_PARAM_READWRITE | G_PARAM_CONSTRUCT_ONLY));
547 g_type_class_add_private (object_class, sizeof (GtkTreeModelFilterPrivate));
551 gtk_tree_model_filter_tree_model_init (GtkTreeModelIface *iface)
553 iface->get_flags = gtk_tree_model_filter_get_flags;
554 iface->get_n_columns = gtk_tree_model_filter_get_n_columns;
555 iface->get_column_type = gtk_tree_model_filter_get_column_type;
556 iface->get_iter = gtk_tree_model_filter_get_iter;
557 iface->get_path = gtk_tree_model_filter_get_path;
558 iface->get_value = gtk_tree_model_filter_get_value;
559 iface->iter_next = gtk_tree_model_filter_iter_next;
560 iface->iter_previous = gtk_tree_model_filter_iter_previous;
561 iface->iter_children = gtk_tree_model_filter_iter_children;
562 iface->iter_has_child = gtk_tree_model_filter_iter_has_child;
563 iface->iter_n_children = gtk_tree_model_filter_iter_n_children;
564 iface->iter_nth_child = gtk_tree_model_filter_iter_nth_child;
565 iface->iter_parent = gtk_tree_model_filter_iter_parent;
566 iface->ref_node = gtk_tree_model_filter_ref_node;
567 iface->unref_node = gtk_tree_model_filter_unref_node;
571 gtk_tree_model_filter_drag_source_init (GtkTreeDragSourceIface *iface)
573 iface->row_draggable = gtk_tree_model_filter_row_draggable;
574 iface->drag_data_delete = gtk_tree_model_filter_drag_data_delete;
575 iface->drag_data_get = gtk_tree_model_filter_drag_data_get;
580 gtk_tree_model_filter_finalize (GObject *object)
582 GtkTreeModelFilter *filter = (GtkTreeModelFilter *) object;
584 if (filter->priv->virtual_root && !filter->priv->virtual_root_deleted)
586 gtk_tree_model_filter_unref_path (filter, filter->priv->virtual_root,
588 filter->priv->virtual_root_deleted = TRUE;
591 gtk_tree_model_filter_set_model (filter, NULL);
593 if (filter->priv->virtual_root)
594 gtk_tree_path_free (filter->priv->virtual_root);
596 if (filter->priv->root)
597 gtk_tree_model_filter_free_level (filter, filter->priv->root, TRUE);
599 g_free (filter->priv->modify_types);
601 if (filter->priv->modify_destroy)
602 filter->priv->modify_destroy (filter->priv->modify_data);
604 if (filter->priv->visible_destroy)
605 filter->priv->visible_destroy (filter->priv->visible_data);
608 G_OBJECT_CLASS (gtk_tree_model_filter_parent_class)->finalize (object);
612 gtk_tree_model_filter_set_property (GObject *object,
617 GtkTreeModelFilter *filter = GTK_TREE_MODEL_FILTER (object);
621 case PROP_CHILD_MODEL:
622 gtk_tree_model_filter_set_model (filter, g_value_get_object (value));
624 case PROP_VIRTUAL_ROOT:
625 gtk_tree_model_filter_set_root (filter, g_value_get_boxed (value));
628 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
634 gtk_tree_model_filter_get_property (GObject *object,
639 GtkTreeModelFilter *filter = GTK_TREE_MODEL_FILTER (object);
643 case PROP_CHILD_MODEL:
644 g_value_set_object (value, filter->priv->child_model);
646 case PROP_VIRTUAL_ROOT:
647 g_value_set_boxed (value, filter->priv->virtual_root);
650 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
658 filter_elt_new (void)
660 return g_slice_new (FilterElt);
664 filter_elt_free (gpointer elt)
666 g_slice_free (FilterElt, elt);
670 filter_elt_cmp (gconstpointer a,
674 const FilterElt *elt_a = a;
675 const FilterElt *elt_b = b;
677 if (elt_a->offset > elt_b->offset)
679 else if (elt_a->offset < elt_b->offset)
686 lookup_elt_with_offset (GSequence *seq,
688 GSequenceIter **ret_siter)
690 GSequenceIter *siter;
693 dummy.offset = offset;
694 siter = g_sequence_lookup (seq, &dummy, filter_elt_cmp, NULL);
699 return GET_ELT (siter);
703 increase_offset_iter (gpointer data,
706 FilterElt *elt = data;
707 gint offset = GPOINTER_TO_INT (user_data);
709 if (elt->offset >= offset)
714 decrease_offset_iter (gpointer data,
717 FilterElt *elt = data;
718 gint offset = GPOINTER_TO_INT (user_data);
720 if (elt->offset > offset)
725 gtk_tree_model_filter_build_level (GtkTreeModelFilter *filter,
726 FilterLevel *parent_level,
727 FilterElt *parent_elt,
728 gboolean emit_inserted)
731 GtkTreeIter first_node;
733 FilterLevel *new_level;
734 FilterLevel *tmp_level;
739 gboolean empty = TRUE;
741 g_assert (filter->priv->child_model != NULL);
743 /* Avoid building a level that already exists */
745 g_assert (parent_elt->children == NULL);
747 g_assert (filter->priv->root == NULL);
749 if (filter->priv->in_row_deleted)
754 if (filter->priv->virtual_root)
756 if (gtk_tree_model_get_iter (filter->priv->child_model, &root, filter->priv->virtual_root) == FALSE)
758 length = gtk_tree_model_iter_n_children (filter->priv->child_model, &root);
760 if (gtk_tree_model_iter_children (filter->priv->child_model, &iter, &root) == FALSE)
765 if (!gtk_tree_model_get_iter_first (filter->priv->child_model, &iter))
767 length = gtk_tree_model_iter_n_children (filter->priv->child_model, NULL);
772 GtkTreeIter parent_iter;
773 GtkTreeIter child_parent_iter;
775 parent_iter.stamp = filter->priv->stamp;
776 parent_iter.user_data = parent_level;
777 parent_iter.user_data2 = parent_elt;
779 gtk_tree_model_filter_convert_iter_to_child_iter (filter,
782 if (gtk_tree_model_iter_children (filter->priv->child_model, &iter, &child_parent_iter) == FALSE)
785 /* stamp may have changed */
786 gtk_tree_model_filter_convert_iter_to_child_iter (filter,
789 length = gtk_tree_model_iter_n_children (filter->priv->child_model, &child_parent_iter);
791 /* Take a reference on the parent */
792 gtk_tree_model_filter_real_ref_node (GTK_TREE_MODEL (filter),
793 &parent_iter, FALSE);
796 g_return_if_fail (length > 0);
798 new_level = g_new (FilterLevel, 1);
799 new_level->seq = g_sequence_new (filter_elt_free);
800 new_level->visible_seq = g_sequence_new (NULL);
801 new_level->ref_count = 0;
802 new_level->ext_ref_count = 0;
803 new_level->parent_elt = parent_elt;
804 new_level->parent_level = parent_level;
807 parent_elt->children = new_level;
809 filter->priv->root = new_level;
811 /* increase the count of zero ref_counts */
812 tmp_level = parent_level;
813 tmp_elt = parent_elt;
817 tmp_elt->zero_ref_count++;
819 tmp_elt = tmp_level->parent_elt;
820 tmp_level = tmp_level->parent_level;
822 if (new_level != filter->priv->root)
823 filter->priv->zero_ref_count++;
831 if (gtk_tree_model_filter_visible (filter, &iter))
833 FilterElt *filter_elt;
835 filter_elt = filter_elt_new ();
836 filter_elt->offset = i;
837 filter_elt->zero_ref_count = 0;
838 filter_elt->ref_count = 0;
839 filter_elt->ext_ref_count = 0;
840 filter_elt->children = NULL;
841 filter_elt->visible_siter = NULL;
843 if (GTK_TREE_MODEL_FILTER_CACHE_CHILD_ITERS (filter))
844 filter_elt->iter = iter;
846 g_sequence_append (new_level->seq, filter_elt);
847 filter_elt->visible_siter = g_sequence_append (new_level->visible_seq, filter_elt);
854 GtkTreeIter children;
856 f_iter.stamp = filter->priv->stamp;
857 f_iter.user_data = new_level;
858 f_iter.user_data2 = filter_elt;
860 f_path = gtk_tree_model_get_path (GTK_TREE_MODEL (filter),
862 gtk_tree_model_row_inserted (GTK_TREE_MODEL (filter),
864 gtk_tree_path_free (f_path);
866 if (gtk_tree_model_iter_children (filter->priv->child_model,
868 gtk_tree_model_filter_update_children (filter,
870 FILTER_ELT (f_iter.user_data2));
875 while (gtk_tree_model_iter_next (filter->priv->child_model, &iter));
877 /* The level does not contain any visible nodes. However, changes in
878 * this level might affect the parent node, which can either be visible
879 * or invisible. Therefore, this level can only be removed again,
880 * if the parent of the parent node is not visible. In that case,
881 * possible changes in state of the parent are not requested.
884 (parent_level && parent_elt->ext_ref_count == 0))
886 gtk_tree_model_filter_free_level (filter, new_level, FALSE);
890 /* If none of the nodes are visible, we will just pull in the
891 * first node of the level.
895 FilterElt *filter_elt;
897 filter_elt = filter_elt_new ();
898 filter_elt->offset = 0;
899 filter_elt->zero_ref_count = 0;
900 filter_elt->ref_count = 0;
901 filter_elt->ext_ref_count = 0;
902 filter_elt->children = NULL;
903 filter_elt->visible_siter = NULL;
905 if (GTK_TREE_MODEL_FILTER_CACHE_CHILD_ITERS (filter))
906 filter_elt->iter = first_node;
908 g_sequence_append (new_level->seq, filter_elt);
911 /* Keep a reference on the first node of this level. We need this
912 * to make sure that we get all signals for this level.
914 f_iter.stamp = filter->priv->stamp;
915 f_iter.user_data = new_level;
916 f_iter.user_data2 = g_sequence_get (g_sequence_get_begin_iter (new_level->seq));
918 gtk_tree_model_filter_real_ref_node (GTK_TREE_MODEL (filter), &f_iter,
923 gtk_tree_model_filter_free_level (GtkTreeModelFilter *filter,
924 FilterLevel *filter_level,
927 GSequenceIter *siter;
928 GSequenceIter *end_siter;
930 g_assert (filter_level);
932 end_siter = g_sequence_get_end_iter (filter_level->seq);
933 for (siter = g_sequence_get_begin_iter (filter_level->seq);
935 siter = g_sequence_iter_next (siter))
937 FilterElt *elt = g_sequence_get (siter);
940 gtk_tree_model_filter_free_level (filter,
941 FILTER_LEVEL (elt->children),
945 /* Release the reference on the first item.
951 f_iter.stamp = filter->priv->stamp;
952 f_iter.user_data = filter_level;
953 f_iter.user_data2 = g_sequence_get (g_sequence_get_begin_iter (filter_level->seq));
955 gtk_tree_model_filter_real_unref_node (GTK_TREE_MODEL (filter),
956 &f_iter, FALSE, TRUE);
959 if (filter_level->ext_ref_count == 0)
961 FilterLevel *parent_level = filter_level->parent_level;
962 FilterElt *parent_elt = filter_level->parent_elt;
966 parent_elt->zero_ref_count--;
968 parent_elt = parent_level->parent_elt;
969 parent_level = parent_level->parent_level;
972 if (filter_level != filter->priv->root)
973 filter->priv->zero_ref_count--;
976 if (filter_level->parent_elt)
978 /* Release reference on parent */
981 GtkTreeIter parent_iter;
983 parent_iter.stamp = filter->priv->stamp;
984 parent_iter.user_data = filter_level->parent_level;
985 parent_iter.user_data2 = filter_level->parent_elt;
987 gtk_tree_model_filter_real_unref_node (GTK_TREE_MODEL (filter),
988 &parent_iter, FALSE, TRUE);
991 filter_level->parent_elt->children = NULL;
994 filter->priv->root = NULL;
996 g_sequence_free (filter_level->seq);
997 g_sequence_free (filter_level->visible_seq);
998 g_free (filter_level);
1002 gtk_tree_model_filter_level_transfer_first_ref (GtkTreeModelFilter *filter,
1004 GSequenceIter *from_iter,
1005 GSequenceIter *to_iter)
1009 f_iter.stamp = filter->priv->stamp;
1010 f_iter.user_data = level;
1011 f_iter.user_data2 = g_sequence_get (to_iter);
1013 gtk_tree_model_filter_real_ref_node (GTK_TREE_MODEL (filter),
1016 f_iter.stamp = filter->priv->stamp;
1017 f_iter.user_data = level;
1018 f_iter.user_data2 = g_sequence_get (from_iter);
1020 gtk_tree_model_filter_real_unref_node (GTK_TREE_MODEL (filter),
1021 &f_iter, FALSE, TRUE);
1025 gtk_tree_model_filter_level_transfer_first_ref_with_index (GtkTreeModelFilter *filter,
1030 gtk_tree_model_filter_level_transfer_first_ref (filter, level,
1031 g_sequence_get_iter_at_pos (level->seq, from_index),
1032 g_sequence_get_iter_at_pos (level->seq, to_index));
1035 /* Creates paths suitable for accessing the child model. */
1036 static GtkTreePath *
1037 gtk_tree_model_filter_elt_get_path (FilterLevel *level,
1041 FilterLevel *walker = level;
1042 FilterElt *walker2 = elt;
1044 GtkTreePath *real_path;
1046 g_return_val_if_fail (level != NULL, NULL);
1047 g_return_val_if_fail (elt != NULL, NULL);
1049 path = gtk_tree_path_new ();
1053 gtk_tree_path_prepend_index (path, walker2->offset);
1055 walker2 = walker->parent_elt;
1056 walker = walker->parent_level;
1061 real_path = gtk_tree_model_filter_add_root (path, root);
1062 gtk_tree_path_free (path);
1069 static GtkTreePath *
1070 gtk_tree_model_filter_add_root (GtkTreePath *src,
1073 GtkTreePath *retval;
1076 retval = gtk_tree_path_copy (root);
1078 for (i = 0; i < gtk_tree_path_get_depth (src); i++)
1079 gtk_tree_path_append_index (retval, gtk_tree_path_get_indices (src)[i]);
1084 static GtkTreePath *
1085 gtk_tree_model_filter_remove_root (GtkTreePath *src,
1088 GtkTreePath *retval;
1093 if (gtk_tree_path_get_depth (src) <= gtk_tree_path_get_depth (root))
1096 depth = gtk_tree_path_get_depth (src);
1097 indices = gtk_tree_path_get_indices (src);
1099 for (i = 0; i < gtk_tree_path_get_depth (root); i++)
1100 if (indices[i] != gtk_tree_path_get_indices (root)[i])
1103 retval = gtk_tree_path_new ();
1105 for (; i < depth; i++)
1106 gtk_tree_path_append_index (retval, indices[i]);
1112 gtk_tree_model_filter_increment_stamp (GtkTreeModelFilter *filter)
1116 filter->priv->stamp++;
1118 while (filter->priv->stamp == 0);
1120 gtk_tree_model_filter_clear_cache (filter);
1124 gtk_tree_model_filter_real_visible (GtkTreeModelFilter *filter,
1125 GtkTreeModel *child_model,
1126 GtkTreeIter *child_iter)
1128 if (filter->priv->visible_func)
1130 return filter->priv->visible_func (child_model,
1132 filter->priv->visible_data)
1135 else if (filter->priv->visible_column >= 0)
1139 gtk_tree_model_get_value (child_model, child_iter,
1140 filter->priv->visible_column, &val);
1142 if (g_value_get_boolean (&val))
1144 g_value_unset (&val);
1148 g_value_unset (&val);
1152 /* no visible function set, so always visible */
1157 gtk_tree_model_filter_visible (GtkTreeModelFilter *self,
1158 GtkTreeIter *child_iter)
1160 return GTK_TREE_MODEL_FILTER_GET_CLASS (self)->visible (self,
1161 self->priv->child_model, child_iter);
1165 gtk_tree_model_filter_clear_cache_helper_iter (gpointer data,
1168 GtkTreeModelFilter *filter = user_data;
1169 FilterElt *elt = data;
1171 if (elt->zero_ref_count > 0)
1172 gtk_tree_model_filter_clear_cache_helper (filter, elt->children);
1176 gtk_tree_model_filter_clear_cache_helper (GtkTreeModelFilter *filter,
1181 g_sequence_foreach (level->seq, gtk_tree_model_filter_clear_cache_helper_iter, filter);
1183 /* If the level's ext_ref_count is zero, it means the level is not visible
1184 * and can be removed. But, since we support monitoring a child level
1185 * of a parent for changes (these might affect the parent), we will only
1186 * free the level if the parent's parent also has an external ref
1187 * count of zero. In that case, changes concerning our parent are
1190 if (level->ext_ref_count == 0 && level != filter->priv->root &&
1191 level->parent_level && level->parent_elt &&
1192 level->parent_elt->ext_ref_count == 0)
1194 gtk_tree_model_filter_free_level (filter, level, TRUE);
1200 gtk_tree_model_filter_elt_is_visible_in_target (FilterLevel *level,
1203 if (!elt->visible_siter)
1206 if (!level->parent_elt)
1211 elt = level->parent_elt;
1212 level = level->parent_level;
1214 if (elt && !elt->visible_siter)
1222 /* If a change has occurred in path (inserted, changed or deleted),
1223 * then this function is used to check all its ancestors. An ancestor
1224 * could have changed state as a result and this needs to be propagated
1225 * to the objects monitoring the filter model.
1228 gtk_tree_model_filter_check_ancestors (GtkTreeModelFilter *filter,
1232 int *indices = gtk_tree_path_get_indices (path);
1235 GtkTreeIter c_iter, tmp_iter;
1237 level = FILTER_LEVEL (filter->priv->root);
1242 if (filter->priv->virtual_root)
1243 gtk_tree_model_get_iter (filter->priv->child_model, &c_iter,
1244 filter->priv->virtual_root);
1247 gtk_tree_model_iter_nth_child (filter->priv->child_model, &c_iter,
1248 filter->priv->virtual_root ? &tmp_iter : NULL,
1251 while (i < gtk_tree_path_get_depth (path) - 1)
1253 gboolean requested_state;
1255 elt = lookup_elt_with_offset (level->seq,
1256 gtk_tree_path_get_indices (path)[i], NULL);
1258 requested_state = gtk_tree_model_filter_visible (filter, &c_iter);
1263 GtkTreePath *c_path;
1265 if (requested_state == FALSE)
1268 /* The elt does not exist in this level (so it is not
1269 * visible), but should now be visible. We emit the
1270 * row-inserted and row-has-child-toggled signals.
1272 elt = gtk_tree_model_filter_insert_elt_in_level (filter,
1278 /* insert_elt_in_level defaults to FALSE */
1279 elt->visible_siter = g_sequence_insert_sorted (level->visible_seq,
1281 filter_elt_cmp, NULL);
1283 c_path = gtk_tree_model_get_path (filter->priv->child_model,
1286 gtk_tree_model_filter_emit_row_inserted_for_path (filter,
1287 filter->priv->child_model,
1291 gtk_tree_path_free (c_path);
1293 /* We can immediately return, because this node was not visible
1294 * before and its children will be checked for in response to
1295 * the emitted row-has-child-toggled signal.
1299 else if (elt->visible_siter)
1301 if (!requested_state)
1303 /* A node has turned invisible. Remove it from the level
1304 * and emit row-deleted. Since this node is being
1305 * deleted. it makes no sense to look further up the
1308 gtk_tree_model_filter_remove_elt_from_level (filter,
1313 /* Otherwise continue up the chain */
1315 else if (!elt->visible_siter)
1317 if (requested_state)
1319 /* A node is already in the cache, but invisible. This
1320 * is usually a node on which a reference is kept by
1321 * the filter model, or a node fetched on the filter's
1322 * request, and thus not shown. Therefore, we will
1323 * not emit row-inserted for this node. Instead,
1324 * we signal to its parent that a change has occurred.
1326 * Exception: root level, in this case, we must emit
1329 if (level->parent_level)
1332 GtkTreePath *f_path;
1334 elt->visible_siter = g_sequence_insert_sorted (level->visible_seq, elt,
1335 filter_elt_cmp, NULL);
1337 f_iter.stamp = filter->priv->stamp;
1338 f_iter.user_data = level->parent_level;
1339 f_iter.user_data2 = level->parent_elt;
1341 f_path = gtk_tree_model_get_path (GTK_TREE_MODEL (filter),
1343 gtk_tree_model_row_has_child_toggled (GTK_TREE_MODEL (filter),
1345 gtk_tree_path_free (f_path);
1349 GtkTreePath *c_path;
1351 elt->visible_siter = g_sequence_insert_sorted (level->visible_seq, elt,
1352 filter_elt_cmp, NULL);
1354 c_path = gtk_tree_model_get_path (filter->priv->child_model,
1357 gtk_tree_model_filter_emit_row_inserted_for_path (filter,
1358 filter->priv->child_model,
1362 gtk_tree_path_free (c_path);
1365 /* We can immediately return, because this node was not visible
1366 * before and the parent will check its children, including
1367 * this node, in response to the emitted row-has-child-toggled
1373 /* Not visible, so no need to continue. */
1379 /* If an elt does not have children, these are not visible.
1380 * Therefore, any signals emitted for these children will
1381 * be ignored, so we do not have to emit them.
1386 level = elt->children;
1390 gtk_tree_model_iter_nth_child (filter->priv->child_model, &c_iter,
1391 &tmp_iter, indices[i]);
1396 gtk_tree_model_filter_insert_elt_in_level (GtkTreeModelFilter *filter,
1397 GtkTreeIter *c_iter,
1403 GSequenceIter *siter;
1405 elt = filter_elt_new ();
1407 if (GTK_TREE_MODEL_FILTER_CACHE_CHILD_ITERS (filter))
1408 elt->iter = *c_iter;
1410 elt->offset = offset;
1411 elt->zero_ref_count = 0;
1413 elt->ext_ref_count = 0;
1414 elt->children = NULL;
1416 /* Because we don't emit row_inserted, the node is invisible and thus
1417 * not inserted in visible_seq
1419 elt->visible_siter = NULL;
1421 siter = g_sequence_insert_sorted (level->seq, elt, filter_elt_cmp, NULL);
1422 *index = g_sequence_iter_get_position (siter);
1424 /* If the insert location is zero, we need to move our reference
1425 * on the old first node to the new first node.
1428 gtk_tree_model_filter_level_transfer_first_ref_with_index (filter, level,
1435 gtk_tree_model_filter_fetch_child (GtkTreeModelFilter *filter,
1441 GtkTreePath *c_path = NULL;
1443 GtkTreePath *c_parent_path = NULL;
1444 GtkTreeIter c_parent_iter;
1446 /* check if child exists and is visible */
1447 if (level->parent_elt)
1450 gtk_tree_model_filter_elt_get_path (level->parent_level,
1452 filter->priv->virtual_root);
1458 if (filter->priv->virtual_root)
1459 c_parent_path = gtk_tree_path_copy (filter->priv->virtual_root);
1461 c_parent_path = NULL;
1466 gtk_tree_model_get_iter (filter->priv->child_model,
1469 len = gtk_tree_model_iter_n_children (filter->priv->child_model,
1472 c_path = gtk_tree_path_copy (c_parent_path);
1473 gtk_tree_path_free (c_parent_path);
1477 len = gtk_tree_model_iter_n_children (filter->priv->child_model, NULL);
1478 c_path = gtk_tree_path_new ();
1481 gtk_tree_path_append_index (c_path, offset);
1482 gtk_tree_model_get_iter (filter->priv->child_model, &c_iter, c_path);
1483 gtk_tree_path_free (c_path);
1485 if (offset >= len || !gtk_tree_model_filter_visible (filter, &c_iter))
1488 return gtk_tree_model_filter_insert_elt_in_level (filter, &c_iter,
1493 /* Note that this function is never called from the row-deleted handler.
1494 * This means that this function is only used for removing elements
1495 * which are still present in the child model. As a result, we must
1496 * take care to properly release the references the filter model has
1497 * on the child model nodes.
1500 gtk_tree_model_filter_remove_elt_from_level (GtkTreeModelFilter *filter,
1505 FilterLevel *parent_level;
1506 gint length, orig_level_ext_ref_count;
1508 GtkTreePath *path = NULL;
1510 gboolean emit_child_toggled = FALSE;
1512 iter.stamp = filter->priv->stamp;
1513 iter.user_data = level;
1514 iter.user_data2 = elt;
1516 path = gtk_tree_model_get_path (GTK_TREE_MODEL (filter), &iter);
1518 parent = level->parent_elt;
1519 parent_level = level->parent_level;
1521 length = g_sequence_get_length (level->seq);
1523 /* We need to know about the level's ext ref count before removal
1526 orig_level_ext_ref_count = level->ext_ref_count;
1528 /* first register the node to be invisible */
1529 g_sequence_remove (elt->visible_siter);
1530 elt->visible_siter = NULL;
1532 /* we distinguish a couple of cases:
1533 * - root level, length > 1: emit row-deleted and remove.
1534 * - root level, length == 1: emit row-deleted and keep in cache.
1535 * - level, length == 1: parent->ext_ref_count > 0: emit row-deleted
1537 * - level, length > 1: emit row-deleted and remove.
1538 * - else, remove level.
1540 * if level != root level and the number of visible nodes is 0 (ie. this
1541 * is the last node to be removed from the level), emit
1542 * row-has-child-toggled.
1545 if (level != filter->priv->root
1546 && g_sequence_get_length (level->visible_seq) == 0
1548 && parent->visible_siter)
1549 emit_child_toggled = TRUE;
1553 GSequenceIter *siter;
1555 /* We emit row-deleted, and remove the node from the cache.
1556 * If it has any children, these will be removed here as well.
1560 gtk_tree_model_filter_free_level (filter, elt->children, TRUE);
1562 /* If the first node is being removed, transfer, the reference */
1563 if (elt == g_sequence_get (g_sequence_get_begin_iter (level->seq)))
1565 gtk_tree_model_filter_level_transfer_first_ref_with_index (filter, level,
1569 while (elt->ext_ref_count > 0)
1570 gtk_tree_model_filter_real_unref_node (GTK_TREE_MODEL (filter),
1571 &iter, TRUE, FALSE);
1572 while (elt->ref_count > 0)
1573 gtk_tree_model_filter_real_unref_node (GTK_TREE_MODEL (filter),
1574 &iter, FALSE, FALSE);
1576 /* remove the node */
1577 lookup_elt_with_offset (level->seq, elt->offset, &siter);
1578 g_sequence_remove (siter);
1580 gtk_tree_model_filter_increment_stamp (filter);
1582 /* Only if the node is in the root level (parent == NULL) or
1583 * the level is visible, a row-deleted signal is necessary.
1585 if (!parent || orig_level_ext_ref_count > 0)
1586 gtk_tree_model_row_deleted (GTK_TREE_MODEL (filter), path);
1588 else if ((length == 1 && parent && parent->ext_ref_count > 0)
1589 || (length == 1 && level == filter->priv->root))
1591 /* We emit row-deleted, but keep the node in the cache and
1592 * referenced. Its children will be removed.
1597 gtk_tree_model_filter_free_level (filter, elt->children, TRUE);
1598 elt->children = NULL;
1601 gtk_tree_model_filter_increment_stamp (filter);
1603 /* Only if the node is in the root level (parent == NULL) or
1604 * the level is visible, a row-deleted signal is necessary.
1606 if (!parent || orig_level_ext_ref_count > 0)
1607 gtk_tree_model_row_deleted (GTK_TREE_MODEL (filter), path);
1611 while (elt->ext_ref_count > 0)
1612 gtk_tree_model_filter_real_unref_node (GTK_TREE_MODEL (filter),
1613 &iter, TRUE, FALSE);
1614 while (elt->ref_count > 0)
1615 gtk_tree_model_filter_real_unref_node (GTK_TREE_MODEL (filter),
1616 &iter, FALSE, FALSE);
1618 /* Blow level away, including any child levels */
1619 gtk_tree_model_filter_free_level (filter, level, TRUE);
1621 gtk_tree_model_filter_increment_stamp (filter);
1623 if (!parent || orig_level_ext_ref_count > 0)
1624 gtk_tree_model_row_deleted (GTK_TREE_MODEL (filter), path);
1627 gtk_tree_path_free (path);
1629 if (emit_child_toggled && parent->ext_ref_count > 0)
1634 piter.stamp = filter->priv->stamp;
1635 piter.user_data = parent_level;
1636 piter.user_data2 = parent;
1638 ppath = gtk_tree_model_get_path (GTK_TREE_MODEL (filter), &piter);
1640 gtk_tree_model_row_has_child_toggled (GTK_TREE_MODEL (filter),
1642 gtk_tree_path_free (ppath);
1646 /* This function is called after the given node has become visible.
1647 * When the node has children, we should build the level and
1648 * take a reference on the first child.
1651 gtk_tree_model_filter_update_children (GtkTreeModelFilter *filter,
1658 if (!elt->visible_siter)
1661 iter.stamp = filter->priv->stamp;
1662 iter.user_data = level;
1663 iter.user_data2 = elt;
1665 gtk_tree_model_filter_convert_iter_to_child_iter (filter, &c_iter, &iter);
1667 if ((!level->parent_level || level->parent_elt->ext_ref_count > 0) &&
1668 gtk_tree_model_iter_has_child (filter->priv->child_model, &c_iter))
1671 gtk_tree_model_filter_build_level (filter, level, elt, FALSE);
1673 if (elt->ext_ref_count > 0 && elt->children &&
1674 g_sequence_get_length (elt->children->seq))
1677 path = gtk_tree_model_get_path (GTK_TREE_MODEL (filter), &iter);
1678 gtk_tree_model_row_has_child_toggled (GTK_TREE_MODEL (filter),
1682 gtk_tree_path_free (path);
1687 /* Path is relative to the child model (this is on search on elt offset)
1688 * but with the virtual root already removed if necesssary.
1691 find_elt_with_offset (GtkTreeModelFilter *filter,
1693 FilterLevel **level_,
1698 FilterLevel *parent_level = NULL;
1699 FilterElt *elt = NULL;
1701 level = FILTER_LEVEL (filter->priv->root);
1703 while (i < gtk_tree_path_get_depth (path))
1708 elt = lookup_elt_with_offset (level->seq,
1709 gtk_tree_path_get_indices (path)[i],
1715 parent_level = level;
1716 level = elt->children;
1721 *level_ = parent_level;
1729 /* TreeModel signals */
1731 gtk_tree_model_filter_emit_row_inserted_for_path (GtkTreeModelFilter *filter,
1732 GtkTreeModel *c_model,
1733 GtkTreePath *c_path,
1734 GtkTreeIter *c_iter)
1739 GtkTreeIter iter, children;
1740 gboolean signals_emitted = FALSE;
1742 if (!filter->priv->root)
1744 /* The root level has not been exposed to the view yet, so we
1745 * need to emit signals for any node that is being inserted.
1747 gtk_tree_model_filter_build_level (filter, NULL, NULL, TRUE);
1749 /* Check if the root level was built. Then child levels
1750 * that matter have also been built (due to update_children,
1751 * which triggers iter_n_children).
1753 if (filter->priv->root &&
1754 g_sequence_get_length (FILTER_LEVEL (filter->priv->root)->visible_seq) > 0)
1755 signals_emitted = TRUE;
1758 gtk_tree_model_filter_increment_stamp (filter);
1760 /* We need to disallow to build new levels, because we are then pulling
1761 * in a child in an invisible level. We only want to find path if it
1762 * is in a visible level (and thus has a parent that is visible).
1764 path = gtk_real_tree_model_filter_convert_child_path_to_path (filter,
1770 /* parent is probably being filtered out */
1773 gtk_tree_model_filter_get_iter_full (GTK_TREE_MODEL (filter), &iter, path);
1775 level = FILTER_LEVEL (iter.user_data);
1776 elt = FILTER_ELT (iter.user_data2);
1778 /* Make sure elt is visible. elt can already be visible in case
1779 * it was pulled in above, so avoid inserted it into visible_seq twice.
1781 if (!elt->visible_siter)
1783 elt->visible_siter = g_sequence_insert_sorted (level->visible_seq,
1784 elt, filter_elt_cmp,
1788 /* Check whether the node and all of its parents are visible */
1789 if (gtk_tree_model_filter_elt_is_visible_in_target (level, elt))
1791 /* visibility changed -- reget path */
1792 gtk_tree_path_free (path);
1793 path = gtk_tree_model_get_path (GTK_TREE_MODEL (filter), &iter);
1795 if (!signals_emitted &&
1796 (!level->parent_level || level->ext_ref_count > 0))
1797 gtk_tree_model_row_inserted (GTK_TREE_MODEL (filter), path, &iter);
1799 if (level->parent_level && level->parent_elt->ext_ref_count > 0 &&
1800 g_sequence_get_length (level->visible_seq) == 1)
1802 /* We know that this is the first visible node in this level, so
1803 * we need to emit row-has-child-toggled on the parent. This
1804 * does not apply to the root level.
1807 gtk_tree_path_up (path);
1808 gtk_tree_model_get_iter (GTK_TREE_MODEL (filter), &iter, path);
1810 gtk_tree_model_row_has_child_toggled (GTK_TREE_MODEL (filter),
1815 if (!signals_emitted
1816 && gtk_tree_model_iter_children (c_model, &children, c_iter))
1817 gtk_tree_model_filter_update_children (filter, level, elt);
1820 gtk_tree_path_free (path);
1824 gtk_tree_model_filter_row_changed (GtkTreeModel *c_model,
1825 GtkTreePath *c_path,
1826 GtkTreeIter *c_iter,
1829 GtkTreeModelFilter *filter = GTK_TREE_MODEL_FILTER (data);
1831 GtkTreeIter children;
1832 GtkTreeIter real_c_iter;
1833 GtkTreePath *path = NULL;
1834 GtkTreePath *real_path = NULL;
1839 gboolean requested_state;
1840 gboolean current_state;
1841 gboolean free_c_path = FALSE;
1843 g_return_if_fail (c_path != NULL || c_iter != NULL);
1847 c_path = gtk_tree_model_get_path (c_model, c_iter);
1851 if (filter->priv->virtual_root)
1852 real_path = gtk_tree_model_filter_remove_root (c_path,
1853 filter->priv->virtual_root);
1855 real_path = gtk_tree_path_copy (c_path);
1858 real_c_iter = *c_iter;
1860 gtk_tree_model_get_iter (c_model, &real_c_iter, c_path);
1862 /* is this node above the virtual root? */
1863 if (filter->priv->virtual_root &&
1864 (gtk_tree_path_get_depth (filter->priv->virtual_root)
1865 >= gtk_tree_path_get_depth (c_path)))
1868 /* what's the requested state? */
1869 requested_state = gtk_tree_model_filter_visible (filter, &real_c_iter);
1871 /* now, let's see whether the item is there */
1872 path = gtk_real_tree_model_filter_convert_child_path_to_path (filter,
1879 gtk_tree_model_filter_get_iter_full (GTK_TREE_MODEL (filter),
1881 current_state = FILTER_ELT (iter.user_data2)->visible_siter != NULL;
1884 current_state = FALSE;
1886 if (current_state == FALSE && requested_state == FALSE)
1887 /* no changes required */
1890 if (current_state == TRUE && requested_state == FALSE)
1892 gtk_tree_model_filter_remove_elt_from_level (filter,
1893 FILTER_LEVEL (iter.user_data),
1894 FILTER_ELT (iter.user_data2));
1897 gtk_tree_model_filter_check_ancestors (filter, real_path);
1902 if (current_state == TRUE && requested_state == TRUE)
1904 /* propagate the signal; also get a path taking only visible
1905 * nodes into account.
1907 gtk_tree_path_free (path);
1908 path = gtk_tree_model_get_path (GTK_TREE_MODEL (filter), &iter);
1910 level = FILTER_LEVEL (iter.user_data);
1911 elt = FILTER_ELT (iter.user_data2);
1913 if (gtk_tree_model_filter_elt_is_visible_in_target (level, elt))
1915 if (level->ext_ref_count > 0)
1916 gtk_tree_model_row_changed (GTK_TREE_MODEL (filter), path, &iter);
1918 /* and update the children */
1919 if (gtk_tree_model_iter_children (c_model, &children, &real_c_iter))
1920 gtk_tree_model_filter_update_children (filter, level, elt);
1924 gtk_tree_model_filter_check_ancestors (filter, real_path);
1929 /* only current == FALSE and requested == TRUE is left,
1932 g_return_if_fail (current_state == FALSE && requested_state == TRUE);
1935 gtk_tree_model_filter_check_ancestors (filter, real_path);
1937 gtk_tree_model_filter_emit_row_inserted_for_path (filter, c_model,
1942 gtk_tree_path_free (path);
1945 gtk_tree_path_free (real_path);
1948 gtk_tree_path_free (c_path);
1952 gtk_tree_model_filter_row_inserted (GtkTreeModel *c_model,
1953 GtkTreePath *c_path,
1954 GtkTreeIter *c_iter,
1957 GtkTreeModelFilter *filter = GTK_TREE_MODEL_FILTER (data);
1958 GtkTreePath *real_path = NULL;
1960 GtkTreeIter real_c_iter;
1962 FilterElt *elt = NULL;
1963 FilterLevel *level = NULL;
1964 FilterLevel *parent_level = NULL;
1965 GSequenceIter *siter;
1970 gboolean free_c_path = FALSE;
1971 gboolean emit_row_inserted = FALSE;
1973 g_return_if_fail (c_path != NULL || c_iter != NULL);
1977 c_path = gtk_tree_model_get_path (c_model, c_iter);
1982 real_c_iter = *c_iter;
1984 gtk_tree_model_get_iter (c_model, &real_c_iter, c_path);
1986 /* the row has already been inserted. so we need to fixup the
1987 * virtual root here first
1989 if (filter->priv->virtual_root)
1991 if (gtk_tree_path_get_depth (filter->priv->virtual_root) >=
1992 gtk_tree_path_get_depth (c_path))
1995 gint *v_indices, *c_indices;
1996 gboolean common_prefix = TRUE;
1998 level = gtk_tree_path_get_depth (c_path) - 1;
1999 v_indices = gtk_tree_path_get_indices (filter->priv->virtual_root);
2000 c_indices = gtk_tree_path_get_indices (c_path);
2002 for (i = 0; i < level; i++)
2003 if (v_indices[i] != c_indices[i])
2005 common_prefix = FALSE;
2009 if (common_prefix && v_indices[level] >= c_indices[level])
2010 (v_indices[level])++;
2014 /* subtract virtual root if necessary */
2015 if (filter->priv->virtual_root)
2017 real_path = gtk_tree_model_filter_remove_root (c_path,
2018 filter->priv->virtual_root);
2024 real_path = gtk_tree_path_copy (c_path);
2026 if (!filter->priv->root)
2028 /* The root level has not been exposed to the view yet, so we
2029 * need to emit signals for any node that is being inserted.
2031 gtk_tree_model_filter_build_level (filter, NULL, NULL, TRUE);
2033 /* Check if the root level was built. Then child levels
2034 * that matter have also been built (due to update_children,
2035 * which triggers iter_n_children).
2037 if (filter->priv->root)
2039 emit_row_inserted = FALSE;
2044 if (gtk_tree_path_get_depth (real_path) - 1 >= 1)
2046 gboolean found = FALSE;
2047 GtkTreePath *parent = gtk_tree_path_copy (real_path);
2048 gtk_tree_path_up (parent);
2050 found = find_elt_with_offset (filter, parent, &parent_level, &elt);
2052 gtk_tree_path_free (parent);
2055 /* Parent is not in the cache and probably being filtered out */
2058 level = elt->children;
2061 level = FILTER_LEVEL (filter->priv->root);
2065 if (elt && elt->visible_siter)
2067 /* The level in which the new node should be inserted does not
2068 * exist, but the parent, elt, does. If elt is visible, emit
2069 * row-has-child-toggled.
2071 GtkTreePath *tmppath;
2072 GtkTreeIter tmpiter;
2074 tmpiter.stamp = filter->priv->stamp;
2075 tmpiter.user_data = parent_level;
2076 tmpiter.user_data2 = elt;
2078 tmppath = gtk_tree_model_get_path (GTK_TREE_MODEL (filter),
2083 gtk_tree_model_row_has_child_toggled (GTK_TREE_MODEL (filter),
2085 gtk_tree_path_free (tmppath);
2091 /* let's try to insert the value */
2092 offset = gtk_tree_path_get_indices (real_path)[gtk_tree_path_get_depth (real_path) - 1];
2094 /* update the offsets, yes if we didn't insert the node above, there will
2095 * be a gap here. This will be filled with the node (via fetch_child) when
2096 * it becomes visible
2098 dummy.offset = offset;
2099 siter = g_sequence_search (level->seq, &dummy, filter_elt_cmp, NULL);
2100 siter = g_sequence_iter_prev (siter);
2101 g_sequence_foreach_range (siter, g_sequence_get_end_iter (level->seq),
2102 increase_offset_iter, GINT_TO_POINTER (offset));
2104 /* only insert when visible */
2105 if (gtk_tree_model_filter_visible (filter, &real_c_iter))
2109 felt = gtk_tree_model_filter_insert_elt_in_level (filter,
2114 /* insert_elt_in_level defaults to FALSE */
2115 felt->visible_siter = g_sequence_insert_sorted (level->visible_seq,
2117 filter_elt_cmp, NULL);
2118 emit_row_inserted = TRUE;
2122 gtk_tree_model_filter_check_ancestors (filter, real_path);
2124 if (emit_row_inserted)
2125 gtk_tree_model_filter_emit_row_inserted_for_path (filter, c_model,
2129 gtk_tree_path_free (real_path);
2132 gtk_tree_path_free (c_path);
2136 gtk_tree_model_filter_row_has_child_toggled (GtkTreeModel *c_model,
2137 GtkTreePath *c_path,
2138 GtkTreeIter *c_iter,
2141 GtkTreeModelFilter *filter = GTK_TREE_MODEL_FILTER (data);
2146 gboolean requested_state;
2148 g_return_if_fail (c_path != NULL && c_iter != NULL);
2150 /* If we get row-has-child-toggled on the virtual root, and there is
2151 * no root level; try to build it now.
2153 if (filter->priv->virtual_root && !filter->priv->root
2154 && !gtk_tree_path_compare (c_path, filter->priv->virtual_root))
2156 gtk_tree_model_filter_build_level (filter, NULL, NULL, TRUE);
2160 /* For all other levels, there is a chance that the visibility state
2161 * of the parent has changed now.
2164 path = gtk_real_tree_model_filter_convert_child_path_to_path (filter,
2171 gtk_tree_model_filter_get_iter_full (GTK_TREE_MODEL (data), &iter, path);
2173 level = FILTER_LEVEL (iter.user_data);
2174 elt = FILTER_ELT (iter.user_data2);
2176 gtk_tree_path_free (path);
2178 requested_state = gtk_tree_model_filter_visible (filter, c_iter);
2180 if (!elt->visible_siter && !requested_state)
2182 /* The parent node currently is not visible and will not become
2183 * visible, so we will not pass on the row-has-child-toggled event.
2187 else if (elt->visible_siter && !requested_state)
2189 /* The node is no longer visible, so it has to be removed.
2190 * _remove_elt_from_level() takes care of emitting row-has-child-toggled
2193 gtk_tree_model_filter_remove_elt_from_level (filter, level, elt);
2197 else if (!elt->visible_siter && requested_state)
2199 elt->visible_siter = g_sequence_insert_sorted (level->visible_seq,
2200 elt, filter_elt_cmp,
2203 /* Only insert if the parent is visible in the target */
2204 if (gtk_tree_model_filter_elt_is_visible_in_target (level, elt))
2206 path = gtk_tree_model_get_path (GTK_TREE_MODEL (filter), &iter);
2207 gtk_tree_model_row_inserted (GTK_TREE_MODEL (filter), path, &iter);
2208 gtk_tree_path_free (path);
2210 /* We do not update children now, because that will happen
2215 /* For the remaining possibility, elt->visible && requested_state
2216 * no action is required.
2219 /* If this node is referenced and has children, build the level so we
2220 * can monitor it for changes.
2222 if (elt->ref_count > 1 && !elt->children &&
2223 gtk_tree_model_iter_has_child (c_model, c_iter))
2224 gtk_tree_model_filter_build_level (filter, level, elt, FALSE);
2226 /* get a path taking only visible nodes into account */
2227 path = gtk_tree_model_get_path (GTK_TREE_MODEL (data), &iter);
2228 gtk_tree_model_row_has_child_toggled (GTK_TREE_MODEL (data), path, &iter);
2229 gtk_tree_path_free (path);
2233 gtk_tree_model_filter_virtual_root_deleted (GtkTreeModelFilter *filter,
2234 GtkTreePath *c_path)
2238 FilterLevel *level = FILTER_LEVEL (filter->priv->root);
2240 /* The virtual root (or one of its ancestors) has been deleted. This
2241 * means that all content for our model is now gone. We deal with
2242 * this by removing everything in the filter model: we just iterate
2243 * over the root level and emit a row-deleted for each FilterElt.
2244 * (FIXME: Should we emit row-deleted for child nodes as well? This
2245 * has never been fully clear in TreeModel).
2248 /* We unref the path of the virtual root, up to and not including the
2249 * deleted node which can no longer be unreffed.
2251 gtk_tree_model_filter_unref_path (filter, filter->priv->virtual_root,
2252 gtk_tree_path_get_depth (c_path) - 1);
2253 filter->priv->virtual_root_deleted = TRUE;
2258 nodes = g_sequence_get_length (level->visible_seq);
2260 /* We should not propagate the unref here. An unref for any of these
2261 * nodes will fail, since the respective nodes in the child model are
2264 gtk_tree_model_filter_free_level (filter, filter->priv->root, FALSE);
2266 gtk_tree_model_filter_increment_stamp (filter);
2268 path = gtk_tree_path_new ();
2269 gtk_tree_path_append_index (path, 0);
2271 for (i = 0; i < nodes; i++)
2272 gtk_tree_model_row_deleted (GTK_TREE_MODEL (filter), path);
2274 gtk_tree_path_free (path);
2278 gtk_tree_model_filter_adjust_virtual_root (GtkTreeModelFilter *filter,
2279 GtkTreePath *c_path)
2283 gint *v_indices, *c_indices;
2284 gboolean common_prefix = TRUE;
2286 level = gtk_tree_path_get_depth (c_path) - 1;
2287 v_indices = gtk_tree_path_get_indices (filter->priv->virtual_root);
2288 c_indices = gtk_tree_path_get_indices (c_path);
2290 for (i = 0; i < level; i++)
2291 if (v_indices[i] != c_indices[i])
2293 common_prefix = FALSE;
2297 if (common_prefix && v_indices[level] > c_indices[level])
2298 (v_indices[level])--;
2302 gtk_tree_model_filter_row_deleted_invisible_node (GtkTreeModelFilter *filter,
2303 GtkTreePath *c_path)
2306 GtkTreePath *real_path;
2310 GSequenceIter *siter;
2312 /* The node deleted in the child model is not visible in the
2313 * filter model. We will not emit a signal, just fixup the offsets
2314 * of the other nodes.
2317 if (!filter->priv->root)
2320 level = FILTER_LEVEL (filter->priv->root);
2322 /* subtract vroot if necessary */
2323 if (filter->priv->virtual_root)
2325 real_path = gtk_tree_model_filter_remove_root (c_path,
2326 filter->priv->virtual_root);
2327 /* we don't handle this */
2332 real_path = gtk_tree_path_copy (c_path);
2334 if (gtk_tree_path_get_depth (real_path) - 1 >= 1)
2336 gboolean found = FALSE;
2337 GtkTreePath *parent = gtk_tree_path_copy (real_path);
2338 gtk_tree_path_up (parent);
2340 found = find_elt_with_offset (filter, parent, &level, &elt);
2342 gtk_tree_path_free (parent);
2346 /* parent is filtered out, so no level */
2347 gtk_tree_path_free (real_path);
2351 level = elt->children;
2354 offset = gtk_tree_path_get_indices (real_path)[gtk_tree_path_get_depth (real_path) - 1];
2355 gtk_tree_path_free (real_path);
2360 /* decrease offset of all nodes following the deleted node */
2361 dummy.offset = offset;
2362 siter = g_sequence_search (level->seq, &dummy, filter_elt_cmp, NULL);
2363 g_sequence_foreach_range (siter, g_sequence_get_end_iter (level->seq),
2364 decrease_offset_iter, GINT_TO_POINTER (offset));
2368 gtk_tree_model_filter_row_deleted (GtkTreeModel *c_model,
2369 GtkTreePath *c_path,
2372 GtkTreeModelFilter *filter = GTK_TREE_MODEL_FILTER (data);
2375 FilterElt *elt, *parent_elt = NULL;
2376 FilterLevel *level, *parent_level = NULL;
2377 GSequenceIter *siter;
2378 gboolean emit_child_toggled = FALSE;
2379 gboolean emit_row_deleted = FALSE;
2381 gint orig_level_ext_ref_count;
2383 g_return_if_fail (c_path != NULL);
2385 /* special case the deletion of an ancestor of the virtual root */
2386 if (filter->priv->virtual_root &&
2387 (gtk_tree_path_is_ancestor (c_path, filter->priv->virtual_root) ||
2388 !gtk_tree_path_compare (c_path, filter->priv->virtual_root)))
2390 gtk_tree_model_filter_virtual_root_deleted (filter, c_path);
2394 /* adjust the virtual root for the deleted row */
2395 if (filter->priv->virtual_root &&
2396 gtk_tree_path_get_depth (filter->priv->virtual_root) >=
2397 gtk_tree_path_get_depth (c_path))
2398 gtk_tree_model_filter_adjust_virtual_root (filter, c_path);
2400 path = gtk_real_tree_model_filter_convert_child_path_to_path (filter,
2407 gtk_tree_model_filter_row_deleted_invisible_node (filter, c_path);
2411 /* a node was deleted, which was in our cache */
2412 gtk_tree_model_filter_get_iter_full (GTK_TREE_MODEL (data), &iter, path);
2414 level = FILTER_LEVEL (iter.user_data);
2415 elt = FILTER_ELT (iter.user_data2);
2416 offset = elt->offset;
2417 orig_level_ext_ref_count = level->ext_ref_count;
2419 if (elt->visible_siter)
2421 /* get a path taking only visible nodes into account */
2422 gtk_tree_path_free (path);
2423 path = gtk_tree_model_get_path (GTK_TREE_MODEL (filter), &iter);
2425 if (g_sequence_get_length (level->visible_seq) == 1)
2427 emit_child_toggled = TRUE;
2428 parent_level = level->parent_level;
2429 parent_elt = level->parent_elt;
2432 emit_row_deleted = TRUE;
2435 /* Release the references on this node, without propagation because
2436 * the node does not exist anymore in the child model. The filter
2437 * model's references on the node in case of level->parent or use
2438 * of a virtual root are automatically destroyed by the child model.
2440 while (elt->ext_ref_count > 0)
2441 gtk_tree_model_filter_real_unref_node (GTK_TREE_MODEL (data), &iter,
2443 while (elt->ref_count > 0)
2444 gtk_tree_model_filter_real_unref_node (GTK_TREE_MODEL (data), &iter,
2447 if (g_sequence_get_length (level->seq) == 1)
2450 gtk_tree_model_filter_free_level (filter, level, FALSE);
2457 lookup_elt_with_offset (level->seq, elt->offset, &siter);
2458 is_first = g_sequence_get_begin_iter (level->seq) == siter;
2460 /* remove the row */
2461 g_sequence_remove (elt->visible_siter);
2462 tmp = g_sequence_iter_next (siter);
2463 g_sequence_remove (siter);
2464 g_sequence_foreach_range (tmp, g_sequence_get_end_iter (level->seq),
2465 decrease_offset_iter, GINT_TO_POINTER (offset));
2467 /* Take a reference on the new first node. The first node previously
2468 * keeping this reference has been removed above.
2474 f_iter.stamp = filter->priv->stamp;
2475 f_iter.user_data = level;
2476 f_iter.user_data2 = g_sequence_get (g_sequence_get_begin_iter (level->seq));
2478 gtk_tree_model_filter_real_ref_node (GTK_TREE_MODEL (filter),
2483 if (emit_row_deleted)
2485 /* emit row_deleted */
2486 gtk_tree_model_filter_increment_stamp (filter);
2488 if (!parent_elt || orig_level_ext_ref_count > 0)
2489 gtk_tree_model_row_deleted (GTK_TREE_MODEL (data), path);
2492 if (emit_child_toggled && parent_level)
2497 iter2.stamp = filter->priv->stamp;
2498 iter2.user_data = parent_level;
2499 iter2.user_data2 = parent_elt;
2501 /* We set in_row_deleted to TRUE to avoid a level build triggered
2502 * by row-has-child-toggled (parent model could call iter_has_child
2505 filter->priv->in_row_deleted = TRUE;
2506 path2 = gtk_tree_model_get_path (GTK_TREE_MODEL (filter), &iter2);
2507 gtk_tree_model_row_has_child_toggled (GTK_TREE_MODEL (filter),
2509 gtk_tree_path_free (path2);
2510 filter->priv->in_row_deleted = FALSE;
2513 if (filter->priv->virtual_root)
2515 GtkTreePath *real_path;
2517 real_path = gtk_tree_model_filter_remove_root (c_path,
2518 filter->priv->root);
2521 gtk_tree_model_filter_check_ancestors (filter, real_path);
2522 gtk_tree_path_free (real_path);
2526 gtk_tree_model_filter_check_ancestors (filter, c_path);
2528 gtk_tree_path_free (path);
2532 gtk_tree_model_filter_rows_reordered (GtkTreeModel *c_model,
2533 GtkTreePath *c_path,
2534 GtkTreeIter *c_iter,
2540 GtkTreeModelFilter *filter = GTK_TREE_MODEL_FILTER (data);
2546 GSequenceIter *tmp_end_iter;
2547 GSequenceIter *old_first_elt = NULL;
2552 g_return_if_fail (new_order != NULL);
2554 if (c_path == NULL || gtk_tree_path_get_depth (c_path) == 0)
2556 length = gtk_tree_model_iter_n_children (c_model, NULL);
2558 if (filter->priv->virtual_root)
2562 /* reorder root level of path */
2563 for (i = 0; i < length; i++)
2564 if (new_order[i] == gtk_tree_path_get_indices (filter->priv->virtual_root)[0])
2570 gtk_tree_path_get_indices (filter->priv->virtual_root)[0] = new_pos;
2574 path = gtk_tree_path_new ();
2575 level = FILTER_LEVEL (filter->priv->root);
2579 GtkTreeIter child_iter;
2581 /* virtual root anchor reordering */
2582 if (filter->priv->virtual_root &&
2583 gtk_tree_path_is_ancestor (c_path, filter->priv->virtual_root))
2588 GtkTreeIter real_c_iter;
2590 level = gtk_tree_path_get_depth (c_path);
2593 real_c_iter = *c_iter;
2595 gtk_tree_model_get_iter (c_model, &real_c_iter, c_path);
2597 length = gtk_tree_model_iter_n_children (c_model, &real_c_iter);
2599 for (i = 0; i < length; i++)
2600 if (new_order[i] == gtk_tree_path_get_indices (filter->priv->virtual_root)[level])
2606 gtk_tree_path_get_indices (filter->priv->virtual_root)[level] = new_pos;
2610 path = gtk_real_tree_model_filter_convert_child_path_to_path (filter,
2615 if (!path && filter->priv->virtual_root &&
2616 gtk_tree_path_compare (c_path, filter->priv->virtual_root))
2619 if (!path && !filter->priv->virtual_root)
2624 /* root level mode */
2626 gtk_tree_model_get_iter (c_model, c_iter, c_path);
2627 length = gtk_tree_model_iter_n_children (c_model, c_iter);
2628 path = gtk_tree_path_new ();
2629 level = FILTER_LEVEL (filter->priv->root);
2633 gtk_tree_model_filter_get_iter_full (GTK_TREE_MODEL (data),
2636 elt = FILTER_ELT (iter.user_data2);
2640 gtk_tree_path_free (path);
2644 level = elt->children;
2646 gtk_tree_model_filter_convert_iter_to_child_iter (GTK_TREE_MODEL_FILTER (filter), &child_iter, &iter);
2647 length = gtk_tree_model_iter_n_children (c_model, &child_iter);
2651 if (!level || g_sequence_get_length (level->seq) < 1)
2653 gtk_tree_path_free (path);
2657 /* NOTE: we do not bail out here if level->seq->len < 2 like
2658 * GtkTreeModelSort does. This because we do some special tricky
2662 tmp_seq = g_sequence_new (filter_elt_free);
2663 tmp_end_iter = g_sequence_get_end_iter (tmp_seq);
2664 tmp_array = g_new (gint, g_sequence_get_length (level->visible_seq));
2667 for (i = 0; i < length; i++)
2670 GSequenceIter *siter;
2672 elt = lookup_elt_with_offset (level->seq, new_order[i], &siter);
2676 /* Keep a reference if this elt has old_pos == 0 */
2677 if (new_order[i] == 0)
2678 old_first_elt = siter;
2680 /* Only for visible items an entry should be present in the order array
2683 if (elt->visible_siter)
2684 tmp_array[elt_count++] = g_sequence_iter_get_position (elt->visible_siter);
2686 /* Steal elt from level->seq and append it to tmp_seq */
2687 g_sequence_move (siter, tmp_end_iter);
2691 g_warn_if_fail (g_sequence_get_length (level->seq) == 0);
2692 g_sequence_free (level->seq);
2693 level->seq = tmp_seq;
2694 g_sequence_sort (level->visible_seq, filter_elt_cmp, NULL);
2696 /* Transfer the reference from the old item at position 0 to the
2697 * new item at position 0.
2699 if (old_first_elt && g_sequence_iter_get_position (old_first_elt))
2700 gtk_tree_model_filter_level_transfer_first_ref (filter,
2703 g_sequence_get_iter_at_pos (level->seq, 0));
2706 /* emit rows_reordered */
2707 if (g_sequence_get_length (level->visible_seq) > 0)
2709 if (!gtk_tree_path_get_indices (path))
2710 gtk_tree_model_rows_reordered (GTK_TREE_MODEL (data), path, NULL,
2714 /* get a path taking only visible nodes into account */
2715 gtk_tree_path_free (path);
2716 path = gtk_tree_model_get_path (GTK_TREE_MODEL (data), &iter);
2718 gtk_tree_model_rows_reordered (GTK_TREE_MODEL (data), path, &iter,
2725 gtk_tree_path_free (path);
2728 /* TreeModelIface implementation */
2729 static GtkTreeModelFlags
2730 gtk_tree_model_filter_get_flags (GtkTreeModel *model)
2732 GtkTreeModelFlags flags;
2734 g_return_val_if_fail (GTK_IS_TREE_MODEL_FILTER (model), 0);
2735 g_return_val_if_fail (GTK_TREE_MODEL_FILTER (model)->priv->child_model != NULL, 0);
2737 flags = gtk_tree_model_get_flags (GTK_TREE_MODEL_FILTER (model)->priv->child_model);
2739 if ((flags & GTK_TREE_MODEL_LIST_ONLY) == GTK_TREE_MODEL_LIST_ONLY)
2740 return GTK_TREE_MODEL_LIST_ONLY;
2746 gtk_tree_model_filter_get_n_columns (GtkTreeModel *model)
2748 GtkTreeModelFilter *filter = (GtkTreeModelFilter *)model;
2750 g_return_val_if_fail (GTK_IS_TREE_MODEL_FILTER (model), 0);
2751 g_return_val_if_fail (filter->priv->child_model != NULL, 0);
2753 if (filter->priv->child_model == NULL)
2756 /* so we can't modify the modify func after this ... */
2757 filter->priv->modify_func_set = TRUE;
2759 if (filter->priv->modify_n_columns > 0)
2760 return filter->priv->modify_n_columns;
2762 return gtk_tree_model_get_n_columns (filter->priv->child_model);
2766 gtk_tree_model_filter_get_column_type (GtkTreeModel *model,
2769 GtkTreeModelFilter *filter = (GtkTreeModelFilter *)model;
2771 g_return_val_if_fail (GTK_IS_TREE_MODEL_FILTER (model), G_TYPE_INVALID);
2772 g_return_val_if_fail (filter->priv->child_model != NULL, G_TYPE_INVALID);
2774 /* so we can't modify the modify func after this ... */
2775 filter->priv->modify_func_set = TRUE;
2777 if (filter->priv->modify_types)
2779 g_return_val_if_fail (index < filter->priv->modify_n_columns, G_TYPE_INVALID);
2781 return filter->priv->modify_types[index];
2784 return gtk_tree_model_get_column_type (filter->priv->child_model, index);
2787 /* A special case of _get_iter; this function can also get iters which
2788 * are not visible. These iters should ONLY be passed internally, never
2789 * pass those along with a signal emission.
2792 gtk_tree_model_filter_get_iter_full (GtkTreeModel *model,
2796 GtkTreeModelFilter *filter = (GtkTreeModelFilter *)model;
2801 GSequenceIter *siter;
2803 g_return_val_if_fail (GTK_IS_TREE_MODEL_FILTER (model), FALSE);
2804 g_return_val_if_fail (filter->priv->child_model != NULL, FALSE);
2806 indices = gtk_tree_path_get_indices (path);
2808 if (filter->priv->root == NULL)
2809 gtk_tree_model_filter_build_level (filter, NULL, NULL, FALSE);
2810 level = FILTER_LEVEL (filter->priv->root);
2812 depth = gtk_tree_path_get_depth (path);
2819 for (i = 0; i < depth - 1; i++)
2821 if (!level || indices[i] >= g_sequence_get_length (level->seq))
2827 siter = g_sequence_get_iter_at_pos (level->seq, indices[i]);
2828 if (g_sequence_iter_is_end (siter))
2834 elt = GET_ELT (siter);
2837 gtk_tree_model_filter_build_level (filter, level, elt, FALSE);
2838 level = elt->children;
2841 if (!level || indices[i] >= g_sequence_get_length (level->seq))
2847 iter->stamp = filter->priv->stamp;
2848 iter->user_data = level;
2850 siter = g_sequence_get_iter_at_pos (level->seq, indices[depth - 1]);
2851 if (g_sequence_iter_is_end (siter))
2856 iter->user_data2 = GET_ELT (siter);
2862 gtk_tree_model_filter_get_iter (GtkTreeModel *model,
2866 GtkTreeModelFilter *filter = (GtkTreeModelFilter *)model;
2870 GSequenceIter *siter;
2873 g_return_val_if_fail (GTK_IS_TREE_MODEL_FILTER (model), FALSE);
2874 g_return_val_if_fail (filter->priv->child_model != NULL, FALSE);
2876 indices = gtk_tree_path_get_indices (path);
2878 if (filter->priv->root == NULL)
2879 gtk_tree_model_filter_build_level (filter, NULL, NULL, FALSE);
2880 level = FILTER_LEVEL (filter->priv->root);
2882 depth = gtk_tree_path_get_depth (path);
2889 for (i = 0; i < depth - 1; i++)
2891 if (!level || indices[i] >= g_sequence_get_length (level->visible_seq))
2897 siter = g_sequence_get_iter_at_pos (level->visible_seq, indices[i]);
2898 if (g_sequence_iter_is_end (siter))
2904 elt = GET_ELT (siter);
2906 gtk_tree_model_filter_build_level (filter, level, elt, FALSE);
2907 level = elt->children;
2910 if (!level || indices[i] >= g_sequence_get_length (level->visible_seq))
2916 iter->stamp = filter->priv->stamp;
2917 iter->user_data = level;
2919 siter = g_sequence_get_iter_at_pos (level->visible_seq, indices[depth - 1]);
2920 if (g_sequence_iter_is_end (siter))
2925 iter->user_data2 = GET_ELT (siter);
2930 static GtkTreePath *
2931 gtk_tree_model_filter_get_path (GtkTreeModel *model,
2934 GtkTreePath *retval;
2938 g_return_val_if_fail (GTK_IS_TREE_MODEL_FILTER (model), NULL);
2939 g_return_val_if_fail (GTK_TREE_MODEL_FILTER (model)->priv->child_model != NULL, NULL);
2940 g_return_val_if_fail (GTK_TREE_MODEL_FILTER (model)->priv->stamp == iter->stamp, NULL);
2942 level = iter->user_data;
2943 elt = iter->user_data2;
2945 if (!elt->visible_siter)
2948 retval = gtk_tree_path_new ();
2954 index = g_sequence_iter_get_position (elt->visible_siter);
2955 gtk_tree_path_prepend_index (retval, index);
2957 elt = level->parent_elt;
2958 level = level->parent_level;
2965 gtk_tree_model_filter_real_modify (GtkTreeModelFilter *self,
2966 GtkTreeModel *child_model,
2971 if (self->priv->modify_func)
2973 g_return_if_fail (column < self->priv->modify_n_columns);
2975 g_value_init (value, self->priv->modify_types[column]);
2976 self->priv->modify_func (GTK_TREE_MODEL (self),
2980 self->priv->modify_data);
2984 GtkTreeIter child_iter;
2986 gtk_tree_model_filter_convert_iter_to_child_iter (GTK_TREE_MODEL_FILTER (self),
2988 gtk_tree_model_get_value (child_model, &child_iter, column, value);
2993 gtk_tree_model_filter_get_value (GtkTreeModel *model,
2998 GtkTreeModelFilter *filter = GTK_TREE_MODEL_FILTER (model);
3000 g_return_if_fail (GTK_IS_TREE_MODEL_FILTER (model));
3001 g_return_if_fail (GTK_TREE_MODEL_FILTER (model)->priv->child_model != NULL);
3002 g_return_if_fail (GTK_TREE_MODEL_FILTER (model)->priv->stamp == iter->stamp);
3004 GTK_TREE_MODEL_FILTER_GET_CLASS (model)->modify (filter,
3005 filter->priv->child_model, iter, value, column);
3009 gtk_tree_model_filter_iter_next (GtkTreeModel *model,
3014 GSequenceIter *siter;
3016 g_return_val_if_fail (GTK_IS_TREE_MODEL_FILTER (model), FALSE);
3017 g_return_val_if_fail (GTK_TREE_MODEL_FILTER (model)->priv->child_model != NULL, FALSE);
3018 g_return_val_if_fail (GTK_TREE_MODEL_FILTER (model)->priv->stamp == iter->stamp, FALSE);
3020 level = iter->user_data;
3021 elt = iter->user_data2;
3023 siter = g_sequence_iter_next (elt->visible_siter);
3024 if (g_sequence_iter_is_end (siter))
3030 iter->user_data2 = GET_ELT (siter);
3036 gtk_tree_model_filter_iter_previous (GtkTreeModel *model,
3040 GSequenceIter *siter;
3042 g_return_val_if_fail (GTK_IS_TREE_MODEL_FILTER (model), FALSE);
3043 g_return_val_if_fail (GTK_TREE_MODEL_FILTER (model)->priv->child_model != NULL, FALSE);
3044 g_return_val_if_fail (GTK_TREE_MODEL_FILTER (model)->priv->stamp == iter->stamp, FALSE);
3046 elt = iter->user_data2;
3048 siter = g_sequence_iter_prev (elt->visible_siter);
3049 if (g_sequence_iter_is_begin (siter))
3055 iter->user_data2 = GET_ELT (siter);
3061 gtk_tree_model_filter_iter_children (GtkTreeModel *model,
3063 GtkTreeIter *parent)
3065 GtkTreeModelFilter *filter = (GtkTreeModelFilter *)model;
3067 GSequenceIter *siter;
3070 g_return_val_if_fail (GTK_IS_TREE_MODEL_FILTER (model), FALSE);
3071 g_return_val_if_fail (filter->priv->child_model != NULL, FALSE);
3073 g_return_val_if_fail (filter->priv->stamp == parent->stamp, FALSE);
3077 if (!filter->priv->root)
3078 gtk_tree_model_filter_build_level (filter, NULL, NULL, FALSE);
3079 if (!filter->priv->root)
3082 level = filter->priv->root;
3083 siter = g_sequence_get_begin_iter (level->visible_seq);
3084 if (g_sequence_iter_is_end (siter))
3090 iter->stamp = filter->priv->stamp;
3091 iter->user_data = level;
3092 iter->user_data2 = GET_ELT (siter);
3098 if (FILTER_ELT (parent->user_data2)->children == NULL)
3099 gtk_tree_model_filter_build_level (filter,
3100 FILTER_LEVEL (parent->user_data),
3101 FILTER_ELT (parent->user_data2),
3103 if (FILTER_ELT (parent->user_data2)->children == NULL)
3106 level = FILTER_ELT (parent->user_data2)->children;
3107 siter = g_sequence_get_begin_iter (level->visible_seq);
3108 if (g_sequence_iter_is_end (siter))
3114 iter->stamp = filter->priv->stamp;
3115 iter->user_data = level;
3116 iter->user_data2 = GET_ELT (siter);
3126 gtk_tree_model_filter_iter_has_child (GtkTreeModel *model,
3129 GtkTreeIter child_iter;
3130 GtkTreeModelFilter *filter = (GtkTreeModelFilter *)model;
3133 g_return_val_if_fail (GTK_IS_TREE_MODEL_FILTER (model), FALSE);
3134 g_return_val_if_fail (filter->priv->child_model != NULL, FALSE);
3135 g_return_val_if_fail (filter->priv->stamp == iter->stamp, FALSE);
3137 filter = GTK_TREE_MODEL_FILTER (model);
3139 gtk_tree_model_filter_convert_iter_to_child_iter (GTK_TREE_MODEL_FILTER (model), &child_iter, iter);
3140 elt = FILTER_ELT (iter->user_data2);
3142 if (!elt->visible_siter)
3145 /* we need to build the level to check if not all children are filtered
3149 && gtk_tree_model_iter_has_child (filter->priv->child_model, &child_iter))
3150 gtk_tree_model_filter_build_level (filter, FILTER_LEVEL (iter->user_data),
3153 if (elt->children && g_sequence_get_length (elt->children->visible_seq) > 0)
3160 gtk_tree_model_filter_iter_n_children (GtkTreeModel *model,
3163 GtkTreeIter child_iter;
3164 GtkTreeModelFilter *filter = (GtkTreeModelFilter *)model;
3167 g_return_val_if_fail (GTK_IS_TREE_MODEL_FILTER (model), 0);
3168 g_return_val_if_fail (filter->priv->child_model != NULL, 0);
3170 g_return_val_if_fail (filter->priv->stamp == iter->stamp, 0);
3174 if (!filter->priv->root)
3175 gtk_tree_model_filter_build_level (filter, NULL, NULL, FALSE);
3177 if (filter->priv->root)
3178 return g_sequence_get_length (FILTER_LEVEL (filter->priv->root)->visible_seq);
3183 elt = FILTER_ELT (iter->user_data2);
3185 if (!elt->visible_siter)
3188 gtk_tree_model_filter_convert_iter_to_child_iter (GTK_TREE_MODEL_FILTER (model), &child_iter, iter);
3190 if (!elt->children &&
3191 gtk_tree_model_iter_has_child (filter->priv->child_model, &child_iter))
3192 gtk_tree_model_filter_build_level (filter,
3193 FILTER_LEVEL (iter->user_data),
3197 return g_sequence_get_length (elt->children->visible_seq);
3203 gtk_tree_model_filter_iter_nth_child (GtkTreeModel *model,
3205 GtkTreeIter *parent,
3209 GtkTreeIter children;
3210 GSequenceIter *siter;
3212 g_return_val_if_fail (GTK_IS_TREE_MODEL_FILTER (model), FALSE);
3214 g_return_val_if_fail (GTK_TREE_MODEL_FILTER (model)->priv->stamp == parent->stamp, FALSE);
3216 /* use this instead of has_child to force us to build the level, if needed */
3217 if (gtk_tree_model_filter_iter_children (model, &children, parent) == FALSE)
3223 level = children.user_data;
3224 siter = g_sequence_get_iter_at_pos (level->visible_seq, n);
3225 if (g_sequence_iter_is_end (siter))
3228 iter->stamp = GTK_TREE_MODEL_FILTER (model)->priv->stamp;
3229 iter->user_data = level;
3230 iter->user_data2 = GET_ELT (siter);
3236 gtk_tree_model_filter_iter_parent (GtkTreeModel *model,
3243 g_return_val_if_fail (GTK_IS_TREE_MODEL_FILTER (model), FALSE);
3244 g_return_val_if_fail (GTK_TREE_MODEL_FILTER (model)->priv->child_model != NULL, FALSE);
3245 g_return_val_if_fail (GTK_TREE_MODEL_FILTER (model)->priv->stamp == child->stamp, FALSE);
3247 level = child->user_data;
3249 if (level->parent_level)
3251 iter->stamp = GTK_TREE_MODEL_FILTER (model)->priv->stamp;
3252 iter->user_data = level->parent_level;
3253 iter->user_data2 = level->parent_elt;
3262 gtk_tree_model_filter_ref_node (GtkTreeModel *model,
3265 gtk_tree_model_filter_real_ref_node (model, iter, TRUE);
3269 gtk_tree_model_filter_real_ref_node (GtkTreeModel *model,
3273 GtkTreeModelFilter *filter = (GtkTreeModelFilter *)model;
3274 GtkTreeIter child_iter;
3278 g_return_if_fail (GTK_IS_TREE_MODEL_FILTER (model));
3279 g_return_if_fail (GTK_TREE_MODEL_FILTER (model)->priv->child_model != NULL);
3280 g_return_if_fail (GTK_TREE_MODEL_FILTER (model)->priv->stamp == iter->stamp);
3282 gtk_tree_model_filter_convert_iter_to_child_iter (GTK_TREE_MODEL_FILTER (model), &child_iter, iter);
3284 gtk_tree_model_ref_node (filter->priv->child_model, &child_iter);
3286 level = iter->user_data;
3287 elt = iter->user_data2;
3294 elt->ext_ref_count++;
3295 level->ext_ref_count++;
3297 if (level->ext_ref_count == 1)
3299 FilterLevel *parent_level = level->parent_level;
3300 FilterElt *parent_elt = level->parent_elt;
3302 /* we were at zero -- time to decrease the zero_ref_count val */
3303 while (parent_level)
3305 parent_elt->zero_ref_count--;
3307 parent_elt = parent_level->parent_elt;
3308 parent_level = parent_level->parent_level;
3311 if (filter->priv->root != level)
3312 filter->priv->zero_ref_count--;
3318 gtk_tree_model_filter_unref_node (GtkTreeModel *model,
3321 gtk_tree_model_filter_real_unref_node (model, iter, TRUE, TRUE);
3325 gtk_tree_model_filter_real_unref_node (GtkTreeModel *model,
3328 gboolean propagate_unref)
3330 GtkTreeModelFilter *filter = (GtkTreeModelFilter *)model;
3334 g_return_if_fail (GTK_IS_TREE_MODEL_FILTER (model));
3335 g_return_if_fail (filter->priv->child_model != NULL);
3336 g_return_if_fail (filter->priv->stamp == iter->stamp);
3338 if (propagate_unref)
3340 GtkTreeIter child_iter;
3341 gtk_tree_model_filter_convert_iter_to_child_iter (GTK_TREE_MODEL_FILTER (model), &child_iter, iter);
3342 gtk_tree_model_unref_node (filter->priv->child_model, &child_iter);
3345 level = iter->user_data;
3346 elt = iter->user_data2;
3348 g_return_if_fail (elt->ref_count > 0);
3355 elt->ext_ref_count--;
3356 level->ext_ref_count--;
3358 if (level->ext_ref_count == 0)
3360 FilterLevel *parent_level = level->parent_level;
3361 FilterElt *parent_elt = level->parent_elt;
3363 /* we are at zero -- time to increase the zero_ref_count val */
3364 while (parent_level)
3366 parent_elt->zero_ref_count++;
3368 parent_elt = parent_level->parent_elt;
3369 parent_level = parent_level->parent_level;
3372 if (filter->priv->root != level)
3373 filter->priv->zero_ref_count++;
3378 /* TreeDragSource interface implementation */
3380 gtk_tree_model_filter_row_draggable (GtkTreeDragSource *drag_source,
3383 GtkTreeModelFilter *tree_model_filter = (GtkTreeModelFilter *)drag_source;
3384 GtkTreePath *child_path;
3387 g_return_val_if_fail (GTK_IS_TREE_MODEL_FILTER (drag_source), FALSE);
3388 g_return_val_if_fail (path != NULL, FALSE);
3390 child_path = gtk_tree_model_filter_convert_path_to_child_path (tree_model_filter, path);
3391 draggable = gtk_tree_drag_source_row_draggable (GTK_TREE_DRAG_SOURCE (tree_model_filter->priv->child_model), child_path);
3392 gtk_tree_path_free (child_path);
3398 gtk_tree_model_filter_drag_data_get (GtkTreeDragSource *drag_source,
3400 GtkSelectionData *selection_data)
3402 GtkTreeModelFilter *tree_model_filter = (GtkTreeModelFilter *)drag_source;
3403 GtkTreePath *child_path;
3406 g_return_val_if_fail (GTK_IS_TREE_MODEL_FILTER (drag_source), FALSE);
3407 g_return_val_if_fail (path != NULL, FALSE);
3409 child_path = gtk_tree_model_filter_convert_path_to_child_path (tree_model_filter, path);
3410 gotten = gtk_tree_drag_source_drag_data_get (GTK_TREE_DRAG_SOURCE (tree_model_filter->priv->child_model), child_path, selection_data);
3411 gtk_tree_path_free (child_path);
3417 gtk_tree_model_filter_drag_data_delete (GtkTreeDragSource *drag_source,
3420 GtkTreeModelFilter *tree_model_filter = (GtkTreeModelFilter *)drag_source;
3421 GtkTreePath *child_path;
3424 g_return_val_if_fail (GTK_IS_TREE_MODEL_FILTER (drag_source), FALSE);
3425 g_return_val_if_fail (path != NULL, FALSE);
3427 child_path = gtk_tree_model_filter_convert_path_to_child_path (tree_model_filter, path);
3428 deleted = gtk_tree_drag_source_drag_data_delete (GTK_TREE_DRAG_SOURCE (tree_model_filter->priv->child_model), child_path);
3429 gtk_tree_path_free (child_path);
3434 /* bits and pieces */
3436 gtk_tree_model_filter_set_model (GtkTreeModelFilter *filter,
3437 GtkTreeModel *child_model)
3439 g_return_if_fail (GTK_IS_TREE_MODEL_FILTER (filter));
3441 if (filter->priv->child_model)
3443 g_signal_handler_disconnect (filter->priv->child_model,
3444 filter->priv->changed_id);
3445 g_signal_handler_disconnect (filter->priv->child_model,
3446 filter->priv->inserted_id);
3447 g_signal_handler_disconnect (filter->priv->child_model,
3448 filter->priv->has_child_toggled_id);
3449 g_signal_handler_disconnect (filter->priv->child_model,
3450 filter->priv->deleted_id);
3451 g_signal_handler_disconnect (filter->priv->child_model,
3452 filter->priv->reordered_id);
3454 /* reset our state */
3455 if (filter->priv->root)
3456 gtk_tree_model_filter_free_level (filter, filter->priv->root, TRUE);
3458 filter->priv->root = NULL;
3459 g_object_unref (filter->priv->child_model);
3460 filter->priv->visible_column = -1;
3462 /* FIXME: do we need to destroy more here? */
3465 filter->priv->child_model = child_model;
3469 g_object_ref (filter->priv->child_model);
3470 filter->priv->changed_id =
3471 g_signal_connect (child_model, "row-changed",
3472 G_CALLBACK (gtk_tree_model_filter_row_changed),
3474 filter->priv->inserted_id =
3475 g_signal_connect (child_model, "row-inserted",
3476 G_CALLBACK (gtk_tree_model_filter_row_inserted),
3478 filter->priv->has_child_toggled_id =
3479 g_signal_connect (child_model, "row-has-child-toggled",
3480 G_CALLBACK (gtk_tree_model_filter_row_has_child_toggled),
3482 filter->priv->deleted_id =
3483 g_signal_connect (child_model, "row-deleted",
3484 G_CALLBACK (gtk_tree_model_filter_row_deleted),
3486 filter->priv->reordered_id =
3487 g_signal_connect (child_model, "rows-reordered",
3488 G_CALLBACK (gtk_tree_model_filter_rows_reordered),
3491 filter->priv->child_flags = gtk_tree_model_get_flags (child_model);
3492 filter->priv->stamp = g_random_int ();
3497 gtk_tree_model_filter_ref_path (GtkTreeModelFilter *filter,
3503 len = gtk_tree_path_get_depth (path);
3504 p = gtk_tree_path_copy (path);
3509 gtk_tree_model_get_iter (GTK_TREE_MODEL (filter->priv->child_model), &iter, p);
3510 gtk_tree_model_ref_node (GTK_TREE_MODEL (filter->priv->child_model), &iter);
3511 gtk_tree_path_up (p);
3514 gtk_tree_path_free (p);
3518 gtk_tree_model_filter_unref_path (GtkTreeModelFilter *filter,
3528 len = gtk_tree_path_get_depth (path);
3530 p = gtk_tree_path_copy (path);
3535 gtk_tree_model_get_iter (GTK_TREE_MODEL (filter->priv->child_model), &iter, p);
3536 gtk_tree_model_unref_node (GTK_TREE_MODEL (filter->priv->child_model), &iter);
3537 gtk_tree_path_up (p);
3540 gtk_tree_path_free (p);
3544 gtk_tree_model_filter_set_root (GtkTreeModelFilter *filter,
3547 g_return_if_fail (GTK_IS_TREE_MODEL_FILTER (filter));
3550 filter->priv->virtual_root = NULL;
3552 filter->priv->virtual_root = gtk_tree_path_copy (root);
3558 * gtk_tree_model_filter_new:
3559 * @child_model: A #GtkTreeModel.
3560 * @root: (allow-none): A #GtkTreePath or %NULL.
3562 * Creates a new #GtkTreeModel, with @child_model as the child_model
3563 * and @root as the virtual root.
3565 * Return value: (transfer full): A new #GtkTreeModel.
3570 gtk_tree_model_filter_new (GtkTreeModel *child_model,
3573 GtkTreeModel *retval;
3574 GtkTreeModelFilter *filter;
3576 g_return_val_if_fail (GTK_IS_TREE_MODEL (child_model), NULL);
3578 retval = g_object_new (GTK_TYPE_TREE_MODEL_FILTER,
3579 "child-model", child_model,
3580 "virtual-root", root,
3583 filter = GTK_TREE_MODEL_FILTER (retval);
3584 if (filter->priv->virtual_root)
3586 gtk_tree_model_filter_ref_path (filter, filter->priv->virtual_root);
3587 filter->priv->virtual_root_deleted = FALSE;
3594 * gtk_tree_model_filter_get_model:
3595 * @filter: A #GtkTreeModelFilter.
3597 * Returns a pointer to the child model of @filter.
3599 * Return value: (transfer none): A pointer to a #GtkTreeModel.
3604 gtk_tree_model_filter_get_model (GtkTreeModelFilter *filter)
3606 g_return_val_if_fail (GTK_IS_TREE_MODEL_FILTER (filter), NULL);
3608 return filter->priv->child_model;
3612 * gtk_tree_model_filter_set_visible_func:
3613 * @filter: A #GtkTreeModelFilter.
3614 * @func: A #GtkTreeModelFilterVisibleFunc, the visible function.
3615 * @data: (allow-none): User data to pass to the visible function, or %NULL.
3616 * @destroy: (allow-none): Destroy notifier of @data, or %NULL.
3618 * Sets the visible function used when filtering the @filter to be @func. The
3619 * function should return %TRUE if the given row should be visible and
3622 * If the condition calculated by the function changes over time (e.g. because
3623 * it depends on some global parameters), you must call
3624 * gtk_tree_model_filter_refilter() to keep the visibility information of
3625 * the model uptodate.
3627 * Note that @func is called whenever a row is inserted, when it may still be
3628 * empty. The visible function should therefore take special care of empty
3629 * rows, like in the example below.
3631 * <informalexample><programlisting>
3633 * visible_func (GtkTreeModel *model,
3634 * GtkTreeIter *iter,
3637 * /* Visible if row is non-empty and first column is "HI" */
3639 * gboolean visible = FALSE;
3641 * gtk_tree_model_get (model, iter, 0, &str, -1);
3642 * if (str && strcmp (str, "HI") == 0)
3648 * </programlisting></informalexample>
3653 gtk_tree_model_filter_set_visible_func (GtkTreeModelFilter *filter,
3654 GtkTreeModelFilterVisibleFunc func,
3656 GDestroyNotify destroy)
3658 g_return_if_fail (GTK_IS_TREE_MODEL_FILTER (filter));
3659 g_return_if_fail (func != NULL);
3660 g_return_if_fail (filter->priv->visible_method_set == FALSE);
3662 filter->priv->visible_func = func;
3663 filter->priv->visible_data = data;
3664 filter->priv->visible_destroy = destroy;
3666 filter->priv->visible_method_set = TRUE;
3670 * gtk_tree_model_filter_set_modify_func:
3671 * @filter: A #GtkTreeModelFilter.
3672 * @n_columns: The number of columns in the filter model.
3673 * @types: (array length=n_columns): The #GType<!-- -->s of the columns.
3674 * @func: A #GtkTreeModelFilterModifyFunc
3675 * @data: (allow-none): User data to pass to the modify function, or %NULL.
3676 * @destroy: (allow-none): Destroy notifier of @data, or %NULL.
3678 * With the @n_columns and @types parameters, you give an array of column
3679 * types for this model (which will be exposed to the parent model/view).
3680 * The @func, @data and @destroy parameters are for specifying the modify
3681 * function. The modify function will get called for <emphasis>each</emphasis>
3682 * data access, the goal of the modify function is to return the data which
3683 * should be displayed at the location specified using the parameters of the
3689 gtk_tree_model_filter_set_modify_func (GtkTreeModelFilter *filter,
3692 GtkTreeModelFilterModifyFunc func,
3694 GDestroyNotify destroy)
3696 g_return_if_fail (GTK_IS_TREE_MODEL_FILTER (filter));
3697 g_return_if_fail (func != NULL);
3698 g_return_if_fail (filter->priv->modify_func_set == FALSE);
3700 if (filter->priv->modify_destroy)
3702 GDestroyNotify d = filter->priv->modify_destroy;
3704 filter->priv->modify_destroy = NULL;
3705 d (filter->priv->modify_data);
3708 filter->priv->modify_n_columns = n_columns;
3709 filter->priv->modify_types = g_new0 (GType, n_columns);
3710 memcpy (filter->priv->modify_types, types, sizeof (GType) * n_columns);
3711 filter->priv->modify_func = func;
3712 filter->priv->modify_data = data;
3713 filter->priv->modify_destroy = destroy;
3715 filter->priv->modify_func_set = TRUE;
3719 * gtk_tree_model_filter_set_visible_column:
3720 * @filter: A #GtkTreeModelFilter.
3721 * @column: A #gint which is the column containing the visible information.
3723 * Sets @column of the child_model to be the column where @filter should
3724 * look for visibility information. @columns should be a column of type
3725 * %G_TYPE_BOOLEAN, where %TRUE means that a row is visible, and %FALSE
3731 gtk_tree_model_filter_set_visible_column (GtkTreeModelFilter *filter,
3734 g_return_if_fail (GTK_IS_TREE_MODEL_FILTER (filter));
3735 g_return_if_fail (column >= 0);
3736 g_return_if_fail (filter->priv->visible_method_set == FALSE);
3738 filter->priv->visible_column = column;
3740 filter->priv->visible_method_set = TRUE;
3746 * gtk_tree_model_filter_convert_child_iter_to_iter:
3747 * @filter: A #GtkTreeModelFilter.
3748 * @filter_iter: (out): An uninitialized #GtkTreeIter.
3749 * @child_iter: A valid #GtkTreeIter pointing to a row on the child model.
3751 * Sets @filter_iter to point to the row in @filter that corresponds to the
3752 * row pointed at by @child_iter. If @filter_iter was not set, %FALSE is
3755 * Return value: %TRUE, if @filter_iter was set, i.e. if @child_iter is a
3756 * valid iterator pointing to a visible row in child model.
3761 gtk_tree_model_filter_convert_child_iter_to_iter (GtkTreeModelFilter *filter,
3762 GtkTreeIter *filter_iter,
3763 GtkTreeIter *child_iter)
3766 GtkTreePath *child_path, *path;
3768 g_return_val_if_fail (GTK_IS_TREE_MODEL_FILTER (filter), FALSE);
3769 g_return_val_if_fail (filter->priv->child_model != NULL, FALSE);
3770 g_return_val_if_fail (filter_iter != NULL, FALSE);
3771 g_return_val_if_fail (child_iter != NULL, FALSE);
3772 g_return_val_if_fail (filter_iter != child_iter, FALSE);
3774 filter_iter->stamp = 0;
3776 child_path = gtk_tree_model_get_path (filter->priv->child_model, child_iter);
3777 g_return_val_if_fail (child_path != NULL, FALSE);
3779 path = gtk_tree_model_filter_convert_child_path_to_path (filter,
3781 gtk_tree_path_free (child_path);
3786 ret = gtk_tree_model_get_iter (GTK_TREE_MODEL (filter), filter_iter, path);
3787 gtk_tree_path_free (path);
3793 * gtk_tree_model_filter_convert_iter_to_child_iter:
3794 * @filter: A #GtkTreeModelFilter.
3795 * @child_iter: (out): An uninitialized #GtkTreeIter.
3796 * @filter_iter: A valid #GtkTreeIter pointing to a row on @filter.
3798 * Sets @child_iter to point to the row pointed to by @filter_iter.
3803 gtk_tree_model_filter_convert_iter_to_child_iter (GtkTreeModelFilter *filter,
3804 GtkTreeIter *child_iter,
3805 GtkTreeIter *filter_iter)
3807 g_return_if_fail (GTK_IS_TREE_MODEL_FILTER (filter));
3808 g_return_if_fail (filter->priv->child_model != NULL);
3809 g_return_if_fail (child_iter != NULL);
3810 g_return_if_fail (filter_iter != NULL);
3811 g_return_if_fail (filter_iter->stamp == filter->priv->stamp);
3812 g_return_if_fail (filter_iter != child_iter);
3814 if (GTK_TREE_MODEL_FILTER_CACHE_CHILD_ITERS (filter))
3816 *child_iter = FILTER_ELT (filter_iter->user_data2)->iter;
3821 gboolean valid = FALSE;
3823 path = gtk_tree_model_filter_elt_get_path (filter_iter->user_data,
3824 filter_iter->user_data2,
3825 filter->priv->virtual_root);
3826 valid = gtk_tree_model_get_iter (filter->priv->child_model, child_iter,
3828 gtk_tree_path_free (path);
3830 g_return_if_fail (valid == TRUE);
3834 /* The path returned can only be used internally in the filter model. */
3835 static GtkTreePath *
3836 gtk_real_tree_model_filter_convert_child_path_to_path (GtkTreeModelFilter *filter,
3837 GtkTreePath *child_path,
3838 gboolean build_levels,
3839 gboolean fetch_children)
3841 gint *child_indices;
3842 GtkTreePath *retval;
3843 GtkTreePath *real_path;
3848 g_return_val_if_fail (GTK_IS_TREE_MODEL_FILTER (filter), NULL);
3849 g_return_val_if_fail (filter->priv->child_model != NULL, NULL);
3850 g_return_val_if_fail (child_path != NULL, NULL);
3852 if (!filter->priv->virtual_root)
3853 real_path = gtk_tree_path_copy (child_path);
3855 real_path = gtk_tree_model_filter_remove_root (child_path,
3856 filter->priv->virtual_root);
3861 retval = gtk_tree_path_new ();
3862 child_indices = gtk_tree_path_get_indices (real_path);
3864 if (filter->priv->root == NULL && build_levels)
3865 gtk_tree_model_filter_build_level (filter, NULL, NULL, FALSE);
3866 level = FILTER_LEVEL (filter->priv->root);
3868 for (i = 0; i < gtk_tree_path_get_depth (real_path); i++)
3870 GSequenceIter *siter;
3871 gboolean found_child = FALSE;
3875 gtk_tree_path_free (real_path);
3876 gtk_tree_path_free (retval);
3880 tmp = lookup_elt_with_offset (level->seq, child_indices[i], &siter);
3883 gtk_tree_path_append_index (retval, g_sequence_iter_get_position (siter));
3884 if (!tmp->children && build_levels)
3885 gtk_tree_model_filter_build_level (filter, level, tmp, FALSE);
3886 level = tmp->children;
3890 if (!found_child && fetch_children)
3894 tmp = gtk_tree_model_filter_fetch_child (filter, level,
3898 /* didn't find the child, let's try to bring it back */
3899 if (!tmp || tmp->offset != child_indices[i])
3902 gtk_tree_path_free (real_path);
3903 gtk_tree_path_free (retval);
3907 gtk_tree_path_append_index (retval, j);
3908 if (!tmp->children && build_levels)
3909 gtk_tree_model_filter_build_level (filter, level, tmp, FALSE);
3910 level = tmp->children;
3913 else if (!found_child && !fetch_children)
3916 gtk_tree_path_free (real_path);
3917 gtk_tree_path_free (retval);
3922 gtk_tree_path_free (real_path);
3927 * gtk_tree_model_filter_convert_child_path_to_path:
3928 * @filter: A #GtkTreeModelFilter.
3929 * @child_path: A #GtkTreePath to convert.
3931 * Converts @child_path to a path relative to @filter. That is, @child_path
3932 * points to a path in the child model. The rerturned path will point to the
3933 * same row in the filtered model. If @child_path isn't a valid path on the
3934 * child model or points to a row which is not visible in @filter, then %NULL
3937 * Return value: A newly allocated #GtkTreePath, or %NULL.
3942 gtk_tree_model_filter_convert_child_path_to_path (GtkTreeModelFilter *filter,
3943 GtkTreePath *child_path)
3948 /* this function does the sanity checks */
3949 path = gtk_real_tree_model_filter_convert_child_path_to_path (filter,
3957 /* get a new path which only takes visible nodes into account.
3958 * -- if this gives any performance issues, we can write a special
3959 * version of convert_child_path_to_path immediately returning
3960 * a visible-nodes-only path.
3962 gtk_tree_model_filter_get_iter_full (GTK_TREE_MODEL (filter), &iter, path);
3964 gtk_tree_path_free (path);
3965 path = gtk_tree_model_get_path (GTK_TREE_MODEL (filter), &iter);
3971 * gtk_tree_model_filter_convert_path_to_child_path:
3972 * @filter: A #GtkTreeModelFilter.
3973 * @filter_path: A #GtkTreePath to convert.
3975 * Converts @filter_path to a path on the child model of @filter. That is,
3976 * @filter_path points to a location in @filter. The returned path will
3977 * point to the same location in the model not being filtered. If @filter_path
3978 * does not point to a location in the child model, %NULL is returned.
3980 * Return value: A newly allocated #GtkTreePath, or %NULL.
3985 gtk_tree_model_filter_convert_path_to_child_path (GtkTreeModelFilter *filter,
3986 GtkTreePath *filter_path)
3988 gint *filter_indices;
3989 GtkTreePath *retval;
3993 g_return_val_if_fail (GTK_IS_TREE_MODEL_FILTER (filter), NULL);
3994 g_return_val_if_fail (filter->priv->child_model != NULL, NULL);
3995 g_return_val_if_fail (filter_path != NULL, NULL);
3998 retval = gtk_tree_path_new ();
3999 filter_indices = gtk_tree_path_get_indices (filter_path);
4000 if (!filter->priv->root)
4001 gtk_tree_model_filter_build_level (filter, NULL, NULL, FALSE);
4002 level = FILTER_LEVEL (filter->priv->root);
4004 for (i = 0; i < gtk_tree_path_get_depth (filter_path); i++)
4007 GSequenceIter *siter;
4011 gtk_tree_path_free (retval);
4015 siter = g_sequence_get_iter_at_pos (level->visible_seq, filter_indices[i]);
4016 if (g_sequence_iter_is_end (siter))
4018 gtk_tree_path_free (retval);
4022 elt = GET_ELT (siter);
4023 if (elt->children == NULL)
4024 gtk_tree_model_filter_build_level (filter, level, elt, FALSE);
4026 gtk_tree_path_append_index (retval, elt->offset);
4027 level = elt->children;
4032 if (filter->priv->virtual_root)
4034 GtkTreePath *real_retval;
4036 real_retval = gtk_tree_model_filter_add_root (retval,
4037 filter->priv->virtual_root);
4038 gtk_tree_path_free (retval);
4047 gtk_tree_model_filter_refilter_helper (GtkTreeModel *model,
4052 /* evil, don't try this at home, but certainly speeds things up */
4053 gtk_tree_model_filter_row_changed (model, path, iter, data);
4059 * gtk_tree_model_filter_refilter:
4060 * @filter: A #GtkTreeModelFilter.
4062 * Emits ::row_changed for each row in the child model, which causes
4063 * the filter to re-evaluate whether a row is visible or not.
4068 gtk_tree_model_filter_refilter (GtkTreeModelFilter *filter)
4070 g_return_if_fail (GTK_IS_TREE_MODEL_FILTER (filter));
4073 gtk_tree_model_foreach (filter->priv->child_model,
4074 gtk_tree_model_filter_refilter_helper,
4079 * gtk_tree_model_filter_clear_cache:
4080 * @filter: A #GtkTreeModelFilter.
4082 * This function should almost never be called. It clears the @filter
4083 * of any cached iterators that haven't been reffed with
4084 * gtk_tree_model_ref_node(). This might be useful if the child model
4085 * being filtered is static (and doesn't change often) and there has been
4086 * a lot of unreffed access to nodes. As a side effect of this function,
4087 * all unreffed iters will be invalid.
4092 gtk_tree_model_filter_clear_cache (GtkTreeModelFilter *filter)
4094 g_return_if_fail (GTK_IS_TREE_MODEL_FILTER (filter));
4096 if (filter->priv->zero_ref_count > 0)
4097 gtk_tree_model_filter_clear_cache_helper (filter,
4098 FILTER_LEVEL (filter->priv->root));