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 GType gtk_list_store_get_column_type (GtkTreeModel *tree_model,
45 static gboolean gtk_list_store_get_iter (GtkTreeModel *tree_model,
48 static GtkTreePath *gtk_list_store_get_path (GtkTreeModel *tree_model,
50 static void gtk_list_store_get_value (GtkTreeModel *tree_model,
54 static gboolean gtk_list_store_iter_next (GtkTreeModel *tree_model,
56 static gboolean gtk_list_store_iter_children (GtkTreeModel *tree_model,
59 static gboolean gtk_list_store_iter_has_child (GtkTreeModel *tree_model,
61 static gint gtk_list_store_iter_n_children (GtkTreeModel *tree_model,
63 static gboolean gtk_list_store_iter_nth_child (GtkTreeModel *tree_model,
67 static gboolean gtk_list_store_iter_parent (GtkTreeModel *tree_model,
73 gtk_list_store_get_type (void)
75 static GtkType list_store_type = 0;
79 static const GTypeInfo list_store_info =
81 sizeof (GtkListStoreClass),
83 NULL, /* base_finalize */
84 (GClassInitFunc) gtk_list_store_class_init,
85 NULL, /* class_finalize */
86 NULL, /* class_data */
87 sizeof (GtkListStore),
89 (GInstanceInitFunc) gtk_list_store_init,
92 static const GInterfaceInfo tree_model_info =
94 (GInterfaceInitFunc) gtk_list_store_tree_model_init,
99 list_store_type = g_type_register_static (GTK_TYPE_OBJECT, "GtkListStore", &list_store_info, 0);
100 g_type_add_interface_static (list_store_type,
105 return list_store_type;
109 gtk_list_store_class_init (GtkListStoreClass *class)
111 GtkObjectClass *object_class;
113 object_class = (GtkObjectClass*) class;
115 list_store_signals[CHANGED] =
116 gtk_signal_new ("changed",
118 GTK_CLASS_TYPE (object_class),
119 GTK_SIGNAL_OFFSET (GtkListStoreClass, changed),
120 gtk_marshal_VOID__BOXED_BOXED,
124 list_store_signals[INSERTED] =
125 gtk_signal_new ("inserted",
127 GTK_CLASS_TYPE (object_class),
128 GTK_SIGNAL_OFFSET (GtkListStoreClass, inserted),
129 gtk_marshal_VOID__BOXED_BOXED,
133 list_store_signals[CHILD_TOGGLED] =
134 gtk_signal_new ("child_toggled",
136 GTK_CLASS_TYPE (object_class),
137 GTK_SIGNAL_OFFSET (GtkListStoreClass, child_toggled),
138 gtk_marshal_VOID__BOXED_BOXED,
142 list_store_signals[DELETED] =
143 gtk_signal_new ("deleted",
145 GTK_CLASS_TYPE (object_class),
146 GTK_SIGNAL_OFFSET (GtkListStoreClass, deleted),
147 gtk_marshal_VOID__BOXED,
152 gtk_object_class_add_signals (object_class, list_store_signals, LAST_SIGNAL);
156 gtk_list_store_tree_model_init (GtkTreeModelIface *iface)
158 iface->get_flags = gtk_list_store_get_flags;
159 iface->get_n_columns = gtk_list_store_get_n_columns;
160 iface->get_column_type = gtk_list_store_get_column_type;
161 iface->get_iter = gtk_list_store_get_iter;
162 iface->get_path = gtk_list_store_get_path;
163 iface->get_value = gtk_list_store_get_value;
164 iface->iter_next = gtk_list_store_iter_next;
165 iface->iter_children = gtk_list_store_iter_children;
166 iface->iter_has_child = gtk_list_store_iter_has_child;
167 iface->iter_n_children = gtk_list_store_iter_n_children;
168 iface->iter_nth_child = gtk_list_store_iter_nth_child;
169 iface->iter_parent = gtk_list_store_iter_parent;
173 gtk_list_store_init (GtkListStore *list_store)
175 list_store->root = NULL;
176 list_store->stamp = g_random_int ();
180 gtk_list_store_new (void)
182 return GTK_LIST_STORE (gtk_type_new (gtk_list_store_get_type ()));
186 gtk_list_store_new_with_types (gint n_columns,
189 GtkListStore *retval;
193 g_return_val_if_fail (n_columns > 0, NULL);
195 retval = gtk_list_store_new ();
196 gtk_list_store_set_n_columns (retval, n_columns);
198 va_start (args, n_columns);
200 for (i = 0; i < n_columns; i++)
201 gtk_list_store_set_column_type (retval, i, va_arg (args, GType));
209 gtk_list_store_set_n_columns (GtkListStore *list_store,
214 g_return_if_fail (list_store != NULL);
215 g_return_if_fail (GTK_IS_LIST_STORE (list_store));
216 g_return_if_fail (n_columns > 0);
218 if (list_store->n_columns == n_columns)
221 new_columns = g_new0 (GType, n_columns);
222 if (list_store->column_headers)
224 /* copy the old header orders over */
225 if (n_columns >= list_store->n_columns)
226 memcpy (new_columns, list_store->column_headers, list_store->n_columns * sizeof (gchar *));
228 memcpy (new_columns, list_store->column_headers, n_columns * sizeof (GType));
230 g_free (list_store->column_headers);
233 list_store->column_headers = new_columns;
234 list_store->n_columns = n_columns;
238 gtk_list_store_set_column_type (GtkListStore *list_store,
242 g_return_if_fail (list_store != NULL);
243 g_return_if_fail (GTK_IS_LIST_STORE (list_store));
244 g_return_if_fail (column >=0 && column < list_store->n_columns);
246 list_store->column_headers[column] = type;
249 /* Fulfill the GtkTreeModel requirements */
251 gtk_list_store_get_flags (GtkTreeModel *tree_model)
253 g_return_val_if_fail (GTK_IS_LIST_STORE (tree_model), 0);
255 return GTK_TREE_MODEL_ITERS_PERSIST;
259 gtk_list_store_get_n_columns (GtkTreeModel *tree_model)
261 g_return_val_if_fail (GTK_IS_LIST_STORE (tree_model), 0);
263 return GTK_LIST_STORE (tree_model)->n_columns;
267 gtk_list_store_get_column_type (GtkTreeModel *tree_model,
270 g_return_val_if_fail (GTK_IS_LIST_STORE (tree_model), G_TYPE_INVALID);
271 g_return_val_if_fail (index < GTK_LIST_STORE (tree_model)->n_columns &&
272 index >= 0, G_TYPE_INVALID);
274 return GTK_LIST_STORE (tree_model)->column_headers[index];
278 gtk_list_store_get_iter (GtkTreeModel *tree_model,
282 g_return_val_if_fail (GTK_IS_LIST_STORE (tree_model), FALSE);
283 g_return_val_if_fail (gtk_tree_path_get_depth (path) > 0, FALSE);
285 iter->stamp = GTK_LIST_STORE (tree_model)->stamp;
286 iter->tree_node = g_slist_nth (G_SLIST (GTK_LIST_STORE (tree_model)->root),
287 gtk_tree_path_get_indices (path)[0]);
289 return iter->tree_node != NULL;
293 gtk_list_store_get_path (GtkTreeModel *tree_model,
300 g_return_val_if_fail (GTK_IS_LIST_STORE (tree_model), NULL);
301 g_return_val_if_fail (iter->stamp == GTK_LIST_STORE (tree_model)->stamp, NULL);
303 for (list = G_SLIST (GTK_LIST_STORE (tree_model)->root); list; list = list->next)
305 if (list == G_SLIST (iter->tree_node))
312 retval = gtk_tree_path_new ();
313 gtk_tree_path_append_index (retval, i);
318 gtk_list_store_get_value (GtkTreeModel *tree_model,
323 GtkTreeDataList *list;
324 gint tmp_column = column;
326 g_return_if_fail (GTK_IS_LIST_STORE (tree_model));
327 g_return_if_fail (column < GTK_LIST_STORE (tree_model)->n_columns);
328 g_return_if_fail (GTK_LIST_STORE (tree_model)->stamp == iter->stamp);
330 list = G_SLIST (iter->tree_node)->data;
332 while (tmp_column-- > 0 && list)
336 g_value_init (value, GTK_LIST_STORE (tree_model)->column_headers[column]);
338 _gtk_tree_data_list_node_to_value (list,
339 GTK_LIST_STORE (tree_model)->column_headers[column],
344 gtk_list_store_iter_next (GtkTreeModel *tree_model,
347 g_return_val_if_fail (GTK_IS_LIST_STORE (tree_model), FALSE);
348 g_return_val_if_fail (GTK_LIST_STORE (tree_model)->stamp == iter->stamp, FALSE);
350 iter->tree_node = G_SLIST (iter->tree_node)->next;
352 return (iter->tree_node != NULL);
356 gtk_list_store_iter_children (GtkTreeModel *tree_model,
361 iter->tree_node = NULL;
367 gtk_list_store_iter_has_child (GtkTreeModel *tree_model,
374 gtk_list_store_iter_n_children (GtkTreeModel *tree_model,
378 return g_slist_length (G_SLIST (GTK_LIST_STORE (tree_model)->root));
384 gtk_list_store_iter_nth_child (GtkTreeModel *tree_model,
389 g_return_val_if_fail (GTK_IS_LIST_STORE (tree_model), FALSE);
393 g_return_val_if_fail (iter->stamp == GTK_LIST_STORE (tree_model)->stamp, FALSE);
395 iter->tree_node = NULL;
400 iter->tree_node = g_slist_nth (G_SLIST (GTK_LIST_STORE (tree_model)->root), n);
402 iter->stamp = GTK_LIST_STORE (tree_model)->stamp;
406 return (iter->tree_node != NULL);
410 gtk_list_store_iter_parent (GtkTreeModel *tree_model,
415 iter->tree_node = NULL;
420 /* Public accessors */
421 /* This is a somewhat inelegant function that does a lot of list
422 * manipulations on it's own.
425 gtk_list_store_set_cell (GtkListStore *list_store,
430 GtkTreeDataList *list;
431 GtkTreeDataList *prev;
433 g_return_if_fail (list_store != NULL);
434 g_return_if_fail (GTK_IS_LIST_STORE (list_store));
435 g_return_if_fail (iter != NULL);
436 g_return_if_fail (column >= 0 && column < list_store->n_columns);
438 prev = list = G_SLIST (iter->tree_node)->data;
444 _gtk_tree_data_list_value_to_node (list, value);
445 gtk_signal_emit_by_name (GTK_OBJECT (list_store),
456 if (G_SLIST (iter->tree_node)->data == NULL)
458 G_SLIST (iter->tree_node)->data = list = _gtk_tree_data_list_alloc ();
463 list = prev->next = _gtk_tree_data_list_alloc ();
469 list->next = _gtk_tree_data_list_alloc ();
474 _gtk_tree_data_list_value_to_node (list, value);
475 gtk_signal_emit_by_name (GTK_OBJECT (list_store),
481 gtk_list_store_remove (GtkListStore *list_store,
486 g_return_if_fail (list_store != NULL);
487 g_return_if_fail (GTK_IS_LIST_STORE (list_store));
489 if (G_SLIST (iter->tree_node)->data)
490 _gtk_tree_data_list_free ((GtkTreeDataList *) G_SLIST (iter->tree_node)->data,
491 list_store->column_headers);
493 path = gtk_list_store_get_path (GTK_TREE_MODEL (list_store), iter);
494 list_store->root = g_slist_remove_link (G_SLIST (list_store->root),
495 G_SLIST (iter->tree_node));
496 list_store->stamp ++;
497 gtk_signal_emit_by_name (GTK_OBJECT (list_store),
500 gtk_tree_path_free (path);
504 gtk_list_store_insert (GtkListStore *list_store,
511 g_return_if_fail (list_store != NULL);
512 g_return_if_fail (GTK_IS_LIST_STORE (list_store));
513 g_return_if_fail (iter != NULL);
514 g_return_if_fail (position < 0);
518 gtk_list_store_prepend (list_store, iter);
522 iter->stamp = list_store->stamp;
523 iter->tree_node = g_slist_alloc ();
525 list = g_slist_nth (G_SLIST (list_store->root), position - 1);
528 G_SLIST (iter->tree_node)->next = list->next;
529 list->next = G_SLIST (iter->tree_node)->next;
531 path = gtk_tree_path_new ();
532 gtk_tree_path_append_index (path, position);
533 gtk_signal_emit_by_name (GTK_OBJECT (list_store),
536 gtk_tree_path_free (path);
540 gtk_list_store_insert_before (GtkListStore *list_store,
542 GtkTreeIter *sibling)
548 g_return_if_fail (list_store != NULL);
549 g_return_if_fail (GTK_IS_LIST_STORE (list_store));
550 g_return_if_fail (iter != NULL);
551 g_return_if_fail (G_SLIST (iter)->next == NULL);
555 gtk_list_store_append (list_store, iter);
559 iter->stamp = list_store->stamp;
560 iter->tree_node = g_slist_alloc ();
562 prev = list = list_store->root;
563 while (list && list != sibling->tree_node)
572 prev->next = iter->tree_node;
576 G_SLIST (iter->tree_node)->next = list_store->root;
577 list_store->root = iter->tree_node;
580 path = gtk_tree_path_new ();
581 gtk_tree_path_append_index (path, i);
582 gtk_signal_emit_by_name (GTK_OBJECT (list_store),
585 gtk_tree_path_free (path);
589 gtk_list_store_insert_after (GtkListStore *list_store,
591 GtkTreeIter *sibling)
597 g_return_if_fail (list_store != NULL);
598 g_return_if_fail (GTK_IS_LIST_STORE (list_store));
599 g_return_if_fail (iter == NULL);
601 g_return_if_fail (sibling->stamp == list_store->stamp);
605 gtk_list_store_prepend (list_store, iter);
609 for (list = list_store->root; list && list != sibling->tree_node; list = list->next)
612 g_return_if_fail (list != NULL);
614 iter->stamp = list_store->stamp;
615 iter->tree_node = g_slist_alloc ();
617 G_SLIST (iter->tree_node)->next = G_SLIST (sibling->tree_node)->next;
618 G_SLIST (sibling)->next = G_SLIST (iter);
620 path = gtk_tree_path_new ();
621 gtk_tree_path_append_index (path, i);
622 gtk_signal_emit_by_name (GTK_OBJECT (list_store),
625 gtk_tree_path_free (path);
629 gtk_list_store_prepend (GtkListStore *list_store,
634 g_return_if_fail (list_store != NULL);
635 g_return_if_fail (GTK_IS_LIST_STORE (list_store));
636 g_return_if_fail (iter != NULL);
638 iter->stamp = list_store->stamp;
639 iter->tree_node = g_slist_alloc ();
641 G_SLIST (iter->tree_node)->next = G_SLIST (list_store->root);
642 list_store->root = iter->tree_node;
644 path = gtk_tree_path_new ();
645 gtk_tree_path_append_index (path, 0);
646 gtk_signal_emit_by_name (GTK_OBJECT (list_store),
649 gtk_tree_path_free (path);
653 gtk_list_store_append (GtkListStore *list_store,
660 g_return_if_fail (list_store != NULL);
661 g_return_if_fail (GTK_IS_LIST_STORE (list_store));
662 g_return_if_fail (iter != NULL);
664 iter->stamp = list_store->stamp;
665 iter->tree_node = g_slist_alloc ();
667 prev = list = list_store->root;
676 prev->next = iter->tree_node;
678 list_store->root = iter->tree_node;
680 path = gtk_tree_path_new ();
681 gtk_tree_path_append_index (path, i);
682 gtk_signal_emit_by_name (GTK_OBJECT (list_store),
685 gtk_tree_path_free (path);