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 (GtkTreeModel *c_model,
1860                                    GtkTreePath  *c_path,
1861                                    gpointer      data)
1862 {
1863   GtkTreeModelFilter *filter = GTK_TREE_MODEL_FILTER (data);
1864   GtkTreePath *path;
1865   GtkTreeIter iter;
1866   FilterElt *elt;
1867   FilterLevel *level, *parent_level = NULL;
1868   gboolean emit_child_toggled = FALSE;
1869   gboolean emit_row_deleted = FALSE;
1870   gint offset;
1871   gint i;
1872   gint parent_elt_index = -1;
1873
1874   g_return_if_fail (c_path != NULL);
1875
1876   /* special case the deletion of an ancestor of the virtual root */
1877   if (filter->priv->virtual_root &&
1878       (gtk_tree_path_is_ancestor (c_path, filter->priv->virtual_root) ||
1879        !gtk_tree_path_compare (c_path, filter->priv->virtual_root)))
1880     {
1881       gtk_tree_model_filter_virtual_root_deleted (filter, c_path);
1882       return;
1883     }
1884
1885   /* adjust the virtual root for the deleted row */
1886   if (filter->priv->virtual_root &&
1887       gtk_tree_path_get_depth (filter->priv->virtual_root) >=
1888       gtk_tree_path_get_depth (c_path))
1889     gtk_tree_model_filter_adjust_virtual_root (filter, c_path);
1890
1891   path = gtk_real_tree_model_filter_convert_child_path_to_path (filter,
1892                                                                 c_path,
1893                                                                 FALSE,
1894                                                                 FALSE);
1895
1896   if (!path)
1897     {
1898       /* The node deleted in the child model is not visible in the
1899        * filter model.  We will not emit a signal, just fixup the offsets
1900        * of the other nodes.
1901        */
1902       GtkTreePath *real_path;
1903
1904       if (!filter->priv->root)
1905         return;
1906
1907       level = FILTER_LEVEL (filter->priv->root);
1908
1909       /* subtract vroot if necessary */
1910       if (filter->priv->virtual_root)
1911         {
1912           real_path = gtk_tree_model_filter_remove_root (c_path,
1913                                                          filter->priv->virtual_root);
1914           /* we don't handle this */
1915           if (!real_path)
1916             return;
1917         }
1918       else
1919         real_path = gtk_tree_path_copy (c_path);
1920
1921       i = 0;
1922       if (gtk_tree_path_get_depth (real_path) - 1 >= 1)
1923         {
1924           /* find the level where the deletion occurred */
1925           while (i < gtk_tree_path_get_depth (real_path) - 1)
1926             {
1927               gint j;
1928
1929               if (!level)
1930                 {
1931                   /* we don't cover this */
1932                   gtk_tree_path_free (real_path);
1933                   return;
1934                 }
1935
1936               elt = bsearch_elt_with_offset (level->array,
1937                                              gtk_tree_path_get_indices (real_path)[i],
1938                                              &j);
1939
1940               if (!elt || !elt->children)
1941                 {
1942                   /* parent is filtered out, so no level */
1943                   gtk_tree_path_free (real_path);
1944                   return;
1945                 }
1946
1947               level = elt->children;
1948               i++;
1949             }
1950         }
1951
1952       offset = gtk_tree_path_get_indices (real_path)[gtk_tree_path_get_depth (real_path) - 1];
1953       gtk_tree_path_free (real_path);
1954
1955       if (!level)
1956         return;
1957
1958       /* decrease offset of all nodes following the deleted node */
1959       for (i = 0; i < level->array->len; i++)
1960         {
1961           elt = &g_array_index (level->array, FilterElt, i);
1962           if (elt->offset > offset)
1963             elt->offset--;
1964           if (elt->children)
1965             elt->children->parent_elt_index = i;
1966         }
1967
1968       return;
1969     }
1970
1971   /* a node was deleted, which was in our cache */
1972   gtk_tree_model_filter_get_iter_full (GTK_TREE_MODEL (data), &iter, path);
1973
1974   level = FILTER_LEVEL (iter.user_data);
1975   elt = FILTER_ELT (iter.user_data2);
1976   offset = elt->offset;
1977
1978   if (elt->visible)
1979     {
1980       /* get a path taking only visible nodes into account */
1981       gtk_tree_path_free (path);
1982       path = gtk_tree_model_get_path (GTK_TREE_MODEL (filter), &iter);
1983
1984       level->visible_nodes--;
1985
1986       if (level->visible_nodes == 0)
1987         {
1988           emit_child_toggled = TRUE;
1989           parent_level = level->parent_level;
1990           parent_elt_index = level->parent_elt_index;
1991         }
1992
1993       emit_row_deleted = TRUE;
1994     }
1995
1996   /* Release the references on this node, without propagation because
1997    * the node does not exist anymore in the child model.  The filter
1998    * model's references on the node in case of level->parent or use
1999    * of a virtual root are automatically destroyed by the child model.
2000    */
2001   while (elt->ref_count > 0)
2002     gtk_tree_model_filter_real_unref_node (GTK_TREE_MODEL (data), &iter, FALSE);
2003
2004   if (level->array->len == 1)
2005     {
2006       /* kill level */
2007       gtk_tree_model_filter_free_level (filter, level, FALSE);
2008     }
2009   else
2010     {
2011       FilterElt *tmp;
2012
2013       /* remove the row */
2014       tmp = bsearch_elt_with_offset (level->array, elt->offset, &i);
2015
2016       offset = tmp->offset;
2017       g_array_remove_index (level->array, i);
2018
2019       i--;
2020       for (i = MAX (i, 0); i < level->array->len; i++)
2021         {
2022           elt = &g_array_index (level->array, FilterElt, i);
2023           if (elt->offset > offset)
2024             elt->offset--;
2025           if (elt->children)
2026             elt->children->parent_elt_index = i;
2027         }
2028     }
2029
2030   if (emit_row_deleted)
2031     {
2032       /* emit row_deleted */
2033       gtk_tree_model_filter_increment_stamp (filter);
2034       gtk_tree_model_row_deleted (GTK_TREE_MODEL (data), path);
2035       iter.stamp = filter->priv->stamp;
2036     }
2037
2038   if (emit_child_toggled && parent_level)
2039     {
2040       GtkTreeIter iter2;
2041       GtkTreePath *path2;
2042
2043       iter2.stamp = filter->priv->stamp;
2044       iter2.user_data = parent_level;
2045       iter2.user_data2 = &g_array_index (parent_level->array, FilterElt, parent_elt_index);
2046
2047       /* We set in_row_deleted to TRUE to avoid a level build triggered
2048        * by row-has-child-toggled (parent model could call iter_has_child
2049        * for example).
2050        */
2051       filter->priv->in_row_deleted = TRUE;
2052       path2 = gtk_tree_model_get_path (GTK_TREE_MODEL (filter), &iter2);
2053       gtk_tree_model_row_has_child_toggled (GTK_TREE_MODEL (filter),
2054                                             path2, &iter2);
2055       gtk_tree_path_free (path2);
2056       filter->priv->in_row_deleted = FALSE;
2057     }
2058
2059   gtk_tree_path_free (path);
2060 }
2061
2062 static void
2063 gtk_tree_model_filter_rows_reordered (GtkTreeModel *c_model,
2064                                       GtkTreePath  *c_path,
2065                                       GtkTreeIter  *c_iter,
2066                                       gint         *new_order,
2067                                       gpointer      data)
2068 {
2069   FilterElt *elt;
2070   FilterLevel *level;
2071   GtkTreeModelFilter *filter = GTK_TREE_MODEL_FILTER (data);
2072
2073   GtkTreePath *path;
2074   GtkTreeIter iter;
2075
2076   gint *tmp_array;
2077   gint i, j, elt_count;
2078   gint length;
2079
2080   GArray *new_array;
2081
2082   g_return_if_fail (new_order != NULL);
2083
2084   if (c_path == NULL || gtk_tree_path_get_depth (c_path) == 0)
2085     {
2086       length = gtk_tree_model_iter_n_children (c_model, NULL);
2087
2088       if (filter->priv->virtual_root)
2089         {
2090           gint new_pos = -1;
2091
2092           /* reorder root level of path */
2093           for (i = 0; i < length; i++)
2094             if (new_order[i] == gtk_tree_path_get_indices (filter->priv->virtual_root)[0])
2095               new_pos = i;
2096
2097           if (new_pos < 0)
2098             return;
2099
2100           gtk_tree_path_get_indices (filter->priv->virtual_root)[0] = new_pos;
2101           return;
2102         }
2103
2104       path = gtk_tree_path_new ();
2105       level = FILTER_LEVEL (filter->priv->root);
2106     }
2107   else
2108     {
2109       GtkTreeIter child_iter;
2110
2111       /* virtual root anchor reordering */
2112       if (filter->priv->virtual_root &&
2113           gtk_tree_path_is_ancestor (c_path, filter->priv->virtual_root))
2114         {
2115           gint new_pos = -1;
2116           gint length;
2117           gint level;
2118           GtkTreeIter real_c_iter;
2119
2120           level = gtk_tree_path_get_depth (c_path);
2121
2122           if (c_iter)
2123             real_c_iter = *c_iter;
2124           else
2125             gtk_tree_model_get_iter (c_model, &real_c_iter, c_path);
2126
2127           length = gtk_tree_model_iter_n_children (c_model, &real_c_iter);
2128
2129           for (i = 0; i < length; i++)
2130             if (new_order[i] == gtk_tree_path_get_indices (filter->priv->virtual_root)[level])
2131               new_pos = i;
2132
2133           if (new_pos < 0)
2134             return;
2135
2136           gtk_tree_path_get_indices (filter->priv->virtual_root)[level] = new_pos;
2137           return;
2138         }
2139
2140       path = gtk_real_tree_model_filter_convert_child_path_to_path (filter,
2141                                                                     c_path,
2142                                                                     FALSE,
2143                                                                     FALSE);
2144
2145       if (!path && filter->priv->virtual_root &&
2146           gtk_tree_path_compare (c_path, filter->priv->virtual_root))
2147         return;
2148
2149       if (!path && !filter->priv->virtual_root)
2150         return;
2151
2152       if (!path)
2153         {
2154           /* root level mode */
2155           if (!c_iter)
2156             gtk_tree_model_get_iter (c_model, c_iter, c_path);
2157           length = gtk_tree_model_iter_n_children (c_model, c_iter);
2158           path = gtk_tree_path_new ();
2159           level = FILTER_LEVEL (filter->priv->root);
2160         }
2161       else
2162         {
2163           gtk_tree_model_filter_get_iter_full (GTK_TREE_MODEL (data),
2164                                                &iter, path);
2165
2166           level = FILTER_LEVEL (iter.user_data);
2167           elt = FILTER_ELT (iter.user_data2);
2168
2169           if (!elt->children)
2170             {
2171               gtk_tree_path_free (path);
2172               return;
2173             }
2174
2175           level = elt->children;
2176
2177           gtk_tree_model_filter_convert_iter_to_child_iter (GTK_TREE_MODEL_FILTER (filter), &child_iter, &iter);
2178           length = gtk_tree_model_iter_n_children (c_model, &child_iter);
2179         }
2180     }
2181
2182   if (!level || level->array->len < 1)
2183     {
2184       gtk_tree_path_free (path);
2185       return;
2186     }
2187
2188   /* NOTE: we do not bail out here if level->array->len < 2 like
2189    * GtkTreeModelSort does. This because we do some special tricky
2190    * reordering.
2191    */
2192
2193   /* construct a new array */
2194   new_array = g_array_sized_new (FALSE, FALSE, sizeof (FilterElt),
2195                                  level->array->len);
2196   tmp_array = g_new (gint, level->array->len);
2197
2198   for (i = 0, elt_count = 0; i < length; i++)
2199     {
2200       FilterElt *e = NULL;
2201       gint old_offset = -1;
2202
2203       for (j = 0; j < level->array->len; j++)
2204         if (g_array_index (level->array, FilterElt, j).offset == new_order[i])
2205           {
2206             e = &g_array_index (level->array, FilterElt, j);
2207             old_offset = j;
2208             break;
2209           }
2210
2211       if (!e)
2212         continue;
2213
2214       tmp_array[elt_count] = old_offset;
2215       g_array_append_val (new_array, *e);
2216       g_array_index (new_array, FilterElt, elt_count).offset = i;
2217       elt_count++;
2218     }
2219
2220   g_array_free (level->array, TRUE);
2221   level->array = new_array;
2222
2223   /* fix up stuff */
2224   for (i = 0; i < level->array->len; i++)
2225     {
2226       FilterElt *e = &g_array_index (level->array, FilterElt, i);
2227       if (e->children)
2228         e->children->parent_elt_index = i;
2229     }
2230
2231   /* emit rows_reordered */
2232   if (!gtk_tree_path_get_indices (path))
2233     gtk_tree_model_rows_reordered (GTK_TREE_MODEL (data), path, NULL,
2234                                    tmp_array);
2235   else
2236     {
2237       /* get a path taking only visible nodes into account */
2238       gtk_tree_path_free (path);
2239       path = gtk_tree_model_get_path (GTK_TREE_MODEL (data), &iter);
2240
2241       gtk_tree_model_rows_reordered (GTK_TREE_MODEL (data), path, &iter,
2242                                      tmp_array);
2243     }
2244
2245   /* done */
2246   g_free (tmp_array);
2247   gtk_tree_path_free (path);
2248 }
2249
2250 /* TreeModelIface implementation */
2251 static GtkTreeModelFlags
2252 gtk_tree_model_filter_get_flags (GtkTreeModel *model)
2253 {
2254   GtkTreeModelFlags flags;
2255
2256   g_return_val_if_fail (GTK_IS_TREE_MODEL_FILTER (model), 0);
2257   g_return_val_if_fail (GTK_TREE_MODEL_FILTER (model)->priv->child_model != NULL, 0);
2258
2259   flags = gtk_tree_model_get_flags (GTK_TREE_MODEL_FILTER (model)->priv->child_model);
2260
2261   if ((flags & GTK_TREE_MODEL_LIST_ONLY) == GTK_TREE_MODEL_LIST_ONLY)
2262     return GTK_TREE_MODEL_LIST_ONLY;
2263
2264   return 0;
2265 }
2266
2267 static gint
2268 gtk_tree_model_filter_get_n_columns (GtkTreeModel *model)
2269 {
2270   GtkTreeModelFilter *filter = (GtkTreeModelFilter *)model;
2271
2272   g_return_val_if_fail (GTK_IS_TREE_MODEL_FILTER (model), 0);
2273   g_return_val_if_fail (filter->priv->child_model != NULL, 0);
2274
2275   if (filter->priv->child_model == NULL)
2276     return 0;
2277
2278   /* so we can't modify the modify func after this ... */
2279   filter->priv->modify_func_set = TRUE;
2280
2281   if (filter->priv->modify_n_columns > 0)
2282     return filter->priv->modify_n_columns;
2283
2284   return gtk_tree_model_get_n_columns (filter->priv->child_model);
2285 }
2286
2287 static GType
2288 gtk_tree_model_filter_get_column_type (GtkTreeModel *model,
2289                                        gint          index)
2290 {
2291   GtkTreeModelFilter *filter = (GtkTreeModelFilter *)model;
2292
2293   g_return_val_if_fail (GTK_IS_TREE_MODEL_FILTER (model), G_TYPE_INVALID);
2294   g_return_val_if_fail (filter->priv->child_model != NULL, G_TYPE_INVALID);
2295
2296   /* so we can't modify the modify func after this ... */
2297   filter->priv->modify_func_set = TRUE;
2298
2299   if (filter->priv->modify_types)
2300     {
2301       g_return_val_if_fail (index < filter->priv->modify_n_columns, G_TYPE_INVALID);
2302
2303       return filter->priv->modify_types[index];
2304     }
2305
2306   return gtk_tree_model_get_column_type (filter->priv->child_model, index);
2307 }
2308
2309 /* A special case of _get_iter; this function can also get iters which
2310  * are not visible.  These iters should ONLY be passed internally, never
2311  * pass those along with a signal emission.
2312  */
2313 static gboolean
2314 gtk_tree_model_filter_get_iter_full (GtkTreeModel *model,
2315                                      GtkTreeIter  *iter,
2316                                      GtkTreePath  *path)
2317 {
2318   GtkTreeModelFilter *filter = (GtkTreeModelFilter *)model;
2319   gint *indices;
2320   FilterLevel *level;
2321   FilterElt *elt;
2322   gint depth, i;
2323   g_return_val_if_fail (GTK_IS_TREE_MODEL_FILTER (model), FALSE);
2324   g_return_val_if_fail (filter->priv->child_model != NULL, FALSE);
2325
2326   indices = gtk_tree_path_get_indices (path);
2327
2328   if (filter->priv->root == NULL)
2329     gtk_tree_model_filter_build_level (filter, NULL, -1, FALSE);
2330   level = FILTER_LEVEL (filter->priv->root);
2331
2332   depth = gtk_tree_path_get_depth (path);
2333   if (!depth)
2334     {
2335       iter->stamp = 0;
2336       return FALSE;
2337     }
2338
2339   for (i = 0; i < depth - 1; i++)
2340     {
2341       if (!level || indices[i] >= level->array->len)
2342         {
2343           iter->stamp = 0;
2344           return FALSE;
2345         }
2346
2347       elt = gtk_tree_model_filter_get_nth (filter, level, indices[i]);
2348
2349       if (!elt->children)
2350         gtk_tree_model_filter_build_level (filter, level,
2351                                            FILTER_LEVEL_ELT_INDEX (level, elt),
2352                                            FALSE);
2353       level = elt->children;
2354     }
2355
2356   if (!level || indices[i] >= level->array->len)
2357     {
2358       iter->stamp = 0;
2359       return FALSE;
2360     }
2361
2362   iter->stamp = filter->priv->stamp;
2363   iter->user_data = level;
2364
2365   elt = gtk_tree_model_filter_get_nth (filter, level, indices[depth - 1]);
2366   iter->user_data2 = elt;
2367
2368   return TRUE;
2369 }
2370
2371 static gboolean
2372 gtk_tree_model_filter_get_iter (GtkTreeModel *model,
2373                                 GtkTreeIter  *iter,
2374                                 GtkTreePath  *path)
2375 {
2376   GtkTreeModelFilter *filter = (GtkTreeModelFilter *)model;
2377   gint *indices;
2378   FilterLevel *level;
2379   FilterElt *elt;
2380   gint depth, i;
2381   g_return_val_if_fail (GTK_IS_TREE_MODEL_FILTER (model), FALSE);
2382   g_return_val_if_fail (filter->priv->child_model != NULL, FALSE);
2383
2384   indices = gtk_tree_path_get_indices (path);
2385
2386   if (filter->priv->root == NULL)
2387     gtk_tree_model_filter_build_level (filter, NULL, -1, FALSE);
2388   level = FILTER_LEVEL (filter->priv->root);
2389
2390   depth = gtk_tree_path_get_depth (path);
2391   if (!depth)
2392     {
2393       iter->stamp = 0;
2394       return FALSE;
2395     }
2396
2397   for (i = 0; i < depth - 1; i++)
2398     {
2399       if (!level || indices[i] >= level->visible_nodes)
2400         {
2401           iter->stamp = 0;
2402           return FALSE;
2403         }
2404
2405       elt = gtk_tree_model_filter_get_nth_visible (filter, level, indices[i]);
2406
2407       if (!elt->children)
2408         gtk_tree_model_filter_build_level (filter, level,
2409                                            FILTER_LEVEL_ELT_INDEX (level, elt),
2410                                            FALSE);
2411       level = elt->children;
2412     }
2413
2414   if (!level || indices[i] >= level->visible_nodes)
2415     {
2416       iter->stamp = 0;
2417       return FALSE;
2418     }
2419
2420   iter->stamp = filter->priv->stamp;
2421   iter->user_data = level;
2422
2423   elt = gtk_tree_model_filter_get_nth_visible (filter, level,
2424                                                indices[depth - 1]);
2425   iter->user_data2 = elt;
2426
2427   return TRUE;
2428 }
2429
2430 static GtkTreePath *
2431 gtk_tree_model_filter_get_path (GtkTreeModel *model,
2432                                 GtkTreeIter  *iter)
2433 {
2434   GtkTreePath *retval;
2435   FilterLevel *level;
2436   FilterElt *elt;
2437   gint elt_index;
2438
2439   g_return_val_if_fail (GTK_IS_TREE_MODEL_FILTER (model), NULL);
2440   g_return_val_if_fail (GTK_TREE_MODEL_FILTER (model)->priv->child_model != NULL, NULL);
2441   g_return_val_if_fail (GTK_TREE_MODEL_FILTER (model)->priv->stamp == iter->stamp, NULL);
2442
2443   level = iter->user_data;
2444   elt = iter->user_data2;
2445   elt_index = FILTER_LEVEL_ELT_INDEX (level, elt);
2446
2447   if (!elt->visible)
2448     return NULL;
2449
2450   retval = gtk_tree_path_new ();
2451
2452   while (level)
2453     {
2454       int i = 0, index = 0;
2455
2456       while (i < elt_index)
2457         {
2458           if (g_array_index (level->array, FilterElt, i).visible)
2459             index++;
2460           i++;
2461
2462           g_assert (i < level->array->len);
2463         }
2464
2465       gtk_tree_path_prepend_index (retval, index);
2466       elt_index = level->parent_elt_index;
2467       level = level->parent_level;
2468     }
2469
2470   return retval;
2471 }
2472
2473 static void
2474 gtk_tree_model_filter_real_modify (GtkTreeModelFilter *self,
2475                                    GtkTreeModel       *child_model,
2476                                    GtkTreeIter        *iter,
2477                                    GValue             *value,
2478                                    gint                column)
2479 {
2480   if (self->priv->modify_func)
2481     {
2482       g_return_if_fail (column < self->priv->modify_n_columns);
2483
2484       g_value_init (value, self->priv->modify_types[column]);
2485       self->priv->modify_func (GTK_TREE_MODEL (self),
2486                            iter,
2487                            value,
2488                            column,
2489                            self->priv->modify_data);
2490     }
2491   else
2492     {
2493       GtkTreeIter child_iter;
2494
2495       gtk_tree_model_filter_convert_iter_to_child_iter (
2496           GTK_TREE_MODEL_FILTER (self), &child_iter, iter);
2497       gtk_tree_model_get_value (child_model,
2498           &child_iter, column, value);
2499     }
2500 }
2501
2502 static void
2503 gtk_tree_model_filter_get_value (GtkTreeModel *model,
2504                                  GtkTreeIter  *iter,
2505                                  gint          column,
2506                                  GValue       *value)
2507 {
2508   GtkTreeModelFilter *filter = GTK_TREE_MODEL_FILTER (model);
2509
2510   g_return_if_fail (GTK_IS_TREE_MODEL_FILTER (model));
2511   g_return_if_fail (GTK_TREE_MODEL_FILTER (model)->priv->child_model != NULL);
2512   g_return_if_fail (GTK_TREE_MODEL_FILTER (model)->priv->stamp == iter->stamp);
2513
2514   GTK_TREE_MODEL_FILTER_GET_CLASS (model)->modify (filter,
2515       filter->priv->child_model, iter, value, column);
2516 }
2517
2518 static gboolean
2519 gtk_tree_model_filter_iter_next (GtkTreeModel *model,
2520                                  GtkTreeIter  *iter)
2521 {
2522   int i;
2523   FilterLevel *level;
2524   FilterElt *elt;
2525
2526   g_return_val_if_fail (GTK_IS_TREE_MODEL_FILTER (model), FALSE);
2527   g_return_val_if_fail (GTK_TREE_MODEL_FILTER (model)->priv->child_model != NULL, FALSE);
2528   g_return_val_if_fail (GTK_TREE_MODEL_FILTER (model)->priv->stamp == iter->stamp, FALSE);
2529
2530   level = iter->user_data;
2531   elt = iter->user_data2;
2532
2533   i = elt - FILTER_ELT (level->array->data);
2534
2535   while (i < level->array->len - 1)
2536     {
2537       i++;
2538       elt++;
2539
2540       if (elt->visible)
2541         {
2542           iter->user_data2 = elt;
2543           return TRUE;
2544         }
2545     }
2546
2547   /* no next visible iter */
2548   iter->stamp = 0;
2549
2550   return FALSE;
2551 }
2552
2553 static gboolean
2554 gtk_tree_model_filter_iter_previous (GtkTreeModel *model,
2555                                      GtkTreeIter  *iter)
2556 {
2557   int i;
2558   FilterLevel *level;
2559   FilterElt *elt;
2560
2561   g_return_val_if_fail (GTK_IS_TREE_MODEL_FILTER (model), FALSE);
2562   g_return_val_if_fail (GTK_TREE_MODEL_FILTER (model)->priv->child_model != NULL, FALSE);
2563   g_return_val_if_fail (GTK_TREE_MODEL_FILTER (model)->priv->stamp == iter->stamp, FALSE);
2564
2565   level = iter->user_data;
2566   elt = iter->user_data2;
2567
2568   i = elt - FILTER_ELT (level->array->data);
2569
2570   while (i > 0)
2571     {
2572       i--;
2573       elt--;
2574
2575       if (elt->visible)
2576         {
2577           iter->user_data2 = elt;
2578           return TRUE;
2579         }
2580     }
2581
2582   /* no previous visible iter */
2583   iter->stamp = 0;
2584
2585   return FALSE;
2586 }
2587
2588 static gboolean
2589 gtk_tree_model_filter_iter_children (GtkTreeModel *model,
2590                                      GtkTreeIter  *iter,
2591                                      GtkTreeIter  *parent)
2592 {
2593   GtkTreeModelFilter *filter = (GtkTreeModelFilter *)model;
2594   FilterLevel *level;
2595
2596   iter->stamp = 0;
2597   g_return_val_if_fail (GTK_IS_TREE_MODEL_FILTER (model), FALSE);
2598   g_return_val_if_fail (filter->priv->child_model != NULL, FALSE);
2599   if (parent)
2600     g_return_val_if_fail (filter->priv->stamp == parent->stamp, FALSE);
2601
2602   if (!parent)
2603     {
2604       int i = 0;
2605
2606       if (!filter->priv->root)
2607         gtk_tree_model_filter_build_level (filter, NULL, -1, FALSE);
2608       if (!filter->priv->root)
2609         return FALSE;
2610
2611       level = filter->priv->root;
2612
2613       if (!level->visible_nodes)
2614         return FALSE;
2615
2616       iter->stamp = filter->priv->stamp;
2617       iter->user_data = level;
2618
2619       while (i < level->array->len)
2620         {
2621           if (!g_array_index (level->array, FilterElt, i).visible)
2622             {
2623               i++;
2624               continue;
2625             }
2626
2627           iter->user_data2 = &g_array_index (level->array, FilterElt, i);
2628           return TRUE;
2629         }
2630
2631       iter->stamp = 0;
2632       return FALSE;
2633     }
2634   else
2635     {
2636       int i = 0;
2637       FilterElt *elt;
2638
2639       elt = FILTER_ELT (parent->user_data2);
2640
2641       if (elt->children == NULL)
2642         gtk_tree_model_filter_build_level (filter,
2643                                            FILTER_LEVEL (parent->user_data),
2644                                            FILTER_LEVEL_ELT_INDEX (parent->user_data, elt),
2645                                            FALSE);
2646
2647       if (elt->children == NULL)
2648         return FALSE;
2649
2650       if (elt->children->visible_nodes <= 0)
2651         return FALSE;
2652
2653       iter->stamp = filter->priv->stamp;
2654       iter->user_data = elt->children;
2655
2656       level = FILTER_LEVEL (iter->user_data);
2657
2658       while (i < level->array->len)
2659         {
2660           if (!g_array_index (level->array, FilterElt, i).visible)
2661             {
2662               i++;
2663               continue;
2664             }
2665
2666           iter->user_data2 = &g_array_index (level->array, FilterElt, i);
2667           return TRUE;
2668         }
2669
2670       iter->stamp = 0;
2671       return FALSE;
2672     }
2673
2674   iter->stamp = 0;
2675   return FALSE;
2676 }
2677
2678 static gboolean
2679 gtk_tree_model_filter_iter_has_child (GtkTreeModel *model,
2680                                       GtkTreeIter  *iter)
2681 {
2682   GtkTreeIter child_iter;
2683   GtkTreeModelFilter *filter = (GtkTreeModelFilter *)model;
2684   FilterElt *elt;
2685
2686   g_return_val_if_fail (GTK_IS_TREE_MODEL_FILTER (model), FALSE);
2687   g_return_val_if_fail (filter->priv->child_model != NULL, FALSE);
2688   g_return_val_if_fail (filter->priv->stamp == iter->stamp, FALSE);
2689
2690   filter = GTK_TREE_MODEL_FILTER (model);
2691
2692   gtk_tree_model_filter_convert_iter_to_child_iter (GTK_TREE_MODEL_FILTER (model), &child_iter, iter);
2693   elt = FILTER_ELT (iter->user_data2);
2694
2695   if (!elt->visible)
2696     return FALSE;
2697
2698   /* we need to build the level to check if not all children are filtered
2699    * out
2700    */
2701   if (!elt->children
2702       && gtk_tree_model_iter_has_child (filter->priv->child_model, &child_iter))
2703     gtk_tree_model_filter_build_level (filter, FILTER_LEVEL (iter->user_data),
2704                                        FILTER_LEVEL_ELT_INDEX (iter->user_data, elt),
2705                                        FALSE);
2706
2707   if (elt->children && elt->children->visible_nodes > 0)
2708     return TRUE;
2709
2710   return FALSE;
2711 }
2712
2713 static gint
2714 gtk_tree_model_filter_iter_n_children (GtkTreeModel *model,
2715                                        GtkTreeIter  *iter)
2716 {
2717   GtkTreeIter child_iter;
2718   GtkTreeModelFilter *filter = (GtkTreeModelFilter *)model;
2719   FilterElt *elt;
2720
2721   g_return_val_if_fail (GTK_IS_TREE_MODEL_FILTER (model), 0);
2722   g_return_val_if_fail (filter->priv->child_model != NULL, 0);
2723   if (iter)
2724     g_return_val_if_fail (filter->priv->stamp == iter->stamp, 0);
2725
2726   if (!iter)
2727     {
2728       if (!filter->priv->root)
2729         gtk_tree_model_filter_build_level (filter, NULL, -1, FALSE);
2730
2731       if (filter->priv->root)
2732         return FILTER_LEVEL (filter->priv->root)->visible_nodes;
2733
2734       return 0;
2735     }
2736
2737   elt = FILTER_ELT (iter->user_data2);
2738
2739   if (!elt->visible)
2740     return 0;
2741
2742   gtk_tree_model_filter_convert_iter_to_child_iter (GTK_TREE_MODEL_FILTER (model), &child_iter, iter);
2743
2744   if (!elt->children &&
2745       gtk_tree_model_iter_has_child (filter->priv->child_model, &child_iter))
2746     gtk_tree_model_filter_build_level (filter,
2747                                        FILTER_LEVEL (iter->user_data),
2748                                        FILTER_LEVEL_ELT_INDEX (iter->user_data, elt),
2749                                        FALSE);
2750
2751   if (elt->children)
2752     return elt->children->visible_nodes;
2753
2754   return 0;
2755 }
2756
2757 static gboolean
2758 gtk_tree_model_filter_iter_nth_child (GtkTreeModel *model,
2759                                       GtkTreeIter  *iter,
2760                                       GtkTreeIter  *parent,
2761                                       gint          n)
2762 {
2763   FilterElt *elt;
2764   FilterLevel *level;
2765   GtkTreeIter children;
2766
2767   g_return_val_if_fail (GTK_IS_TREE_MODEL_FILTER (model), FALSE);
2768   if (parent)
2769     g_return_val_if_fail (GTK_TREE_MODEL_FILTER (model)->priv->stamp == parent->stamp, FALSE);
2770
2771   /* use this instead of has_child to force us to build the level, if needed */
2772   if (gtk_tree_model_filter_iter_children (model, &children, parent) == FALSE)
2773     {
2774       iter->stamp = 0;
2775       return FALSE;
2776     }
2777
2778   level = children.user_data;
2779   elt = FILTER_ELT (level->array->data);
2780
2781   if (n >= level->visible_nodes)
2782     {
2783       iter->stamp = 0;
2784       return FALSE;
2785     }
2786
2787   elt = gtk_tree_model_filter_get_nth_visible (GTK_TREE_MODEL_FILTER (model),
2788                                                level, n);
2789
2790   iter->stamp = GTK_TREE_MODEL_FILTER (model)->priv->stamp;
2791   iter->user_data = level;
2792   iter->user_data2 = elt;
2793
2794   return TRUE;
2795 }
2796
2797 static gboolean
2798 gtk_tree_model_filter_iter_parent (GtkTreeModel *model,
2799                                    GtkTreeIter  *iter,
2800                                    GtkTreeIter  *child)
2801 {
2802   FilterLevel *level;
2803
2804   iter->stamp = 0;
2805   g_return_val_if_fail (GTK_IS_TREE_MODEL_FILTER (model), FALSE);
2806   g_return_val_if_fail (GTK_TREE_MODEL_FILTER (model)->priv->child_model != NULL, FALSE);
2807   g_return_val_if_fail (GTK_TREE_MODEL_FILTER (model)->priv->stamp == child->stamp, FALSE);
2808
2809   level = child->user_data;
2810
2811   if (level->parent_level)
2812     {
2813       iter->stamp = GTK_TREE_MODEL_FILTER (model)->priv->stamp;
2814       iter->user_data = level->parent_level;
2815       iter->user_data2 = FILTER_LEVEL_PARENT_ELT (level);
2816
2817       return TRUE;
2818     }
2819
2820   return FALSE;
2821 }
2822
2823 static void
2824 gtk_tree_model_filter_ref_node (GtkTreeModel *model,
2825                                 GtkTreeIter  *iter)
2826 {
2827   GtkTreeModelFilter *filter = (GtkTreeModelFilter *)model;
2828   GtkTreeIter child_iter;
2829   FilterLevel *level;
2830   FilterElt *elt;
2831
2832   g_return_if_fail (GTK_IS_TREE_MODEL_FILTER (model));
2833   g_return_if_fail (GTK_TREE_MODEL_FILTER (model)->priv->child_model != NULL);
2834   g_return_if_fail (GTK_TREE_MODEL_FILTER (model)->priv->stamp == iter->stamp);
2835
2836   gtk_tree_model_filter_convert_iter_to_child_iter (GTK_TREE_MODEL_FILTER (model), &child_iter, iter);
2837
2838   gtk_tree_model_ref_node (filter->priv->child_model, &child_iter);
2839
2840   level = iter->user_data;
2841   elt = iter->user_data2;
2842
2843   elt->ref_count++;
2844   level->ref_count++;
2845   if (level->ref_count == 1)
2846     {
2847       FilterLevel *parent_level = level->parent_level;
2848       gint parent_elt_index = level->parent_elt_index;
2849
2850       /* we were at zero -- time to decrease the zero_ref_count val */
2851       while (parent_level)
2852         {
2853           g_array_index (parent_level->array, FilterElt, parent_elt_index).zero_ref_count--;
2854
2855           parent_elt_index = parent_level->parent_elt_index;
2856           parent_level = parent_level->parent_level;
2857         }
2858
2859       if (filter->priv->root != level)
2860         filter->priv->zero_ref_count--;
2861     }
2862 }
2863
2864 static void
2865 gtk_tree_model_filter_unref_node (GtkTreeModel *model,
2866                                   GtkTreeIter  *iter)
2867 {
2868   gtk_tree_model_filter_real_unref_node (model, iter, TRUE);
2869 }
2870
2871 static void
2872 gtk_tree_model_filter_real_unref_node (GtkTreeModel *model,
2873                                        GtkTreeIter  *iter,
2874                                        gboolean      propagate_unref)
2875 {
2876   GtkTreeModelFilter *filter = (GtkTreeModelFilter *)model;
2877   FilterLevel *level;
2878   FilterElt *elt;
2879
2880   g_return_if_fail (GTK_IS_TREE_MODEL_FILTER (model));
2881   g_return_if_fail (filter->priv->child_model != NULL);
2882   g_return_if_fail (filter->priv->stamp == iter->stamp);
2883
2884   if (propagate_unref)
2885     {
2886       GtkTreeIter child_iter;
2887       gtk_tree_model_filter_convert_iter_to_child_iter (GTK_TREE_MODEL_FILTER (model), &child_iter, iter);
2888       gtk_tree_model_unref_node (filter->priv->child_model, &child_iter);
2889     }
2890
2891   level = iter->user_data;
2892   elt = iter->user_data2;
2893
2894   g_return_if_fail (elt->ref_count > 0);
2895
2896   elt->ref_count--;
2897   level->ref_count--;
2898   if (level->ref_count == 0)
2899     {
2900       FilterLevel *parent_level = level->parent_level;
2901       gint parent_elt_index = level->parent_elt_index;
2902
2903       /* we are at zero -- time to increase the zero_ref_count val */
2904       while (parent_level)
2905         {
2906           g_array_index (parent_level->array, FilterElt, parent_elt_index).zero_ref_count++;
2907
2908           parent_elt_index = parent_level->parent_elt_index;
2909           parent_level = parent_level->parent_level;
2910         }
2911
2912       if (filter->priv->root != level)
2913         filter->priv->zero_ref_count++;
2914     }
2915 }
2916
2917 /* TreeDragSource interface implementation */
2918 static gboolean
2919 gtk_tree_model_filter_row_draggable (GtkTreeDragSource *drag_source,
2920                                      GtkTreePath       *path)
2921 {
2922   GtkTreeModelFilter *tree_model_filter = (GtkTreeModelFilter *)drag_source;
2923   GtkTreePath *child_path;
2924   gboolean draggable;
2925
2926   g_return_val_if_fail (GTK_IS_TREE_MODEL_FILTER (drag_source), FALSE);
2927   g_return_val_if_fail (path != NULL, FALSE);
2928
2929   child_path = gtk_tree_model_filter_convert_path_to_child_path (tree_model_filter, path);
2930   draggable = gtk_tree_drag_source_row_draggable (GTK_TREE_DRAG_SOURCE (tree_model_filter->priv->child_model), child_path);
2931   gtk_tree_path_free (child_path);
2932
2933   return draggable;
2934 }
2935
2936 static gboolean
2937 gtk_tree_model_filter_drag_data_get (GtkTreeDragSource *drag_source,
2938                                      GtkTreePath       *path,
2939                                      GtkSelectionData  *selection_data)
2940 {
2941   GtkTreeModelFilter *tree_model_filter = (GtkTreeModelFilter *)drag_source;
2942   GtkTreePath *child_path;
2943   gboolean gotten;
2944
2945   g_return_val_if_fail (GTK_IS_TREE_MODEL_FILTER (drag_source), FALSE);
2946   g_return_val_if_fail (path != NULL, FALSE);
2947
2948   child_path = gtk_tree_model_filter_convert_path_to_child_path (tree_model_filter, path);
2949   gotten = gtk_tree_drag_source_drag_data_get (GTK_TREE_DRAG_SOURCE (tree_model_filter->priv->child_model), child_path, selection_data);
2950   gtk_tree_path_free (child_path);
2951
2952   return gotten;
2953 }
2954
2955 static gboolean
2956 gtk_tree_model_filter_drag_data_delete (GtkTreeDragSource *drag_source,
2957                                         GtkTreePath       *path)
2958 {
2959   GtkTreeModelFilter *tree_model_filter = (GtkTreeModelFilter *)drag_source;
2960   GtkTreePath *child_path;
2961   gboolean deleted;
2962
2963   g_return_val_if_fail (GTK_IS_TREE_MODEL_FILTER (drag_source), FALSE);
2964   g_return_val_if_fail (path != NULL, FALSE);
2965
2966   child_path = gtk_tree_model_filter_convert_path_to_child_path (tree_model_filter, path);
2967   deleted = gtk_tree_drag_source_drag_data_delete (GTK_TREE_DRAG_SOURCE (tree_model_filter->priv->child_model), child_path);
2968   gtk_tree_path_free (child_path);
2969
2970   return deleted;
2971 }
2972
2973 /* bits and pieces */
2974 static void
2975 gtk_tree_model_filter_set_model (GtkTreeModelFilter *filter,
2976                                  GtkTreeModel       *child_model)
2977 {
2978   g_return_if_fail (GTK_IS_TREE_MODEL_FILTER (filter));
2979
2980   if (filter->priv->child_model)
2981     {
2982       g_signal_handler_disconnect (filter->priv->child_model,
2983                                    filter->priv->changed_id);
2984       g_signal_handler_disconnect (filter->priv->child_model,
2985                                    filter->priv->inserted_id);
2986       g_signal_handler_disconnect (filter->priv->child_model,
2987                                    filter->priv->has_child_toggled_id);
2988       g_signal_handler_disconnect (filter->priv->child_model,
2989                                    filter->priv->deleted_id);
2990       g_signal_handler_disconnect (filter->priv->child_model,
2991                                    filter->priv->reordered_id);
2992
2993       /* reset our state */
2994       if (filter->priv->root)
2995         gtk_tree_model_filter_free_level (filter, filter->priv->root, TRUE);
2996
2997       filter->priv->root = NULL;
2998       g_object_unref (filter->priv->child_model);
2999       filter->priv->visible_column = -1;
3000
3001       /* FIXME: do we need to destroy more here? */
3002     }
3003
3004   filter->priv->child_model = child_model;
3005
3006   if (child_model)
3007     {
3008       g_object_ref (filter->priv->child_model);
3009       filter->priv->changed_id =
3010         g_signal_connect (child_model, "row-changed",
3011                           G_CALLBACK (gtk_tree_model_filter_row_changed),
3012                           filter);
3013       filter->priv->inserted_id =
3014         g_signal_connect (child_model, "row-inserted",
3015                           G_CALLBACK (gtk_tree_model_filter_row_inserted),
3016                           filter);
3017       filter->priv->has_child_toggled_id =
3018         g_signal_connect (child_model, "row-has-child-toggled",
3019                           G_CALLBACK (gtk_tree_model_filter_row_has_child_toggled),
3020                           filter);
3021       filter->priv->deleted_id =
3022         g_signal_connect (child_model, "row-deleted",
3023                           G_CALLBACK (gtk_tree_model_filter_row_deleted),
3024                           filter);
3025       filter->priv->reordered_id =
3026         g_signal_connect (child_model, "rows-reordered",
3027                           G_CALLBACK (gtk_tree_model_filter_rows_reordered),
3028                           filter);
3029
3030       filter->priv->child_flags = gtk_tree_model_get_flags (child_model);
3031       filter->priv->stamp = g_random_int ();
3032     }
3033 }
3034
3035 static void
3036 gtk_tree_model_filter_ref_path (GtkTreeModelFilter *filter,
3037                                 GtkTreePath        *path)
3038 {
3039   int len;
3040   GtkTreePath *p;
3041
3042   len = gtk_tree_path_get_depth (path);
3043   p = gtk_tree_path_copy (path);
3044   while (len--)
3045     {
3046       GtkTreeIter iter;
3047
3048       gtk_tree_model_get_iter (GTK_TREE_MODEL (filter->priv->child_model), &iter, p);
3049       gtk_tree_model_ref_node (GTK_TREE_MODEL (filter->priv->child_model), &iter);
3050       gtk_tree_path_up (p);
3051     }
3052
3053   gtk_tree_path_free (p);
3054 }
3055
3056 static void
3057 gtk_tree_model_filter_unref_path (GtkTreeModelFilter *filter,
3058                                   GtkTreePath        *path,
3059                                   int                 depth)
3060 {
3061   int len;
3062   GtkTreePath *p;
3063
3064   if (depth != -1)
3065     len = depth;
3066   else
3067     len = gtk_tree_path_get_depth (path);
3068
3069   p = gtk_tree_path_copy (path);
3070   while (len--)
3071     {
3072       GtkTreeIter iter;
3073
3074       gtk_tree_model_get_iter (GTK_TREE_MODEL (filter->priv->child_model), &iter, p);
3075       gtk_tree_model_unref_node (GTK_TREE_MODEL (filter->priv->child_model), &iter);
3076       gtk_tree_path_up (p);
3077     }
3078
3079   gtk_tree_path_free (p);
3080 }
3081
3082 static void
3083 gtk_tree_model_filter_set_root (GtkTreeModelFilter *filter,
3084                                 GtkTreePath        *root)
3085 {
3086   g_return_if_fail (GTK_IS_TREE_MODEL_FILTER (filter));
3087
3088   if (!root)
3089     filter->priv->virtual_root = NULL;
3090   else
3091     filter->priv->virtual_root = gtk_tree_path_copy (root);
3092 }
3093
3094 /* public API */
3095
3096 /**
3097  * gtk_tree_model_filter_new:
3098  * @child_model: A #GtkTreeModel.
3099  * @root: (allow-none): A #GtkTreePath or %NULL.
3100  *
3101  * Creates a new #GtkTreeModel, with @child_model as the child_model
3102  * and @root as the virtual root.
3103  *
3104  * Return value: (transfer full): A new #GtkTreeModel.
3105  *
3106  * Since: 2.4
3107  */
3108 GtkTreeModel *
3109 gtk_tree_model_filter_new (GtkTreeModel *child_model,
3110                            GtkTreePath  *root)
3111 {
3112   GtkTreeModel *retval;
3113   GtkTreeModelFilter *filter;
3114
3115   g_return_val_if_fail (GTK_IS_TREE_MODEL (child_model), NULL);
3116
3117   retval = g_object_new (GTK_TYPE_TREE_MODEL_FILTER,
3118                          "child-model", child_model,
3119                          "virtual-root", root,
3120                          NULL);
3121
3122   filter = GTK_TREE_MODEL_FILTER (retval);
3123   if (filter->priv->virtual_root)
3124     {
3125       gtk_tree_model_filter_ref_path (filter, filter->priv->virtual_root);
3126       filter->priv->virtual_root_deleted = FALSE;
3127     }
3128
3129   return retval;
3130 }
3131
3132 /**
3133  * gtk_tree_model_filter_get_model:
3134  * @filter: A #GtkTreeModelFilter.
3135  *
3136  * Returns a pointer to the child model of @filter.
3137  *
3138  * Return value: (transfer none): A pointer to a #GtkTreeModel.
3139  *
3140  * Since: 2.4
3141  */
3142 GtkTreeModel *
3143 gtk_tree_model_filter_get_model (GtkTreeModelFilter *filter)
3144 {
3145   g_return_val_if_fail (GTK_IS_TREE_MODEL_FILTER (filter), NULL);
3146
3147   return filter->priv->child_model;
3148 }
3149
3150 /**
3151  * gtk_tree_model_filter_set_visible_func:
3152  * @filter: A #GtkTreeModelFilter.
3153  * @func: A #GtkTreeModelFilterVisibleFunc, the visible function.
3154  * @data: (allow-none): User data to pass to the visible function, or %NULL.
3155  * @destroy: (allow-none): Destroy notifier of @data, or %NULL.
3156  *
3157  * Sets the visible function used when filtering the @filter to be @func. The
3158  * function should return %TRUE if the given row should be visible and
3159  * %FALSE otherwise.
3160  *
3161  * If the condition calculated by the function changes over time (e.g. because
3162  * it depends on some global parameters), you must call
3163  * gtk_tree_model_filter_refilter() to keep the visibility information of
3164  * the model uptodate.
3165  *
3166  * Note that @func is called whenever a row is inserted, when it may still be
3167  * empty. The visible function should therefore take special care of empty
3168  * rows, like in the example below.
3169  *
3170  * <informalexample><programlisting>
3171  * static gboolean
3172  * visible_func (GtkTreeModel *model,
3173  *               GtkTreeIter  *iter,
3174  *               gpointer      data)
3175  * {
3176  *   /&ast; Visible if row is non-empty and first column is "HI" &ast;/
3177  *   gchar *str;
3178  *   gboolean visible = FALSE;
3179  *
3180  *   gtk_tree_model_get (model, iter, 0, &str, -1);
3181  *   if (str && strcmp (str, "HI") == 0)
3182  *     visible = TRUE;
3183  *   g_free (str);
3184  *
3185  *   return visible;
3186  * }
3187  * </programlisting></informalexample>
3188  *
3189  * Since: 2.4
3190  */
3191 void
3192 gtk_tree_model_filter_set_visible_func (GtkTreeModelFilter            *filter,
3193                                         GtkTreeModelFilterVisibleFunc  func,
3194                                         gpointer                       data,
3195                                         GDestroyNotify                 destroy)
3196 {
3197   g_return_if_fail (GTK_IS_TREE_MODEL_FILTER (filter));
3198   g_return_if_fail (func != NULL);
3199   g_return_if_fail (filter->priv->visible_method_set == FALSE);
3200
3201   filter->priv->visible_func = func;
3202   filter->priv->visible_data = data;
3203   filter->priv->visible_destroy = destroy;
3204
3205   filter->priv->visible_method_set = TRUE;
3206 }
3207
3208 /**
3209  * gtk_tree_model_filter_set_modify_func:
3210  * @filter: A #GtkTreeModelFilter.
3211  * @n_columns: The number of columns in the filter model.
3212  * @types: (array length=n_columns): The #GType<!-- -->s of the columns.
3213  * @func: A #GtkTreeModelFilterModifyFunc
3214  * @data: (allow-none): User data to pass to the modify function, or %NULL.
3215  * @destroy: (allow-none): Destroy notifier of @data, or %NULL.
3216  *
3217  * With the @n_columns and @types parameters, you give an array of column
3218  * types for this model (which will be exposed to the parent model/view).
3219  * The @func, @data and @destroy parameters are for specifying the modify
3220  * function. The modify function will get called for <emphasis>each</emphasis>
3221  * data access, the goal of the modify function is to return the data which
3222  * should be displayed at the location specified using the parameters of the
3223  * modify function.
3224  *
3225  * Since: 2.4
3226  */
3227 void
3228 gtk_tree_model_filter_set_modify_func (GtkTreeModelFilter           *filter,
3229                                        gint                          n_columns,
3230                                        GType                        *types,
3231                                        GtkTreeModelFilterModifyFunc  func,
3232                                        gpointer                      data,
3233                                        GDestroyNotify                destroy)
3234 {
3235   g_return_if_fail (GTK_IS_TREE_MODEL_FILTER (filter));
3236   g_return_if_fail (func != NULL);
3237   g_return_if_fail (filter->priv->modify_func_set == FALSE);
3238
3239   if (filter->priv->modify_destroy)
3240     {
3241       GDestroyNotify d = filter->priv->modify_destroy;
3242
3243       filter->priv->modify_destroy = NULL;
3244       d (filter->priv->modify_data);
3245     }
3246
3247   filter->priv->modify_n_columns = n_columns;
3248   filter->priv->modify_types = g_new0 (GType, n_columns);
3249   memcpy (filter->priv->modify_types, types, sizeof (GType) * n_columns);
3250   filter->priv->modify_func = func;
3251   filter->priv->modify_data = data;
3252   filter->priv->modify_destroy = destroy;
3253
3254   filter->priv->modify_func_set = TRUE;
3255 }
3256
3257 /**
3258  * gtk_tree_model_filter_set_visible_column:
3259  * @filter: A #GtkTreeModelFilter.
3260  * @column: A #gint which is the column containing the visible information.
3261  *
3262  * Sets @column of the child_model to be the column where @filter should
3263  * look for visibility information. @columns should be a column of type
3264  * %G_TYPE_BOOLEAN, where %TRUE means that a row is visible, and %FALSE
3265  * if not.
3266  *
3267  * Since: 2.4
3268  */
3269 void
3270 gtk_tree_model_filter_set_visible_column (GtkTreeModelFilter *filter,
3271                                           gint column)
3272 {
3273   g_return_if_fail (GTK_IS_TREE_MODEL_FILTER (filter));
3274   g_return_if_fail (column >= 0);
3275   g_return_if_fail (filter->priv->visible_method_set == FALSE);
3276
3277   filter->priv->visible_column = column;
3278
3279   filter->priv->visible_method_set = TRUE;
3280 }
3281
3282 /* conversion */
3283
3284 /**
3285  * gtk_tree_model_filter_convert_child_iter_to_iter:
3286  * @filter: A #GtkTreeModelFilter.
3287  * @filter_iter: (out): An uninitialized #GtkTreeIter.
3288  * @child_iter: A valid #GtkTreeIter pointing to a row on the child model.
3289  *
3290  * Sets @filter_iter to point to the row in @filter that corresponds to the
3291  * row pointed at by @child_iter.  If @filter_iter was not set, %FALSE is
3292  * returned.
3293  *
3294  * Return value: %TRUE, if @filter_iter was set, i.e. if @child_iter is a
3295  * valid iterator pointing to a visible row in child model.
3296  *
3297  * Since: 2.4
3298  */
3299 gboolean
3300 gtk_tree_model_filter_convert_child_iter_to_iter (GtkTreeModelFilter *filter,
3301                                                   GtkTreeIter        *filter_iter,
3302                                                   GtkTreeIter        *child_iter)
3303 {
3304   gboolean ret;
3305   GtkTreePath *child_path, *path;
3306
3307   g_return_val_if_fail (GTK_IS_TREE_MODEL_FILTER (filter), FALSE);
3308   g_return_val_if_fail (filter->priv->child_model != NULL, FALSE);
3309   g_return_val_if_fail (filter_iter != NULL, FALSE);
3310   g_return_val_if_fail (child_iter != NULL, FALSE);
3311   g_return_val_if_fail (filter_iter != child_iter, FALSE);
3312
3313   filter_iter->stamp = 0;
3314
3315   child_path = gtk_tree_model_get_path (filter->priv->child_model, child_iter);
3316   g_return_val_if_fail (child_path != NULL, FALSE);
3317
3318   path = gtk_tree_model_filter_convert_child_path_to_path (filter,
3319                                                            child_path);
3320   gtk_tree_path_free (child_path);
3321
3322   if (!path)
3323     return FALSE;
3324
3325   ret = gtk_tree_model_get_iter (GTK_TREE_MODEL (filter), filter_iter, path);
3326   gtk_tree_path_free (path);
3327
3328   return ret;
3329 }
3330
3331 /**
3332  * gtk_tree_model_filter_convert_iter_to_child_iter:
3333  * @filter: A #GtkTreeModelFilter.
3334  * @child_iter: (out): An uninitialized #GtkTreeIter.
3335  * @filter_iter: A valid #GtkTreeIter pointing to a row on @filter.
3336  *
3337  * Sets @child_iter to point to the row pointed to by @filter_iter.
3338  *
3339  * Since: 2.4
3340  */
3341 void
3342 gtk_tree_model_filter_convert_iter_to_child_iter (GtkTreeModelFilter *filter,
3343                                                   GtkTreeIter        *child_iter,
3344                                                   GtkTreeIter        *filter_iter)
3345 {
3346   g_return_if_fail (GTK_IS_TREE_MODEL_FILTER (filter));
3347   g_return_if_fail (filter->priv->child_model != NULL);
3348   g_return_if_fail (child_iter != NULL);
3349   g_return_if_fail (filter_iter != NULL);
3350   g_return_if_fail (filter_iter->stamp == filter->priv->stamp);
3351   g_return_if_fail (filter_iter != child_iter);
3352
3353   if (GTK_TREE_MODEL_FILTER_CACHE_CHILD_ITERS (filter))
3354     {
3355       *child_iter = FILTER_ELT (filter_iter->user_data2)->iter;
3356     }
3357   else
3358     {
3359       GtkTreePath *path;
3360       gboolean valid = FALSE;
3361
3362       path = gtk_tree_model_filter_elt_get_path (filter_iter->user_data,
3363                                                  filter_iter->user_data2,
3364                                                  filter->priv->virtual_root);
3365       valid = gtk_tree_model_get_iter (filter->priv->child_model, child_iter,
3366                                        path);
3367       gtk_tree_path_free (path);
3368
3369       g_return_if_fail (valid == TRUE);
3370     }
3371 }
3372
3373 /* The path returned can only be used internally in the filter model. */
3374 static GtkTreePath *
3375 gtk_real_tree_model_filter_convert_child_path_to_path (GtkTreeModelFilter *filter,
3376                                                        GtkTreePath        *child_path,
3377                                                        gboolean            build_levels,
3378                                                        gboolean            fetch_children)
3379 {
3380   gint *child_indices;
3381   GtkTreePath *retval;
3382   GtkTreePath *real_path;
3383   FilterLevel *level;
3384   FilterElt *tmp;
3385   gint i;
3386
3387   g_return_val_if_fail (GTK_IS_TREE_MODEL_FILTER (filter), NULL);
3388   g_return_val_if_fail (filter->priv->child_model != NULL, NULL);
3389   g_return_val_if_fail (child_path != NULL, NULL);
3390
3391   if (!filter->priv->virtual_root)
3392     real_path = gtk_tree_path_copy (child_path);
3393   else
3394     real_path = gtk_tree_model_filter_remove_root (child_path,
3395                                                    filter->priv->virtual_root);
3396
3397   if (!real_path)
3398     return NULL;
3399
3400   retval = gtk_tree_path_new ();
3401   child_indices = gtk_tree_path_get_indices (real_path);
3402
3403   if (filter->priv->root == NULL && build_levels)
3404     gtk_tree_model_filter_build_level (filter, NULL, -1, FALSE);
3405   level = FILTER_LEVEL (filter->priv->root);
3406
3407   for (i = 0; i < gtk_tree_path_get_depth (real_path); i++)
3408     {
3409       gint j;
3410       gboolean found_child = FALSE;
3411
3412       if (!level)
3413         {
3414           gtk_tree_path_free (real_path);
3415           gtk_tree_path_free (retval);
3416           return NULL;
3417         }
3418
3419       tmp = bsearch_elt_with_offset (level->array, child_indices[i], &j);
3420       if (tmp)
3421         {
3422           gtk_tree_path_append_index (retval, j);
3423           if (!tmp->children && build_levels)
3424             gtk_tree_model_filter_build_level (filter, level,
3425                                                FILTER_LEVEL_ELT_INDEX (level, tmp),
3426                                                FALSE);
3427           level = tmp->children;
3428           found_child = TRUE;
3429         }
3430
3431       if (!found_child && fetch_children)
3432         {
3433           tmp = gtk_tree_model_filter_fetch_child (filter, level,
3434                                                    child_indices[i],
3435                                                    &j);
3436
3437           /* didn't find the child, let's try to bring it back */
3438           if (!tmp || tmp->offset != child_indices[i])
3439             {
3440               /* not there */
3441               gtk_tree_path_free (real_path);
3442               gtk_tree_path_free (retval);
3443               return NULL;
3444             }
3445
3446           gtk_tree_path_append_index (retval, j);
3447           if (!tmp->children && build_levels)
3448             gtk_tree_model_filter_build_level (filter, level,
3449                                                FILTER_LEVEL_ELT_INDEX (level, tmp),
3450                                                FALSE);
3451           level = tmp->children;
3452           found_child = TRUE;
3453         }
3454       else if (!found_child && !fetch_children)
3455         {
3456           /* no path */
3457           gtk_tree_path_free (real_path);
3458           gtk_tree_path_free (retval);
3459           return NULL;
3460         }
3461     }
3462
3463   gtk_tree_path_free (real_path);
3464   return retval;
3465 }
3466
3467 /**
3468  * gtk_tree_model_filter_convert_child_path_to_path:
3469  * @filter: A #GtkTreeModelFilter.
3470  * @child_path: A #GtkTreePath to convert.
3471  *
3472  * Converts @child_path to a path relative to @filter. That is, @child_path
3473  * points to a path in the child model. The rerturned path will point to the
3474  * same row in the filtered model. If @child_path isn't a valid path on the
3475  * child model or points to a row which is not visible in @filter, then %NULL
3476  * is returned.
3477  *
3478  * Return value: A newly allocated #GtkTreePath, or %NULL.
3479  *
3480  * Since: 2.4
3481  */
3482 GtkTreePath *
3483 gtk_tree_model_filter_convert_child_path_to_path (GtkTreeModelFilter *filter,
3484                                                   GtkTreePath        *child_path)
3485 {
3486   GtkTreeIter iter;
3487   GtkTreePath *path;
3488
3489   /* this function does the sanity checks */
3490   path = gtk_real_tree_model_filter_convert_child_path_to_path (filter,
3491                                                                 child_path,
3492                                                                 TRUE,
3493                                                                 TRUE);
3494
3495   if (!path)
3496       return NULL;
3497
3498   /* get a new path which only takes visible nodes into account.
3499    * -- if this gives any performance issues, we can write a special
3500    *    version of convert_child_path_to_path immediately returning
3501    *    a visible-nodes-only path.
3502    */
3503   gtk_tree_model_filter_get_iter_full (GTK_TREE_MODEL (filter), &iter, path);
3504
3505   gtk_tree_path_free (path);
3506   path = gtk_tree_model_get_path (GTK_TREE_MODEL (filter), &iter);
3507
3508   return path;
3509 }
3510
3511 /**
3512  * gtk_tree_model_filter_convert_path_to_child_path:
3513  * @filter: A #GtkTreeModelFilter.
3514  * @filter_path: A #GtkTreePath to convert.
3515  *
3516  * Converts @filter_path to a path on the child model of @filter. That is,
3517  * @filter_path points to a location in @filter. The returned path will
3518  * point to the same location in the model not being filtered. If @filter_path
3519  * does not point to a location in the child model, %NULL is returned.
3520  *
3521  * Return value: A newly allocated #GtkTreePath, or %NULL.
3522  *
3523  * Since: 2.4
3524  */
3525 GtkTreePath *
3526 gtk_tree_model_filter_convert_path_to_child_path (GtkTreeModelFilter *filter,
3527                                                   GtkTreePath        *filter_path)
3528 {
3529   gint *filter_indices;
3530   GtkTreePath *retval;
3531   FilterLevel *level;
3532   gint i;
3533
3534   g_return_val_if_fail (GTK_IS_TREE_MODEL_FILTER (filter), NULL);
3535   g_return_val_if_fail (filter->priv->child_model != NULL, NULL);
3536   g_return_val_if_fail (filter_path != NULL, NULL);
3537
3538   /* convert path */
3539   retval = gtk_tree_path_new ();
3540   filter_indices = gtk_tree_path_get_indices (filter_path);
3541   if (!filter->priv->root)
3542     gtk_tree_model_filter_build_level (filter, NULL, -1, FALSE);
3543   level = FILTER_LEVEL (filter->priv->root);
3544
3545   for (i = 0; i < gtk_tree_path_get_depth (filter_path); i++)
3546     {
3547       FilterElt *elt;
3548
3549       if (!level || level->visible_nodes <= filter_indices[i])
3550         {
3551           gtk_tree_path_free (retval);
3552           return NULL;
3553         }
3554
3555       elt = gtk_tree_model_filter_get_nth_visible (filter, level,
3556                                                    filter_indices[i]);
3557
3558       if (elt->children == NULL)
3559         gtk_tree_model_filter_build_level (filter, level,
3560                                            FILTER_LEVEL_ELT_INDEX (level, elt),
3561                                            FALSE);
3562
3563       if (!level || level->visible_nodes <= filter_indices[i])
3564         {
3565           gtk_tree_path_free (retval);
3566           return NULL;
3567         }
3568
3569       gtk_tree_path_append_index (retval, elt->offset);
3570       level = elt->children;
3571     }
3572
3573   /* apply vroot */
3574
3575   if (filter->priv->virtual_root)
3576     {
3577       GtkTreePath *real_retval;
3578
3579       real_retval = gtk_tree_model_filter_add_root (retval,
3580                                                     filter->priv->virtual_root);
3581       gtk_tree_path_free (retval);
3582
3583       return real_retval;
3584     }
3585
3586   return retval;
3587 }
3588
3589 static gboolean
3590 gtk_tree_model_filter_refilter_helper (GtkTreeModel *model,
3591                                        GtkTreePath  *path,
3592                                        GtkTreeIter  *iter,
3593                                        gpointer      data)
3594 {
3595   /* evil, don't try this at home, but certainly speeds things up */
3596   gtk_tree_model_filter_row_changed (model, path, iter, data);
3597
3598   return FALSE;
3599 }
3600
3601 /**
3602  * gtk_tree_model_filter_refilter:
3603  * @filter: A #GtkTreeModelFilter.
3604  *
3605  * Emits ::row_changed for each row in the child model, which causes
3606  * the filter to re-evaluate whether a row is visible or not.
3607  *
3608  * Since: 2.4
3609  */
3610 void
3611 gtk_tree_model_filter_refilter (GtkTreeModelFilter *filter)
3612 {
3613   g_return_if_fail (GTK_IS_TREE_MODEL_FILTER (filter));
3614
3615   /* S L O W */
3616   gtk_tree_model_foreach (filter->priv->child_model,
3617                           gtk_tree_model_filter_refilter_helper,
3618                           filter);
3619 }
3620
3621 /**
3622  * gtk_tree_model_filter_clear_cache:
3623  * @filter: A #GtkTreeModelFilter.
3624  *
3625  * This function should almost never be called. It clears the @filter
3626  * of any cached iterators that haven't been reffed with
3627  * gtk_tree_model_ref_node(). This might be useful if the child model
3628  * being filtered is static (and doesn't change often) and there has been
3629  * a lot of unreffed access to nodes. As a side effect of this function,
3630  * all unreffed iters will be invalid.
3631  *
3632  * Since: 2.4
3633  */
3634 void
3635 gtk_tree_model_filter_clear_cache (GtkTreeModelFilter *filter)
3636 {
3637   g_return_if_fail (GTK_IS_TREE_MODEL_FILTER (filter));
3638
3639   if (filter->priv->zero_ref_count > 0)
3640     gtk_tree_model_filter_clear_cache_helper (filter,
3641                                               FILTER_LEVEL (filter->priv->root));
3642 }