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