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.
21 #include "gtktreemodel.h"
22 #include "gtkliststore.h"
23 #include "gtktreedatalist.h"
24 #include "gtksignal.h"
26 #define G_SLIST(x) ((GSList *) x)
36 static guint list_store_signals[LAST_SIGNAL] = { 0 };
38 static void gtk_list_store_init (GtkListStore *list_store);
39 static void gtk_list_store_class_init (GtkListStoreClass *class);
40 static void gtk_list_store_tree_model_init (GtkTreeModelIface *iface);
41 static guint gtk_list_store_get_flags (GtkTreeModel *tree_model);
42 static gint gtk_list_store_get_n_columns (GtkTreeModel *tree_model);
43 static gboolean gtk_list_store_get_iter (GtkTreeModel *tree_model,
46 static GtkTreePath *gtk_list_store_get_path (GtkTreeModel *tree_model,
48 static void gtk_list_store_get_value (GtkTreeModel *tree_model,
52 static gboolean gtk_list_store_iter_next (GtkTreeModel *tree_model,
54 static gboolean gtk_list_store_iter_children (GtkTreeModel *tree_model,
57 static gboolean gtk_list_store_iter_has_child (GtkTreeModel *tree_model,
59 static gint gtk_list_store_iter_n_children (GtkTreeModel *tree_model,
61 static gboolean gtk_list_store_iter_nth_child (GtkTreeModel *tree_model,
65 static gboolean gtk_list_store_iter_parent (GtkTreeModel *tree_model,
71 gtk_list_store_get_type (void)
73 static GtkType list_store_type = 0;
77 static const GTypeInfo list_store_info =
79 sizeof (GtkListStoreClass),
81 NULL, /* base_finalize */
82 (GClassInitFunc) gtk_list_store_class_init,
83 NULL, /* class_finalize */
84 NULL, /* class_data */
85 sizeof (GtkListStore),
87 (GInstanceInitFunc) gtk_list_store_init,
90 static const GInterfaceInfo tree_model_info =
92 (GInterfaceInitFunc) gtk_list_store_tree_model_init,
97 list_store_type = g_type_register_static (GTK_TYPE_OBJECT, "GtkListStore", &list_store_info, 0);
98 g_type_add_interface_static (list_store_type,
103 return list_store_type;
107 gtk_list_store_class_init (GtkListStoreClass *class)
109 GtkObjectClass *object_class;
111 object_class = (GtkObjectClass*) class;
113 list_store_signals[CHANGED] =
114 gtk_signal_new ("changed",
116 GTK_CLASS_TYPE (object_class),
117 GTK_SIGNAL_OFFSET (GtkListStoreClass, changed),
118 gtk_marshal_VOID__POINTER_POINTER,
122 list_store_signals[INSERTED] =
123 gtk_signal_new ("inserted",
125 GTK_CLASS_TYPE (object_class),
126 GTK_SIGNAL_OFFSET (GtkListStoreClass, inserted),
127 gtk_marshal_VOID__POINTER_POINTER,
131 list_store_signals[CHILD_TOGGLED] =
132 gtk_signal_new ("child_toggled",
134 GTK_CLASS_TYPE (object_class),
135 GTK_SIGNAL_OFFSET (GtkListStoreClass, child_toggled),
136 gtk_marshal_VOID__POINTER_POINTER,
140 list_store_signals[DELETED] =
141 gtk_signal_new ("deleted",
143 GTK_CLASS_TYPE (object_class),
144 GTK_SIGNAL_OFFSET (GtkListStoreClass, deleted),
145 gtk_marshal_VOID__POINTER,
150 gtk_object_class_add_signals (object_class, list_store_signals, LAST_SIGNAL);
154 gtk_list_store_tree_model_init (GtkTreeModelIface *iface)
156 iface->get_flags = gtk_list_store_get_flags;
157 iface->get_n_columns = gtk_list_store_get_n_columns;
158 iface->get_iter = gtk_list_store_get_iter;
159 iface->get_path = gtk_list_store_get_path;
160 iface->get_value = gtk_list_store_get_value;
161 iface->iter_next = gtk_list_store_iter_next;
162 iface->iter_children = gtk_list_store_iter_children;
163 iface->iter_has_child = gtk_list_store_iter_has_child;
164 iface->iter_n_children = gtk_list_store_iter_n_children;
165 iface->iter_nth_child = gtk_list_store_iter_nth_child;
166 iface->iter_parent = gtk_list_store_iter_parent;
170 gtk_list_store_init (GtkListStore *list_store)
172 list_store->root = NULL;
173 list_store->stamp = g_random_int ();
177 gtk_list_store_new (void)
179 return GTK_LIST_STORE (gtk_type_new (gtk_list_store_get_type ()));
183 gtk_list_store_new_with_types (gint n_columns,
186 GtkListStore *retval;
190 g_return_val_if_fail (n_columns > 0, NULL);
192 retval = gtk_list_store_new ();
193 gtk_list_store_set_n_columns (retval, n_columns);
195 va_start (args, n_columns);
197 for (i = 0; i < n_columns; i++)
198 gtk_list_store_set_column_type (retval, i, va_arg (args, GType));
206 gtk_list_store_set_n_columns (GtkListStore *list_store,
211 g_return_if_fail (list_store != NULL);
212 g_return_if_fail (GTK_IS_LIST_STORE (list_store));
213 g_return_if_fail (n_columns > 0);
215 if (list_store->n_columns == n_columns)
218 new_columns = g_new0 (GType, n_columns);
219 if (list_store->column_headers)
221 /* copy the old header orders over */
222 if (n_columns >= list_store->n_columns)
223 memcpy (new_columns, list_store->column_headers, list_store->n_columns * sizeof (gchar *));
225 memcpy (new_columns, list_store->column_headers, n_columns * sizeof (GType));
227 g_free (list_store->column_headers);
230 list_store->column_headers = new_columns;
231 list_store->n_columns = n_columns;
235 gtk_list_store_set_column_type (GtkListStore *list_store,
239 g_return_if_fail (list_store != NULL);
240 g_return_if_fail (GTK_IS_LIST_STORE (list_store));
241 g_return_if_fail (column >=0 && column < list_store->n_columns);
243 list_store->column_headers[column] = type;
246 /* Fulfill the GtkTreeModel requirements */
248 gtk_list_store_get_flags (GtkTreeModel *tree_model)
250 g_return_val_if_fail (GTK_IS_LIST_STORE (tree_model), 0);
252 return GTK_TREE_MODEL_ITERS_PERSIST;
256 gtk_list_store_get_n_columns (GtkTreeModel *tree_model)
258 g_return_val_if_fail (GTK_IS_LIST_STORE (tree_model), 0);
260 return GTK_LIST_STORE (tree_model)->n_columns;
264 gtk_list_store_get_iter (GtkTreeModel *tree_model,
268 g_return_val_if_fail (GTK_IS_LIST_STORE (tree_model), FALSE);
269 g_return_val_if_fail (gtk_tree_path_get_depth (path) > 0, FALSE);
271 iter->stamp = GTK_LIST_STORE (tree_model)->stamp;
272 iter->tree_node = g_slist_nth (G_SLIST (GTK_LIST_STORE (tree_model)->root),
273 gtk_tree_path_get_indices (path)[0]);
275 return iter->tree_node != NULL;
279 gtk_list_store_get_path (GtkTreeModel *tree_model,
286 g_return_val_if_fail (GTK_IS_LIST_STORE (tree_model), NULL);
287 g_return_val_if_fail (iter->stamp == GTK_LIST_STORE (tree_model)->stamp, NULL);
289 for (list = G_SLIST (GTK_LIST_STORE (tree_model)->root); list; list = list->next)
291 if (list == G_SLIST (iter->tree_node))
298 retval = gtk_tree_path_new ();
299 gtk_tree_path_append_index (retval, i);
304 gtk_list_store_get_value (GtkTreeModel *tree_model,
309 GtkTreeDataList *list;
310 gint tmp_column = column;
312 g_return_if_fail (GTK_IS_LIST_STORE (tree_model));
313 g_return_if_fail (column < GTK_LIST_STORE (tree_model)->n_columns);
314 g_return_if_fail (GTK_LIST_STORE (tree_model)->stamp == iter->stamp);
316 list = G_SLIST (iter->tree_node)->data;
318 while (tmp_column-- > 0 && list)
322 g_value_init (value, GTK_LIST_STORE (tree_model)->column_headers[column]);
324 _gtk_tree_data_list_node_to_value (list,
325 GTK_LIST_STORE (tree_model)->column_headers[column],
330 gtk_list_store_iter_next (GtkTreeModel *tree_model,
333 g_return_val_if_fail (GTK_IS_LIST_STORE (tree_model), FALSE);
334 g_return_val_if_fail (GTK_LIST_STORE (tree_model)->stamp == iter->stamp, FALSE);
336 iter->tree_node = G_SLIST (iter->tree_node)->next;
338 return (iter->tree_node != NULL);
342 gtk_list_store_iter_children (GtkTreeModel *tree_model,
347 iter->tree_node = NULL;
353 gtk_list_store_iter_has_child (GtkTreeModel *tree_model,
360 gtk_list_store_iter_n_children (GtkTreeModel *tree_model,
364 return g_slist_length (G_SLIST (GTK_LIST_STORE (tree_model)->root));
370 gtk_list_store_iter_nth_child (GtkTreeModel *tree_model,
375 g_return_val_if_fail (GTK_IS_LIST_STORE (tree_model), FALSE);
379 g_return_val_if_fail (iter->stamp == GTK_LIST_STORE (tree_model)->stamp, FALSE);
381 iter->tree_node = NULL;
386 iter->tree_node = g_slist_nth (G_SLIST (GTK_LIST_STORE (tree_model)->root), n);
388 iter->stamp = GTK_LIST_STORE (tree_model)->stamp;
392 return (iter->tree_node != NULL);
396 gtk_list_store_iter_parent (GtkTreeModel *tree_model,
401 iter->tree_node = NULL;
406 /* Public accessors */
407 /* This is a somewhat inelegant function that does a lot of list
408 * manipulations on it's own.
411 gtk_list_store_set_cell (GtkListStore *list_store,
416 GtkTreeDataList *list;
417 GtkTreeDataList *prev;
419 g_return_if_fail (list_store != NULL);
420 g_return_if_fail (GTK_IS_LIST_STORE (list_store));
421 g_return_if_fail (iter != NULL);
422 g_return_if_fail (column >= 0 && column < list_store->n_columns);
424 prev = list = G_SLIST (iter->tree_node)->data;
430 _gtk_tree_data_list_value_to_node (list, value);
439 if (G_SLIST (iter->tree_node)->data == NULL)
441 G_SLIST (iter->tree_node)->data = list = _gtk_tree_data_list_alloc ();
446 list = prev->next = _gtk_tree_data_list_alloc ();
452 list->next = _gtk_tree_data_list_alloc ();
457 _gtk_tree_data_list_value_to_node (list, value);
458 gtk_signal_emit_by_name (GTK_OBJECT (list_store),
464 gtk_list_store_remove (GtkListStore *list_store,
469 g_return_if_fail (list_store != NULL);
470 g_return_if_fail (GTK_IS_LIST_STORE (list_store));
472 if (G_SLIST (iter->tree_node)->data)
473 _gtk_tree_data_list_free ((GtkTreeDataList *) G_SLIST (iter->tree_node)->data,
474 list_store->column_headers);
476 path = gtk_list_store_get_path (GTK_TREE_MODEL (list_store), iter);
477 list_store->root = g_slist_remove_link (G_SLIST (list_store->root),
478 G_SLIST (iter->tree_node));
479 list_store->stamp ++;
480 gtk_signal_emit_by_name (GTK_OBJECT (list_store),
483 gtk_tree_path_free (path);
487 gtk_list_store_insert (GtkListStore *list_store,
494 g_return_if_fail (list_store != NULL);
495 g_return_if_fail (GTK_IS_LIST_STORE (list_store));
496 g_return_if_fail (iter != NULL);
497 g_return_if_fail (position < 0);
501 gtk_list_store_prepend (list_store, iter);
505 iter->stamp = list_store->stamp;
506 iter->tree_node = g_slist_alloc ();
508 list = g_slist_nth (G_SLIST (list_store->root), position - 1);
511 G_SLIST (iter->tree_node)->next = list->next;
512 list->next = G_SLIST (iter->tree_node)->next;
514 path = gtk_tree_path_new ();
515 gtk_tree_path_append_index (path, position);
516 gtk_signal_emit_by_name (GTK_OBJECT (list_store),
519 gtk_tree_path_free (path);
523 gtk_list_store_insert_before (GtkListStore *list_store,
525 GtkTreeIter *sibling)
531 g_return_if_fail (list_store != NULL);
532 g_return_if_fail (GTK_IS_LIST_STORE (list_store));
533 g_return_if_fail (iter != NULL);
534 g_return_if_fail (G_SLIST (iter)->next == NULL);
538 gtk_list_store_append (list_store, iter);
542 iter->stamp = list_store->stamp;
543 iter->tree_node = g_slist_alloc ();
545 prev = list = list_store->root;
546 while (list && list != sibling->tree_node)
555 prev->next = iter->tree_node;
559 G_SLIST (iter->tree_node)->next = list_store->root;
560 list_store->root = iter->tree_node;
563 path = gtk_tree_path_new ();
564 gtk_tree_path_append_index (path, i);
565 gtk_signal_emit_by_name (GTK_OBJECT (list_store),
568 gtk_tree_path_free (path);
572 gtk_list_store_insert_after (GtkListStore *list_store,
574 GtkTreeIter *sibling)
580 g_return_if_fail (list_store != NULL);
581 g_return_if_fail (GTK_IS_LIST_STORE (list_store));
582 g_return_if_fail (iter == NULL);
584 g_return_if_fail (sibling->stamp == list_store->stamp);
588 gtk_list_store_prepend (list_store, iter);
592 for (list = list_store->root; list && list != sibling->tree_node; list = list->next)
595 g_return_if_fail (list != NULL);
597 iter->stamp = list_store->stamp;
598 iter->tree_node = g_slist_alloc ();
600 G_SLIST (iter->tree_node)->next = G_SLIST (sibling->tree_node)->next;
601 G_SLIST (sibling)->next = G_SLIST (iter);
603 path = gtk_tree_path_new ();
604 gtk_tree_path_append_index (path, i);
605 gtk_signal_emit_by_name (GTK_OBJECT (list_store),
608 gtk_tree_path_free (path);
612 gtk_list_store_prepend (GtkListStore *list_store,
617 g_return_if_fail (list_store != NULL);
618 g_return_if_fail (GTK_IS_LIST_STORE (list_store));
619 g_return_if_fail (iter != NULL);
621 iter->stamp = list_store->stamp;
622 iter->tree_node = g_slist_alloc ();
624 G_SLIST (iter->tree_node)->next = G_SLIST (list_store->root);
625 list_store->root = iter->tree_node;
627 path = gtk_tree_path_new ();
628 gtk_tree_path_append_index (path, 0);
629 gtk_signal_emit_by_name (GTK_OBJECT (list_store),
632 gtk_tree_path_free (path);
636 gtk_list_store_append (GtkListStore *list_store,
643 g_return_if_fail (list_store != NULL);
644 g_return_if_fail (GTK_IS_LIST_STORE (list_store));
645 g_return_if_fail (iter != NULL);
646 g_return_if_fail (G_SLIST (iter)->next == NULL);
648 iter->stamp = list_store->stamp;
649 iter->tree_node = g_slist_alloc ();
651 prev = list = list_store->root;
660 prev->next = iter->tree_node;
662 list_store->root = iter->tree_node;
664 path = gtk_tree_path_new ();
665 gtk_tree_path_append_index (path, i);
666 gtk_signal_emit_by_name (GTK_OBJECT (list_store),
669 gtk_tree_path_free (path);