]> Pileus Git - ~andy/gtk/blob - gtk/gtktreemodelfilter.c
Do not emit has-child-toggled when a root level node is removed
[~andy/gtk] / gtk / gtktreemodelfilter.c
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>
4  *
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.
9  *
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.
14  *
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.
19  */
20
21 #include "config.h"
22 #include "gtktreemodelfilter.h"
23 #include "gtkintl.h"
24 #include "gtktreednd.h"
25 #include "gtkprivate.h"
26 #include "gtkalias.h"
27 #include <string.h>
28
29 /* ITER FORMAT:
30  *
31  * iter->stamp = filter->priv->stamp
32  * iter->user_data = FilterLevel
33  * iter->user_data2 = FilterElt
34  */
35
36 /* all paths, iters, etc prefixed with c_ are paths, iters, etc relative to the
37  * child model.
38  */
39
40 /* A few notes:
41  *  There are three model/views involved, so there are two mappings:
42  *    * this model -> child model: mapped via offset in FilterElt.
43  *    * this model -> parent model (or view): mapped via the array index
44  *                                            of FilterElt.
45  *
46  *  Note that there are two kinds of paths relative to the filter model
47  *  (those generated from the array indices): paths taking non-visible
48  *  nodes into account, and paths which don't.  Paths which take
49  *  non-visible nodes into account should only be used internally and
50  *  NEVER be passed along with a signal emission.
51  *
52  *  The filter model has a reference on every node that is not in the root
53  *  level and has a parent with ref_count > 1.  Exception is a virtual root
54  *  level; all nodes in the virtual root level are referenced too.
55  */
56
57 typedef struct _FilterElt FilterElt;
58 typedef struct _FilterLevel FilterLevel;
59
60 struct _FilterElt
61 {
62   GtkTreeIter iter;
63   FilterLevel *children;
64   gint offset;
65   gint ref_count;
66   gint zero_ref_count;
67   gboolean visible;
68 };
69
70 struct _FilterLevel
71 {
72   GArray *array;
73   gint ref_count;
74   gint visible_nodes;
75
76   FilterElt *parent_elt;
77   FilterLevel *parent_level;
78 };
79
80 #define GTK_TREE_MODEL_FILTER_GET_PRIVATE(obj)  (G_TYPE_INSTANCE_GET_PRIVATE ((obj), GTK_TYPE_TREE_MODEL_FILTER, GtkTreeModelFilterPrivate))
81
82 struct _GtkTreeModelFilterPrivate
83 {
84   gpointer root;
85   gint stamp;
86   guint child_flags;
87   GtkTreeModel *child_model;
88   gint zero_ref_count;
89
90   GtkTreePath *virtual_root;
91
92   GtkTreeModelFilterVisibleFunc visible_func;
93   gpointer visible_data;
94   GDestroyNotify visible_destroy;
95
96   gint modify_n_columns;
97   GType *modify_types;
98   GtkTreeModelFilterModifyFunc modify_func;
99   gpointer modify_data;
100   GDestroyNotify modify_destroy;
101
102   gint visible_column;
103
104   gboolean visible_method_set;
105   gboolean modify_func_set;
106
107   gboolean in_row_deleted;
108   gboolean virtual_root_deleted;
109
110   /* signal ids */
111   guint changed_id;
112   guint inserted_id;
113   guint has_child_toggled_id;
114   guint deleted_id;
115   guint reordered_id;
116 };
117
118 /* properties */
119 enum
120 {
121   PROP_0,
122   PROP_CHILD_MODEL,
123   PROP_VIRTUAL_ROOT
124 };
125
126 #define GTK_TREE_MODEL_FILTER_CACHE_CHILD_ITERS(filter) \
127         (((GtkTreeModelFilter *)filter)->priv->child_flags & GTK_TREE_MODEL_ITERS_PERSIST)
128
129 #define FILTER_ELT(filter_elt) ((FilterElt *)filter_elt)
130 #define FILTER_LEVEL(filter_level) ((FilterLevel *)filter_level)
131
132 /* general code (object/interface init, properties, etc) */
133 static void         gtk_tree_model_filter_tree_model_init                 (GtkTreeModelIface       *iface);
134 static void         gtk_tree_model_filter_drag_source_init                (GtkTreeDragSourceIface  *iface);
135 static void         gtk_tree_model_filter_finalize                        (GObject                 *object);
136 static void         gtk_tree_model_filter_set_property                    (GObject                 *object,
137                                                                            guint                    prop_id,
138                                                                            const GValue            *value,
139                                                                            GParamSpec              *pspec);
140 static void         gtk_tree_model_filter_get_property                    (GObject                 *object,
141                                                                            guint                    prop_id,
142                                                                            GValue                 *value,
143                                                                            GParamSpec             *pspec);
144
145 /* signal handlers */
146 static void         gtk_tree_model_filter_row_changed                     (GtkTreeModel           *c_model,
147                                                                            GtkTreePath            *c_path,
148                                                                            GtkTreeIter            *c_iter,
149                                                                            gpointer                data);
150 static void         gtk_tree_model_filter_row_inserted                    (GtkTreeModel           *c_model,
151                                                                            GtkTreePath            *c_path,
152                                                                            GtkTreeIter            *c_iter,
153                                                                            gpointer                data);
154 static void         gtk_tree_model_filter_row_has_child_toggled           (GtkTreeModel           *c_model,
155                                                                            GtkTreePath            *c_path,
156                                                                            GtkTreeIter            *c_iter,
157                                                                            gpointer                data);
158 static void         gtk_tree_model_filter_row_deleted                     (GtkTreeModel           *c_model,
159                                                                            GtkTreePath            *c_path,
160                                                                            gpointer                data);
161 static void         gtk_tree_model_filter_rows_reordered                  (GtkTreeModel           *c_model,
162                                                                            GtkTreePath            *c_path,
163                                                                            GtkTreeIter            *c_iter,
164                                                                            gint                   *new_order,
165                                                                            gpointer                data);
166
167 /* GtkTreeModel interface */
168 static GtkTreeModelFlags gtk_tree_model_filter_get_flags                       (GtkTreeModel           *model);
169 static gint         gtk_tree_model_filter_get_n_columns                   (GtkTreeModel           *model);
170 static GType        gtk_tree_model_filter_get_column_type                 (GtkTreeModel           *model,
171                                                                            gint                    index);
172 static gboolean     gtk_tree_model_filter_get_iter_full                   (GtkTreeModel           *model,
173                                                                            GtkTreeIter            *iter,
174                                                                            GtkTreePath            *path);
175 static gboolean     gtk_tree_model_filter_get_iter                        (GtkTreeModel           *model,
176                                                                            GtkTreeIter            *iter,
177                                                                            GtkTreePath            *path);
178 static GtkTreePath *gtk_tree_model_filter_get_path                        (GtkTreeModel           *model,
179                                                                            GtkTreeIter            *iter);
180 static void         gtk_tree_model_filter_get_value                       (GtkTreeModel           *model,
181                                                                            GtkTreeIter            *iter,
182                                                                            gint                    column,
183                                                                            GValue                 *value);
184 static gboolean     gtk_tree_model_filter_iter_next                       (GtkTreeModel           *model,
185                                                                            GtkTreeIter            *iter);
186 static gboolean     gtk_tree_model_filter_iter_children                   (GtkTreeModel           *model,
187                                                                            GtkTreeIter            *iter,
188                                                                            GtkTreeIter            *parent);
189 static gboolean     gtk_tree_model_filter_iter_has_child                  (GtkTreeModel           *model,
190                                                                            GtkTreeIter            *iter);
191 static gint         gtk_tree_model_filter_iter_n_children                 (GtkTreeModel           *model,
192                                                                            GtkTreeIter            *iter);
193 static gboolean     gtk_tree_model_filter_iter_nth_child                  (GtkTreeModel           *model,
194                                                                            GtkTreeIter            *iter,
195                                                                            GtkTreeIter            *parent,
196                                                                            gint                    n);
197 static gboolean     gtk_tree_model_filter_iter_parent                     (GtkTreeModel           *model,
198                                                                            GtkTreeIter            *iter,
199                                                                            GtkTreeIter            *child);
200 static void         gtk_tree_model_filter_ref_node                        (GtkTreeModel           *model,
201                                                                            GtkTreeIter            *iter);
202 static void         gtk_tree_model_filter_unref_node                      (GtkTreeModel           *model,
203                                                                            GtkTreeIter            *iter);
204
205 /* TreeDragSource interface */
206 static gboolean    gtk_tree_model_filter_row_draggable                    (GtkTreeDragSource      *drag_source,
207                                                                            GtkTreePath            *path);
208 static gboolean    gtk_tree_model_filter_drag_data_get                    (GtkTreeDragSource      *drag_source,
209                                                                            GtkTreePath            *path,
210                                                                            GtkSelectionData       *selection_data);
211 static gboolean    gtk_tree_model_filter_drag_data_delete                 (GtkTreeDragSource      *drag_source,
212                                                                            GtkTreePath            *path);
213
214 /* private functions */
215 static void        gtk_tree_model_filter_build_level                      (GtkTreeModelFilter     *filter,
216                                                                            FilterLevel            *parent_level,
217                                                                            FilterElt              *parent_elt,
218                                                                            gboolean                emit_inserted);
219
220 static void        gtk_tree_model_filter_free_level                       (GtkTreeModelFilter     *filter,
221                                                                            FilterLevel            *filter_level);
222
223 static GtkTreePath *gtk_tree_model_filter_elt_get_path                    (FilterLevel            *level,
224                                                                            FilterElt              *elt,
225                                                                            GtkTreePath            *root);
226
227 static GtkTreePath *gtk_tree_model_filter_add_root                        (GtkTreePath            *src,
228                                                                            GtkTreePath            *root);
229 static GtkTreePath *gtk_tree_model_filter_remove_root                     (GtkTreePath            *src,
230                                                                            GtkTreePath            *root);
231
232 static void         gtk_tree_model_filter_increment_stamp                 (GtkTreeModelFilter     *filter);
233
234 static gboolean     gtk_tree_model_filter_visible                         (GtkTreeModelFilter     *filter,
235                                                                            GtkTreeIter            *child_iter);
236 static void         gtk_tree_model_filter_clear_cache_helper              (GtkTreeModelFilter     *filter,
237                                                                            FilterLevel            *level);
238
239 static void         gtk_tree_model_filter_real_unref_node                 (GtkTreeModel           *model,
240                                                                            GtkTreeIter            *iter,
241                                                                            gboolean                propagate_unref);
242
243 static void         gtk_tree_model_filter_set_model                       (GtkTreeModelFilter     *filter,
244                                                                            GtkTreeModel           *child_model);
245 static void         gtk_tree_model_filter_ref_path                        (GtkTreeModelFilter     *filter,
246                                                                            GtkTreePath            *path);
247 static void         gtk_tree_model_filter_unref_path                      (GtkTreeModelFilter     *filter,
248                                                                            GtkTreePath            *path);
249 static void         gtk_tree_model_filter_set_root                        (GtkTreeModelFilter     *filter,
250                                                                            GtkTreePath            *root);
251
252 static GtkTreePath *gtk_real_tree_model_filter_convert_child_path_to_path (GtkTreeModelFilter     *filter,
253                                                                            GtkTreePath            *child_path,
254                                                                            gboolean                build_levels,
255                                                                            gboolean                fetch_children);
256
257 static FilterElt   *gtk_tree_model_filter_get_nth                         (GtkTreeModelFilter     *filter,
258                                                                            FilterLevel            *level,
259                                                                            int                     n);
260 static gboolean    gtk_tree_model_filter_elt_is_visible_in_target         (FilterLevel            *level,
261                                                                            FilterElt              *elt);
262 static FilterElt   *gtk_tree_model_filter_get_nth_visible                 (GtkTreeModelFilter     *filter,
263                                                                            FilterLevel            *level,
264                                                                            int                     n);
265
266 static FilterElt   *gtk_tree_model_filter_fetch_child                     (GtkTreeModelFilter     *filter,
267                                                                            FilterLevel            *level,
268                                                                            gint                    offset,
269                                                                            gint                   *index);
270 static void         gtk_tree_model_filter_remove_node                     (GtkTreeModelFilter     *filter,
271                                                                            GtkTreeIter            *iter);
272 static void         gtk_tree_model_filter_update_children                 (GtkTreeModelFilter     *filter,
273                                                                            FilterLevel            *level,
274                                                                            FilterElt              *elt);
275 static FilterElt   *bsearch_elt_with_offset                               (GArray                 *array,
276                                                                            gint                   offset,
277                                                                            gint                  *index);
278
279
280 G_DEFINE_TYPE_WITH_CODE (GtkTreeModelFilter, gtk_tree_model_filter, G_TYPE_OBJECT,
281                          G_IMPLEMENT_INTERFACE (GTK_TYPE_TREE_MODEL,
282                                                 gtk_tree_model_filter_tree_model_init)
283                          G_IMPLEMENT_INTERFACE (GTK_TYPE_TREE_DRAG_SOURCE,
284                                                 gtk_tree_model_filter_drag_source_init))
285
286 static void
287 gtk_tree_model_filter_init (GtkTreeModelFilter *filter)
288 {
289   filter->priv = GTK_TREE_MODEL_FILTER_GET_PRIVATE (filter);
290
291   filter->priv->visible_column = -1;
292   filter->priv->zero_ref_count = 0;
293   filter->priv->visible_method_set = FALSE;
294   filter->priv->modify_func_set = FALSE;
295   filter->priv->in_row_deleted = FALSE;
296   filter->priv->virtual_root_deleted = FALSE;
297 }
298
299 static void
300 gtk_tree_model_filter_class_init (GtkTreeModelFilterClass *filter_class)
301 {
302   GObjectClass *object_class;
303
304   object_class = (GObjectClass *) filter_class;
305
306   object_class->set_property = gtk_tree_model_filter_set_property;
307   object_class->get_property = gtk_tree_model_filter_get_property;
308
309   object_class->finalize = gtk_tree_model_filter_finalize;
310
311   /* Properties -- FIXME: disabled translations for now, until I can come up with a
312    * better description
313    */
314   g_object_class_install_property (object_class,
315                                    PROP_CHILD_MODEL,
316                                    g_param_spec_object ("child-model",
317                                                         ("The child model"),
318                                                         ("The model for the filtermodel to filter"),
319                                                         GTK_TYPE_TREE_MODEL,
320                                                         GTK_PARAM_READWRITE | G_PARAM_CONSTRUCT_ONLY));
321
322   g_object_class_install_property (object_class,
323                                    PROP_VIRTUAL_ROOT,
324                                    g_param_spec_boxed ("virtual-root",
325                                                        ("The virtual root"),
326                                                        ("The virtual root (relative to the child model) for this filtermodel"),
327                                                        GTK_TYPE_TREE_PATH,
328                                                        GTK_PARAM_READWRITE | G_PARAM_CONSTRUCT_ONLY));
329
330   g_type_class_add_private (object_class, sizeof (GtkTreeModelFilterPrivate));
331 }
332
333 static void
334 gtk_tree_model_filter_tree_model_init (GtkTreeModelIface *iface)
335 {
336   iface->get_flags = gtk_tree_model_filter_get_flags;
337   iface->get_n_columns = gtk_tree_model_filter_get_n_columns;
338   iface->get_column_type = gtk_tree_model_filter_get_column_type;
339   iface->get_iter = gtk_tree_model_filter_get_iter;
340   iface->get_path = gtk_tree_model_filter_get_path;
341   iface->get_value = gtk_tree_model_filter_get_value;
342   iface->iter_next = gtk_tree_model_filter_iter_next;
343   iface->iter_children = gtk_tree_model_filter_iter_children;
344   iface->iter_has_child = gtk_tree_model_filter_iter_has_child;
345   iface->iter_n_children = gtk_tree_model_filter_iter_n_children;
346   iface->iter_nth_child = gtk_tree_model_filter_iter_nth_child;
347   iface->iter_parent = gtk_tree_model_filter_iter_parent;
348   iface->ref_node = gtk_tree_model_filter_ref_node;
349   iface->unref_node = gtk_tree_model_filter_unref_node;
350 }
351
352 static void
353 gtk_tree_model_filter_drag_source_init (GtkTreeDragSourceIface *iface)
354 {
355   iface->row_draggable = gtk_tree_model_filter_row_draggable;
356   iface->drag_data_delete = gtk_tree_model_filter_drag_data_delete;
357   iface->drag_data_get = gtk_tree_model_filter_drag_data_get;
358 }
359
360
361 static void
362 gtk_tree_model_filter_finalize (GObject *object)
363 {
364   GtkTreeModelFilter *filter = (GtkTreeModelFilter *) object;
365
366   if (filter->priv->virtual_root && !filter->priv->virtual_root_deleted)
367     {
368       gtk_tree_model_filter_unref_path (filter, filter->priv->virtual_root);
369       filter->priv->virtual_root_deleted = TRUE;
370     }
371
372   gtk_tree_model_filter_set_model (filter, NULL);
373
374   if (filter->priv->virtual_root)
375     gtk_tree_path_free (filter->priv->virtual_root);
376
377   if (filter->priv->root)
378     gtk_tree_model_filter_free_level (filter, filter->priv->root);
379
380   g_free (filter->priv->modify_types);
381   
382   if (filter->priv->modify_destroy)
383     filter->priv->modify_destroy (filter->priv->modify_data);
384
385   if (filter->priv->visible_destroy)
386     filter->priv->visible_destroy (filter->priv->visible_data);
387
388   /* must chain up */
389   G_OBJECT_CLASS (gtk_tree_model_filter_parent_class)->finalize (object);
390 }
391
392 static void
393 gtk_tree_model_filter_set_property (GObject      *object,
394                                     guint         prop_id,
395                                     const GValue *value,
396                                     GParamSpec   *pspec)
397 {
398   GtkTreeModelFilter *filter = GTK_TREE_MODEL_FILTER (object);
399
400   switch (prop_id)
401     {
402       case PROP_CHILD_MODEL:
403         gtk_tree_model_filter_set_model (filter, g_value_get_object (value));
404         break;
405       case PROP_VIRTUAL_ROOT:
406         gtk_tree_model_filter_set_root (filter, g_value_get_boxed (value));
407         break;
408       default:
409         G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
410         break;
411     }
412 }
413
414 static void
415 gtk_tree_model_filter_get_property (GObject    *object,
416                                     guint       prop_id,
417                                     GValue     *value,
418                                     GParamSpec *pspec)
419 {
420   GtkTreeModelFilter *filter = GTK_TREE_MODEL_FILTER (object);
421
422   switch (prop_id)
423     {
424       case PROP_CHILD_MODEL:
425         g_value_set_object (value, filter->priv->child_model);
426         break;
427       case PROP_VIRTUAL_ROOT:
428         g_value_set_boxed (value, filter->priv->virtual_root);
429         break;
430       default:
431         G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
432         break;
433     }
434 }
435
436 /* helpers */
437
438 static void
439 gtk_tree_model_filter_build_level (GtkTreeModelFilter *filter,
440                                    FilterLevel        *parent_level,
441                                    FilterElt          *parent_elt,
442                                    gboolean            emit_inserted)
443 {
444   GtkTreeIter iter;
445   GtkTreeIter first_node;
446   GtkTreeIter root;
447   FilterLevel *new_level;
448   gint length = 0;
449   gint i;
450
451   g_assert (filter->priv->child_model != NULL);
452
453   if (filter->priv->in_row_deleted)
454     return;
455
456   if (!parent_level)
457     {
458       if (filter->priv->virtual_root)
459         {
460           if (gtk_tree_model_get_iter (filter->priv->child_model, &root, filter->priv->virtual_root) == FALSE)
461             return;
462           length = gtk_tree_model_iter_n_children (filter->priv->child_model, &root);
463
464           if (gtk_tree_model_iter_children (filter->priv->child_model, &iter, &root) == FALSE)
465             return;
466         }
467       else
468         {
469           if (!gtk_tree_model_get_iter_first (filter->priv->child_model, &iter))
470             return;
471           length = gtk_tree_model_iter_n_children (filter->priv->child_model, NULL);
472         }
473     }
474   else
475     {
476       GtkTreeIter parent_iter;
477       GtkTreeIter child_parent_iter;
478
479       parent_iter.stamp = filter->priv->stamp;
480       parent_iter.user_data = parent_level;
481       parent_iter.user_data2 = parent_elt;
482
483       gtk_tree_model_filter_convert_iter_to_child_iter (filter,
484                                                         &child_parent_iter,
485                                                         &parent_iter);
486       if (gtk_tree_model_iter_children (filter->priv->child_model, &iter, &child_parent_iter) == FALSE)
487         return;
488
489       /* stamp may have changed */
490       gtk_tree_model_filter_convert_iter_to_child_iter (filter,
491                                                         &child_parent_iter,
492                                                         &parent_iter);
493       length = gtk_tree_model_iter_n_children (filter->priv->child_model, &child_parent_iter);
494     }
495
496   g_return_if_fail (length > 0);
497
498   new_level = g_new (FilterLevel, 1);
499   new_level->array = g_array_sized_new (FALSE, FALSE,
500                                         sizeof (FilterElt),
501                                         length);
502   new_level->ref_count = 0;
503   new_level->visible_nodes = 0;
504   new_level->parent_elt = parent_elt;
505   new_level->parent_level = parent_level;
506
507   if (parent_elt)
508     parent_elt->children = new_level;
509   else
510     filter->priv->root = new_level;
511
512   /* increase the count of zero ref_counts */
513   while (parent_level)
514     {
515       parent_elt->zero_ref_count++;
516
517       parent_elt = parent_level->parent_elt;
518       parent_level = parent_level->parent_level;
519     }
520   if (new_level != filter->priv->root)
521     filter->priv->zero_ref_count++;
522
523   i = 0;
524
525   first_node = iter;
526
527   do
528     {
529       if (gtk_tree_model_filter_visible (filter, &iter))
530         {
531           FilterElt filter_elt;
532
533           filter_elt.offset = i;
534           filter_elt.zero_ref_count = 0;
535           filter_elt.ref_count = 0;
536           filter_elt.children = NULL;
537           filter_elt.visible = TRUE;
538
539           if (GTK_TREE_MODEL_FILTER_CACHE_CHILD_ITERS (filter))
540             filter_elt.iter = iter;
541
542           g_array_append_val (new_level->array, filter_elt);
543           new_level->visible_nodes++;
544
545           if (new_level->parent_level || filter->priv->virtual_root)
546             {
547               GtkTreeIter f_iter;
548
549               f_iter.stamp = filter->priv->stamp;
550               f_iter.user_data = new_level;
551               f_iter.user_data2 = &(g_array_index (new_level->array, FilterElt, new_level->array->len - 1));
552
553               gtk_tree_model_filter_ref_node (GTK_TREE_MODEL (filter), &f_iter);
554
555               if (emit_inserted)
556                 {
557                   GtkTreePath *f_path;
558
559                   f_path = gtk_tree_model_get_path (GTK_TREE_MODEL (filter),
560                                                     &f_iter);
561                   gtk_tree_model_row_inserted (GTK_TREE_MODEL (filter),
562                                                f_path, &f_iter);
563                   gtk_tree_path_free (f_path);
564                 }
565             }
566         }
567       i++;
568     }
569   while (gtk_tree_model_iter_next (filter->priv->child_model, &iter));
570
571   if (new_level->array->len == 0
572       && (new_level != filter->priv->root || filter->priv->virtual_root))
573     {
574       /* If none of the nodes are visible, we will just pull in the
575        * first node of the level and keep a reference on it.  We need this
576        * to make sure that we get all signals for this level.
577        */
578       FilterElt filter_elt;
579       GtkTreeIter f_iter;
580
581       filter_elt.offset = 0;
582       filter_elt.zero_ref_count = 0;
583       filter_elt.ref_count = 0;
584       filter_elt.children = NULL;
585       filter_elt.visible = FALSE;
586
587       if (GTK_TREE_MODEL_FILTER_CACHE_CHILD_ITERS (filter))
588         filter_elt.iter = first_node;
589
590       g_array_append_val (new_level->array, filter_elt);
591
592       f_iter.stamp = filter->priv->stamp;
593       f_iter.user_data = new_level;
594       f_iter.user_data2 = &(g_array_index (new_level->array, FilterElt, new_level->array->len - 1));
595
596       gtk_tree_model_filter_ref_node (GTK_TREE_MODEL (filter), &f_iter);
597     }
598   else if (new_level->array->len == 0)
599     gtk_tree_model_filter_free_level (filter, new_level);
600 }
601
602 static void
603 gtk_tree_model_filter_free_level (GtkTreeModelFilter *filter,
604                                   FilterLevel        *filter_level)
605 {
606   gint i;
607
608   g_assert (filter_level);
609
610   for (i = 0; i < filter_level->array->len; i++)
611     {
612       if (g_array_index (filter_level->array, FilterElt, i).children)
613         gtk_tree_model_filter_free_level (filter,
614                                           FILTER_LEVEL (g_array_index (filter_level->array, FilterElt, i).children));
615
616       if (filter_level->parent_level || filter->priv->virtual_root)
617         {
618           GtkTreeIter f_iter;
619
620           f_iter.stamp = filter->priv->stamp;
621           f_iter.user_data = filter_level;
622           f_iter.user_data2 = &(g_array_index (filter_level->array, FilterElt, i));
623
624           gtk_tree_model_filter_unref_node (GTK_TREE_MODEL (filter), &f_iter);
625         }
626     }
627
628   if (filter_level->ref_count == 0)
629     {
630       FilterLevel *parent_level = filter_level->parent_level;
631       FilterElt *parent_elt = filter_level->parent_elt;
632
633       while (parent_level)
634         {
635           parent_elt->zero_ref_count--;
636
637           parent_elt = parent_level->parent_elt;
638           parent_level = parent_level->parent_level;
639         }
640
641       if (filter_level != filter->priv->root)
642         filter->priv->zero_ref_count--;
643     }
644
645   if (filter_level->parent_elt)
646     filter_level->parent_elt->children = NULL;
647   else
648     filter->priv->root = NULL;
649
650   g_array_free (filter_level->array, TRUE);
651   filter_level->array = NULL;
652
653   g_free (filter_level);
654   filter_level = NULL;
655 }
656
657 /* Creates paths suitable for accessing the child model. */
658 static GtkTreePath *
659 gtk_tree_model_filter_elt_get_path (FilterLevel *level,
660                                     FilterElt   *elt,
661                                     GtkTreePath *root)
662 {
663   FilterLevel *walker = level;
664   FilterElt *walker2 = elt;
665   GtkTreePath *path;
666   GtkTreePath *real_path;
667
668   g_return_val_if_fail (level != NULL, NULL);
669   g_return_val_if_fail (elt != NULL, NULL);
670
671   path = gtk_tree_path_new ();
672
673   while (walker)
674     {
675       gtk_tree_path_prepend_index (path, walker2->offset);
676
677       walker2 = walker->parent_elt;
678       walker = walker->parent_level;
679     }
680
681   if (root)
682     {
683       real_path = gtk_tree_model_filter_add_root (path, root);
684       gtk_tree_path_free (path);
685       return real_path;
686     }
687
688   return path;
689 }
690
691 static GtkTreePath *
692 gtk_tree_model_filter_add_root (GtkTreePath *src,
693                                 GtkTreePath *root)
694 {
695   GtkTreePath *retval;
696   gint i;
697
698   retval = gtk_tree_path_copy (root);
699
700   for (i = 0; i < gtk_tree_path_get_depth (src); i++)
701     gtk_tree_path_append_index (retval, gtk_tree_path_get_indices (src)[i]);
702
703   return retval;
704 }
705
706 static GtkTreePath *
707 gtk_tree_model_filter_remove_root (GtkTreePath *src,
708                                    GtkTreePath *root)
709 {
710   GtkTreePath *retval;
711   gint i;
712   gint depth;
713   gint *indices;
714
715   if (gtk_tree_path_get_depth (src) <= gtk_tree_path_get_depth (root))
716     return NULL;
717
718   depth = gtk_tree_path_get_depth (src);
719   indices = gtk_tree_path_get_indices (src);
720
721   for (i = 0; i < gtk_tree_path_get_depth (root); i++)
722     if (indices[i] != gtk_tree_path_get_indices (root)[i])
723       return NULL;
724
725   retval = gtk_tree_path_new ();
726
727   for (; i < depth; i++)
728     gtk_tree_path_append_index (retval, indices[i]);
729
730   return retval;
731 }
732
733 static void
734 gtk_tree_model_filter_increment_stamp (GtkTreeModelFilter *filter)
735 {
736   do
737     {
738       filter->priv->stamp++;
739     }
740   while (filter->priv->stamp == 0);
741
742   gtk_tree_model_filter_clear_cache (filter);
743 }
744
745 static gboolean
746 gtk_tree_model_filter_visible (GtkTreeModelFilter *filter,
747                                GtkTreeIter        *child_iter)
748 {
749   if (filter->priv->visible_func)
750     {
751       return filter->priv->visible_func (filter->priv->child_model,
752                                          child_iter,
753                                          filter->priv->visible_data)
754         ? TRUE : FALSE;
755     }
756   else if (filter->priv->visible_column >= 0)
757    {
758      GValue val = {0, };
759
760      gtk_tree_model_get_value (filter->priv->child_model, child_iter,
761                                filter->priv->visible_column, &val);
762
763      if (g_value_get_boolean (&val))
764        {
765          g_value_unset (&val);
766          return TRUE;
767        }
768
769      g_value_unset (&val);
770      return FALSE;
771    }
772
773   /* no visible function set, so always visible */
774   return TRUE;
775 }
776
777 static void
778 gtk_tree_model_filter_clear_cache_helper (GtkTreeModelFilter *filter,
779                                           FilterLevel        *level)
780 {
781   gint i;
782
783   g_assert (level);
784
785   for (i = 0; i < level->array->len; i++)
786     {
787       if (g_array_index (level->array, FilterElt, i).zero_ref_count > 0)
788         gtk_tree_model_filter_clear_cache_helper (filter, g_array_index (level->array, FilterElt, i).children);
789      }
790
791   if (level->ref_count == 0 && level != filter->priv->root)
792     {
793       gtk_tree_model_filter_free_level (filter, level);
794       return;
795     }
796 }
797
798 static FilterElt *
799 gtk_tree_model_filter_get_nth (GtkTreeModelFilter *filter,
800                                FilterLevel        *level,
801                                int                 n)
802 {
803   if (level->array->len <= n)
804     return NULL;
805
806   return &g_array_index (level->array, FilterElt, n);
807 }
808
809 static gboolean
810 gtk_tree_model_filter_elt_is_visible_in_target (FilterLevel *level,
811                                                 FilterElt   *elt)
812 {
813   if (!elt->visible)
814     return FALSE;
815
816   if (!level->parent_elt)
817     return TRUE;
818
819   do
820     {
821       elt = level->parent_elt;
822       level = level->parent_level;
823
824       if (elt && !elt->visible)
825         return FALSE;
826     }
827   while (level);
828
829   return TRUE;
830 }
831
832 static FilterElt *
833 gtk_tree_model_filter_get_nth_visible (GtkTreeModelFilter *filter,
834                                        FilterLevel        *level,
835                                        int                 n)
836 {
837   int i = 0;
838   FilterElt *elt;
839
840   if (level->visible_nodes <= n)
841     return NULL;
842
843   elt = FILTER_ELT (level->array->data);
844   while (!elt->visible)
845     elt++;
846
847   while (i < n)
848     {
849       if (elt->visible)
850         i++;
851       elt++;
852     }
853
854   while (!elt->visible)
855     elt++;
856
857   return elt;
858 }
859
860 static FilterElt *
861 gtk_tree_model_filter_fetch_child (GtkTreeModelFilter *filter,
862                                    FilterLevel        *level,
863                                    gint                offset,
864                                    gint               *index)
865 {
866   gint i = 0;
867   gint start, middle, end;
868   gint len;
869   GtkTreePath *c_path = NULL;
870   GtkTreeIter c_iter;
871   GtkTreePath *c_parent_path = NULL;
872   GtkTreeIter c_parent_iter;
873   FilterElt elt;
874
875   /* check if child exists and is visible */
876   if (level->parent_elt)
877     {
878       c_parent_path =
879         gtk_tree_model_filter_elt_get_path (level->parent_level,
880                                             level->parent_elt,
881                                             filter->priv->virtual_root);
882       if (!c_parent_path)
883         return NULL;
884     }
885   else
886     {
887       if (filter->priv->virtual_root)
888         c_parent_path = gtk_tree_path_copy (filter->priv->virtual_root);
889       else
890         c_parent_path = NULL;
891     }
892
893   if (c_parent_path)
894     {
895       gtk_tree_model_get_iter (filter->priv->child_model,
896                                &c_parent_iter,
897                                c_parent_path);
898       len = gtk_tree_model_iter_n_children (filter->priv->child_model,
899                                             &c_parent_iter);
900
901       c_path = gtk_tree_path_copy (c_parent_path);
902       gtk_tree_path_free (c_parent_path);
903     }
904   else
905     {
906       len = gtk_tree_model_iter_n_children (filter->priv->child_model, NULL);
907       c_path = gtk_tree_path_new ();
908     }
909
910   gtk_tree_path_append_index (c_path, offset);
911   gtk_tree_model_get_iter (filter->priv->child_model, &c_iter, c_path);
912   gtk_tree_path_free (c_path);
913
914   if (offset >= len || !gtk_tree_model_filter_visible (filter, &c_iter))
915     return NULL;
916
917   /* add child */
918   elt.offset = offset;
919   elt.zero_ref_count = 0;
920   elt.ref_count = 0;
921   elt.children = NULL;
922   /* visibility should be FALSE as we don't emit row_inserted */
923   elt.visible = FALSE;
924
925   if (GTK_TREE_MODEL_FILTER_CACHE_CHILD_ITERS (filter))
926     elt.iter = c_iter;
927
928   /* find index (binary search on offset) */
929   start = 0;
930   end = level->array->len;
931
932   if (start != end)
933     {
934       while (start != end)
935         {
936           middle = (start + end) / 2;
937
938           if (g_array_index (level->array, FilterElt, middle).offset <= offset)
939             start = middle + 1;
940           else
941             end = middle;
942         }
943
944       if (g_array_index (level->array, FilterElt, middle).offset <= offset)
945         i = middle + 1;
946       else
947         i = middle;
948     }
949   else
950     i = 0;
951
952   g_array_insert_val (level->array, i, elt);
953   *index = i;
954
955   for (i = 0; i < level->array->len; i++)
956     {
957       FilterElt *e = &(g_array_index (level->array, FilterElt, i));
958       if (e->children)
959         e->children->parent_elt = e;
960     }
961
962   c_iter.stamp = filter->priv->stamp;
963   c_iter.user_data = level;
964   c_iter.user_data2 = &g_array_index (level->array, FilterElt, *index);
965
966   if (level->parent_level || filter->priv->virtual_root)
967     gtk_tree_model_filter_ref_node (GTK_TREE_MODEL (filter), &c_iter);
968
969   return &g_array_index (level->array, FilterElt, *index);
970 }
971
972 static void
973 gtk_tree_model_filter_remove_node (GtkTreeModelFilter *filter,
974                                    GtkTreeIter        *iter)
975 {
976   FilterElt *elt, *parent;
977   FilterLevel *level, *parent_level;
978   gint i, length;
979
980   gboolean emit_child_toggled = FALSE;
981
982   level = FILTER_LEVEL (iter->user_data);
983   elt = FILTER_ELT (iter->user_data2);
984
985   parent = level->parent_elt;
986   parent_level = level->parent_level;
987
988   length = level->array->len;
989
990   /* we distinguish a couple of cases:
991    *  - root level, length > 1: emit row-deleted and remove.
992    *  - root level, length == 1: emit row-deleted and keep in cache.
993    *  - level, length == 1: parent->ref_count > 1: emit row-deleted and keep.
994    *  - level, length > 1: emit row-deleted and remove.
995    *  - else, remove level.
996    *
997    *  if level != root level and visible nodes == 0, emit row-has-child-toggled.
998    */
999
1000   if (level != filter->priv->root
1001       && level->visible_nodes == 0
1002       && level->parent_elt
1003       && level->parent_elt->visible)
1004     emit_child_toggled = TRUE;
1005
1006   if (length > 1)
1007     {
1008       GtkTreePath *path;
1009       FilterElt *tmp;
1010
1011       /* we emit row-deleted, and remove the node from the cache.
1012        */
1013
1014       path = gtk_tree_model_get_path (GTK_TREE_MODEL (filter), iter);
1015       elt->visible = FALSE;
1016       gtk_tree_model_filter_increment_stamp (filter);
1017       iter->stamp = filter->priv->stamp;
1018       gtk_tree_model_row_deleted (GTK_TREE_MODEL (filter), path);
1019       gtk_tree_path_free (path);
1020
1021       while (elt->ref_count > 1)
1022         gtk_tree_model_filter_real_unref_node (GTK_TREE_MODEL (filter),
1023                                                iter, FALSE);
1024
1025       if (parent_level || filter->priv->virtual_root)
1026         gtk_tree_model_filter_unref_node (GTK_TREE_MODEL (filter), iter);
1027       else if (elt->ref_count > 0)
1028         gtk_tree_model_filter_real_unref_node (GTK_TREE_MODEL (filter),
1029                                                iter, FALSE);
1030
1031       /* remove the node */
1032       tmp = bsearch_elt_with_offset (level->array, elt->offset, &i);
1033
1034       if (tmp)
1035         {
1036           g_array_remove_index (level->array, i);
1037
1038           i--;
1039           for (i = MAX (i, 0); i < level->array->len; i++)
1040             {
1041               /* NOTE: here we do *not* decrease offsets, because the node was
1042                * not removed from the child model
1043                */
1044               elt = &g_array_index (level->array, FilterElt, i);
1045               if (elt->children)
1046                 elt->children->parent_elt = elt;
1047             }
1048         }
1049     }
1050   else if ((length == 1 && parent && parent->ref_count > 1)
1051            || (length == 1 && level == filter->priv->root))
1052     {
1053       GtkTreePath *path;
1054
1055       /* we emit row-deleted, but keep the node in the cache and
1056        * referenced.
1057        */
1058
1059       path = gtk_tree_model_get_path (GTK_TREE_MODEL (filter), iter);
1060       elt->visible = FALSE;
1061       gtk_tree_model_filter_increment_stamp (filter);
1062       gtk_tree_model_row_deleted (GTK_TREE_MODEL (filter), path);
1063       gtk_tree_path_free (path);
1064     }
1065   else
1066     {
1067       GtkTreePath *path;
1068
1069       /* blow level away */
1070
1071       path = gtk_tree_model_get_path (GTK_TREE_MODEL (filter), iter);
1072       elt->visible = FALSE;
1073       gtk_tree_model_filter_increment_stamp (filter);
1074       iter->stamp = filter->priv->stamp;
1075       gtk_tree_model_row_deleted (GTK_TREE_MODEL (filter), path);
1076       gtk_tree_path_free (path);
1077
1078       while (elt->ref_count > 1)
1079         gtk_tree_model_filter_real_unref_node (GTK_TREE_MODEL (filter),
1080                                                iter, FALSE);
1081
1082       gtk_tree_model_filter_free_level (filter, level);
1083     }
1084
1085   if (emit_child_toggled)
1086     {
1087       GtkTreeIter piter;
1088       GtkTreePath *ppath;
1089
1090       piter.stamp = filter->priv->stamp;
1091       piter.user_data = parent_level;
1092       piter.user_data2 = parent;
1093
1094       ppath = gtk_tree_model_get_path (GTK_TREE_MODEL (filter), &piter);
1095
1096       gtk_tree_model_row_has_child_toggled (GTK_TREE_MODEL (filter),
1097                                             ppath, &piter);
1098       gtk_tree_path_free (ppath);
1099     }
1100 }
1101
1102 static void
1103 gtk_tree_model_filter_update_children (GtkTreeModelFilter *filter,
1104                                        FilterLevel        *level,
1105                                        FilterElt          *elt)
1106 {
1107   GtkTreeIter c_iter;
1108   GtkTreeIter iter;
1109
1110   if (!elt->visible)
1111     return;
1112
1113   iter.stamp = filter->priv->stamp;
1114   iter.user_data = level;
1115   iter.user_data2 = elt;
1116
1117   gtk_tree_model_filter_convert_iter_to_child_iter (filter, &c_iter, &iter);
1118
1119   if (gtk_tree_model_iter_has_child (filter->priv->child_model, &c_iter))
1120     {
1121       GtkTreePath *path = gtk_tree_model_get_path (GTK_TREE_MODEL (filter),
1122                                                    &iter);
1123       gtk_tree_model_row_has_child_toggled (GTK_TREE_MODEL (filter),
1124                                             path,
1125                                             &iter);
1126       if (path)
1127         gtk_tree_path_free (path);
1128     }
1129 }
1130
1131 static FilterElt *
1132 bsearch_elt_with_offset (GArray *array,
1133                          gint    offset,
1134                          gint   *index)
1135 {
1136   gint start, middle, end;
1137   FilterElt *elt;
1138
1139   start = 0;
1140   end = array->len;
1141
1142   if (array->len < 1)
1143     return NULL;
1144
1145   if (start == end)
1146     {
1147       elt = &g_array_index (array, FilterElt, 0);
1148
1149       if (elt->offset == offset)
1150         {
1151           *index = 0;
1152           return elt;
1153         }
1154       else
1155         return NULL;
1156     }
1157
1158   do
1159     {
1160       middle = (start + end) / 2;
1161
1162       elt = &g_array_index (array, FilterElt, middle);
1163
1164       if (elt->offset < offset)
1165         start = middle + 1;
1166       else if (elt->offset > offset)
1167         end = middle;
1168       else
1169         break;
1170     }
1171   while (start != end);
1172
1173   if (elt->offset == offset)
1174     {
1175       *index = middle;
1176       return elt;
1177     }
1178
1179   return NULL;
1180 }
1181
1182 /* TreeModel signals */
1183 static void
1184 gtk_tree_model_filter_row_changed (GtkTreeModel *c_model,
1185                                    GtkTreePath  *c_path,
1186                                    GtkTreeIter  *c_iter,
1187                                    gpointer      data)
1188 {
1189   GtkTreeModelFilter *filter = GTK_TREE_MODEL_FILTER (data);
1190   GtkTreeIter iter;
1191   GtkTreeIter children;
1192   GtkTreeIter real_c_iter;
1193   GtkTreePath *path = NULL;
1194
1195   FilterElt *elt;
1196   FilterLevel *level;
1197
1198   gboolean requested_state;
1199   gboolean current_state;
1200   gboolean free_c_path = FALSE;
1201
1202   g_return_if_fail (c_path != NULL || c_iter != NULL);
1203
1204   if (!c_path)
1205     {
1206       c_path = gtk_tree_model_get_path (c_model, c_iter);
1207       free_c_path = TRUE;
1208     }
1209
1210   if (c_iter)
1211     real_c_iter = *c_iter;
1212   else
1213     gtk_tree_model_get_iter (c_model, &real_c_iter, c_path);
1214
1215   /* is this node above the virtual root? */
1216   if (filter->priv->virtual_root
1217       && (gtk_tree_path_get_depth (filter->priv->virtual_root)
1218           >= gtk_tree_path_get_depth (c_path)))
1219     goto done;
1220
1221   /* what's the requested state? */
1222   requested_state = gtk_tree_model_filter_visible (filter, &real_c_iter);
1223
1224   /* now, let's see whether the item is there */
1225   path = gtk_real_tree_model_filter_convert_child_path_to_path (filter,
1226                                                                 c_path,
1227                                                                 FALSE,
1228                                                                 FALSE);
1229
1230   if (path)
1231     {
1232       gtk_tree_model_filter_get_iter_full (GTK_TREE_MODEL (filter),
1233                                            &iter, path);
1234       current_state = FILTER_ELT (iter.user_data2)->visible;
1235     }
1236   else
1237     current_state = FALSE;
1238
1239   if (current_state == FALSE && requested_state == FALSE)
1240     /* no changes required */
1241     goto done;
1242
1243   if (current_state == TRUE && requested_state == FALSE)
1244     {
1245       /* get rid of this node */
1246       level = FILTER_LEVEL (iter.user_data);
1247       level->visible_nodes--;
1248
1249       gtk_tree_model_filter_remove_node (filter, &iter);
1250
1251       goto done;
1252     }
1253
1254   if (current_state == TRUE && requested_state == TRUE)
1255     {
1256       /* propagate the signal; also get a path taking only visible
1257        * nodes into account.
1258        */
1259       gtk_tree_path_free (path);
1260       path = gtk_tree_model_get_path (GTK_TREE_MODEL (filter), &iter);
1261       gtk_tree_model_row_changed (GTK_TREE_MODEL (filter), path, &iter);
1262
1263       level = FILTER_LEVEL (iter.user_data);
1264       elt = FILTER_ELT (iter.user_data2);
1265
1266       /* and update the children */
1267       if (gtk_tree_model_iter_children (c_model, &children, &real_c_iter))
1268         gtk_tree_model_filter_update_children (filter, level, elt);
1269
1270       goto done;
1271     }
1272
1273   /* only current == FALSE and requested == TRUE is left,
1274    * pull in the child
1275    */
1276   g_return_if_fail (current_state == FALSE && requested_state == TRUE);
1277
1278   /* make sure the new item has been pulled in */
1279   if (!filter->priv->root)
1280     {
1281       gint i;
1282       FilterLevel *root;
1283
1284       gtk_tree_model_filter_build_level (filter, NULL, NULL, FALSE);
1285
1286       root = FILTER_LEVEL (filter->priv->root);
1287
1288       if (root)
1289         {
1290           for (i = 0; i < root->array->len; i++)
1291             g_array_index (root->array, FilterElt, i).visible = FALSE;
1292           root->visible_nodes = 0;
1293         }
1294     }
1295
1296   gtk_tree_model_filter_increment_stamp (filter);
1297
1298   if (!path)
1299     path = gtk_real_tree_model_filter_convert_child_path_to_path (filter,
1300                                                                   c_path,
1301                                                                   TRUE,
1302                                                                   TRUE);
1303
1304   if (!path)
1305     /* parent is probably being filtered out */
1306     goto done;
1307
1308   gtk_tree_model_filter_get_iter_full (GTK_TREE_MODEL (filter), &iter, path);
1309
1310   level = FILTER_LEVEL (iter.user_data);
1311   elt = FILTER_ELT (iter.user_data2);
1312
1313   /* elt->visible can be TRUE at this point if it was pulled in above */
1314   if (!elt->visible)
1315     {
1316       elt->visible = TRUE;
1317       level->visible_nodes++;
1318     }
1319
1320   if (gtk_tree_model_filter_elt_is_visible_in_target (level, elt))
1321     {
1322       /* visibility changed -- reget path */
1323       gtk_tree_path_free (path);
1324       path = gtk_tree_model_get_path (GTK_TREE_MODEL (filter), &iter);
1325
1326       gtk_tree_model_row_inserted (GTK_TREE_MODEL (filter), path, &iter);
1327
1328       if (gtk_tree_model_iter_children (c_model, &children, c_iter))
1329         gtk_tree_model_filter_update_children (filter, level, elt);
1330     }
1331
1332 done:
1333   if (path)
1334     gtk_tree_path_free (path);
1335
1336   if (free_c_path)
1337     gtk_tree_path_free (c_path);
1338 }
1339
1340 static void
1341 gtk_tree_model_filter_row_inserted (GtkTreeModel *c_model,
1342                                     GtkTreePath  *c_path,
1343                                     GtkTreeIter  *c_iter,
1344                                     gpointer      data)
1345 {
1346   GtkTreeModelFilter *filter = GTK_TREE_MODEL_FILTER (data);
1347   GtkTreePath *path = NULL;
1348   GtkTreePath *real_path = NULL;
1349   GtkTreeIter iter;
1350
1351   GtkTreeIter real_c_iter;
1352
1353   FilterElt *elt;
1354   FilterLevel *level;
1355   FilterLevel *parent_level;
1356
1357   gint i = 0, offset;
1358
1359   gboolean free_c_path = FALSE;
1360
1361   g_return_if_fail (c_path != NULL || c_iter != NULL);
1362
1363   if (!c_path)
1364     {
1365       c_path = gtk_tree_model_get_path (c_model, c_iter);
1366       free_c_path = TRUE;
1367     }
1368
1369   if (c_iter)
1370     real_c_iter = *c_iter;
1371   else
1372     gtk_tree_model_get_iter (c_model, &real_c_iter, c_path);
1373
1374   /* the row has already been inserted. so we need to fixup the
1375    * virtual root here first
1376    */
1377   if (filter->priv->virtual_root)
1378     {
1379       if (gtk_tree_path_get_depth (filter->priv->virtual_root) >=
1380           gtk_tree_path_get_depth (c_path))
1381         {
1382           gint level;
1383           gint *v_indices, *c_indices;
1384           gboolean common_prefix = TRUE;
1385
1386           level = gtk_tree_path_get_depth (c_path) - 1;
1387           v_indices = gtk_tree_path_get_indices (filter->priv->virtual_root);
1388           c_indices = gtk_tree_path_get_indices (c_path);
1389
1390           for (i = 0; i < level; i++)
1391             if (v_indices[i] != c_indices[i])
1392               {
1393                 common_prefix = FALSE;
1394                 break;
1395               }
1396
1397           if (common_prefix && v_indices[level] >= c_indices[level])
1398             (v_indices[level])++;
1399         }
1400     }
1401
1402   if (!filter->priv->root)
1403     {
1404       /* No point in building the level if this node is not visible. */
1405       if (!filter->priv->virtual_root
1406           && !gtk_tree_model_filter_visible (filter, c_iter))
1407         goto done;
1408
1409       /* build level will pull in the new child */
1410       gtk_tree_model_filter_build_level (filter, NULL, NULL, FALSE);
1411
1412       if (filter->priv->root
1413           && FILTER_LEVEL (filter->priv->root)->visible_nodes)
1414         goto done_and_emit;
1415       else
1416         goto done;
1417     }
1418
1419   parent_level = level = FILTER_LEVEL (filter->priv->root);
1420
1421   /* subtract virtual root if necessary */
1422   if (filter->priv->virtual_root)
1423     {
1424       real_path = gtk_tree_model_filter_remove_root (c_path,
1425                                                      filter->priv->virtual_root);
1426       /* not our child */
1427       if (!real_path)
1428         goto done;
1429     }
1430   else
1431     real_path = gtk_tree_path_copy (c_path);
1432
1433   if (gtk_tree_path_get_depth (real_path) - 1 >= 1)
1434     {
1435       /* find the parent level */
1436       while (i < gtk_tree_path_get_depth (real_path) - 1)
1437         {
1438           gint j;
1439
1440           if (!level)
1441             /* we don't cover this signal */
1442             goto done;
1443
1444           elt = bsearch_elt_with_offset (level->array,
1445                                          gtk_tree_path_get_indices (real_path)[i],
1446                                          &j);
1447
1448           if (!elt)
1449             /* parent is probably being filtered out */
1450             goto done;
1451
1452           if (!elt->children)
1453             {
1454               GtkTreePath *tmppath;
1455               GtkTreeIter  tmpiter;
1456
1457               tmpiter.stamp = filter->priv->stamp;
1458               tmpiter.user_data = level;
1459               tmpiter.user_data2 = elt;
1460
1461               tmppath = gtk_tree_model_get_path (GTK_TREE_MODEL (data),
1462                                                  &tmpiter);
1463
1464               if (tmppath)
1465                 {
1466                   gtk_tree_model_row_has_child_toggled (GTK_TREE_MODEL (data),
1467                                                         tmppath, &tmpiter);
1468                   gtk_tree_path_free (tmppath);
1469                 }
1470
1471               /* not covering this signal */
1472               goto done;
1473             }
1474
1475           level = elt->children;
1476           parent_level = level;
1477           i++;
1478         }
1479     }
1480
1481   if (!parent_level)
1482     goto done;
1483
1484   /* let's try to insert the value */
1485   offset = gtk_tree_path_get_indices (real_path)[gtk_tree_path_get_depth (real_path) - 1];
1486
1487   /* update the offsets, yes if we didn't insert the node above, there will
1488    * be a gap here. This will be filled with the node (via fetch_child) when
1489    * it becomes visible
1490    */
1491   for (i = 0; i < level->array->len; i++)
1492     {
1493       FilterElt *e = &g_array_index (level->array, FilterElt, i);
1494       if ((e->offset >= offset))
1495         e->offset++;
1496     }
1497
1498   /* only insert when visible */
1499   if (gtk_tree_model_filter_visible (filter, &real_c_iter))
1500     {
1501       FilterElt felt;
1502
1503       if (GTK_TREE_MODEL_FILTER_CACHE_CHILD_ITERS (filter))
1504         felt.iter = real_c_iter;
1505
1506       felt.offset = offset;
1507       felt.zero_ref_count = 0;
1508       felt.ref_count = 0;
1509       felt.visible = TRUE;
1510       felt.children = NULL;
1511
1512       for (i = 0; i < level->array->len; i++)
1513         if (g_array_index (level->array, FilterElt, i).offset > offset)
1514           break;
1515
1516       level->visible_nodes++;
1517
1518       g_array_insert_val (level->array, i, felt);
1519
1520       if (level->parent_level || filter->priv->virtual_root)
1521         {
1522           GtkTreeIter f_iter;
1523
1524           f_iter.stamp = filter->priv->stamp;
1525           f_iter.user_data = level;
1526           f_iter.user_data2 = &g_array_index (level->array, FilterElt, i);
1527
1528           gtk_tree_model_filter_ref_node (GTK_TREE_MODEL (filter), &f_iter);
1529         }
1530     }
1531
1532   /* another iteration to update the references of children to parents. */
1533   for (i = 0; i < level->array->len; i++)
1534     {
1535       FilterElt *e = &g_array_index (level->array, FilterElt, i);
1536       if (e->children)
1537         e->children->parent_elt = e;
1538     }
1539
1540   /* don't emit the signal if we aren't visible */
1541   if (!gtk_tree_model_filter_visible (filter, &real_c_iter))
1542     goto done;
1543
1544 done_and_emit:
1545   /* NOTE: pass c_path here and NOT real_path. This function does
1546    * root subtraction itself
1547    */
1548   path = gtk_real_tree_model_filter_convert_child_path_to_path (filter,
1549                                                                 c_path,
1550                                                                 FALSE, TRUE);
1551
1552   if (!path)
1553     goto done;
1554
1555   gtk_tree_model_filter_increment_stamp (filter);
1556
1557   gtk_tree_model_filter_get_iter_full (GTK_TREE_MODEL (data), &iter, path);
1558
1559   /* get a path taking only visible nodes into account */
1560   gtk_tree_path_free (path);
1561   path = gtk_tree_model_get_path (GTK_TREE_MODEL (data), &iter);
1562
1563   gtk_tree_model_row_inserted (GTK_TREE_MODEL (data), path, &iter);
1564
1565   gtk_tree_path_free (path);
1566
1567 done:
1568   if (real_path)
1569     gtk_tree_path_free (real_path);
1570
1571   if (free_c_path)
1572     gtk_tree_path_free (c_path);
1573 }
1574
1575 static void
1576 gtk_tree_model_filter_row_has_child_toggled (GtkTreeModel *c_model,
1577                                              GtkTreePath  *c_path,
1578                                              GtkTreeIter  *c_iter,
1579                                              gpointer      data)
1580 {
1581   GtkTreeModelFilter *filter = GTK_TREE_MODEL_FILTER (data);
1582   GtkTreePath *path;
1583   GtkTreeIter iter;
1584   FilterLevel *level;
1585   FilterElt *elt;
1586
1587   g_return_if_fail (c_path != NULL && c_iter != NULL);
1588
1589   /* If we get row-has-child-toggled on the virtual root, and there is
1590    * no root level; try to build it now.
1591    */
1592   if (filter->priv->virtual_root && !filter->priv->root
1593       && !gtk_tree_path_compare (c_path, filter->priv->virtual_root))
1594     {
1595       gtk_tree_model_filter_build_level (filter, NULL, NULL, TRUE);
1596       return;
1597     }
1598
1599   if (!gtk_tree_model_filter_visible (filter, c_iter))
1600     return;
1601
1602   path = gtk_real_tree_model_filter_convert_child_path_to_path (filter,
1603                                                                 c_path,
1604                                                                 FALSE,
1605                                                                 TRUE);
1606   if (!path)
1607     return;
1608
1609   gtk_tree_model_filter_get_iter_full (GTK_TREE_MODEL (data), &iter, path);
1610
1611   gtk_tree_path_free (path);
1612
1613   level = FILTER_LEVEL (iter.user_data);
1614   elt = FILTER_ELT (iter.user_data2);
1615
1616   g_assert (elt->visible);
1617
1618   /* If this node is referenced and has children, build the level so we
1619    * can monitor it for changes.
1620    */
1621   if (elt->ref_count > 1 && gtk_tree_model_iter_has_child (c_model, c_iter))
1622     gtk_tree_model_filter_build_level (filter, level, elt, TRUE);
1623
1624   /* get a path taking only visible nodes into account */
1625   path = gtk_tree_model_get_path (GTK_TREE_MODEL (data), &iter);
1626   gtk_tree_model_row_has_child_toggled (GTK_TREE_MODEL (data), path, &iter);
1627   gtk_tree_path_free (path);
1628 }
1629
1630 static void
1631 gtk_tree_model_filter_row_deleted (GtkTreeModel *c_model,
1632                                    GtkTreePath  *c_path,
1633                                    gpointer      data)
1634 {
1635   GtkTreeModelFilter *filter = GTK_TREE_MODEL_FILTER (data);
1636   GtkTreePath *path;
1637   GtkTreeIter iter;
1638   FilterElt *elt, *parent = NULL;
1639   FilterLevel *level, *parent_level = NULL;
1640   gboolean emit_child_toggled = FALSE;
1641   gint offset;
1642   gint i;
1643
1644   g_return_if_fail (c_path != NULL);
1645
1646   /* special case the deletion of an ancestor of the virtual root */
1647   if (filter->priv->virtual_root &&
1648       (gtk_tree_path_is_ancestor (c_path, filter->priv->virtual_root) ||
1649        !gtk_tree_path_compare (c_path, filter->priv->virtual_root)))
1650     {
1651       gint i;
1652       GtkTreePath *path;
1653       FilterLevel *level = FILTER_LEVEL (filter->priv->root);
1654
1655       gtk_tree_model_filter_unref_path (filter, filter->priv->virtual_root);
1656       filter->priv->virtual_root_deleted = TRUE;
1657
1658       if (!level)
1659         return;
1660
1661       /* remove everything in the filter model
1662        *
1663        * For now, we just iterate over the root level and emit a
1664        * row_deleted for each FilterElt. Not sure if this is correct.
1665        */
1666
1667       gtk_tree_model_filter_increment_stamp (filter);
1668       path = gtk_tree_path_new ();
1669       gtk_tree_path_append_index (path, 0);
1670
1671       for (i = 0; i < level->visible_nodes; i++)
1672         gtk_tree_model_row_deleted (GTK_TREE_MODEL (data), path);
1673
1674       gtk_tree_path_free (path);
1675       gtk_tree_model_filter_free_level (filter, filter->priv->root);
1676
1677       return;
1678     }
1679
1680   /* fixup virtual root */
1681   if (filter->priv->virtual_root)
1682     {
1683       if (gtk_tree_path_get_depth (filter->priv->virtual_root) >=
1684           gtk_tree_path_get_depth (c_path))
1685         {
1686           gint level;
1687           gint *v_indices, *c_indices;
1688           gboolean common_prefix = TRUE;
1689
1690           level = gtk_tree_path_get_depth (c_path) - 1;
1691           v_indices = gtk_tree_path_get_indices (filter->priv->virtual_root);
1692           c_indices = gtk_tree_path_get_indices (c_path);
1693
1694           for (i = 0; i < level; i++)
1695             if (v_indices[i] != c_indices[i])
1696               {
1697                 common_prefix = FALSE;
1698                 break;
1699               }
1700
1701           if (common_prefix && v_indices[level] > c_indices[level])
1702             (v_indices[level])--;
1703         }
1704     }
1705
1706   path = gtk_real_tree_model_filter_convert_child_path_to_path (filter,
1707                                                                 c_path,
1708                                                                 FALSE,
1709                                                                 FALSE);
1710
1711   if (!path)
1712     {
1713       /* The node deleted in the child model is not visible in the
1714        * filter model.  We will not emit a signal, just fixup the offsets
1715        * of the other nodes.
1716        */
1717       GtkTreePath *real_path;
1718
1719       if (!filter->priv->root)
1720         return;
1721
1722       level = FILTER_LEVEL (filter->priv->root);
1723
1724       /* subtract vroot if necessary */
1725       if (filter->priv->virtual_root)
1726         {
1727           real_path = gtk_tree_model_filter_remove_root (c_path,
1728                                                          filter->priv->virtual_root);
1729           /* we don't handle this */
1730           if (!real_path)
1731             return;
1732         }
1733       else
1734         real_path = gtk_tree_path_copy (c_path);
1735
1736       i = 0;
1737       if (gtk_tree_path_get_depth (real_path) - 1 >= 1)
1738         {
1739           /* find the level where the deletion occurred */
1740           while (i < gtk_tree_path_get_depth (real_path) - 1)
1741             {
1742               gint j;
1743
1744               if (!level)
1745                 {
1746                   /* we don't cover this */
1747                   gtk_tree_path_free (real_path);
1748                   return;
1749                 }
1750
1751               elt = bsearch_elt_with_offset (level->array,
1752                                              gtk_tree_path_get_indices (real_path)[i],
1753                                              &j);
1754
1755               if (!elt || !elt->children)
1756                 {
1757                   /* parent is filtered out, so no level */
1758                   gtk_tree_path_free (real_path);
1759                   return;
1760                 }
1761
1762               level = elt->children;
1763               i++;
1764             }
1765         }
1766
1767       offset = gtk_tree_path_get_indices (real_path)[gtk_tree_path_get_depth (real_path) - 1];
1768       gtk_tree_path_free (real_path);
1769
1770       if (!level)
1771         return;
1772
1773       /* decrease offset of all nodes following the deleted node */
1774       for (i = 0; i < level->array->len; i++)
1775         {
1776           elt = &g_array_index (level->array, FilterElt, i);
1777           if (elt->offset > offset)
1778             elt->offset--;
1779           if (elt->children)
1780             elt->children->parent_elt = elt;
1781         }
1782
1783       return;
1784     }
1785
1786   /* a node was deleted, which was in our cache */
1787   gtk_tree_model_filter_get_iter_full (GTK_TREE_MODEL (data), &iter, path);
1788
1789   level = FILTER_LEVEL (iter.user_data);
1790   elt = FILTER_ELT (iter.user_data2);
1791   offset = elt->offset;
1792
1793   if (elt->visible)
1794     {
1795       /* get a path taking only visible nodes into account */
1796       gtk_tree_path_free (path);
1797       path = gtk_tree_model_get_path (GTK_TREE_MODEL (filter), &iter);
1798
1799       level->visible_nodes--;
1800
1801       if (level->visible_nodes == 0)
1802         {
1803           emit_child_toggled = TRUE;
1804           parent_level = level->parent_level;
1805           parent = level->parent_elt;
1806         }
1807
1808       /* emit row_deleted */
1809       gtk_tree_model_filter_increment_stamp (filter);
1810       gtk_tree_model_row_deleted (GTK_TREE_MODEL (data), path);
1811       iter.stamp = filter->priv->stamp;
1812     }
1813
1814   /* The filter model's reference on the child node is released
1815    * below.
1816    */
1817   while (elt->ref_count > 1)
1818     gtk_tree_model_filter_real_unref_node (GTK_TREE_MODEL (data), &iter,
1819                                            FALSE);
1820
1821   if (level->array->len == 1)
1822     {
1823       /* kill level */
1824       gtk_tree_model_filter_free_level (filter, level);
1825     }
1826   else
1827     {
1828       FilterElt *tmp;
1829
1830       /* release the filter model's reference on the node */
1831       if (level->parent_level || filter->priv->virtual_root)
1832         gtk_tree_model_filter_unref_node (GTK_TREE_MODEL (filter), &iter);
1833       else if (elt->ref_count > 0)
1834         gtk_tree_model_filter_real_unref_node (GTK_TREE_MODEL (data), &iter,
1835                                                FALSE);
1836
1837       /* remove the row */
1838       tmp = bsearch_elt_with_offset (level->array, elt->offset, &i);
1839
1840       offset = tmp->offset;
1841       g_array_remove_index (level->array, i);
1842
1843       i--;
1844       for (i = MAX (i, 0); i < level->array->len; i++)
1845         {
1846           elt = &g_array_index (level->array, FilterElt, i);
1847           if (elt->offset > offset)
1848             elt->offset--;
1849           if (elt->children)
1850             elt->children->parent_elt = elt;
1851         }
1852     }
1853
1854   if (emit_child_toggled && parent_level)
1855     {
1856       GtkTreeIter iter;
1857       GtkTreePath *path;
1858
1859       iter.stamp = filter->priv->stamp;
1860       iter.user_data = parent_level;
1861       iter.user_data2 = parent;
1862
1863       /* We set in_row_deleted to TRUE to avoid a level build triggered
1864        * by row-has-child-toggled (parent model could call iter_has_child
1865        * for example).
1866        */
1867       filter->priv->in_row_deleted = TRUE;
1868       path = gtk_tree_model_get_path (GTK_TREE_MODEL (filter), &iter);
1869       gtk_tree_model_row_has_child_toggled (GTK_TREE_MODEL (filter),
1870                                             path, &iter);
1871       gtk_tree_path_free (path);
1872       filter->priv->in_row_deleted = FALSE;
1873     }
1874
1875   gtk_tree_path_free (path);
1876 }
1877
1878 static void
1879 gtk_tree_model_filter_rows_reordered (GtkTreeModel *c_model,
1880                                       GtkTreePath  *c_path,
1881                                       GtkTreeIter  *c_iter,
1882                                       gint         *new_order,
1883                                       gpointer      data)
1884 {
1885   FilterElt *elt;
1886   FilterLevel *level;
1887   GtkTreeModelFilter *filter = GTK_TREE_MODEL_FILTER (data);
1888
1889   GtkTreePath *path;
1890   GtkTreeIter iter;
1891
1892   gint *tmp_array;
1893   gint i, j, elt_count;
1894   gint length;
1895
1896   GArray *new_array;
1897
1898   g_return_if_fail (new_order != NULL);
1899
1900   if (c_path == NULL || gtk_tree_path_get_depth (c_path) == 0)
1901     {
1902       length = gtk_tree_model_iter_n_children (c_model, NULL);
1903
1904       if (filter->priv->virtual_root)
1905         {
1906           gint new_pos = -1;
1907
1908           /* reorder root level of path */
1909           for (i = 0; i < length; i++)
1910             if (new_order[i] == gtk_tree_path_get_indices (filter->priv->virtual_root)[0])
1911               new_pos = i;
1912
1913           if (new_pos < 0)
1914             return;
1915
1916           gtk_tree_path_get_indices (filter->priv->virtual_root)[0] = new_pos;
1917           return;
1918         }
1919
1920       path = gtk_tree_path_new ();
1921       level = FILTER_LEVEL (filter->priv->root);
1922     }
1923   else
1924     {
1925       GtkTreeIter child_iter;
1926
1927       /* virtual root anchor reordering */
1928       if (filter->priv->virtual_root &&
1929           gtk_tree_path_is_ancestor (c_path, filter->priv->virtual_root))
1930         {
1931           gint new_pos = -1;
1932           gint length;
1933           gint level;
1934           GtkTreeIter real_c_iter;
1935
1936           level = gtk_tree_path_get_depth (c_path);
1937
1938           if (c_iter)
1939             real_c_iter = *c_iter;
1940           else
1941             gtk_tree_model_get_iter (c_model, &real_c_iter, c_path);
1942
1943           length = gtk_tree_model_iter_n_children (c_model, &real_c_iter);
1944
1945           for (i = 0; i < length; i++)
1946             if (new_order[i] == gtk_tree_path_get_indices (filter->priv->virtual_root)[level])
1947               new_pos = i;
1948
1949           if (new_pos < 0)
1950             return;
1951
1952           gtk_tree_path_get_indices (filter->priv->virtual_root)[level] = new_pos;
1953           return;
1954         }
1955
1956       path = gtk_real_tree_model_filter_convert_child_path_to_path (filter,
1957                                                                     c_path,
1958                                                                     FALSE,
1959                                                                     FALSE);
1960
1961       if (!path && filter->priv->virtual_root &&
1962           gtk_tree_path_compare (c_path, filter->priv->virtual_root))
1963         return;
1964
1965       if (!path && !filter->priv->virtual_root)
1966         return;
1967
1968       if (!path)
1969         {
1970           /* root level mode */
1971           if (!c_iter)
1972             gtk_tree_model_get_iter (c_model, c_iter, c_path);
1973           length = gtk_tree_model_iter_n_children (c_model, c_iter);
1974           path = gtk_tree_path_new ();
1975           level = FILTER_LEVEL (filter->priv->root);
1976         }
1977       else
1978         {
1979           gtk_tree_model_filter_get_iter_full (GTK_TREE_MODEL (data),
1980                                                &iter, path);
1981
1982           level = FILTER_LEVEL (iter.user_data);
1983           elt = FILTER_ELT (iter.user_data2);
1984
1985           if (!elt->children)
1986             {
1987               gtk_tree_path_free (path);
1988               return;
1989             }
1990
1991           level = elt->children;
1992
1993           gtk_tree_model_filter_convert_iter_to_child_iter (GTK_TREE_MODEL_FILTER (filter), &child_iter, &iter);
1994           length = gtk_tree_model_iter_n_children (c_model, &child_iter);
1995         }
1996     }
1997
1998   if (!level || level->array->len < 1)
1999     {
2000       gtk_tree_path_free (path);
2001       return;
2002     }
2003
2004   /* NOTE: we do not bail out here if level->array->len < 2 like
2005    * GtkTreeModelSort does. This because we do some special tricky
2006    * reordering.
2007    */
2008
2009   /* construct a new array */
2010   new_array = g_array_sized_new (FALSE, FALSE, sizeof (FilterElt),
2011                                  level->array->len);
2012   tmp_array = g_new (gint, level->array->len);
2013
2014   for (i = 0, elt_count = 0; i < length; i++)
2015     {
2016       FilterElt *e = NULL;
2017       gint old_offset = -1;
2018
2019       for (j = 0; j < level->array->len; j++)
2020         if (g_array_index (level->array, FilterElt, j).offset == new_order[i])
2021           {
2022             e = &g_array_index (level->array, FilterElt, j);
2023             old_offset = j;
2024             break;
2025           }
2026
2027       if (!e)
2028         continue;
2029
2030       tmp_array[elt_count] = old_offset;
2031       g_array_append_val (new_array, *e);
2032       g_array_index (new_array, FilterElt, elt_count).offset = i;
2033       elt_count++;
2034     }
2035
2036   g_array_free (level->array, TRUE);
2037   level->array = new_array;
2038
2039   /* fix up stuff */
2040   for (i = 0; i < level->array->len; i++)
2041     {
2042       FilterElt *e = &g_array_index (level->array, FilterElt, i);
2043       if (e->children)
2044         e->children->parent_elt = e;
2045     }
2046
2047   /* emit rows_reordered */
2048   if (!gtk_tree_path_get_indices (path))
2049     gtk_tree_model_rows_reordered (GTK_TREE_MODEL (data), path, NULL,
2050                                    tmp_array);
2051   else
2052     {
2053       /* get a path taking only visible nodes into account */
2054       gtk_tree_path_free (path);
2055       path = gtk_tree_model_get_path (GTK_TREE_MODEL (data), &iter);
2056
2057       gtk_tree_model_rows_reordered (GTK_TREE_MODEL (data), path, &iter,
2058                                      tmp_array);
2059     }
2060
2061   /* done */
2062   g_free (tmp_array);
2063   gtk_tree_path_free (path);
2064 }
2065
2066 /* TreeModelIface implementation */
2067 static GtkTreeModelFlags
2068 gtk_tree_model_filter_get_flags (GtkTreeModel *model)
2069 {
2070   GtkTreeModelFlags flags;
2071
2072   g_return_val_if_fail (GTK_IS_TREE_MODEL_FILTER (model), 0);
2073   g_return_val_if_fail (GTK_TREE_MODEL_FILTER (model)->priv->child_model != NULL, 0);
2074
2075   flags = gtk_tree_model_get_flags (GTK_TREE_MODEL_FILTER (model)->priv->child_model);
2076
2077   if ((flags & GTK_TREE_MODEL_LIST_ONLY) == GTK_TREE_MODEL_LIST_ONLY)
2078     return GTK_TREE_MODEL_LIST_ONLY;
2079
2080   return 0;
2081 }
2082
2083 static gint
2084 gtk_tree_model_filter_get_n_columns (GtkTreeModel *model)
2085 {
2086   GtkTreeModelFilter *filter = (GtkTreeModelFilter *)model;
2087
2088   g_return_val_if_fail (GTK_IS_TREE_MODEL_FILTER (model), 0);
2089   g_return_val_if_fail (filter->priv->child_model != NULL, 0);
2090
2091   if (filter->priv->child_model == NULL)
2092     return 0;
2093
2094   /* so we can't modify the modify func after this ... */
2095   filter->priv->modify_func_set = TRUE;
2096
2097   if (filter->priv->modify_n_columns > 0)
2098     return filter->priv->modify_n_columns;
2099
2100   return gtk_tree_model_get_n_columns (filter->priv->child_model);
2101 }
2102
2103 static GType
2104 gtk_tree_model_filter_get_column_type (GtkTreeModel *model,
2105                                        gint          index)
2106 {
2107   GtkTreeModelFilter *filter = (GtkTreeModelFilter *)model;
2108
2109   g_return_val_if_fail (GTK_IS_TREE_MODEL_FILTER (model), G_TYPE_INVALID);
2110   g_return_val_if_fail (filter->priv->child_model != NULL, G_TYPE_INVALID);
2111
2112   /* so we can't modify the modify func after this ... */
2113   filter->priv->modify_func_set = TRUE;
2114
2115   if (filter->priv->modify_types)
2116     {
2117       g_return_val_if_fail (index < filter->priv->modify_n_columns, G_TYPE_INVALID);
2118
2119       return filter->priv->modify_types[index];
2120     }
2121
2122   return gtk_tree_model_get_column_type (filter->priv->child_model, index);
2123 }
2124
2125 /* A special case of _get_iter; this function can also get iters which
2126  * are not visible.  These iters should ONLY be passed internally, never
2127  * pass those along with a signal emission.
2128  */
2129 static gboolean
2130 gtk_tree_model_filter_get_iter_full (GtkTreeModel *model,
2131                                      GtkTreeIter  *iter,
2132                                      GtkTreePath  *path)
2133 {
2134   GtkTreeModelFilter *filter = (GtkTreeModelFilter *)model;
2135   gint *indices;
2136   FilterLevel *level;
2137   FilterElt *elt;
2138   gint depth, i;
2139   g_return_val_if_fail (GTK_IS_TREE_MODEL_FILTER (model), FALSE);
2140   g_return_val_if_fail (filter->priv->child_model != NULL, FALSE);
2141
2142   indices = gtk_tree_path_get_indices (path);
2143
2144   if (filter->priv->root == NULL)
2145     gtk_tree_model_filter_build_level (filter, NULL, NULL, FALSE);
2146   level = FILTER_LEVEL (filter->priv->root);
2147
2148   depth = gtk_tree_path_get_depth (path);
2149   if (!depth)
2150     {
2151       iter->stamp = 0;
2152       return FALSE;
2153     }
2154
2155   for (i = 0; i < depth - 1; i++)
2156     {
2157       if (!level || indices[i] >= level->array->len)
2158         {
2159           return FALSE;
2160         }
2161
2162       elt = gtk_tree_model_filter_get_nth (filter, level, indices[i]);
2163
2164       if (!elt->children)
2165         gtk_tree_model_filter_build_level (filter, level, elt, FALSE);
2166       level = elt->children;
2167     }
2168
2169   if (!level || indices[i] >= level->array->len)
2170     {
2171       iter->stamp = 0;
2172       return FALSE;
2173     }
2174
2175   iter->stamp = filter->priv->stamp;
2176   iter->user_data = level;
2177
2178   elt = gtk_tree_model_filter_get_nth (filter, level, indices[depth - 1]);
2179   iter->user_data2 = elt;
2180
2181   return TRUE;
2182 }
2183
2184 static gboolean
2185 gtk_tree_model_filter_get_iter (GtkTreeModel *model,
2186                                 GtkTreeIter  *iter,
2187                                 GtkTreePath  *path)
2188 {
2189   GtkTreeModelFilter *filter = (GtkTreeModelFilter *)model;
2190   gint *indices;
2191   FilterLevel *level;
2192   FilterElt *elt;
2193   gint depth, i;
2194   g_return_val_if_fail (GTK_IS_TREE_MODEL_FILTER (model), FALSE);
2195   g_return_val_if_fail (filter->priv->child_model != NULL, FALSE);
2196
2197   indices = gtk_tree_path_get_indices (path);
2198
2199   if (filter->priv->root == NULL)
2200     gtk_tree_model_filter_build_level (filter, NULL, NULL, FALSE);
2201   level = FILTER_LEVEL (filter->priv->root);
2202
2203   depth = gtk_tree_path_get_depth (path);
2204   if (!depth)
2205     {
2206       iter->stamp = 0;
2207       return FALSE;
2208     }
2209
2210   for (i = 0; i < depth - 1; i++)
2211     {
2212       if (!level || indices[i] >= level->visible_nodes)
2213         {
2214           return FALSE;
2215         }
2216
2217       elt = gtk_tree_model_filter_get_nth_visible (filter, level, indices[i]);
2218
2219       if (!elt->children)
2220         gtk_tree_model_filter_build_level (filter, level, elt, FALSE);
2221       level = elt->children;
2222     }
2223
2224   if (!level || indices[i] >= level->visible_nodes)
2225     {
2226       iter->stamp = 0;
2227       return FALSE;
2228     }
2229
2230   iter->stamp = filter->priv->stamp;
2231   iter->user_data = level;
2232
2233   elt = gtk_tree_model_filter_get_nth_visible (filter, level,
2234                                                indices[depth - 1]);
2235   iter->user_data2 = elt;
2236
2237   return TRUE;
2238 }
2239
2240 static GtkTreePath *
2241 gtk_tree_model_filter_get_path (GtkTreeModel *model,
2242                                 GtkTreeIter  *iter)
2243 {
2244   GtkTreePath *retval;
2245   FilterLevel *level;
2246   FilterElt *elt;
2247
2248   g_return_val_if_fail (GTK_IS_TREE_MODEL_FILTER (model), NULL);
2249   g_return_val_if_fail (GTK_TREE_MODEL_FILTER (model)->priv->child_model != NULL, NULL);
2250   g_return_val_if_fail (GTK_TREE_MODEL_FILTER (model)->priv->stamp == iter->stamp, NULL);
2251
2252   level = iter->user_data;
2253   elt = iter->user_data2;
2254
2255   if (!elt->visible)
2256     return NULL;
2257
2258   retval = gtk_tree_path_new ();
2259
2260   while (level)
2261     {
2262       int i = 0, index = 0;
2263
2264       while (&g_array_index (level->array, FilterElt, i) != elt)
2265         {
2266           if (g_array_index (level->array, FilterElt, i).visible)
2267             index++;
2268           i++;
2269
2270           g_assert (i < level->array->len);
2271         }
2272
2273       gtk_tree_path_prepend_index (retval, index);
2274       elt = level->parent_elt;
2275       level = level->parent_level;
2276     }
2277
2278   return retval;
2279 }
2280
2281 static void
2282 gtk_tree_model_filter_get_value (GtkTreeModel *model,
2283                                  GtkTreeIter  *iter,
2284                                  gint          column,
2285                                  GValue       *value)
2286 {
2287   GtkTreeIter child_iter;
2288   GtkTreeModelFilter *filter = GTK_TREE_MODEL_FILTER (model);
2289
2290   g_return_if_fail (GTK_IS_TREE_MODEL_FILTER (model));
2291   g_return_if_fail (GTK_TREE_MODEL_FILTER (model)->priv->child_model != NULL);
2292   g_return_if_fail (GTK_TREE_MODEL_FILTER (model)->priv->stamp == iter->stamp);
2293
2294   if (filter->priv->modify_func)
2295     {
2296       g_return_if_fail (column < filter->priv->modify_n_columns);
2297
2298       g_value_init (value, filter->priv->modify_types[column]);
2299       filter->priv->modify_func (model,
2300                            iter,
2301                            value,
2302                            column,
2303                            filter->priv->modify_data);
2304
2305       return;
2306     }
2307
2308   gtk_tree_model_filter_convert_iter_to_child_iter (GTK_TREE_MODEL_FILTER (model), &child_iter, iter);
2309   gtk_tree_model_get_value (GTK_TREE_MODEL_FILTER (model)->priv->child_model,
2310                             &child_iter, column, value);
2311 }
2312
2313 static gboolean
2314 gtk_tree_model_filter_iter_next (GtkTreeModel *model,
2315                                  GtkTreeIter  *iter)
2316 {
2317   int i;
2318   FilterLevel *level;
2319   FilterElt *elt;
2320
2321   g_return_val_if_fail (GTK_IS_TREE_MODEL_FILTER (model), FALSE);
2322   g_return_val_if_fail (GTK_TREE_MODEL_FILTER (model)->priv->child_model != NULL, FALSE);
2323   g_return_val_if_fail (GTK_TREE_MODEL_FILTER (model)->priv->stamp == iter->stamp, FALSE);
2324
2325   level = iter->user_data;
2326   elt = iter->user_data2;
2327
2328   i = elt - FILTER_ELT (level->array->data);
2329
2330   while (i < level->array->len - 1)
2331     {
2332       i++;
2333       elt++;
2334
2335       if (elt->visible)
2336         {
2337           iter->user_data2 = elt;
2338           return TRUE;
2339         }
2340     }
2341
2342   /* no next visible iter */
2343   iter->stamp = 0;
2344
2345   return FALSE;
2346 }
2347
2348 static gboolean
2349 gtk_tree_model_filter_iter_children (GtkTreeModel *model,
2350                                      GtkTreeIter  *iter,
2351                                      GtkTreeIter  *parent)
2352 {
2353   GtkTreeModelFilter *filter = (GtkTreeModelFilter *)model;
2354   FilterLevel *level;
2355
2356   iter->stamp = 0;
2357   g_return_val_if_fail (GTK_IS_TREE_MODEL_FILTER (model), FALSE);
2358   g_return_val_if_fail (filter->priv->child_model != NULL, FALSE);
2359   if (parent)
2360     g_return_val_if_fail (filter->priv->stamp == parent->stamp, FALSE);
2361
2362   if (!parent)
2363     {
2364       int i = 0;
2365
2366       if (!filter->priv->root)
2367         gtk_tree_model_filter_build_level (filter, NULL, NULL, FALSE);
2368       if (!filter->priv->root)
2369         return FALSE;
2370
2371       level = filter->priv->root;
2372
2373       if (!level->visible_nodes)
2374         return FALSE;
2375
2376       iter->stamp = filter->priv->stamp;
2377       iter->user_data = level;
2378
2379       while (i < level->array->len)
2380         {
2381           if (!g_array_index (level->array, FilterElt, i).visible)
2382             {
2383               i++;
2384               continue;
2385             }
2386
2387           iter->user_data2 = &g_array_index (level->array, FilterElt, i);
2388           return TRUE;
2389         }
2390
2391       iter->stamp = 0;
2392       return FALSE;
2393     }
2394   else
2395     {
2396       int i = 0;
2397
2398       if (FILTER_ELT (parent->user_data2)->children == NULL)
2399         gtk_tree_model_filter_build_level (filter,
2400                                            FILTER_LEVEL (parent->user_data),
2401                                            FILTER_ELT (parent->user_data2),
2402                                            FALSE);
2403       if (FILTER_ELT (parent->user_data2)->children == NULL)
2404         return FALSE;
2405
2406       if (FILTER_ELT (parent->user_data2)->children->visible_nodes <= 0)
2407         return FALSE;
2408
2409       iter->stamp = filter->priv->stamp;
2410       iter->user_data = FILTER_ELT (parent->user_data2)->children;
2411
2412       level = FILTER_LEVEL (iter->user_data);
2413
2414       while (i < level->array->len)
2415         {
2416           if (!g_array_index (level->array, FilterElt, i).visible)
2417             {
2418               i++;
2419               continue;
2420             }
2421
2422           iter->user_data2 = &g_array_index (level->array, FilterElt, i);
2423           return TRUE;
2424         }
2425
2426       iter->stamp = 0;
2427       return FALSE;
2428     }
2429
2430   iter->stamp = 0;
2431   return FALSE;
2432 }
2433
2434 static gboolean
2435 gtk_tree_model_filter_iter_has_child (GtkTreeModel *model,
2436                                       GtkTreeIter  *iter)
2437 {
2438   GtkTreeIter child_iter;
2439   GtkTreeModelFilter *filter = (GtkTreeModelFilter *)model;
2440   FilterElt *elt;
2441
2442   g_return_val_if_fail (GTK_IS_TREE_MODEL_FILTER (model), FALSE);
2443   g_return_val_if_fail (filter->priv->child_model != NULL, FALSE);
2444   g_return_val_if_fail (filter->priv->stamp == iter->stamp, FALSE);
2445
2446   filter = GTK_TREE_MODEL_FILTER (model);
2447
2448   gtk_tree_model_filter_convert_iter_to_child_iter (GTK_TREE_MODEL_FILTER (model), &child_iter, iter);
2449   elt = FILTER_ELT (iter->user_data2);
2450
2451   if (!elt->visible)
2452     return FALSE;
2453
2454   /* we need to build the level to check if not all children are filtered
2455    * out
2456    */
2457   if (!elt->children
2458       && gtk_tree_model_iter_has_child (filter->priv->child_model, &child_iter))
2459     gtk_tree_model_filter_build_level (filter, FILTER_LEVEL (iter->user_data),
2460                                        elt, FALSE);
2461
2462   if (elt->children && elt->children->visible_nodes > 0)
2463     return TRUE;
2464
2465   return FALSE;
2466 }
2467
2468 static gint
2469 gtk_tree_model_filter_iter_n_children (GtkTreeModel *model,
2470                                        GtkTreeIter  *iter)
2471 {
2472   GtkTreeIter child_iter;
2473   GtkTreeModelFilter *filter = (GtkTreeModelFilter *)model;
2474   FilterElt *elt;
2475
2476   g_return_val_if_fail (GTK_IS_TREE_MODEL_FILTER (model), 0);
2477   g_return_val_if_fail (filter->priv->child_model != NULL, 0);
2478   if (iter)
2479     g_return_val_if_fail (filter->priv->stamp == iter->stamp, 0);
2480
2481   if (!iter)
2482     {
2483       if (!filter->priv->root)
2484         gtk_tree_model_filter_build_level (filter, NULL, NULL, FALSE);
2485
2486       if (filter->priv->root)
2487         return FILTER_LEVEL (filter->priv->root)->visible_nodes;
2488
2489       return 0;
2490     }
2491
2492   elt = FILTER_ELT (iter->user_data2);
2493
2494   if (!elt->visible)
2495     return 0;
2496
2497   gtk_tree_model_filter_convert_iter_to_child_iter (GTK_TREE_MODEL_FILTER (model), &child_iter, iter);
2498
2499   if (!elt->children &&
2500       gtk_tree_model_iter_has_child (filter->priv->child_model, &child_iter))
2501     gtk_tree_model_filter_build_level (filter,
2502                                        FILTER_LEVEL (iter->user_data),
2503                                        elt, FALSE);
2504
2505   if (elt->children)
2506     return elt->children->visible_nodes;
2507
2508   return 0;
2509 }
2510
2511 static gboolean
2512 gtk_tree_model_filter_iter_nth_child (GtkTreeModel *model,
2513                                       GtkTreeIter  *iter,
2514                                       GtkTreeIter  *parent,
2515                                       gint          n)
2516 {
2517   FilterElt *elt;
2518   FilterLevel *level;
2519   GtkTreeIter children;
2520
2521   g_return_val_if_fail (GTK_IS_TREE_MODEL_FILTER (model), FALSE);
2522   if (parent)
2523     g_return_val_if_fail (GTK_TREE_MODEL_FILTER (model)->priv->stamp == parent->stamp, FALSE);
2524
2525   /* use this instead of has_child to force us to build the level, if needed */
2526   if (gtk_tree_model_filter_iter_children (model, &children, parent) == FALSE)
2527     {
2528       iter->stamp = 0;
2529       return FALSE;
2530     }
2531
2532   level = children.user_data;
2533   elt = FILTER_ELT (level->array->data);
2534
2535   if (n >= level->visible_nodes)
2536     {
2537       iter->stamp = 0;
2538       return FALSE;
2539     }
2540
2541   elt = gtk_tree_model_filter_get_nth_visible (GTK_TREE_MODEL_FILTER (model),
2542                                                level, n);
2543
2544   iter->stamp = GTK_TREE_MODEL_FILTER (model)->priv->stamp;
2545   iter->user_data = level;
2546   iter->user_data2 = elt;
2547
2548   return TRUE;
2549 }
2550
2551 static gboolean
2552 gtk_tree_model_filter_iter_parent (GtkTreeModel *model,
2553                                    GtkTreeIter  *iter,
2554                                    GtkTreeIter  *child)
2555 {
2556   FilterLevel *level;
2557
2558   iter->stamp = 0;
2559   g_return_val_if_fail (GTK_IS_TREE_MODEL_FILTER (model), FALSE);
2560   g_return_val_if_fail (GTK_TREE_MODEL_FILTER (model)->priv->child_model != NULL, FALSE);
2561   g_return_val_if_fail (GTK_TREE_MODEL_FILTER (model)->priv->stamp == child->stamp, FALSE);
2562
2563   level = child->user_data;
2564
2565   if (level->parent_level)
2566     {
2567       iter->stamp = GTK_TREE_MODEL_FILTER (model)->priv->stamp;
2568       iter->user_data = level->parent_level;
2569       iter->user_data2 = level->parent_elt;
2570
2571       return TRUE;
2572     }
2573
2574   return FALSE;
2575 }
2576
2577 static void
2578 gtk_tree_model_filter_ref_node (GtkTreeModel *model,
2579                                 GtkTreeIter  *iter)
2580 {
2581   GtkTreeModelFilter *filter = (GtkTreeModelFilter *)model;
2582   GtkTreeIter child_iter;
2583   FilterLevel *level;
2584   FilterElt *elt;
2585
2586   g_return_if_fail (GTK_IS_TREE_MODEL_FILTER (model));
2587   g_return_if_fail (GTK_TREE_MODEL_FILTER (model)->priv->child_model != NULL);
2588   g_return_if_fail (GTK_TREE_MODEL_FILTER (model)->priv->stamp == iter->stamp);
2589
2590   gtk_tree_model_filter_convert_iter_to_child_iter (GTK_TREE_MODEL_FILTER (model), &child_iter, iter);
2591
2592   gtk_tree_model_ref_node (filter->priv->child_model, &child_iter);
2593
2594   level = iter->user_data;
2595   elt = iter->user_data2;
2596
2597   elt->ref_count++;
2598   level->ref_count++;
2599   if (level->ref_count == 1)
2600     {
2601       FilterLevel *parent_level = level->parent_level;
2602       FilterElt *parent_elt = level->parent_elt;
2603
2604       /* we were at zero -- time to decrease the zero_ref_count val */
2605       while (parent_level)
2606         {
2607           parent_elt->zero_ref_count--;
2608
2609           parent_elt = parent_level->parent_elt;
2610           parent_level = parent_level->parent_level;
2611         }
2612
2613       if (filter->priv->root != level)
2614         filter->priv->zero_ref_count--;
2615     }
2616 }
2617
2618 static void
2619 gtk_tree_model_filter_unref_node (GtkTreeModel *model,
2620                                   GtkTreeIter  *iter)
2621 {
2622   gtk_tree_model_filter_real_unref_node (model, iter, TRUE);
2623 }
2624
2625 static void
2626 gtk_tree_model_filter_real_unref_node (GtkTreeModel *model,
2627                                        GtkTreeIter  *iter,
2628                                        gboolean      propagate_unref)
2629 {
2630   GtkTreeModelFilter *filter = (GtkTreeModelFilter *)model;
2631   FilterLevel *level;
2632   FilterElt *elt;
2633
2634   g_return_if_fail (GTK_IS_TREE_MODEL_FILTER (model));
2635   g_return_if_fail (filter->priv->child_model != NULL);
2636   g_return_if_fail (filter->priv->stamp == iter->stamp);
2637
2638   if (propagate_unref)
2639     {
2640       GtkTreeIter child_iter;
2641       gtk_tree_model_filter_convert_iter_to_child_iter (GTK_TREE_MODEL_FILTER (model), &child_iter, iter);
2642       gtk_tree_model_unref_node (filter->priv->child_model, &child_iter);
2643     }
2644
2645   level = iter->user_data;
2646   elt = iter->user_data2;
2647
2648   g_return_if_fail (elt->ref_count > 0);
2649
2650   elt->ref_count--;
2651   level->ref_count--;
2652   if (level->ref_count == 0)
2653     {
2654       FilterLevel *parent_level = level->parent_level;
2655       FilterElt *parent_elt = level->parent_elt;
2656
2657       /* we are at zero -- time to increase the zero_ref_count val */
2658       while (parent_level)
2659         {
2660           parent_elt->zero_ref_count++;
2661
2662           parent_elt = parent_level->parent_elt;
2663           parent_level = parent_level->parent_level;
2664         }
2665
2666       if (filter->priv->root != level)
2667         filter->priv->zero_ref_count++;
2668     }
2669 }
2670
2671 /* TreeDragSource interface implementation */
2672 static gboolean
2673 gtk_tree_model_filter_row_draggable (GtkTreeDragSource *drag_source,
2674                                      GtkTreePath       *path)
2675 {
2676   GtkTreeModelFilter *tree_model_filter = (GtkTreeModelFilter *)drag_source;
2677   GtkTreePath *child_path;
2678   gboolean draggable;
2679
2680   g_return_val_if_fail (GTK_IS_TREE_MODEL_FILTER (drag_source), FALSE);
2681   g_return_val_if_fail (path != NULL, FALSE);
2682
2683   child_path = gtk_tree_model_filter_convert_path_to_child_path (tree_model_filter, path);
2684   draggable = gtk_tree_drag_source_row_draggable (GTK_TREE_DRAG_SOURCE (tree_model_filter->priv->child_model), child_path);
2685   gtk_tree_path_free (child_path);
2686
2687   return draggable;
2688 }
2689
2690 static gboolean
2691 gtk_tree_model_filter_drag_data_get (GtkTreeDragSource *drag_source,
2692                                      GtkTreePath       *path,
2693                                      GtkSelectionData  *selection_data)
2694 {
2695   GtkTreeModelFilter *tree_model_filter = (GtkTreeModelFilter *)drag_source;
2696   GtkTreePath *child_path;
2697   gboolean gotten;
2698
2699   g_return_val_if_fail (GTK_IS_TREE_MODEL_FILTER (drag_source), FALSE);
2700   g_return_val_if_fail (path != NULL, FALSE);
2701
2702   child_path = gtk_tree_model_filter_convert_path_to_child_path (tree_model_filter, path);
2703   gotten = gtk_tree_drag_source_drag_data_get (GTK_TREE_DRAG_SOURCE (tree_model_filter->priv->child_model), child_path, selection_data);
2704   gtk_tree_path_free (child_path);
2705
2706   return gotten;
2707 }
2708
2709 static gboolean
2710 gtk_tree_model_filter_drag_data_delete (GtkTreeDragSource *drag_source,
2711                                         GtkTreePath       *path)
2712 {
2713   GtkTreeModelFilter *tree_model_filter = (GtkTreeModelFilter *)drag_source;
2714   GtkTreePath *child_path;
2715   gboolean deleted;
2716
2717   g_return_val_if_fail (GTK_IS_TREE_MODEL_FILTER (drag_source), FALSE);
2718   g_return_val_if_fail (path != NULL, FALSE);
2719
2720   child_path = gtk_tree_model_filter_convert_path_to_child_path (tree_model_filter, path);
2721   deleted = gtk_tree_drag_source_drag_data_delete (GTK_TREE_DRAG_SOURCE (tree_model_filter->priv->child_model), child_path);
2722   gtk_tree_path_free (child_path);
2723
2724   return deleted;
2725 }
2726
2727 /* bits and pieces */
2728 static void
2729 gtk_tree_model_filter_set_model (GtkTreeModelFilter *filter,
2730                                  GtkTreeModel       *child_model)
2731 {
2732   g_return_if_fail (GTK_IS_TREE_MODEL_FILTER (filter));
2733
2734   if (filter->priv->child_model)
2735     {
2736       g_signal_handler_disconnect (filter->priv->child_model,
2737                                    filter->priv->changed_id);
2738       g_signal_handler_disconnect (filter->priv->child_model,
2739                                    filter->priv->inserted_id);
2740       g_signal_handler_disconnect (filter->priv->child_model,
2741                                    filter->priv->has_child_toggled_id);
2742       g_signal_handler_disconnect (filter->priv->child_model,
2743                                    filter->priv->deleted_id);
2744       g_signal_handler_disconnect (filter->priv->child_model,
2745                                    filter->priv->reordered_id);
2746
2747       /* reset our state */
2748       if (filter->priv->root)
2749         gtk_tree_model_filter_free_level (filter, filter->priv->root);
2750
2751       filter->priv->root = NULL;
2752       g_object_unref (filter->priv->child_model);
2753       filter->priv->visible_column = -1;
2754
2755       /* FIXME: do we need to destroy more here? */
2756     }
2757
2758   filter->priv->child_model = child_model;
2759
2760   if (child_model)
2761     {
2762       g_object_ref (filter->priv->child_model);
2763       filter->priv->changed_id =
2764         g_signal_connect (child_model, "row-changed",
2765                           G_CALLBACK (gtk_tree_model_filter_row_changed),
2766                           filter);
2767       filter->priv->inserted_id =
2768         g_signal_connect (child_model, "row-inserted",
2769                           G_CALLBACK (gtk_tree_model_filter_row_inserted),
2770                           filter);
2771       filter->priv->has_child_toggled_id =
2772         g_signal_connect (child_model, "row-has-child-toggled",
2773                           G_CALLBACK (gtk_tree_model_filter_row_has_child_toggled),
2774                           filter);
2775       filter->priv->deleted_id =
2776         g_signal_connect (child_model, "row-deleted",
2777                           G_CALLBACK (gtk_tree_model_filter_row_deleted),
2778                           filter);
2779       filter->priv->reordered_id =
2780         g_signal_connect (child_model, "rows-reordered",
2781                           G_CALLBACK (gtk_tree_model_filter_rows_reordered),
2782                           filter);
2783
2784       filter->priv->child_flags = gtk_tree_model_get_flags (child_model);
2785       filter->priv->stamp = g_random_int ();
2786     }
2787 }
2788
2789 static void
2790 gtk_tree_model_filter_ref_path (GtkTreeModelFilter *filter,
2791                                 GtkTreePath        *path)
2792 {
2793   int len;
2794   GtkTreePath *p;
2795
2796   len = gtk_tree_path_get_depth (path);
2797   p = gtk_tree_path_copy (path);
2798   while (len--)
2799     {
2800       GtkTreeIter iter;
2801
2802       gtk_tree_model_get_iter (GTK_TREE_MODEL (filter->priv->child_model), &iter, p);
2803       gtk_tree_model_ref_node (GTK_TREE_MODEL (filter->priv->child_model), &iter);
2804       gtk_tree_path_up (p);
2805     }
2806
2807   gtk_tree_path_free (p);
2808 }
2809
2810 static void
2811 gtk_tree_model_filter_unref_path (GtkTreeModelFilter *filter,
2812                                   GtkTreePath        *path)
2813 {
2814   int len;
2815   GtkTreePath *p;
2816
2817   len = gtk_tree_path_get_depth (path);
2818   p = gtk_tree_path_copy (path);
2819   while (len--)
2820     {
2821       GtkTreeIter iter;
2822
2823       gtk_tree_model_get_iter (GTK_TREE_MODEL (filter->priv->child_model), &iter, p);
2824       gtk_tree_model_unref_node (GTK_TREE_MODEL (filter->priv->child_model), &iter);
2825       gtk_tree_path_up (p);
2826     }
2827
2828   gtk_tree_path_free (p);
2829 }
2830
2831 static void
2832 gtk_tree_model_filter_set_root (GtkTreeModelFilter *filter,
2833                                 GtkTreePath        *root)
2834 {
2835   g_return_if_fail (GTK_IS_TREE_MODEL_FILTER (filter));
2836
2837   if (!root)
2838     filter->priv->virtual_root = NULL;
2839   else
2840     filter->priv->virtual_root = gtk_tree_path_copy (root);
2841 }
2842
2843 /* public API */
2844
2845 /**
2846  * gtk_tree_model_filter_new:
2847  * @child_model: A #GtkTreeModel.
2848  * @root: A #GtkTreePath or %NULL.
2849  *
2850  * Creates a new #GtkTreeModel, with @child_model as the child_model
2851  * and @root as the virtual root.
2852  *
2853  * Return value: A new #GtkTreeModel.
2854  *
2855  * Since: 2.4
2856  */
2857 GtkTreeModel *
2858 gtk_tree_model_filter_new (GtkTreeModel *child_model,
2859                            GtkTreePath  *root)
2860 {
2861   GtkTreeModel *retval;
2862   GtkTreeModelFilter *filter;
2863
2864   g_return_val_if_fail (GTK_IS_TREE_MODEL (child_model), NULL);
2865
2866   retval = g_object_new (GTK_TYPE_TREE_MODEL_FILTER, 
2867                          "child-model", child_model,
2868                          "virtual-root", root,
2869                          NULL);
2870
2871   filter = GTK_TREE_MODEL_FILTER (retval);
2872   if (filter->priv->virtual_root)
2873     {
2874       gtk_tree_model_filter_ref_path (filter, filter->priv->virtual_root);
2875       filter->priv->virtual_root_deleted = FALSE;
2876     }
2877
2878   return retval;
2879 }
2880
2881 /**
2882  * gtk_tree_model_filter_get_model:
2883  * @filter: A #GtkTreeModelFilter.
2884  *
2885  * Returns a pointer to the child model of @filter.
2886  *
2887  * Return value: A pointer to a #GtkTreeModel.
2888  *
2889  * Since: 2.4
2890  */
2891 GtkTreeModel *
2892 gtk_tree_model_filter_get_model (GtkTreeModelFilter *filter)
2893 {
2894   g_return_val_if_fail (GTK_IS_TREE_MODEL_FILTER (filter), NULL);
2895
2896   return filter->priv->child_model;
2897 }
2898
2899 /**
2900  * gtk_tree_model_filter_set_visible_func:
2901  * @filter: A #GtkTreeModelFilter.
2902  * @func: A #GtkTreeModelFilterVisibleFunc, the visible function.
2903  * @data: User data to pass to the visible function, or %NULL.
2904  * @destroy: Destroy notifier of @data, or %NULL.
2905  *
2906  * Sets the visible function used when filtering the @filter to be @func. The
2907  * function should return %TRUE if the given row should be visible and
2908  * %FALSE otherwise.
2909  *
2910  * If the condition calculated by the function changes over time (e.g. because
2911  * it depends on some global parameters), you must call 
2912  * gtk_tree_model_filter_refilter() to keep the visibility information of 
2913  * the model uptodate.
2914  *
2915  * Note that @func is called whenever a row is inserted, when it may still be
2916  * empty. The visible function should therefore take special care of empty
2917  * rows, like in the example below.
2918  *
2919  * <informalexample><programlisting>
2920  * static gboolean
2921  * visible_func (GtkTreeModel *model,
2922  *               GtkTreeIter  *iter,
2923  *               gpointer      data)
2924  * {
2925  *   /&ast; Visible if row is non-empty and first column is "HI" &ast;/
2926  *   gchar *str;
2927  *   gboolean visible = FALSE;
2928  *
2929  *   gtk_tree_model_get (model, iter, 0, &str, -1);
2930  *   if (str && strcmp (str, "HI") == 0)
2931  *     visible = TRUE;
2932  *   g_free (str);
2933  *
2934  *   return visible;
2935  * }
2936  * </programlisting></informalexample>
2937  *
2938  * Since: 2.4
2939  */
2940 void
2941 gtk_tree_model_filter_set_visible_func (GtkTreeModelFilter            *filter,
2942                                         GtkTreeModelFilterVisibleFunc  func,
2943                                         gpointer                       data,
2944                                         GDestroyNotify                 destroy)
2945 {
2946   g_return_if_fail (GTK_IS_TREE_MODEL_FILTER (filter));
2947   g_return_if_fail (func != NULL);
2948   g_return_if_fail (filter->priv->visible_method_set == FALSE);
2949
2950   if (filter->priv->visible_func)
2951     {
2952       GDestroyNotify d = filter->priv->visible_destroy;
2953
2954       filter->priv->visible_destroy = NULL;
2955       d (filter->priv->visible_data);
2956     }
2957
2958   filter->priv->visible_func = func;
2959   filter->priv->visible_data = data;
2960   filter->priv->visible_destroy = destroy;
2961
2962   filter->priv->visible_method_set = TRUE;
2963 }
2964
2965 /**
2966  * gtk_tree_model_filter_set_modify_func:
2967  * @filter: A #GtkTreeModelFilter.
2968  * @n_columns: The number of columns in the filter model.
2969  * @types: The #GType<!-- -->s of the columns.
2970  * @func: A #GtkTreeModelFilterModifyFunc
2971  * @data: User data to pass to the modify function, or %NULL.
2972  * @destroy: Destroy notifier of @data, or %NULL.
2973  *
2974  * With the @n_columns and @types parameters, you give an array of column
2975  * types for this model (which will be exposed to the parent model/view).
2976  * The @func, @data and @destroy parameters are for specifying the modify
2977  * function. The modify function will get called for <emphasis>each</emphasis>
2978  * data access, the goal of the modify function is to return the data which 
2979  * should be displayed at the location specified using the parameters of the 
2980  * modify function.
2981  *
2982  * Since: 2.4
2983  */
2984 void
2985 gtk_tree_model_filter_set_modify_func (GtkTreeModelFilter           *filter,
2986                                        gint                          n_columns,
2987                                        GType                        *types,
2988                                        GtkTreeModelFilterModifyFunc  func,
2989                                        gpointer                      data,
2990                                        GDestroyNotify                destroy)
2991 {
2992   g_return_if_fail (GTK_IS_TREE_MODEL_FILTER (filter));
2993   g_return_if_fail (func != NULL);
2994   g_return_if_fail (filter->priv->modify_func_set == FALSE);
2995
2996   if (filter->priv->modify_destroy)
2997     {
2998       GDestroyNotify d = filter->priv->modify_destroy;
2999
3000       filter->priv->modify_destroy = NULL;
3001       d (filter->priv->modify_data);
3002     }
3003
3004   filter->priv->modify_n_columns = n_columns;
3005   filter->priv->modify_types = g_new0 (GType, n_columns);
3006   memcpy (filter->priv->modify_types, types, sizeof (GType) * n_columns);
3007   filter->priv->modify_func = func;
3008   filter->priv->modify_data = data;
3009   filter->priv->modify_destroy = destroy;
3010
3011   filter->priv->modify_func_set = TRUE;
3012 }
3013
3014 /**
3015  * gtk_tree_model_filter_set_visible_column:
3016  * @filter: A #GtkTreeModelFilter.
3017  * @column: A #gint which is the column containing the visible information.
3018  *
3019  * Sets @column of the child_model to be the column where @filter should
3020  * look for visibility information. @columns should be a column of type
3021  * %G_TYPE_BOOLEAN, where %TRUE means that a row is visible, and %FALSE
3022  * if not.
3023  *
3024  * Since: 2.4
3025  */
3026 void
3027 gtk_tree_model_filter_set_visible_column (GtkTreeModelFilter *filter,
3028                                           gint column)
3029 {
3030   g_return_if_fail (GTK_IS_TREE_MODEL_FILTER (filter));
3031   g_return_if_fail (column >= 0);
3032   g_return_if_fail (filter->priv->visible_method_set == FALSE);
3033
3034   filter->priv->visible_column = column;
3035
3036   filter->priv->visible_method_set = TRUE;
3037 }
3038
3039 /* conversion */
3040
3041 /**
3042  * gtk_tree_model_filter_convert_child_iter_to_iter:
3043  * @filter: A #GtkTreeModelFilter.
3044  * @filter_iter: An uninitialized #GtkTreeIter.
3045  * @child_iter: A valid #GtkTreeIter pointing to a row on the child model.
3046  *
3047  * Sets @filter_iter to point to the row in @filter that corresponds to the
3048  * row pointed at by @child_iter.  If @filter_iter was not set, %FALSE is
3049  * returned.
3050  *
3051  * Return value: %TRUE, if @filter_iter was set, i.e. if @child_iter is a
3052  * valid iterator pointing to a visible row in child model.
3053  *
3054  * Since: 2.4
3055  */
3056 gboolean
3057 gtk_tree_model_filter_convert_child_iter_to_iter (GtkTreeModelFilter *filter,
3058                                                   GtkTreeIter        *filter_iter,
3059                                                   GtkTreeIter        *child_iter)
3060 {
3061   gboolean ret;
3062   GtkTreePath *child_path, *path;
3063
3064   g_return_val_if_fail (GTK_IS_TREE_MODEL_FILTER (filter), FALSE);
3065   g_return_val_if_fail (filter->priv->child_model != NULL, FALSE);
3066   g_return_val_if_fail (filter_iter != NULL, FALSE);
3067   g_return_val_if_fail (child_iter != NULL, FALSE);
3068   g_return_val_if_fail (filter_iter != child_iter, FALSE);
3069
3070   filter_iter->stamp = 0;
3071
3072   child_path = gtk_tree_model_get_path (filter->priv->child_model, child_iter);
3073   g_return_val_if_fail (child_path != NULL, FALSE);
3074
3075   path = gtk_tree_model_filter_convert_child_path_to_path (filter,
3076                                                            child_path);
3077   gtk_tree_path_free (child_path);
3078
3079   if (!path)
3080     return FALSE;
3081
3082   ret = gtk_tree_model_get_iter (GTK_TREE_MODEL (filter), filter_iter, path);
3083   gtk_tree_path_free (path);
3084
3085   return ret;
3086 }
3087
3088 /**
3089  * gtk_tree_model_filter_convert_iter_to_child_iter:
3090  * @filter: A #GtkTreeModelFilter.
3091  * @child_iter: An uninitialized #GtkTreeIter.
3092  * @filter_iter: A valid #GtkTreeIter pointing to a row on @filter.
3093  *
3094  * Sets @child_iter to point to the row pointed to by @filter_iter.
3095  *
3096  * Since: 2.4
3097  */
3098 void
3099 gtk_tree_model_filter_convert_iter_to_child_iter (GtkTreeModelFilter *filter,
3100                                                   GtkTreeIter        *child_iter,
3101                                                   GtkTreeIter        *filter_iter)
3102 {
3103   g_return_if_fail (GTK_IS_TREE_MODEL_FILTER (filter));
3104   g_return_if_fail (filter->priv->child_model != NULL);
3105   g_return_if_fail (child_iter != NULL);
3106   g_return_if_fail (filter_iter != NULL);
3107   g_return_if_fail (filter_iter->stamp == filter->priv->stamp);
3108   g_return_if_fail (filter_iter != child_iter);
3109
3110   if (GTK_TREE_MODEL_FILTER_CACHE_CHILD_ITERS (filter))
3111     {
3112       *child_iter = FILTER_ELT (filter_iter->user_data2)->iter;
3113     }
3114   else
3115     {
3116       GtkTreePath *path;
3117
3118       path = gtk_tree_model_filter_elt_get_path (filter_iter->user_data,
3119                                                  filter_iter->user_data2,
3120                                                  filter->priv->virtual_root);
3121       gtk_tree_model_get_iter (filter->priv->child_model, child_iter, path);
3122       gtk_tree_path_free (path);
3123     }
3124 }
3125
3126 /* The path returned can only be used internally in the filter model. */
3127 static GtkTreePath *
3128 gtk_real_tree_model_filter_convert_child_path_to_path (GtkTreeModelFilter *filter,
3129                                                        GtkTreePath        *child_path,
3130                                                        gboolean            build_levels,
3131                                                        gboolean            fetch_children)
3132 {
3133   gint *child_indices;
3134   GtkTreePath *retval;
3135   GtkTreePath *real_path;
3136   FilterLevel *level;
3137   FilterElt *tmp;
3138   gint i;
3139
3140   g_return_val_if_fail (GTK_IS_TREE_MODEL_FILTER (filter), NULL);
3141   g_return_val_if_fail (filter->priv->child_model != NULL, NULL);
3142   g_return_val_if_fail (child_path != NULL, NULL);
3143
3144   if (!filter->priv->virtual_root)
3145     real_path = gtk_tree_path_copy (child_path);
3146   else
3147     real_path = gtk_tree_model_filter_remove_root (child_path,
3148                                                    filter->priv->virtual_root);
3149
3150   if (!real_path)
3151     return NULL;
3152
3153   retval = gtk_tree_path_new ();
3154   child_indices = gtk_tree_path_get_indices (real_path);
3155
3156   if (filter->priv->root == NULL && build_levels)
3157     gtk_tree_model_filter_build_level (filter, NULL, NULL, FALSE);
3158   level = FILTER_LEVEL (filter->priv->root);
3159
3160   for (i = 0; i < gtk_tree_path_get_depth (real_path); i++)
3161     {
3162       gint j;
3163       gboolean found_child = FALSE;
3164
3165       if (!level)
3166         {
3167           gtk_tree_path_free (real_path);
3168           gtk_tree_path_free (retval);
3169           return NULL;
3170         }
3171
3172       tmp = bsearch_elt_with_offset (level->array, child_indices[i], &j);
3173       if (tmp)
3174         {
3175           gtk_tree_path_append_index (retval, j);
3176           if (!tmp->children && build_levels)
3177             gtk_tree_model_filter_build_level (filter, level, tmp, FALSE);
3178           level = tmp->children;
3179           found_child = TRUE;
3180         }
3181
3182       if (!found_child && fetch_children)
3183         {
3184           tmp = gtk_tree_model_filter_fetch_child (filter, level,
3185                                                    child_indices[i],
3186                                                    &j);
3187
3188           /* didn't find the child, let's try to bring it back */
3189           if (!tmp || tmp->offset != child_indices[i])
3190             {
3191               /* not there */
3192               gtk_tree_path_free (real_path);
3193               gtk_tree_path_free (retval);
3194               return NULL;
3195             }
3196
3197           gtk_tree_path_append_index (retval, j);
3198           if (!tmp->children && build_levels)
3199             gtk_tree_model_filter_build_level (filter, level, tmp, FALSE);
3200           level = tmp->children;
3201           found_child = TRUE;
3202         }
3203       else if (!found_child && !fetch_children)
3204         {
3205           /* no path */
3206           gtk_tree_path_free (real_path);
3207           gtk_tree_path_free (retval);
3208           return NULL;
3209         }
3210     }
3211
3212   gtk_tree_path_free (real_path);
3213   return retval;
3214 }
3215
3216 /**
3217  * gtk_tree_model_filter_convert_child_path_to_path:
3218  * @filter: A #GtkTreeModelFilter.
3219  * @child_path: A #GtkTreePath to convert.
3220  *
3221  * Converts @child_path to a path relative to @filter. That is, @child_path
3222  * points to a path in the child model. The rerturned path will point to the
3223  * same row in the filtered model. If @child_path isn't a valid path on the
3224  * child model or points to a row which is not visible in @filter, then %NULL
3225  * is returned.
3226  *
3227  * Return value: A newly allocated #GtkTreePath, or %NULL.
3228  *
3229  * Since: 2.4
3230  */
3231 GtkTreePath *
3232 gtk_tree_model_filter_convert_child_path_to_path (GtkTreeModelFilter *filter,
3233                                                   GtkTreePath        *child_path)
3234 {
3235   GtkTreeIter iter;
3236   GtkTreePath *path;
3237
3238   /* this function does the sanity checks */
3239   path = gtk_real_tree_model_filter_convert_child_path_to_path (filter,
3240                                                                 child_path,
3241                                                                 TRUE,
3242                                                                 TRUE);
3243
3244   if (!path)
3245       return NULL;
3246
3247   /* get a new path which only takes visible nodes into account.
3248    * -- if this gives any performance issues, we can write a special
3249    *    version of convert_child_path_to_path immediately returning
3250    *    a visible-nodes-only path.
3251    */
3252   gtk_tree_model_filter_get_iter_full (GTK_TREE_MODEL (filter), &iter, path);
3253
3254   gtk_tree_path_free (path);
3255   path = gtk_tree_model_get_path (GTK_TREE_MODEL (filter), &iter);
3256
3257   return path;
3258 }
3259
3260 /**
3261  * gtk_tree_model_filter_convert_path_to_child_path:
3262  * @filter: A #GtkTreeModelFilter.
3263  * @filter_path: A #GtkTreePath to convert.
3264  *
3265  * Converts @filter_path to a path on the child model of @filter. That is,
3266  * @filter_path points to a location in @filter. The returned path will
3267  * point to the same location in the model not being filtered. If @filter_path
3268  * does not point to a location in the child model, %NULL is returned.
3269  *
3270  * Return value: A newly allocated #GtkTreePath, or %NULL.
3271  *
3272  * Since: 2.4
3273  */
3274 GtkTreePath *
3275 gtk_tree_model_filter_convert_path_to_child_path (GtkTreeModelFilter *filter,
3276                                                   GtkTreePath        *filter_path)
3277 {
3278   gint *filter_indices;
3279   GtkTreePath *retval;
3280   FilterLevel *level;
3281   gint i;
3282
3283   g_return_val_if_fail (GTK_IS_TREE_MODEL_FILTER (filter), NULL);
3284   g_return_val_if_fail (filter->priv->child_model != NULL, NULL);
3285   g_return_val_if_fail (filter_path != NULL, NULL);
3286
3287   /* convert path */
3288   retval = gtk_tree_path_new ();
3289   filter_indices = gtk_tree_path_get_indices (filter_path);
3290   if (!filter->priv->root)
3291     gtk_tree_model_filter_build_level (filter, NULL, NULL, FALSE);
3292   level = FILTER_LEVEL (filter->priv->root);
3293
3294   for (i = 0; i < gtk_tree_path_get_depth (filter_path); i++)
3295     {
3296       FilterElt *elt;
3297
3298       if (!level || level->visible_nodes <= filter_indices[i])
3299         {
3300           gtk_tree_path_free (retval);
3301           return NULL;
3302         }
3303
3304       elt = gtk_tree_model_filter_get_nth_visible (filter, level,
3305                                                    filter_indices[i]);
3306
3307       if (elt->children == NULL)
3308         gtk_tree_model_filter_build_level (filter, level, elt, FALSE);
3309
3310       if (!level || level->visible_nodes <= filter_indices[i])
3311         {
3312           gtk_tree_path_free (retval);
3313           return NULL;
3314         }
3315
3316       gtk_tree_path_append_index (retval, elt->offset);
3317       level = elt->children;
3318     }
3319
3320   /* apply vroot */
3321
3322   if (filter->priv->virtual_root)
3323     {
3324       GtkTreePath *real_retval;
3325
3326       real_retval = gtk_tree_model_filter_add_root (retval,
3327                                                     filter->priv->virtual_root);
3328       gtk_tree_path_free (retval);
3329
3330       return real_retval;
3331     }
3332
3333   return retval;
3334 }
3335
3336 static gboolean
3337 gtk_tree_model_filter_refilter_helper (GtkTreeModel *model,
3338                                        GtkTreePath  *path,
3339                                        GtkTreeIter  *iter,
3340                                        gpointer      data)
3341 {
3342   /* evil, don't try this at home, but certainly speeds things up */
3343   gtk_tree_model_filter_row_changed (model, path, iter, data);
3344
3345   return FALSE;
3346 }
3347
3348 /**
3349  * gtk_tree_model_filter_refilter:
3350  * @filter: A #GtkTreeModelFilter.
3351  *
3352  * Emits ::row_changed for each row in the child model, which causes
3353  * the filter to re-evaluate whether a row is visible or not.
3354  *
3355  * Since: 2.4
3356  */
3357 void
3358 gtk_tree_model_filter_refilter (GtkTreeModelFilter *filter)
3359 {
3360   g_return_if_fail (GTK_IS_TREE_MODEL_FILTER (filter));
3361
3362   /* S L O W */
3363   gtk_tree_model_foreach (filter->priv->child_model,
3364                           gtk_tree_model_filter_refilter_helper,
3365                           filter);
3366 }
3367
3368 /**
3369  * gtk_tree_model_filter_clear_cache:
3370  * @filter: A #GtkTreeModelFilter.
3371  *
3372  * This function should almost never be called. It clears the @filter
3373  * of any cached iterators that haven't been reffed with
3374  * gtk_tree_model_ref_node(). This might be useful if the child model
3375  * being filtered is static (and doesn't change often) and there has been
3376  * a lot of unreffed access to nodes. As a side effect of this function,
3377  * all unreffed iters will be invalid.
3378  *
3379  * Since: 2.4
3380  */
3381 void
3382 gtk_tree_model_filter_clear_cache (GtkTreeModelFilter *filter)
3383 {
3384   g_return_if_fail (GTK_IS_TREE_MODEL_FILTER (filter));
3385
3386   if (filter->priv->zero_ref_count > 0)
3387     gtk_tree_model_filter_clear_cache_helper (filter,
3388                                               FILTER_LEVEL (filter->priv->root));
3389 }
3390
3391 #define __GTK_TREE_MODEL_FILTER_C__
3392 #include "gtkaliasdef.c"