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