1 /* gtktreemodelrefcount.c
2 * Copyright (C) 2011 Kristian Rietveld <kris@gtk.org>
4 * This library is free software; you can redistribute it and/or
5 * modify it under the terms of the GNU Library General Public
6 * License as published by the Free Software Foundation; either
7 * version 2 of the License, or (at your option) any later version.
9 * This library is distributed in the hope that it will be useful,
10 * but WITHOUT ANY WARRANTY; without even the implied warranty of
11 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
12 * Library General Public License for more details.
14 * You should have received a copy of the GNU Library General Public
15 * License along with this library. If not, see <http://www.gnu.org/licenses/>.
19 #include "gtktreemodelrefcount.h"
22 /* The purpose of this GtkTreeModel is to keep record of the reference count
23 * of each node. The reference count does not effect the functioning of
24 * the model in any way. Because this model is a subclass of GtkTreeStore,
25 * the GtkTreeStore API should be used to add to and remove nodes from
26 * this model. We depend on the iter format of GtkTreeStore, which means
27 * that this model needs to be revised in case the iter format of
28 * GtkTreeStore is modified. Currently, we make use of the fact that
29 * the value stored in the user_data field is unique for each node.
32 struct _GtkTreeModelRefCountPrivate
34 GHashTable *node_hash;
44 static void gtk_tree_model_ref_count_tree_model_init (GtkTreeModelIface *iface);
45 static void gtk_tree_model_ref_count_finalize (GObject *object);
47 static NodeInfo *node_info_new (void);
48 static void node_info_free (NodeInfo *info);
50 /* GtkTreeModel interface */
51 static void gtk_tree_model_ref_count_ref_node (GtkTreeModel *model,
53 static void gtk_tree_model_ref_count_unref_node (GtkTreeModel *model,
57 G_DEFINE_TYPE_WITH_CODE (GtkTreeModelRefCount, gtk_tree_model_ref_count, GTK_TYPE_TREE_STORE,
58 G_IMPLEMENT_INTERFACE (GTK_TYPE_TREE_MODEL,
59 gtk_tree_model_ref_count_tree_model_init))
62 row_removed (GtkTreeModelRefCount *ref_model,
66 GtkTreeIter tree_iter;
68 if (!gtk_tree_model_get_iter_first (GTK_TREE_MODEL (ref_model), &tree_iter))
70 g_hash_table_remove_all (ref_model->priv->node_hash);
74 g_hash_table_iter_init (&iter, ref_model->priv->node_hash);
76 while (g_hash_table_iter_next (&iter, &tree_iter.user_data, NULL))
78 if (!gtk_tree_store_iter_is_valid (GTK_TREE_STORE (ref_model), &tree_iter))
79 g_hash_table_iter_remove (&iter);
84 gtk_tree_model_ref_count_init (GtkTreeModelRefCount *ref_model)
86 ref_model->priv = G_TYPE_INSTANCE_GET_PRIVATE (ref_model,
87 GTK_TYPE_TREE_MODEL_REF_COUNT,
88 GtkTreeModelRefCountPrivate);
90 ref_model->priv->node_hash = g_hash_table_new_full (g_direct_hash,
93 (GDestroyNotify)node_info_free);
95 g_signal_connect (ref_model, "row-deleted", G_CALLBACK (row_removed), NULL);
99 gtk_tree_model_ref_count_class_init (GtkTreeModelRefCountClass *ref_model_class)
101 GObjectClass *object_class;
103 object_class = (GObjectClass *) ref_model_class;
105 object_class->finalize = gtk_tree_model_ref_count_finalize;
107 g_type_class_add_private (object_class, sizeof (GtkTreeModelRefCountPrivate));
111 gtk_tree_model_ref_count_tree_model_init (GtkTreeModelIface *iface)
113 iface->ref_node = gtk_tree_model_ref_count_ref_node;
114 iface->unref_node = gtk_tree_model_ref_count_unref_node;
118 gtk_tree_model_ref_count_finalize (GObject *object)
120 GtkTreeModelRefCount *ref_model = GTK_TREE_MODEL_REF_COUNT (object);
122 if (ref_model->priv->node_hash)
124 g_hash_table_destroy (ref_model->priv->node_hash);
125 ref_model->priv->node_hash = NULL;
128 G_OBJECT_CLASS (gtk_tree_model_ref_count_parent_class)->finalize (object);
135 NodeInfo *info = g_slice_new (NodeInfo);
142 node_info_free (NodeInfo *info)
144 g_slice_free (NodeInfo, info);
148 gtk_tree_model_ref_count_ref_node (GtkTreeModel *model,
152 GtkTreeModelRefCount *ref_model = GTK_TREE_MODEL_REF_COUNT (model);
154 info = g_hash_table_lookup (ref_model->priv->node_hash, iter->user_data);
157 info = node_info_new ();
159 g_hash_table_insert (ref_model->priv->node_hash, iter->user_data, info);
166 gtk_tree_model_ref_count_unref_node (GtkTreeModel *model,
170 GtkTreeModelRefCount *ref_model = GTK_TREE_MODEL_REF_COUNT (model);
172 info = g_hash_table_lookup (ref_model->priv->node_hash, iter->user_data);
173 g_assert (info != NULL);
174 g_assert (info->ref_count > 0);
181 gtk_tree_model_ref_count_new (void)
183 GtkTreeModel *retval;
185 retval = g_object_new (gtk_tree_model_ref_count_get_type (), NULL);
191 dump_iter (GtkTreeModelRefCount *ref_model,
198 path = gtk_tree_model_get_path (GTK_TREE_MODEL (ref_model), iter);
199 path_str = gtk_tree_path_to_string (path);
200 gtk_tree_path_free (path);
202 info = g_hash_table_lookup (ref_model->priv->node_hash, iter->user_data);
204 g_print ("%-16s ref_count=0\n", path_str);
206 g_print ("%-16s ref_count=%d\n", path_str, info->ref_count);
212 gtk_tree_model_ref_count_dump_recurse (GtkTreeModelRefCount *ref_model,
219 dump_iter (ref_model, iter);
221 if (gtk_tree_model_iter_children (GTK_TREE_MODEL (ref_model),
223 gtk_tree_model_ref_count_dump_recurse (ref_model, &child);
225 while (gtk_tree_model_iter_next (GTK_TREE_MODEL (ref_model), iter));
229 gtk_tree_model_ref_count_dump (GtkTreeModelRefCount *ref_model)
233 if (!gtk_tree_model_get_iter_first (GTK_TREE_MODEL (ref_model), &iter))
236 gtk_tree_model_ref_count_dump_recurse (ref_model, &iter);
240 check_iter (GtkTreeModelRefCount *ref_model,
242 gint expected_ref_count,
248 g_assert (gtk_tree_store_iter_is_valid (GTK_TREE_STORE (ref_model), iter));
250 info = g_hash_table_lookup (ref_model->priv->node_hash, iter->user_data);
253 if (expected_ref_count == 0)
258 g_error ("Expected ref count %d, but node has never been referenced.\n", expected_ref_count);
265 if (expected_ref_count == 0)
266 g_assert_cmpint (expected_ref_count, ==, info->ref_count);
268 g_assert_cmpint (expected_ref_count, <=, info->ref_count);
271 return expected_ref_count == info->ref_count;
275 gtk_tree_model_ref_count_check_level (GtkTreeModelRefCount *ref_model,
277 gint expected_ref_count,
283 if (!gtk_tree_model_iter_children (GTK_TREE_MODEL (ref_model),
289 if (!check_iter (ref_model, &iter, expected_ref_count, may_assert))
293 gtk_tree_model_iter_has_child (GTK_TREE_MODEL (ref_model), &iter))
295 if (!gtk_tree_model_ref_count_check_level (ref_model, &iter,
297 recurse, may_assert))
301 while (gtk_tree_model_iter_next (GTK_TREE_MODEL (ref_model), &iter));
307 gtk_tree_model_ref_count_check_node (GtkTreeModelRefCount *ref_model,
309 gint expected_ref_count,
312 return check_iter (ref_model, iter, expected_ref_count, may_assert);