2 * Copyright (C) 2000 Red Hat, Inc., Jonathan Blandford <jrb@redhat.com>
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, write to the
16 * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
17 * Boston, MA 02111-1307, USA.
20 #include "gtktreemodel.h"
21 #include "gtktreestore.h"
22 #include "gtktreedatalist.h"
23 #include "gtksignal.h"
25 #include <gobject/gvaluecollector.h>
27 #define G_NODE(node) ((GNode *)node)
37 static guint tree_store_signals[LAST_SIGNAL] = { 0 };
40 static void gtk_tree_store_init (GtkTreeStore *tree_store);
41 static void gtk_tree_store_class_init (GtkTreeStoreClass *tree_store_class);
42 static void gtk_tree_store_tree_model_init (GtkTreeModelIface *iface);
43 static guint gtk_tree_store_get_flags (GtkTreeModel *tree_model);
44 static gint gtk_tree_store_get_n_columns (GtkTreeModel *tree_model);
45 static GType gtk_tree_store_get_column_type (GtkTreeModel *tree_model,
47 static GtkTreePath *gtk_tree_store_get_path (GtkTreeModel *tree_model,
49 static void gtk_tree_store_get_value (GtkTreeModel *tree_model,
53 static gboolean gtk_tree_store_iter_next (GtkTreeModel *tree_model,
55 static gboolean gtk_tree_store_iter_children (GtkTreeModel *tree_model,
58 static gboolean gtk_tree_store_iter_has_child (GtkTreeModel *tree_model,
60 static gint gtk_tree_store_iter_n_children (GtkTreeModel *tree_model,
62 static gboolean gtk_tree_store_iter_nth_child (GtkTreeModel *tree_model,
66 static gboolean gtk_tree_store_iter_parent (GtkTreeModel *tree_model,
72 gtk_tree_store_get_type (void)
74 static GtkType tree_store_type = 0;
78 static const GTypeInfo tree_store_info =
80 sizeof (GtkTreeStoreClass),
82 NULL, /* base_finalize */
83 (GClassInitFunc) gtk_tree_store_class_init,
84 NULL, /* class_finalize */
85 NULL, /* class_data */
86 sizeof (GtkTreeStore),
88 (GInstanceInitFunc) gtk_tree_store_init
91 static const GInterfaceInfo tree_model_info =
93 (GInterfaceInitFunc) gtk_tree_store_tree_model_init,
98 tree_store_type = g_type_register_static (GTK_TYPE_OBJECT, "GtkTreeStore", &tree_store_info, 0);
99 g_type_add_interface_static (tree_store_type,
104 return tree_store_type;
108 gtk_tree_store_class_init (GtkTreeStoreClass *tree_store_class)
110 GtkObjectClass *object_class;
112 object_class = (GtkObjectClass *) tree_store_class;
114 tree_store_signals[CHANGED] =
115 gtk_signal_new ("changed",
117 GTK_CLASS_TYPE (object_class),
118 GTK_SIGNAL_OFFSET (GtkTreeStoreClass, changed),
119 gtk_marshal_VOID__BOXED_BOXED,
123 tree_store_signals[INSERTED] =
124 gtk_signal_new ("inserted",
126 GTK_CLASS_TYPE (object_class),
127 GTK_SIGNAL_OFFSET (GtkTreeStoreClass, inserted),
128 gtk_marshal_VOID__BOXED_BOXED,
132 tree_store_signals[CHILD_TOGGLED] =
133 gtk_signal_new ("child_toggled",
135 GTK_CLASS_TYPE (object_class),
136 GTK_SIGNAL_OFFSET (GtkTreeStoreClass, child_toggled),
137 gtk_marshal_VOID__BOXED_BOXED,
141 tree_store_signals[DELETED] =
142 gtk_signal_new ("deleted",
144 GTK_CLASS_TYPE (object_class),
145 GTK_SIGNAL_OFFSET (GtkTreeStoreClass, deleted),
146 gtk_marshal_VOID__BOXED,
152 gtk_tree_store_tree_model_init (GtkTreeModelIface *iface)
154 iface->get_flags = gtk_tree_store_get_flags;
155 iface->get_n_columns = gtk_tree_store_get_n_columns;
156 iface->get_column_type = gtk_tree_store_get_column_type;
157 iface->get_path = gtk_tree_store_get_path;
158 iface->get_value = gtk_tree_store_get_value;
159 iface->iter_next = gtk_tree_store_iter_next;
160 iface->iter_children = gtk_tree_store_iter_children;
161 iface->iter_has_child = gtk_tree_store_iter_has_child;
162 iface->iter_n_children = gtk_tree_store_iter_n_children;
163 iface->iter_nth_child = gtk_tree_store_iter_nth_child;
164 iface->iter_parent = gtk_tree_store_iter_parent;
168 gtk_tree_store_init (GtkTreeStore *tree_store)
170 tree_store->root = g_node_new (NULL);
171 tree_store->stamp = g_random_int ();
175 gtk_tree_store_new (void)
177 return GTK_TREE_STORE (gtk_type_new (gtk_tree_store_get_type ()));
181 gtk_tree_store_new_with_types (gint n_columns,
184 GtkTreeStore *retval;
188 g_return_val_if_fail (n_columns > 0, NULL);
190 retval = gtk_tree_store_new ();
191 gtk_tree_store_set_n_columns (retval, n_columns);
193 va_start (args, n_columns);
195 for (i = 0; i < n_columns; i++)
196 gtk_tree_store_set_column_type (retval, i, va_arg (args, GType));
204 gtk_tree_store_set_n_columns (GtkTreeStore *tree_store,
209 g_return_if_fail (tree_store != NULL);
210 g_return_if_fail (GTK_IS_TREE_STORE (tree_store));
212 if (tree_store->n_columns == n_columns)
215 new_columns = g_new0 (GType, n_columns);
216 if (tree_store->column_headers)
218 /* copy the old header orders over */
219 if (n_columns >= tree_store->n_columns)
220 memcpy (new_columns, tree_store->column_headers, tree_store->n_columns * sizeof (gchar *));
222 memcpy (new_columns, tree_store->column_headers, n_columns * sizeof (GType));
224 g_free (tree_store->column_headers);
227 tree_store->column_headers = new_columns;
228 tree_store->n_columns = n_columns;
232 gtk_tree_store_set_column_type (GtkTreeStore *tree_store,
236 g_return_if_fail (tree_store != NULL);
237 g_return_if_fail (GTK_IS_TREE_STORE (tree_store));
238 g_return_if_fail (column >=0 && column < tree_store->n_columns);
240 tree_store->column_headers[column] = type;
243 /* fulfill the GtkTreeModel requirements */
244 /* NOTE: GtkTreeStore::root is a GNode, that acts as the parent node. However,
245 * it is not visible to the tree or to the user., and the path "1" refers to the
246 * first child of GtkTreeStore::root.
251 gtk_tree_store_get_flags (GtkTreeModel *tree_model)
253 g_return_val_if_fail (GTK_IS_TREE_STORE (tree_model), 0);
255 return GTK_TREE_MODEL_ITERS_PERSIST;
259 gtk_tree_store_get_n_columns (GtkTreeModel *tree_model)
261 g_return_val_if_fail (GTK_IS_TREE_STORE (tree_model), 0);
263 return GTK_TREE_STORE (tree_model)->n_columns;
267 gtk_tree_store_get_column_type (GtkTreeModel *tree_model,
270 g_return_val_if_fail (GTK_IS_TREE_STORE (tree_model), G_TYPE_INVALID);
271 g_return_val_if_fail (index < GTK_TREE_STORE (tree_model)->n_columns &&
272 index >= 0, G_TYPE_INVALID);
274 return GTK_TREE_STORE (tree_model)->column_headers[index];
278 gtk_tree_store_get_path (GtkTreeModel *tree_model,
285 g_return_val_if_fail (tree_model != NULL, NULL);
286 g_return_val_if_fail (GTK_IS_TREE_STORE (tree_model), NULL);
287 g_return_val_if_fail (iter != NULL, NULL);
289 if (iter->user_data == NULL)
292 g_assert (G_NODE (iter->user_data)->parent != NULL);
294 if (G_NODE (iter->user_data)->parent == G_NODE (GTK_TREE_STORE (tree_model)->root))
296 retval = gtk_tree_path_new ();
297 tmp_node = G_NODE (GTK_TREE_STORE (tree_model)->root)->children;
301 GtkTreeIter tmp_iter = *iter;
302 tmp_iter.user_data = G_NODE (tmp_iter.user_data)->parent;
304 retval = gtk_tree_store_get_path (tree_model,
306 tmp_node = G_NODE (iter->user_data)->parent->children;
312 if (tmp_node == NULL)
314 gtk_tree_path_free (retval);
318 for (; tmp_node; tmp_node = tmp_node->next)
320 if (tmp_node == G_NODE (iter->user_data))
325 if (tmp_node == NULL)
327 /* We couldn't find node, meaning it's prolly not ours */
328 /* Perhaps I should do a g_return_if_fail here. */
329 gtk_tree_path_free (retval);
333 gtk_tree_path_append_index (retval, i);
340 gtk_tree_store_get_value (GtkTreeModel *tree_model,
345 GtkTreeDataList *list;
346 gint tmp_column = column;
348 g_return_if_fail (tree_model != NULL);
349 g_return_if_fail (GTK_IS_TREE_STORE (tree_model));
350 g_return_if_fail (iter != NULL);
351 g_return_if_fail (column < GTK_TREE_STORE (tree_model)->n_columns);
353 list = G_NODE (iter->user_data)->data;
355 while (tmp_column-- > 0 && list)
360 _gtk_tree_data_list_node_to_value (list,
361 GTK_TREE_STORE (tree_model)->column_headers[column],
366 /* We want to return an initialized but empty (default) value */
367 g_value_init (value, GTK_TREE_STORE (tree_model)->column_headers[column]);
372 gtk_tree_store_iter_next (GtkTreeModel *tree_model,
375 if (iter->user_data == NULL)
378 iter->user_data = G_NODE (iter->user_data)->next;
380 return (iter->user_data != NULL);
384 gtk_tree_store_iter_children (GtkTreeModel *tree_model,
388 iter->stamp = GTK_TREE_STORE (tree_model)->stamp;
390 iter->user_data = G_NODE (parent->user_data)->children;
392 iter->user_data = G_NODE (GTK_TREE_STORE (tree_model)->root)->children;
394 return iter->user_data != NULL;
398 gtk_tree_store_iter_has_child (GtkTreeModel *tree_model,
401 g_return_val_if_fail (tree_model != NULL, FALSE);
402 g_return_val_if_fail (GTK_IS_TREE_STORE (tree_model), FALSE);
403 g_return_val_if_fail (iter != NULL, FALSE);
405 return G_NODE (iter->user_data)->children != NULL;
409 gtk_tree_store_iter_n_children (GtkTreeModel *tree_model,
415 g_return_val_if_fail (tree_model != NULL, 0);
416 g_return_val_if_fail (GTK_IS_TREE_STORE (tree_model), 0);
419 node = G_NODE (GTK_TREE_STORE (tree_model)->root)->children;
421 node = G_NODE (iter->user_data)->children;
432 gtk_tree_store_iter_nth_child (GtkTreeModel *tree_model,
439 g_return_val_if_fail (tree_model != NULL, FALSE);
440 g_return_val_if_fail (GTK_IS_TREE_STORE (tree_model), FALSE);
441 g_return_val_if_fail (iter != NULL, FALSE);
444 parent_node = GTK_TREE_STORE (tree_model)->root;
446 parent_node = parent->user_data;
448 iter->user_data = g_node_nth_child (parent_node, n);
450 if (iter->user_data == NULL)
453 iter->stamp = GTK_TREE_STORE (tree_model)->stamp;
455 return (iter->user_data != NULL);
459 gtk_tree_store_iter_parent (GtkTreeModel *tree_model,
463 g_assert (G_NODE (child->user_data)->parent != NULL);
465 iter->stamp = GTK_TREE_STORE (tree_model)->stamp;
466 iter->user_data = G_NODE (child->user_data)->parent;
468 if (iter->user_data == GTK_TREE_STORE (tree_model)->root)
471 iter->user_data = NULL;
479 * This is a somewhat inelegant function that does a lot of list
480 * manipulations on it's own.
483 gtk_tree_store_set_cell (GtkTreeStore *tree_store,
488 GtkTreeDataList *list;
489 GtkTreeDataList *prev;
491 g_return_if_fail (tree_store != NULL);
492 g_return_if_fail (GTK_IS_TREE_STORE (tree_store));
493 g_return_if_fail (column >= 0 && column < tree_store->n_columns);
495 prev = list = G_NODE (iter->user_data)->data;
501 _gtk_tree_data_list_value_to_node (list, value);
502 gtk_signal_emit_by_name (GTK_OBJECT (tree_store),
513 if (G_NODE (iter->user_data)->data == NULL)
515 G_NODE (iter->user_data)->data = list = _gtk_tree_data_list_alloc ();
520 list = prev->next = _gtk_tree_data_list_alloc ();
526 list->next = _gtk_tree_data_list_alloc ();
531 _gtk_tree_data_list_value_to_node (list, value);
532 gtk_signal_emit_by_name (GTK_OBJECT (tree_store),
538 gtk_tree_store_set_valist (GtkTreeStore *tree_store,
544 g_return_if_fail (GTK_IS_TREE_STORE (tree_store));
546 column = va_arg (var_args, gint);
550 GValue value = { 0, };
553 if (column >= tree_store->n_columns)
555 g_warning ("%s: Invalid column number %d added to iter (remember to end your list of columns with a -1)", G_STRLOC, column);
558 g_value_init (&value, tree_store->column_headers[column]);
560 G_VALUE_COLLECT (&value, var_args, &error);
563 g_warning ("%s: %s", G_STRLOC, error);
566 /* we purposely leak the value here, it might not be
567 * in a sane state if an error condition occoured
572 gtk_tree_store_set_cell (tree_store,
577 g_value_unset (&value);
579 column = va_arg (var_args, gint);
584 * gtk_tree_store_set:
585 * @tree_store: a #GtkTreeStore
586 * @iter: row iterator
587 * @Varargs: pairs of column number and value, terminated with -1
589 * Sets the value of one or more cells in the row referenced by @iter.
590 * The variable argument list should contain integer column numbers,
591 * each column number followed by the value to be set. For example,
592 * The list is terminated by a -1. For example, to set column 0 with type
593 * %G_TYPE_STRING to "Foo", you would write gtk_tree_store_set (store, iter,
597 gtk_tree_store_set (GtkTreeStore *tree_store,
603 g_return_if_fail (GTK_IS_TREE_STORE (tree_store));
605 va_start (var_args, iter);
606 gtk_tree_store_set_valist (tree_store, iter, var_args);
611 gtk_tree_store_get_valist (GtkTreeStore *tree_store,
617 g_return_if_fail (GTK_IS_TREE_STORE (tree_store));
619 column = va_arg (var_args, gint);
623 GValue value = { 0, };
626 if (column >= tree_store->n_columns)
628 g_warning ("%s: Invalid column number %d accessed (remember to end your list of columns with a -1)", G_STRLOC, column);
632 gtk_tree_store_get_value (GTK_TREE_MODEL (tree_store), iter, column, &value);
634 G_VALUE_LCOPY (&value, var_args, &error);
637 g_warning ("%s: %s", G_STRLOC, error);
640 /* we purposely leak the value here, it might not be
641 * in a sane state if an error condition occoured
646 g_value_unset (&value);
648 column = va_arg (var_args, gint);
653 gtk_tree_store_get (GtkTreeStore *tree_store,
659 g_return_if_fail (GTK_IS_TREE_STORE (tree_store));
661 va_start (var_args, iter);
662 gtk_tree_store_get_valist (tree_store, iter, var_args);
667 gtk_tree_store_remove (GtkTreeStore *model,
674 g_return_if_fail (model != NULL);
675 g_return_if_fail (GTK_IS_TREE_STORE (model));
677 parent = G_NODE (iter->user_data)->parent;
679 g_assert (parent != NULL);
681 if (G_NODE (iter->user_data)->data)
682 _gtk_tree_data_list_free ((GtkTreeDataList *) G_NODE (iter->user_data)->data,
683 model->column_headers);
685 path = gtk_tree_store_get_path (GTK_TREE_MODEL (model), iter);
686 g_node_destroy (G_NODE (iter->user_data));
689 gtk_signal_emit_by_name (GTK_OBJECT (model),
692 if (parent != G_NODE (model->root) && parent->children == NULL)
694 gtk_tree_path_up (path);
696 gtk_signal_emit_by_name (GTK_OBJECT (model),
701 gtk_tree_path_free (path);
705 gtk_tree_store_insert (GtkTreeStore *model,
712 g_return_if_fail (model != NULL);
713 g_return_if_fail (GTK_IS_TREE_STORE (model));
715 if (parent->user_data == NULL)
716 parent->user_data = model->root;
718 iter->stamp = model->stamp;
719 iter->user_data = g_node_new (NULL);
720 g_node_insert (G_NODE (parent->user_data), position, G_NODE (iter->user_data));
722 path = gtk_tree_store_get_path (GTK_TREE_MODEL (model), iter);
723 gtk_signal_emit_by_name (GTK_OBJECT (model),
726 gtk_tree_path_free (path);
730 gtk_tree_store_insert_before (GtkTreeStore *model,
733 GtkTreeIter *sibling)
736 GNode *parent_node = NULL;
739 g_return_if_fail (model != NULL);
740 g_return_if_fail (GTK_IS_TREE_STORE (model));
741 g_return_if_fail (iter != NULL);
743 new_node = g_node_new (NULL);
745 if (parent == NULL && sibling == NULL)
746 parent_node = model->root;
747 else if (parent == NULL)
748 parent_node = G_NODE (sibling->user_data)->parent;
749 else if (sibling == NULL)
750 parent_node = G_NODE (parent->user_data);
753 g_return_if_fail (G_NODE (sibling->user_data)->parent ==
754 G_NODE (parent->user_data));
755 parent_node = G_NODE (parent->user_data);
758 g_node_insert_before (parent_node,
759 sibling ? G_NODE (sibling->user_data) : NULL,
762 iter->stamp = model->stamp;
763 iter->user_data = new_node;
765 path = gtk_tree_store_get_path (GTK_TREE_MODEL (model), iter);
766 gtk_signal_emit_by_name (GTK_OBJECT (model),
769 gtk_tree_path_free (path);
773 gtk_tree_store_insert_after (GtkTreeStore *model,
776 GtkTreeIter *sibling)
782 g_return_if_fail (model != NULL);
783 g_return_if_fail (GTK_IS_TREE_STORE (model));
784 g_return_if_fail (iter != NULL);
786 new_node = g_node_new (NULL);
788 if (parent == NULL && sibling == NULL)
789 parent_node = model->root;
790 else if (parent == NULL)
791 parent_node = G_NODE (sibling->user_data)->parent;
792 else if (sibling == NULL)
793 parent_node = G_NODE (parent->user_data);
796 g_return_if_fail (G_NODE (sibling->user_data)->parent ==
797 G_NODE (parent->user_data));
798 parent_node = G_NODE (parent->user_data);
802 g_node_insert_after (parent_node,
803 sibling ? G_NODE (sibling->user_data) : NULL,
806 iter->stamp = model->stamp;
807 iter->user_data = new_node;
809 path = gtk_tree_store_get_path (GTK_TREE_MODEL (model), iter);
810 gtk_signal_emit_by_name (GTK_OBJECT (model),
813 gtk_tree_path_free (path);
817 gtk_tree_store_prepend (GtkTreeStore *model,
823 g_return_if_fail (model != NULL);
824 g_return_if_fail (GTK_IS_TREE_STORE (model));
825 g_return_if_fail (iter != NULL);
828 parent_node = model->root;
830 parent_node = parent->user_data;
832 if (parent_node->children == NULL)
836 iter->stamp = model->stamp;
837 iter->user_data = g_node_new (NULL);
839 g_node_prepend (parent_node, iter->user_data);
841 if (parent_node != model->root)
843 path = gtk_tree_store_get_path (GTK_TREE_MODEL (model), parent);
844 gtk_signal_emit_by_name (GTK_OBJECT (model),
848 gtk_tree_path_append_index (path, 0);
852 path = gtk_tree_store_get_path (GTK_TREE_MODEL (model), iter);
854 gtk_signal_emit_by_name (GTK_OBJECT (model),
858 gtk_tree_path_free (path);
862 gtk_tree_store_insert_after (model, iter, parent, NULL);
867 gtk_tree_store_append (GtkTreeStore *model,
873 g_return_if_fail (model != NULL);
874 g_return_if_fail (GTK_IS_TREE_STORE (model));
875 g_return_if_fail (iter != NULL);
878 parent_node = model->root;
880 parent_node = parent->user_data;
882 iter->stamp = model->stamp;
883 iter->user_data = g_node_new (NULL);
885 if (parent_node->children == NULL)
889 g_node_append (parent_node, G_NODE (iter->user_data));
891 if (parent_node != model->root)
893 path = gtk_tree_store_get_path (GTK_TREE_MODEL (model), parent);
894 gtk_signal_emit_by_name (GTK_OBJECT (model),
898 gtk_tree_path_append_index (path, 0);
902 path = gtk_tree_store_get_path (GTK_TREE_MODEL (model), iter);
904 gtk_signal_emit_by_name (GTK_OBJECT (model),
908 gtk_tree_path_free (path);
912 gtk_tree_store_insert_before (model, iter, parent, NULL);
917 gtk_tree_store_is_ancestor (GtkTreeStore *model,
919 GtkTreeIter *descendant)
921 g_return_val_if_fail (model != NULL, FALSE);
922 g_return_val_if_fail (GTK_IS_TREE_STORE (model), FALSE);
923 g_return_val_if_fail (iter != NULL, FALSE);
924 g_return_val_if_fail (descendant != NULL, FALSE);
926 return g_node_is_ancestor (G_NODE (iter->user_data),
927 G_NODE (descendant->user_data));
932 gtk_tree_store_iter_depth (GtkTreeStore *model,
935 g_return_val_if_fail (model != NULL, 0);
936 g_return_val_if_fail (GTK_IS_TREE_STORE (model), 0);
937 g_return_val_if_fail (iter != NULL, 0);
939 return g_node_depth (G_NODE (iter->user_data)) - 1;