]> Pileus Git - ~andy/gtk/blob - gtk/gtktreestore.c
return a value in the range of [-1, 1] instead [0, 1],
[~andy/gtk] / gtk / gtktreestore.c
1 /* gtktreestore.c
2  * Copyright (C) 2000  Red Hat, Inc.,  Jonathan Blandford <jrb@redhat.com>
3  *
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.
8  *
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.
13  *
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.
18  */
19
20 #include <string.h>
21 #include <gobject/gvaluecollector.h>
22 #include "gtktreemodel.h"
23 #include "gtktreestore.h"
24 #include "gtktreedatalist.h"
25 #include "gtktreednd.h"
26
27 #define G_NODE(node) ((GNode *)node)
28 #define GTK_TREE_STORE_IS_SORTED(tree) (GTK_TREE_STORE (tree)->sort_column_id != -2)
29 #define VALID_ITER(iter, tree_store) (iter!= NULL && iter->user_data != NULL && tree_store->stamp == iter->stamp)
30
31 static void         gtk_tree_store_init            (GtkTreeStore      *tree_store);
32 static void         gtk_tree_store_class_init      (GtkTreeStoreClass *tree_store_class);
33 static void         gtk_tree_store_tree_model_init (GtkTreeModelIface *iface);
34 static void         gtk_tree_store_drag_source_init(GtkTreeDragSourceIface *iface);
35 static void         gtk_tree_store_drag_dest_init  (GtkTreeDragDestIface   *iface);
36 static void         gtk_tree_store_sortable_init   (GtkTreeSortableIface   *iface);
37 static void         gtk_tree_store_finalize        (GObject           *object);
38 static GtkTreeModelFlags gtk_tree_store_get_flags  (GtkTreeModel      *tree_model);
39 static gint         gtk_tree_store_get_n_columns   (GtkTreeModel      *tree_model);
40 static GType        gtk_tree_store_get_column_type (GtkTreeModel      *tree_model,
41                                                     gint               index);
42 static gboolean     gtk_tree_store_get_iter        (GtkTreeModel      *tree_model,
43                                                     GtkTreeIter       *iter,
44                                                     GtkTreePath       *path);
45 static GtkTreePath *gtk_tree_store_get_path        (GtkTreeModel      *tree_model,
46                                                     GtkTreeIter       *iter);
47 static void         gtk_tree_store_get_value       (GtkTreeModel      *tree_model,
48                                                     GtkTreeIter       *iter,
49                                                     gint               column,
50                                                     GValue            *value);
51 static gboolean     gtk_tree_store_iter_next       (GtkTreeModel      *tree_model,
52                                                     GtkTreeIter       *iter);
53 static gboolean     gtk_tree_store_iter_children   (GtkTreeModel      *tree_model,
54                                                     GtkTreeIter       *iter,
55                                                     GtkTreeIter       *parent);
56 static gboolean     gtk_tree_store_iter_has_child  (GtkTreeModel      *tree_model,
57                                                     GtkTreeIter       *iter);
58 static gint         gtk_tree_store_iter_n_children (GtkTreeModel      *tree_model,
59                                                     GtkTreeIter       *iter);
60 static gboolean     gtk_tree_store_iter_nth_child  (GtkTreeModel      *tree_model,
61                                                     GtkTreeIter       *iter,
62                                                     GtkTreeIter       *parent,
63                                                     gint               n);
64 static gboolean     gtk_tree_store_iter_parent     (GtkTreeModel      *tree_model,
65                                                     GtkTreeIter       *iter,
66                                                     GtkTreeIter       *child);
67
68
69 static void gtk_tree_store_set_n_columns   (GtkTreeStore *tree_store,
70                                             gint          n_columns);
71 static void gtk_tree_store_set_column_type (GtkTreeStore *tree_store,
72                                             gint          column,
73                                             GType         type);
74
75
76 /* DND interfaces */
77 static gboolean gtk_tree_store_drag_data_delete   (GtkTreeDragSource *drag_source,
78                                                    GtkTreePath       *path);
79 static gboolean gtk_tree_store_drag_data_get      (GtkTreeDragSource *drag_source,
80                                                    GtkTreePath       *path,
81                                                    GtkSelectionData  *selection_data);
82 static gboolean gtk_tree_store_drag_data_received (GtkTreeDragDest   *drag_dest,
83                                                    GtkTreePath       *dest,
84                                                    GtkSelectionData  *selection_data);
85 static gboolean gtk_tree_store_row_drop_possible  (GtkTreeDragDest   *drag_dest,
86                                                    GtkTreePath       *dest_path,
87                                                    GtkSelectionData  *selection_data);
88
89 /* Sortable Interfaces */
90
91 static void     gtk_tree_store_sort                    (GtkTreeStore           *tree_store);
92 static void     gtk_tree_store_sort_iter_changed       (GtkTreeStore           *tree_store,
93                                                         GtkTreeIter            *iter,
94                                                         gint                    column);
95 static gboolean gtk_tree_store_get_sort_column_id      (GtkTreeSortable        *sortable,
96                                                         gint                   *sort_column_id,
97                                                         GtkSortType            *order);
98 static void     gtk_tree_store_set_sort_column_id      (GtkTreeSortable        *sortable,
99                                                         gint                    sort_column_id,
100                                                         GtkSortType             order);
101 static void     gtk_tree_store_set_sort_func           (GtkTreeSortable        *sortable,
102                                                         gint                    sort_column_id,
103                                                         GtkTreeIterCompareFunc  func,
104                                                         gpointer                data,
105                                                         GtkDestroyNotify        destroy);
106 static void     gtk_tree_store_set_default_sort_func   (GtkTreeSortable        *sortable,
107                                                         GtkTreeIterCompareFunc  func,
108                                                         gpointer                data,
109                                                         GtkDestroyNotify        destroy);
110 static gboolean gtk_tree_store_has_default_sort_func   (GtkTreeSortable        *sortable);
111
112 static void     validate_gnode                         (GNode *node);
113
114 static void     gtk_tree_store_move                    (GtkTreeStore           *tree_store,
115                                                         GtkTreeIter            *iter,
116                                                         GtkTreeIter            *position,
117                                                         gboolean                before);
118
119
120 static GObjectClass *parent_class = NULL;
121
122
123 static inline void
124 validate_tree (GtkTreeStore *tree_store)
125 {
126   if (gtk_debug_flags & GTK_DEBUG_TREE)
127     {
128       g_assert (G_NODE (tree_store->root)->parent == NULL);
129
130       validate_gnode (G_NODE (tree_store->root));
131     }
132 }
133
134 GType
135 gtk_tree_store_get_type (void)
136 {
137   static GType tree_store_type = 0;
138
139   if (!tree_store_type)
140     {
141       static const GTypeInfo tree_store_info =
142       {
143         sizeof (GtkTreeStoreClass),
144         NULL,           /* base_init */
145         NULL,           /* base_finalize */
146         (GClassInitFunc) gtk_tree_store_class_init,
147         NULL,           /* class_finalize */
148         NULL,           /* class_data */
149         sizeof (GtkTreeStore),
150         0,              /* n_preallocs */
151         (GInstanceInitFunc) gtk_tree_store_init
152       };
153
154       static const GInterfaceInfo tree_model_info =
155       {
156         (GInterfaceInitFunc) gtk_tree_store_tree_model_init,
157         NULL,
158         NULL
159       };
160
161       static const GInterfaceInfo drag_source_info =
162       {
163         (GInterfaceInitFunc) gtk_tree_store_drag_source_init,
164         NULL,
165         NULL
166       };
167
168       static const GInterfaceInfo drag_dest_info =
169       {
170         (GInterfaceInitFunc) gtk_tree_store_drag_dest_init,
171         NULL,
172         NULL
173       };
174
175       static const GInterfaceInfo sortable_info =
176       {
177         (GInterfaceInitFunc) gtk_tree_store_sortable_init,
178         NULL,
179         NULL
180       };
181
182       tree_store_type = g_type_register_static (G_TYPE_OBJECT, "GtkTreeStore",
183                                                 &tree_store_info, 0);
184
185       g_type_add_interface_static (tree_store_type,
186                                    GTK_TYPE_TREE_MODEL,
187                                    &tree_model_info);
188       g_type_add_interface_static (tree_store_type,
189                                    GTK_TYPE_TREE_DRAG_SOURCE,
190                                    &drag_source_info);
191       g_type_add_interface_static (tree_store_type,
192                                    GTK_TYPE_TREE_DRAG_DEST,
193                                    &drag_dest_info);
194       g_type_add_interface_static (tree_store_type,
195                                    GTK_TYPE_TREE_SORTABLE,
196                                    &sortable_info);
197
198     }
199
200   return tree_store_type;
201 }
202
203 static void
204 gtk_tree_store_class_init (GtkTreeStoreClass *class)
205 {
206   GObjectClass *object_class;
207
208   parent_class = g_type_class_peek_parent (class);
209   object_class = (GObjectClass *) class;
210
211   object_class->finalize = gtk_tree_store_finalize;
212 }
213
214 static void
215 gtk_tree_store_tree_model_init (GtkTreeModelIface *iface)
216 {
217   iface->get_flags = gtk_tree_store_get_flags;
218   iface->get_n_columns = gtk_tree_store_get_n_columns;
219   iface->get_column_type = gtk_tree_store_get_column_type;
220   iface->get_iter = gtk_tree_store_get_iter;
221   iface->get_path = gtk_tree_store_get_path;
222   iface->get_value = gtk_tree_store_get_value;
223   iface->iter_next = gtk_tree_store_iter_next;
224   iface->iter_children = gtk_tree_store_iter_children;
225   iface->iter_has_child = gtk_tree_store_iter_has_child;
226   iface->iter_n_children = gtk_tree_store_iter_n_children;
227   iface->iter_nth_child = gtk_tree_store_iter_nth_child;
228   iface->iter_parent = gtk_tree_store_iter_parent;
229 }
230
231 static void
232 gtk_tree_store_drag_source_init (GtkTreeDragSourceIface *iface)
233 {
234   iface->drag_data_delete = gtk_tree_store_drag_data_delete;
235   iface->drag_data_get = gtk_tree_store_drag_data_get;
236 }
237
238 static void
239 gtk_tree_store_drag_dest_init (GtkTreeDragDestIface *iface)
240 {
241   iface->drag_data_received = gtk_tree_store_drag_data_received;
242   iface->row_drop_possible = gtk_tree_store_row_drop_possible;
243 }
244
245 static void
246 gtk_tree_store_sortable_init (GtkTreeSortableIface *iface)
247 {
248   iface->get_sort_column_id = gtk_tree_store_get_sort_column_id;
249   iface->set_sort_column_id = gtk_tree_store_set_sort_column_id;
250   iface->set_sort_func = gtk_tree_store_set_sort_func;
251   iface->set_default_sort_func = gtk_tree_store_set_default_sort_func;
252   iface->has_default_sort_func = gtk_tree_store_has_default_sort_func;
253 }
254
255 static void
256 gtk_tree_store_init (GtkTreeStore *tree_store)
257 {
258   tree_store->root = g_node_new (NULL);
259   /* While the odds are against us getting 0...
260    */
261   do
262     {
263       tree_store->stamp = g_random_int ();
264     }
265   while (tree_store->stamp == 0);
266
267   tree_store->sort_list = NULL;
268   tree_store->sort_column_id = -2;
269   tree_store->columns_dirty = FALSE;
270 }
271
272 /**
273  * gtk_tree_store_new:
274  * @n_columns: number of columns in the tree store
275  * @Varargs: all #GType types for the columns, from first to last
276  *
277  * Creates a new tree store as with @n_columns columns each of the types passed
278  * in.  As an example, <literal>gtk_tree_store_new (3, G_TYPE_INT, G_TYPE_STRING,
279  * GDK_TYPE_PIXBUF);</literal> will create a new #GtkTreeStore with three columns, of type
280  * <type>int</type>, <type>string</type> and #GdkPixbuf respectively.
281  *
282  * Return value: a new #GtkTreeStore
283  **/
284 GtkTreeStore *
285 gtk_tree_store_new (gint n_columns,
286                                ...)
287 {
288   GtkTreeStore *retval;
289   va_list args;
290   gint i;
291
292   g_return_val_if_fail (n_columns > 0, NULL);
293
294   retval = g_object_new (GTK_TYPE_TREE_STORE, NULL);
295   gtk_tree_store_set_n_columns (retval, n_columns);
296
297   va_start (args, n_columns);
298
299   for (i = 0; i < n_columns; i++)
300     {
301       GType type = va_arg (args, GType);
302       if (! _gtk_tree_data_list_check_type (type))
303         {
304           g_warning ("%s: Invalid type %s passed to gtk_tree_store_new_with_types\n",
305                      G_STRLOC, g_type_name (type));
306           g_object_unref (retval);
307           return NULL;
308         }
309       gtk_tree_store_set_column_type (retval, i, type);
310     }
311   va_end (args);
312
313   return retval;
314 }
315 /**
316  * gtk_tree_store_newv:
317  * @n_columns: number of columns in the tree store
318  * @types: an array of #GType types for the columns, from first to last
319  *
320  * Non vararg creation function.  Used primarily by language bindings.
321  *
322  * Return value: a new #GtkTreeStore
323  **/
324 GtkTreeStore *
325 gtk_tree_store_newv (gint   n_columns,
326                      GType *types)
327 {
328   GtkTreeStore *retval;
329   gint i;
330
331   g_return_val_if_fail (n_columns > 0, NULL);
332
333   retval = g_object_new (GTK_TYPE_TREE_STORE, NULL);
334   gtk_tree_store_set_n_columns (retval, n_columns);
335
336    for (i = 0; i < n_columns; i++)
337     {
338       if (! _gtk_tree_data_list_check_type (types[i]))
339         {
340           g_warning ("%s: Invalid type %s passed to gtk_tree_store_new_with_types\n",
341                      G_STRLOC, g_type_name (types[i]));
342           g_object_unref (retval);
343           return NULL;
344         }
345       gtk_tree_store_set_column_type (retval, i, types[i]);
346     }
347
348   return retval;
349 }
350
351
352 /**
353  * gtk_tree_store_set_column_types:
354  * @tree_store: A #GtkTreeStore
355  * @n_columns: Number of columns for the tree store
356  * @types: An array of #GType types, one for each column
357  * 
358  * This function is meant primarily for #GObjects that inherit from 
359  * #GtkTreeStore, and should only be used when constructing a new 
360  * #GtkTreeStore.  It will not function after a row has been added, 
361  * or a method on the #GtkTreeModel interface is called.
362  **/
363 void
364 gtk_tree_store_set_column_types (GtkTreeStore *tree_store,
365                                  gint          n_columns,
366                                  GType        *types)
367 {
368   gint i;
369
370   g_return_if_fail (GTK_IS_TREE_STORE (tree_store));
371   g_return_if_fail (tree_store->columns_dirty == 0);
372
373   gtk_tree_store_set_n_columns (tree_store, n_columns);
374    for (i = 0; i < n_columns; i++)
375     {
376       if (! _gtk_tree_data_list_check_type (types[i]))
377         {
378           g_warning ("%s: Invalid type %s passed to gtk_tree_store_set_column_types\n", G_STRLOC, g_type_name (types[i]));
379           continue;
380         }
381       gtk_tree_store_set_column_type (tree_store, i, types[i]);
382     }
383 }
384
385 static void
386 gtk_tree_store_set_n_columns (GtkTreeStore *tree_store,
387                               gint          n_columns)
388 {
389   GType *new_columns;
390
391   g_return_if_fail (GTK_IS_TREE_STORE (tree_store));
392
393   if (tree_store->n_columns == n_columns)
394     return;
395
396   new_columns = g_new0 (GType, n_columns);
397   if (tree_store->column_headers)
398     {
399       /* copy the old header orders over */
400       if (n_columns >= tree_store->n_columns)
401         memcpy (new_columns, tree_store->column_headers, tree_store->n_columns * sizeof (gchar *));
402       else
403         memcpy (new_columns, tree_store->column_headers, n_columns * sizeof (GType));
404
405       g_free (tree_store->column_headers);
406     }
407
408   if (tree_store->sort_list)
409     _gtk_tree_data_list_header_free (tree_store->sort_list);
410
411   tree_store->sort_list = _gtk_tree_data_list_header_new (n_columns, tree_store->column_headers);
412
413   tree_store->column_headers = new_columns;
414   tree_store->n_columns = n_columns;
415 }
416
417 /**
418  * gtk_tree_store_set_column_type:
419  * @tree_store: a #GtkTreeStore
420  * @column: column number
421  * @type: type of the data to be stored in @column
422  *
423  * Supported types include: %G_TYPE_UINT, %G_TYPE_INT, %G_TYPE_UCHAR,
424  * %G_TYPE_CHAR, %G_TYPE_BOOLEAN, %G_TYPE_POINTER, %G_TYPE_FLOAT,
425  * %G_TYPE_DOUBLE, %G_TYPE_STRING, %G_TYPE_OBJECT, and %G_TYPE_BOXED, along with
426  * subclasses of those types such as %GDK_TYPE_PIXBUF.
427  *
428  **/
429 static void
430 gtk_tree_store_set_column_type (GtkTreeStore *tree_store,
431                                 gint          column,
432                                 GType         type)
433 {
434   g_return_if_fail (GTK_IS_TREE_STORE (tree_store));
435   g_return_if_fail (column >=0 && column < tree_store->n_columns);
436   if (!_gtk_tree_data_list_check_type (type))
437     {
438       g_warning ("%s: Invalid type %s passed to gtk_tree_store_new_with_types\n", G_STRLOC, g_type_name (type));
439       return;
440     }
441   tree_store->column_headers[column] = type;
442 }
443
444 static gboolean
445 node_free (GNode *node, gpointer data)
446 {
447   if (node->data)
448     _gtk_tree_data_list_free (node->data, (GType*)data);
449   node->data = NULL;
450
451   return FALSE;
452 }
453
454 static void
455 gtk_tree_store_finalize (GObject *object)
456 {
457   GtkTreeStore *tree_store = GTK_TREE_STORE (object);
458
459   g_node_traverse (tree_store->root, G_POST_ORDER, G_TRAVERSE_ALL, -1,
460                    node_free, tree_store->column_headers);
461   g_node_destroy (tree_store->root);
462   _gtk_tree_data_list_header_free (tree_store->sort_list);
463   g_free (tree_store->column_headers);
464
465   if (tree_store->default_sort_destroy)
466     {
467       GtkDestroyNotify d = tree_store->default_sort_destroy;
468
469       tree_store->default_sort_destroy = NULL;
470       d (tree_store->default_sort_data);
471       tree_store->default_sort_data = NULL;
472     }
473
474   /* must chain up */
475   (* parent_class->finalize) (object);
476 }
477
478 /* fulfill the GtkTreeModel requirements */
479 /* NOTE: GtkTreeStore::root is a GNode, that acts as the parent node.  However,
480  * it is not visible to the tree or to the user., and the path "0" refers to the
481  * first child of GtkTreeStore::root.
482  */
483
484
485 static GtkTreeModelFlags
486 gtk_tree_store_get_flags (GtkTreeModel *tree_model)
487 {
488   g_return_val_if_fail (GTK_IS_TREE_STORE (tree_model), 0);
489
490   return GTK_TREE_MODEL_ITERS_PERSIST;
491 }
492
493 static gint
494 gtk_tree_store_get_n_columns (GtkTreeModel *tree_model)
495 {
496   GtkTreeStore *tree_store = (GtkTreeStore *) tree_model;
497
498   g_return_val_if_fail (GTK_IS_TREE_STORE (tree_model), 0);
499
500   tree_store->columns_dirty = TRUE;
501
502   return tree_store->n_columns;
503 }
504
505 static GType
506 gtk_tree_store_get_column_type (GtkTreeModel *tree_model,
507                                 gint          index)
508 {
509   GtkTreeStore *tree_store = (GtkTreeStore *) tree_model;
510
511   g_return_val_if_fail (GTK_IS_TREE_STORE (tree_model), G_TYPE_INVALID);
512   g_return_val_if_fail (index < GTK_TREE_STORE (tree_model)->n_columns &&
513                         index >= 0, G_TYPE_INVALID);
514
515   tree_store->columns_dirty = TRUE;
516
517   return tree_store->column_headers[index];
518 }
519
520 static gboolean
521 gtk_tree_store_get_iter (GtkTreeModel *tree_model,
522                          GtkTreeIter  *iter,
523                          GtkTreePath  *path)
524 {
525   GtkTreeStore *tree_store = (GtkTreeStore *) tree_model;
526   GtkTreeIter parent;
527   gint *indices;
528   gint depth, i;
529
530   g_return_val_if_fail (GTK_IS_TREE_STORE (tree_store), FALSE);
531
532   tree_store->columns_dirty = TRUE;
533
534   indices = gtk_tree_path_get_indices (path);
535   depth = gtk_tree_path_get_depth (path);
536
537   g_return_val_if_fail (depth > 0, FALSE);
538
539   parent.stamp = tree_store->stamp;
540   parent.user_data = tree_store->root;
541
542   if (! gtk_tree_model_iter_nth_child (tree_model, iter, &parent, indices[0]))
543     return FALSE;
544
545   for (i = 1; i < depth; i++)
546     {
547       parent = *iter;
548       if (! gtk_tree_model_iter_nth_child (tree_model, iter, &parent, indices[i]))
549         return FALSE;
550     }
551
552   return TRUE;
553 }
554
555 static GtkTreePath *
556 gtk_tree_store_get_path (GtkTreeModel *tree_model,
557                          GtkTreeIter  *iter)
558 {
559   GtkTreePath *retval;
560   GNode *tmp_node;
561   gint i = 0;
562
563   g_return_val_if_fail (GTK_IS_TREE_STORE (tree_model), NULL);
564   g_return_val_if_fail (iter != NULL, NULL);
565   g_return_val_if_fail (iter->user_data != NULL, NULL);
566   g_return_val_if_fail (iter->stamp == GTK_TREE_STORE (tree_model)->stamp, NULL);
567
568   validate_tree ((GtkTreeStore*)tree_model);
569
570   if (G_NODE (iter->user_data)->parent == NULL &&
571       G_NODE (iter->user_data) == GTK_TREE_STORE (tree_model)->root)
572     return gtk_tree_path_new ();
573   g_assert (G_NODE (iter->user_data)->parent != NULL);
574
575   if (G_NODE (iter->user_data)->parent == G_NODE (GTK_TREE_STORE (tree_model)->root))
576     {
577       retval = gtk_tree_path_new ();
578       tmp_node = G_NODE (GTK_TREE_STORE (tree_model)->root)->children;
579     }
580   else
581     {
582       GtkTreeIter tmp_iter = *iter;
583
584       tmp_iter.user_data = G_NODE (iter->user_data)->parent;
585
586       retval = gtk_tree_store_get_path (tree_model,
587                                         &tmp_iter);
588       tmp_node = G_NODE (iter->user_data)->parent->children;
589     }
590
591   if (retval == NULL)
592     return NULL;
593
594   if (tmp_node == NULL)
595     {
596       gtk_tree_path_free (retval);
597       return NULL;
598     }
599
600   for (; tmp_node; tmp_node = tmp_node->next)
601     {
602       if (tmp_node == G_NODE (iter->user_data))
603         break;
604       i++;
605     }
606
607   if (tmp_node == NULL)
608     {
609       /* We couldn't find node, meaning it's prolly not ours */
610       /* Perhaps I should do a g_return_if_fail here. */
611       gtk_tree_path_free (retval);
612       return NULL;
613     }
614
615   gtk_tree_path_append_index (retval, i);
616
617   return retval;
618 }
619
620
621 static void
622 gtk_tree_store_get_value (GtkTreeModel *tree_model,
623                           GtkTreeIter  *iter,
624                           gint          column,
625                           GValue       *value)
626 {
627   GtkTreeDataList *list;
628   gint tmp_column = column;
629
630   g_return_if_fail (GTK_IS_TREE_STORE (tree_model));
631   g_return_if_fail (iter != NULL);
632   g_return_if_fail (iter->stamp == GTK_TREE_STORE (tree_model)->stamp);
633   g_return_if_fail (column < GTK_TREE_STORE (tree_model)->n_columns);
634
635   list = G_NODE (iter->user_data)->data;
636
637   while (tmp_column-- > 0 && list)
638     list = list->next;
639
640   if (list)
641     {
642       _gtk_tree_data_list_node_to_value (list,
643                                          GTK_TREE_STORE (tree_model)->column_headers[column],
644                                          value);
645     }
646   else
647     {
648       /* We want to return an initialized but empty (default) value */
649       g_value_init (value, GTK_TREE_STORE (tree_model)->column_headers[column]);
650     }
651 }
652
653 static gboolean
654 gtk_tree_store_iter_next (GtkTreeModel  *tree_model,
655                           GtkTreeIter   *iter)
656 {
657   g_return_val_if_fail (iter != NULL, FALSE);
658   g_return_val_if_fail (iter->user_data != NULL, FALSE);
659   g_return_val_if_fail (iter->stamp == GTK_TREE_STORE (tree_model)->stamp, FALSE);
660
661   if (G_NODE (iter->user_data)->next)
662     {
663       iter->user_data = G_NODE (iter->user_data)->next;
664       return TRUE;
665     }
666   else
667     return FALSE;
668 }
669
670 static gboolean
671 gtk_tree_store_iter_children (GtkTreeModel *tree_model,
672                               GtkTreeIter  *iter,
673                               GtkTreeIter  *parent)
674 {
675   GNode *children;
676
677   g_return_val_if_fail (parent == NULL || parent->user_data != NULL, FALSE);
678   g_return_val_if_fail (parent == NULL || parent->stamp == GTK_TREE_STORE (tree_model)->stamp, FALSE);
679
680   if (parent)
681     children = G_NODE (parent->user_data)->children;
682   else
683     children = G_NODE (GTK_TREE_STORE (tree_model)->root)->children;
684
685   if (children)
686     {
687       iter->stamp = GTK_TREE_STORE (tree_model)->stamp;
688       iter->user_data = children;
689       return TRUE;
690     }
691   else
692     return FALSE;
693 }
694
695 static gboolean
696 gtk_tree_store_iter_has_child (GtkTreeModel *tree_model,
697                                GtkTreeIter  *iter)
698 {
699   g_return_val_if_fail (GTK_IS_TREE_STORE (tree_model), FALSE);
700   g_return_val_if_fail (iter->stamp == GTK_TREE_STORE (tree_model)->stamp, FALSE);
701   g_return_val_if_fail (iter->user_data != NULL, FALSE);
702
703   return G_NODE (iter->user_data)->children != NULL;
704 }
705
706 static gint
707 gtk_tree_store_iter_n_children (GtkTreeModel *tree_model,
708                                 GtkTreeIter  *iter)
709 {
710   GNode *node;
711   gint i = 0;
712
713   g_return_val_if_fail (GTK_IS_TREE_STORE (tree_model), 0);
714   g_return_val_if_fail (iter == NULL || iter->user_data != NULL, FALSE);
715
716   if (iter == NULL)
717     node = G_NODE (GTK_TREE_STORE (tree_model)->root)->children;
718   else
719     node = G_NODE (iter->user_data)->children;
720
721   while (node)
722     {
723       i++;
724       node = node->next;
725     }
726
727   return i;
728 }
729
730 static gboolean
731 gtk_tree_store_iter_nth_child (GtkTreeModel *tree_model,
732                                GtkTreeIter  *iter,
733                                GtkTreeIter  *parent,
734                                gint          n)
735 {
736   GNode *parent_node;
737   GNode *child;
738
739   g_return_val_if_fail (GTK_IS_TREE_STORE (tree_model), FALSE);
740   g_return_val_if_fail (parent == NULL || parent->user_data != NULL, FALSE);
741
742   if (parent == NULL)
743     parent_node = GTK_TREE_STORE (tree_model)->root;
744   else
745     parent_node = parent->user_data;
746
747   child = g_node_nth_child (parent_node, n);
748
749   if (child)
750     {
751       iter->user_data = child;
752       iter->stamp = GTK_TREE_STORE (tree_model)->stamp;
753       return TRUE;
754     }
755   else
756     return FALSE;
757 }
758
759 static gboolean
760 gtk_tree_store_iter_parent (GtkTreeModel *tree_model,
761                             GtkTreeIter  *iter,
762                             GtkTreeIter  *child)
763 {
764   GNode *parent;
765
766   g_return_val_if_fail (iter != NULL, FALSE);
767   g_return_val_if_fail (child != NULL, FALSE);
768   g_return_val_if_fail (child->user_data != NULL, FALSE);
769   g_return_val_if_fail (child->stamp == GTK_TREE_STORE (tree_model)->stamp, FALSE);
770
771   parent = G_NODE (child->user_data)->parent;
772
773   g_assert (parent != NULL);
774
775   if (parent != GTK_TREE_STORE (tree_model)->root)
776     {
777       iter->user_data = parent;
778       iter->stamp = GTK_TREE_STORE (tree_model)->stamp;
779       return TRUE;
780     }
781   else
782     return FALSE;
783 }
784
785
786 /* Does not emit a signal */
787 static gboolean
788 gtk_tree_store_real_set_value (GtkTreeStore *tree_store,
789                                GtkTreeIter  *iter,
790                                gint          column,
791                                GValue       *value,
792                                gboolean      sort)
793 {
794   GtkTreeDataList *list;
795   GtkTreeDataList *prev;
796   gint old_column = column;
797   GValue real_value = {0, };
798   gboolean converted = FALSE;
799   gboolean retval = FALSE;
800
801   g_return_val_if_fail (GTK_IS_TREE_STORE (tree_store), FALSE);
802   g_return_val_if_fail (VALID_ITER (iter, tree_store), FALSE);
803   g_return_val_if_fail (column >= 0 && column < tree_store->n_columns, FALSE);
804   g_return_val_if_fail (G_IS_VALUE (value), FALSE);
805
806   if (! g_type_is_a (G_VALUE_TYPE (value), tree_store->column_headers[column]))
807     {
808       if (! (g_value_type_compatible (G_VALUE_TYPE (value), tree_store->column_headers[column]) &&
809              g_value_type_compatible (tree_store->column_headers[column], G_VALUE_TYPE (value))))
810         {
811           g_warning ("%s: Unable to convert from %s to %s\n",
812                      G_STRLOC,
813                      g_type_name (G_VALUE_TYPE (value)),
814                      g_type_name (tree_store->column_headers[column]));
815           return retval;
816         }
817       if (!g_value_transform (value, &real_value))
818         {
819           g_warning ("%s: Unable to make conversion from %s to %s\n",
820                      G_STRLOC,
821                      g_type_name (G_VALUE_TYPE (value)),
822                      g_type_name (tree_store->column_headers[column]));
823           g_value_unset (&real_value);
824           return retval;
825         }
826       converted = TRUE;
827     }
828
829   prev = list = G_NODE (iter->user_data)->data;
830
831   while (list != NULL)
832     {
833       if (column == 0)
834         {
835           if (converted)
836             _gtk_tree_data_list_value_to_node (list, &real_value);
837           else
838             _gtk_tree_data_list_value_to_node (list, value);
839           retval = TRUE;
840           if (converted)
841             g_value_unset (&real_value);
842           return retval;
843         }
844
845       column--;
846       prev = list;
847       list = list->next;
848     }
849
850   if (G_NODE (iter->user_data)->data == NULL)
851     {
852       G_NODE (iter->user_data)->data = list = _gtk_tree_data_list_alloc ();
853       list->next = NULL;
854     }
855   else
856     {
857       list = prev->next = _gtk_tree_data_list_alloc ();
858       list->next = NULL;
859     }
860
861   while (column != 0)
862     {
863       list->next = _gtk_tree_data_list_alloc ();
864       list = list->next;
865       list->next = NULL;
866       column --;
867     }
868
869   if (converted)
870     _gtk_tree_data_list_value_to_node (list, &real_value);
871   else
872     _gtk_tree_data_list_value_to_node (list, value);
873   
874   retval = TRUE;
875   if (converted)
876     g_value_unset (&real_value);
877
878   if (sort && GTK_TREE_STORE_IS_SORTED (tree_store))
879     gtk_tree_store_sort_iter_changed (tree_store, iter, old_column);
880
881   return retval;
882 }
883
884 /**
885  * gtk_tree_store_set_value:
886  * @tree_store: a #GtkTreeStore
887  * @iter: A valid #GtkTreeIter for the row being modified
888  * @column: column number to modify
889  * @value: new value for the cell
890  *
891  * Sets the data in the cell specified by @iter and @column.
892  * The type of @value must be convertible to the type of the
893  * column.
894  *
895  **/
896 void
897 gtk_tree_store_set_value (GtkTreeStore *tree_store,
898                           GtkTreeIter  *iter,
899                           gint          column,
900                           GValue       *value)
901 {
902   g_return_if_fail (GTK_IS_TREE_STORE (tree_store));
903   g_return_if_fail (VALID_ITER (iter, tree_store));
904   g_return_if_fail (column >= 0 && column < tree_store->n_columns);
905   g_return_if_fail (G_IS_VALUE (value));
906
907   if (gtk_tree_store_real_set_value (tree_store, iter, column, value, TRUE))
908     {
909       GtkTreePath *path;
910
911       path = gtk_tree_model_get_path (GTK_TREE_MODEL (tree_store), iter);
912       gtk_tree_model_row_changed (GTK_TREE_MODEL (tree_store), path, iter);
913       gtk_tree_path_free (path);
914     }
915 }
916
917 /**
918  * gtk_tree_store_set_valist:
919  * @tree_store: A #GtkTreeStore
920  * @iter: A valid #GtkTreeIter for the row being modified
921  * @var_args: <type>va_list</type> of column/value pairs
922  *
923  * See gtk_tree_store_set(); this version takes a <type>va_list</type> for
924  * use by language bindings.
925  *
926  **/
927 void
928 gtk_tree_store_set_valist (GtkTreeStore *tree_store,
929                            GtkTreeIter  *iter,
930                            va_list      var_args)
931 {
932   gint column;
933   gboolean emit_signal = FALSE;
934   gboolean maybe_need_sort = FALSE;
935   GtkTreeIterCompareFunc func = NULL;
936
937   g_return_if_fail (GTK_IS_TREE_STORE (tree_store));
938   g_return_if_fail (VALID_ITER (iter, tree_store));
939
940   column = va_arg (var_args, gint);
941
942   if (GTK_TREE_STORE_IS_SORTED (tree_store))
943     {
944       if (tree_store->sort_column_id != -1)
945         {
946           GtkTreeDataSortHeader *header;
947           header = _gtk_tree_data_list_get_header (tree_store->sort_list,
948                                                    tree_store->sort_column_id);
949           g_return_if_fail (header != NULL);
950           g_return_if_fail (header->func != NULL);
951           func = header->func;
952         }
953       else
954         {
955           func = tree_store->default_sort_func;
956         }
957     }
958
959   if (func != gtk_tree_data_list_compare_func)
960     maybe_need_sort = TRUE;
961
962   while (column != -1)
963     {
964       GValue value = { 0, };
965       gchar *error = NULL;
966
967       if (column >= tree_store->n_columns)
968         {
969           g_warning ("%s: Invalid column number %d added to iter (remember to end your list of columns with a -1)", G_STRLOC, column);
970           break;
971         }
972       g_value_init (&value, tree_store->column_headers[column]);
973
974       G_VALUE_COLLECT (&value, var_args, 0, &error);
975       if (error)
976         {
977           g_warning ("%s: %s", G_STRLOC, error);
978           g_free (error);
979
980           /* we purposely leak the value here, it might not be
981            * in a sane state if an error condition occoured
982            */
983           break;
984         }
985
986       emit_signal = gtk_tree_store_real_set_value (tree_store,
987                                                    iter,
988                                                    column,
989                                                    &value,
990                                                    FALSE) || emit_signal;
991
992       if (func == gtk_tree_data_list_compare_func &&
993           column == tree_store->sort_column_id)
994         maybe_need_sort = TRUE;
995
996       g_value_unset (&value);
997
998       column = va_arg (var_args, gint);
999     }
1000
1001   if (maybe_need_sort && GTK_TREE_STORE_IS_SORTED (tree_store))
1002     gtk_tree_store_sort_iter_changed (tree_store, iter, tree_store->sort_column_id);
1003
1004   if (emit_signal)
1005     {
1006       GtkTreePath *path;
1007
1008       path = gtk_tree_model_get_path (GTK_TREE_MODEL (tree_store), iter);
1009       gtk_tree_model_row_changed (GTK_TREE_MODEL (tree_store), path, iter);
1010       gtk_tree_path_free (path);
1011     }
1012 }
1013
1014 /**
1015  * gtk_tree_store_set:
1016  * @tree_store: A #GtkTreeStore
1017  * @iter: A valid #GtkTreeIter for the row being modified
1018  * @Varargs: pairs of column number and value, terminated with -1
1019  *
1020  * Sets the value of one or more cells in the row referenced by @iter.
1021  * The variable argument list should contain integer column numbers,
1022  * each column number followed by the value to be set. 
1023  * The list is terminated by a -1. For example, to set column 0 with type
1024  * %G_TYPE_STRING to "Foo", you would write 
1025  * <literal>gtk_tree_store_set (store, iter, 0, "Foo", -1)</literal>.
1026  **/
1027 void
1028 gtk_tree_store_set (GtkTreeStore *tree_store,
1029                     GtkTreeIter  *iter,
1030                     ...)
1031 {
1032   va_list var_args;
1033
1034   g_return_if_fail (GTK_IS_TREE_STORE (tree_store));
1035   g_return_if_fail (VALID_ITER (iter, tree_store));
1036
1037   va_start (var_args, iter);
1038   gtk_tree_store_set_valist (tree_store, iter, var_args);
1039   va_end (var_args);
1040 }
1041
1042 /**
1043  * gtk_tree_store_remove:
1044  * @tree_store: A #GtkTreeStore
1045  * @iter: A valid #GtkTreeIter
1046  * 
1047  * Removes @iter from @tree_store.  After being removed, @iter is set to the
1048  * next valid row at that level, or invalidated if it previously pointed to the
1049  * last one.
1050  *
1051  * Return value: %TRUE if @iter is still valid, %FALSE if not.
1052  **/
1053 gboolean
1054 gtk_tree_store_remove (GtkTreeStore *tree_store,
1055                        GtkTreeIter  *iter)
1056 {
1057   GtkTreePath *path;
1058   GtkTreeIter new_iter = {0,};
1059   GNode *parent;
1060   GNode *next_node;
1061
1062   g_return_val_if_fail (GTK_IS_TREE_STORE (tree_store), FALSE);
1063   g_return_val_if_fail (VALID_ITER (iter, tree_store), FALSE);
1064
1065   parent = G_NODE (iter->user_data)->parent;
1066
1067   g_assert (parent != NULL);
1068   next_node = G_NODE (iter->user_data)->next;
1069
1070   if (G_NODE (iter->user_data)->data)
1071     g_node_traverse (G_NODE (iter->user_data), G_POST_ORDER, G_TRAVERSE_ALL,
1072                      -1, node_free, tree_store->column_headers);
1073
1074   path = gtk_tree_store_get_path (GTK_TREE_MODEL (tree_store), iter);
1075   g_node_destroy (G_NODE (iter->user_data));
1076
1077   gtk_tree_model_row_deleted (GTK_TREE_MODEL (tree_store), path);
1078
1079   if (parent != G_NODE (tree_store->root))
1080     {
1081       /* child_toggled */
1082       if (parent->children == NULL)
1083         {
1084           gtk_tree_path_up (path);
1085
1086           new_iter.stamp = tree_store->stamp;
1087           new_iter.user_data = parent;
1088           gtk_tree_model_row_has_child_toggled (GTK_TREE_MODEL (tree_store), path, &new_iter);
1089         }
1090     }
1091   gtk_tree_path_free (path);
1092
1093   /* revalidate iter */
1094   if (next_node != NULL)
1095     {
1096       iter->stamp = tree_store->stamp;
1097       iter->user_data = next_node;
1098       return TRUE;
1099     }
1100   else
1101     {
1102       iter->stamp = 0;
1103       iter->user_data = NULL;
1104     }
1105
1106   return FALSE;
1107 }
1108
1109 /**
1110  * gtk_tree_store_insert:
1111  * @tree_store: A #GtkTreeStore
1112  * @iter: An unset #GtkTreeIter to set to the new row
1113  * @parent: A valid #GtkTreeIter, or %NULL
1114  * @position: position to insert the new row
1115  *
1116  * Creates a new row at @position.  If parent is non-%NULL, then the row will be
1117  * made a child of @parent.  Otherwise, the row will be created at the toplevel.
1118  * If @position is larger than the number of rows at that level, then the new
1119  * row will be inserted to the end of the list.  @iter will be changed to point
1120  * to this new row.  The row will be empty after this function is called.  To
1121  * fill in values, you need to call gtk_tree_store_set() or
1122  * gtk_tree_store_set_value().
1123  *
1124  **/
1125 void
1126 gtk_tree_store_insert (GtkTreeStore *tree_store,
1127                        GtkTreeIter  *iter,
1128                        GtkTreeIter  *parent,
1129                        gint          position)
1130 {
1131   GtkTreePath *path;
1132   GNode *parent_node;
1133
1134   g_return_if_fail (GTK_IS_TREE_STORE (tree_store));
1135   if (parent)
1136     g_return_if_fail (VALID_ITER (parent, tree_store));
1137
1138   if (parent)
1139     parent_node = parent->user_data;
1140   else
1141     parent_node = tree_store->root;
1142
1143   tree_store->columns_dirty = TRUE;
1144
1145   iter->stamp = tree_store->stamp;
1146   iter->user_data = g_node_new (NULL);
1147   g_node_insert (parent_node, position, G_NODE (iter->user_data));
1148
1149   path = gtk_tree_store_get_path (GTK_TREE_MODEL (tree_store), iter);
1150   gtk_tree_model_row_inserted (GTK_TREE_MODEL (tree_store), path, iter);
1151
1152   gtk_tree_path_free (path);
1153
1154   validate_tree ((GtkTreeStore*)tree_store);
1155 }
1156
1157 /**
1158  * gtk_tree_store_insert_before:
1159  * @tree_store: A #GtkTreeStore
1160  * @iter: An unset #GtkTreeIter to set to the new row
1161  * @parent: A valid #GtkTreeIter, or %NULL
1162  * @sibling: A valid #GtkTreeIter, or %NULL
1163  *
1164  * Inserts a new row before @sibling.  If @sibling is %NULL, then the row will
1165  * be appended to @parent 's children.  If @parent and @sibling are %NULL, then
1166  * the row will be appended to the toplevel.  If both @sibling and @parent are
1167  * set, then @parent must be the parent of @sibling.  When @sibling is set,
1168  * @parent is optional.
1169  *
1170  * @iter will be changed to point to this new row.  The row will be empty after
1171  * this function is called.  To fill in values, you need to call
1172  * gtk_tree_store_set() or gtk_tree_store_set_value().
1173  *
1174  **/
1175 void
1176 gtk_tree_store_insert_before (GtkTreeStore *tree_store,
1177                               GtkTreeIter  *iter,
1178                               GtkTreeIter  *parent,
1179                               GtkTreeIter  *sibling)
1180 {
1181   GtkTreePath *path;
1182   GNode *parent_node = NULL;
1183   GNode *new_node;
1184
1185   g_return_if_fail (GTK_IS_TREE_STORE (tree_store));
1186   g_return_if_fail (iter != NULL);
1187   if (parent != NULL)
1188     g_return_if_fail (VALID_ITER (parent, tree_store));
1189   if (sibling != NULL)
1190     g_return_if_fail (VALID_ITER (sibling, tree_store));
1191
1192   tree_store->columns_dirty = TRUE;
1193
1194   new_node = g_node_new (NULL);
1195
1196   if (parent == NULL && sibling == NULL)
1197     parent_node = tree_store->root;
1198   else if (parent == NULL)
1199     parent_node = G_NODE (sibling->user_data)->parent;
1200   else if (sibling == NULL)
1201     parent_node = G_NODE (parent->user_data);
1202   else
1203     {
1204       g_return_if_fail (G_NODE (sibling->user_data)->parent == G_NODE (parent->user_data));
1205       parent_node = G_NODE (parent->user_data);
1206     }
1207
1208   g_node_insert_before (parent_node,
1209                         sibling ? G_NODE (sibling->user_data) : NULL,
1210                         new_node);
1211
1212   iter->stamp = tree_store->stamp;
1213   iter->user_data = new_node;
1214
1215   path = gtk_tree_store_get_path (GTK_TREE_MODEL (tree_store), iter);
1216   gtk_tree_model_row_inserted (GTK_TREE_MODEL (tree_store), path, iter);
1217
1218   gtk_tree_path_free (path);
1219
1220   validate_tree ((GtkTreeStore*)tree_store);
1221 }
1222
1223 /**
1224  * gtk_tree_store_insert_after:
1225  * @tree_store: A #GtkTreeStore
1226  * @iter: An unset #GtkTreeIter to set to the new row
1227  * @parent: A valid #GtkTreeIter, or %NULL
1228  * @sibling: A valid #GtkTreeIter, or %NULL
1229  *
1230  * Inserts a new row after @sibling.  If @sibling is %NULL, then the row will be
1231  * prepended to @parent 's children.  If @parent and @sibling are %NULL, then
1232  * the row will be prepended to the toplevel.  If both @sibling and @parent are
1233  * set, then @parent must be the parent of @sibling.  When @sibling is set,
1234  * @parent is optional.
1235  *
1236  * @iter will be changed to point to this new row.  The row will be empty after
1237  * this function is called.  To fill in values, you need to call
1238  * gtk_tree_store_set() or gtk_tree_store_set_value().
1239  *
1240  **/
1241 void
1242 gtk_tree_store_insert_after (GtkTreeStore *tree_store,
1243                              GtkTreeIter  *iter,
1244                              GtkTreeIter  *parent,
1245                              GtkTreeIter  *sibling)
1246 {
1247   GtkTreePath *path;
1248   GNode *parent_node;
1249   GNode *new_node;
1250
1251   g_return_if_fail (GTK_IS_TREE_STORE (tree_store));
1252   g_return_if_fail (iter != NULL);
1253   if (parent != NULL)
1254     g_return_if_fail (VALID_ITER (parent, tree_store));
1255   if (sibling != NULL)
1256     g_return_if_fail (VALID_ITER (sibling, tree_store));
1257
1258   tree_store->columns_dirty = TRUE;
1259
1260   new_node = g_node_new (NULL);
1261
1262   if (parent == NULL && sibling == NULL)
1263     parent_node = tree_store->root;
1264   else if (parent == NULL)
1265     parent_node = G_NODE (sibling->user_data)->parent;
1266   else if (sibling == NULL)
1267     parent_node = G_NODE (parent->user_data);
1268   else
1269     {
1270       g_return_if_fail (G_NODE (sibling->user_data)->parent ==
1271                         G_NODE (parent->user_data));
1272       parent_node = G_NODE (parent->user_data);
1273     }
1274
1275
1276   g_node_insert_after (parent_node,
1277                        sibling ? G_NODE (sibling->user_data) : NULL,
1278                        new_node);
1279
1280   iter->stamp = tree_store->stamp;
1281   iter->user_data = new_node;
1282
1283   path = gtk_tree_store_get_path (GTK_TREE_MODEL (tree_store), iter);
1284   gtk_tree_model_row_inserted (GTK_TREE_MODEL (tree_store), path, iter);
1285
1286   gtk_tree_path_free (path);
1287
1288   validate_tree ((GtkTreeStore*)tree_store);
1289 }
1290
1291 /**
1292  * gtk_tree_store_prepend:
1293  * @tree_store: A #GtkTreeStore
1294  * @iter: An unset #GtkTreeIter to set to the prepended row
1295  * @parent: A valid #GtkTreeIter, or %NULL
1296  * 
1297  * Prepends a new row to @tree_store.  If @parent is non-%NULL, then it will prepend
1298  * the new row before the first child of @parent, otherwise it will prepend a row
1299  * to the top level.  @iter will be changed to point to this new row.  The row
1300  * will be empty after this function is called.  To fill in values, you need to
1301  * call gtk_tree_store_set() or gtk_tree_store_set_value().
1302  **/
1303 void
1304 gtk_tree_store_prepend (GtkTreeStore *tree_store,
1305                         GtkTreeIter  *iter,
1306                         GtkTreeIter  *parent)
1307 {
1308   GNode *parent_node;
1309
1310   g_return_if_fail (GTK_IS_TREE_STORE (tree_store));
1311   g_return_if_fail (iter != NULL);
1312   if (parent != NULL)
1313     g_return_if_fail (VALID_ITER (parent, tree_store));
1314
1315   tree_store->columns_dirty = TRUE;
1316
1317   if (parent == NULL)
1318     parent_node = tree_store->root;
1319   else
1320     parent_node = parent->user_data;
1321
1322   if (parent_node->children == NULL)
1323     {
1324       GtkTreePath *path;
1325       
1326       iter->stamp = tree_store->stamp;
1327       iter->user_data = g_node_new (NULL);
1328
1329       g_node_prepend (parent_node, G_NODE (iter->user_data));
1330
1331       path = gtk_tree_store_get_path (GTK_TREE_MODEL (tree_store), iter);
1332       gtk_tree_model_row_inserted (GTK_TREE_MODEL (tree_store), path, iter);
1333
1334       if (parent_node != tree_store->root)
1335         {
1336           gtk_tree_path_up (path);
1337           gtk_tree_model_row_has_child_toggled (GTK_TREE_MODEL (tree_store), path, parent);
1338         }
1339       gtk_tree_path_free (path);
1340     }
1341   else
1342     {
1343       gtk_tree_store_insert_after (tree_store, iter, parent, NULL);
1344     }
1345
1346   validate_tree ((GtkTreeStore*)tree_store);
1347 }
1348
1349 /**
1350  * gtk_tree_store_append:
1351  * @tree_store: A #GtkTreeStore
1352  * @iter: An unset #GtkTreeIter to set to the appended row
1353  * @parent: A valid #GtkTreeIter, or %NULL
1354  * 
1355  * Appends a new row to @tree_store.  If @parent is non-%NULL, then it will append the
1356  * new row after the last child of @parent, otherwise it will append a row to
1357  * the top level.  @iter will be changed to point to this new row.  The row will
1358  * be empty after this function is called.  To fill in values, you need to call
1359  * gtk_tree_store_set() or gtk_tree_store_set_value().
1360  **/
1361 void
1362 gtk_tree_store_append (GtkTreeStore *tree_store,
1363                        GtkTreeIter  *iter,
1364                        GtkTreeIter  *parent)
1365 {
1366   GNode *parent_node;
1367
1368   g_return_if_fail (GTK_IS_TREE_STORE (tree_store));
1369   g_return_if_fail (iter != NULL);
1370
1371   if (parent != NULL)
1372     g_return_if_fail (VALID_ITER (parent, tree_store));
1373
1374   if (parent == NULL)
1375     parent_node = tree_store->root;
1376   else
1377     parent_node = parent->user_data;
1378
1379   tree_store->columns_dirty = TRUE;
1380
1381   if (parent_node->children == NULL)
1382     {
1383       GtkTreePath *path;
1384
1385       iter->stamp = tree_store->stamp;
1386       iter->user_data = g_node_new (NULL);
1387
1388       g_node_append (parent_node, G_NODE (iter->user_data));
1389
1390       path = gtk_tree_store_get_path (GTK_TREE_MODEL (tree_store), iter);
1391       gtk_tree_model_row_inserted (GTK_TREE_MODEL (tree_store), path, iter);
1392
1393       if (parent_node != tree_store->root)
1394         {
1395           gtk_tree_path_up (path);
1396           gtk_tree_model_row_has_child_toggled (GTK_TREE_MODEL (tree_store), path, parent);
1397         }
1398       gtk_tree_path_free (path);
1399     }
1400   else
1401     {
1402       gtk_tree_store_insert_before (tree_store, iter, parent, NULL);
1403     }
1404
1405   validate_tree ((GtkTreeStore*)tree_store);
1406 }
1407
1408 /**
1409  * gtk_tree_store_is_ancestor:
1410  * @tree_store: A #GtkTreeStore
1411  * @iter: A valid #GtkTreeIter
1412  * @descendant: A valid #GtkTreeIter
1413  * 
1414  * Returns %TRUE if @iter is an ancestor of @descendant.  That is, @iter is the
1415  * parent (or grandparent or great-grandparent) of @descendant.
1416  * 
1417  * Return value: %TRUE, if @iter is an ancestor of @descendant
1418  **/
1419 gboolean
1420 gtk_tree_store_is_ancestor (GtkTreeStore *tree_store,
1421                             GtkTreeIter  *iter,
1422                             GtkTreeIter  *descendant)
1423 {
1424   g_return_val_if_fail (GTK_IS_TREE_STORE (tree_store), FALSE);
1425   g_return_val_if_fail (VALID_ITER (iter, tree_store), FALSE);
1426   g_return_val_if_fail (VALID_ITER (descendant, tree_store), FALSE);
1427
1428   return g_node_is_ancestor (G_NODE (iter->user_data),
1429                              G_NODE (descendant->user_data));
1430 }
1431
1432
1433 /**
1434  * gtk_tree_store_iter_depth:
1435  * @tree_store: A #GtkTreeStore
1436  * @iter: A valid #GtkTreeIter
1437  * 
1438  * Returns the depth of @iter.  This will be 0 for anything on the root level, 1
1439  * for anything down a level, etc.
1440  * 
1441  * Return value: The depth of @iter
1442  **/
1443 gint
1444 gtk_tree_store_iter_depth (GtkTreeStore *tree_store,
1445                            GtkTreeIter  *iter)
1446 {
1447   g_return_val_if_fail (GTK_IS_TREE_STORE (tree_store), 0);
1448   g_return_val_if_fail (VALID_ITER (iter, tree_store), 0);
1449
1450   return g_node_depth (G_NODE (iter->user_data)) - 2;
1451 }
1452
1453 /* simple ripoff from g_node_traverse_post_order */
1454 static gboolean
1455 gtk_tree_store_clear_traverse (GNode *node,
1456                                GtkTreeStore *store)
1457 {
1458   GtkTreeIter iter;
1459
1460   if (node->children)
1461     {
1462       GNode *child;
1463
1464       child = node->children;
1465       while (child)
1466         {
1467           register GNode *current;
1468
1469           current = child;
1470           child = current->next;
1471           if (gtk_tree_store_clear_traverse (current, store))
1472             return TRUE;
1473         }
1474
1475       if (node->parent)
1476         {
1477           iter.stamp = store->stamp;
1478           iter.user_data = node;
1479
1480           gtk_tree_store_remove (store, &iter);
1481         }
1482     }
1483   else if (node->parent)
1484     {
1485       iter.stamp = store->stamp;
1486       iter.user_data = node;
1487
1488       gtk_tree_store_remove (store, &iter);
1489     }
1490
1491   return FALSE;
1492 }
1493
1494 /**
1495  * gtk_tree_store_clear:
1496  * @tree_store: a #GtkTreeStore
1497  * 
1498  * Removes all rows from @tree_store
1499  **/
1500 void
1501 gtk_tree_store_clear (GtkTreeStore *tree_store)
1502 {
1503   g_return_if_fail (GTK_IS_TREE_STORE (tree_store));
1504
1505   gtk_tree_store_clear_traverse (tree_store->root, tree_store);
1506 }
1507
1508 static gboolean
1509 gtk_tree_store_iter_is_valid_helper (GtkTreeIter *iter,
1510                                      GNode       *first)
1511 {
1512   GNode *node;
1513
1514   node = first;
1515
1516   do
1517     {
1518       if (node == iter->user_data)
1519         return TRUE;
1520
1521       if (node->children)
1522         if (gtk_tree_store_iter_is_valid_helper (iter, node->children))
1523           return TRUE;
1524
1525       node = node->next;
1526     }
1527   while (node);
1528
1529   return FALSE;
1530 }
1531
1532 /**
1533  * gtk_tree_store_iter_is_valid:
1534  * @tree_store: A #GtkTreeStore.
1535  * @iter: A #GtkTreeIter.
1536  *
1537  * WARNING: This function is slow. Only use it for debugging and/or testing
1538  * purposes.
1539  *
1540  * Checks if the given iter is a valid iter for this #GtkTreeStore.
1541  *
1542  * Return value: %TRUE if the iter is valid, %FALSE if the iter is invalid.
1543  **/
1544 gboolean
1545 gtk_tree_store_iter_is_valid (GtkTreeStore *tree_store,
1546                               GtkTreeIter  *iter)
1547 {
1548   g_return_val_if_fail (GTK_IS_TREE_STORE (tree_store), FALSE);
1549   g_return_val_if_fail (iter != NULL, FALSE);
1550
1551   if (!VALID_ITER (iter, tree_store))
1552     return FALSE;
1553
1554   return gtk_tree_store_iter_is_valid_helper (iter, tree_store->root);
1555 }
1556
1557 /* DND */
1558
1559
1560 static gboolean
1561 gtk_tree_store_drag_data_delete (GtkTreeDragSource *drag_source,
1562                                  GtkTreePath       *path)
1563 {
1564   GtkTreeIter iter;
1565
1566   g_return_val_if_fail (GTK_IS_TREE_STORE (drag_source), FALSE);
1567
1568   if (gtk_tree_model_get_iter (GTK_TREE_MODEL (drag_source),
1569                                &iter,
1570                                path))
1571     {
1572       gtk_tree_store_remove (GTK_TREE_STORE (drag_source),
1573                              &iter);
1574       return TRUE;
1575     }
1576   else
1577     {
1578       return FALSE;
1579     }
1580 }
1581
1582 static gboolean
1583 gtk_tree_store_drag_data_get (GtkTreeDragSource *drag_source,
1584                               GtkTreePath       *path,
1585                               GtkSelectionData  *selection_data)
1586 {
1587   g_return_val_if_fail (GTK_IS_TREE_STORE (drag_source), FALSE);
1588
1589   /* Note that we don't need to handle the GTK_TREE_MODEL_ROW
1590    * target, because the default handler does it for us, but
1591    * we do anyway for the convenience of someone maybe overriding the
1592    * default handler.
1593    */
1594
1595   if (gtk_tree_set_row_drag_data (selection_data,
1596                                   GTK_TREE_MODEL (drag_source),
1597                                   path))
1598     {
1599       return TRUE;
1600     }
1601   else
1602     {
1603       /* FIXME handle text targets at least. */
1604     }
1605
1606   return FALSE;
1607 }
1608
1609 static void
1610 copy_node_data (GtkTreeStore *tree_store,
1611                 GtkTreeIter  *src_iter,
1612                 GtkTreeIter  *dest_iter)
1613 {
1614   GtkTreeDataList *dl = G_NODE (src_iter->user_data)->data;
1615   GtkTreeDataList *copy_head = NULL;
1616   GtkTreeDataList *copy_prev = NULL;
1617   GtkTreeDataList *copy_iter = NULL;
1618   GtkTreePath *path;
1619   gint col;
1620
1621   col = 0;
1622   while (dl)
1623     {
1624       copy_iter = _gtk_tree_data_list_node_copy (dl, tree_store->column_headers[col]);
1625
1626       if (copy_head == NULL)
1627         copy_head = copy_iter;
1628
1629       if (copy_prev)
1630         copy_prev->next = copy_iter;
1631
1632       copy_prev = copy_iter;
1633
1634       dl = dl->next;
1635       ++col;
1636     }
1637
1638   G_NODE (dest_iter->user_data)->data = copy_head;
1639
1640   path = gtk_tree_store_get_path (GTK_TREE_MODEL (tree_store), dest_iter);
1641   gtk_tree_model_row_changed (GTK_TREE_MODEL (tree_store), path, dest_iter);
1642   gtk_tree_path_free (path);
1643 }
1644
1645 static void
1646 recursive_node_copy (GtkTreeStore *tree_store,
1647                      GtkTreeIter  *src_iter,
1648                      GtkTreeIter  *dest_iter)
1649 {
1650   GtkTreeIter child;
1651   GtkTreeModel *model;
1652
1653   model = GTK_TREE_MODEL (tree_store);
1654
1655   copy_node_data (tree_store, src_iter, dest_iter);
1656
1657   if (gtk_tree_model_iter_children (model,
1658                                     &child,
1659                                     src_iter))
1660     {
1661       /* Need to create children and recurse. Note our
1662        * dependence on persistent iterators here.
1663        */
1664       do
1665         {
1666           GtkTreeIter copy;
1667
1668           /* Gee, a really slow algorithm... ;-) FIXME */
1669           gtk_tree_store_append (tree_store,
1670                                  &copy,
1671                                  dest_iter);
1672
1673           recursive_node_copy (tree_store, &child, &copy);
1674         }
1675       while (gtk_tree_model_iter_next (model, &child));
1676     }
1677 }
1678
1679 static gboolean
1680 gtk_tree_store_drag_data_received (GtkTreeDragDest   *drag_dest,
1681                                    GtkTreePath       *dest,
1682                                    GtkSelectionData  *selection_data)
1683 {
1684   GtkTreeModel *tree_model;
1685   GtkTreeStore *tree_store;
1686   GtkTreeModel *src_model = NULL;
1687   GtkTreePath *src_path = NULL;
1688   gboolean retval = FALSE;
1689
1690   g_return_val_if_fail (GTK_IS_TREE_STORE (drag_dest), FALSE);
1691
1692   tree_model = GTK_TREE_MODEL (drag_dest);
1693   tree_store = GTK_TREE_STORE (drag_dest);
1694
1695   validate_tree (tree_store);
1696
1697   if (gtk_tree_get_row_drag_data (selection_data,
1698                                   &src_model,
1699                                   &src_path) &&
1700       src_model == tree_model)
1701     {
1702       /* Copy the given row to a new position */
1703       GtkTreeIter src_iter;
1704       GtkTreeIter dest_iter;
1705       GtkTreePath *prev;
1706
1707       if (!gtk_tree_model_get_iter (src_model,
1708                                     &src_iter,
1709                                     src_path))
1710         {
1711           goto out;
1712         }
1713
1714       /* Get the path to insert _after_ (dest is the path to insert _before_) */
1715       prev = gtk_tree_path_copy (dest);
1716
1717       if (!gtk_tree_path_prev (prev))
1718         {
1719           GtkTreeIter dest_parent;
1720           GtkTreePath *parent;
1721           GtkTreeIter *dest_parent_p;
1722
1723           /* dest was the first spot at the current depth; which means
1724            * we are supposed to prepend.
1725            */
1726
1727           /* Get the parent, NULL if parent is the root */
1728           dest_parent_p = NULL;
1729           parent = gtk_tree_path_copy (dest);
1730           if (gtk_tree_path_up (parent) &&
1731               gtk_tree_path_get_depth (parent) > 0)
1732             {
1733               gtk_tree_model_get_iter (tree_model,
1734                                        &dest_parent,
1735                                        parent);
1736               dest_parent_p = &dest_parent;
1737             }
1738           gtk_tree_path_free (parent);
1739           parent = NULL;
1740
1741           gtk_tree_store_prepend (GTK_TREE_STORE (tree_model),
1742                                   &dest_iter,
1743                                   dest_parent_p);
1744
1745           retval = TRUE;
1746         }
1747       else
1748         {
1749           if (gtk_tree_model_get_iter (GTK_TREE_MODEL (tree_model),
1750                                        &dest_iter,
1751                                        prev))
1752             {
1753               GtkTreeIter tmp_iter = dest_iter;
1754
1755               if (GPOINTER_TO_INT (g_object_get_data (G_OBJECT (tree_model), "gtk-tree-model-drop-append")))
1756                 {
1757                   GtkTreeIter parent;
1758
1759                   if (gtk_tree_model_iter_parent (GTK_TREE_MODEL (tree_model), &parent, &tmp_iter))
1760                     gtk_tree_store_append (GTK_TREE_STORE (tree_model),
1761                                            &dest_iter, &parent);
1762                   else
1763                     gtk_tree_store_append (GTK_TREE_STORE (tree_model),
1764                                            &dest_iter, NULL);
1765                 }
1766               else
1767                 gtk_tree_store_insert_after (GTK_TREE_STORE (tree_model),
1768                                              &dest_iter,
1769                                              NULL,
1770                                              &tmp_iter);
1771               retval = TRUE;
1772
1773             }
1774         }
1775
1776       g_object_set_data (G_OBJECT (tree_model), "gtk-tree-model-drop-append",
1777                          NULL);
1778
1779       gtk_tree_path_free (prev);
1780
1781       /* If we succeeded in creating dest_iter, walk src_iter tree branch,
1782        * duplicating it below dest_iter.
1783        */
1784
1785       if (retval)
1786         {
1787           recursive_node_copy (tree_store,
1788                                &src_iter,
1789                                &dest_iter);
1790         }
1791     }
1792   else
1793     {
1794       /* FIXME maybe add some data targets eventually, or handle text
1795        * targets in the simple case.
1796        */
1797
1798     }
1799
1800  out:
1801
1802   if (src_path)
1803     gtk_tree_path_free (src_path);
1804
1805   return retval;
1806 }
1807
1808 static gboolean
1809 gtk_tree_store_row_drop_possible (GtkTreeDragDest  *drag_dest,
1810                                   GtkTreePath      *dest_path,
1811                                   GtkSelectionData *selection_data)
1812 {
1813   GtkTreeModel *src_model = NULL;
1814   GtkTreePath *src_path = NULL;
1815   GtkTreePath *tmp = NULL;
1816   gboolean retval = FALSE;
1817   
1818   g_return_val_if_fail (GTK_IS_TREE_STORE (drag_dest), FALSE);
1819
1820   /* don't accept drops if the tree has been sorted */
1821   if (GTK_TREE_STORE_IS_SORTED (drag_dest))
1822     return FALSE;
1823
1824   if (!gtk_tree_get_row_drag_data (selection_data,
1825                                    &src_model,
1826                                    &src_path))
1827     goto out;
1828     
1829   /* can only drag to ourselves */
1830   if (src_model != GTK_TREE_MODEL (drag_dest))
1831     goto out;
1832
1833   /* Can't drop into ourself. */
1834   if (gtk_tree_path_is_ancestor (src_path,
1835                                  dest_path))
1836     goto out;
1837
1838   /* Can't drop if dest_path's parent doesn't exist */
1839   {
1840     GtkTreeIter iter;
1841
1842     if (gtk_tree_path_get_depth (dest_path) > 1)
1843       {
1844         tmp = gtk_tree_path_copy (dest_path);
1845         gtk_tree_path_up (tmp);
1846         
1847         if (!gtk_tree_model_get_iter (GTK_TREE_MODEL (drag_dest),
1848                                       &iter, tmp))
1849           goto out;
1850       }
1851   }
1852   
1853   /* Can otherwise drop anywhere. */
1854   retval = TRUE;
1855
1856  out:
1857
1858   if (src_path)
1859     gtk_tree_path_free (src_path);
1860   if (tmp)
1861     gtk_tree_path_free (tmp);
1862
1863   return retval;
1864 }
1865
1866 /* Sorting and reordering */
1867 typedef struct _SortTuple
1868 {
1869   gint offset;
1870   GNode *node;
1871 } SortTuple;
1872
1873 /* Reordering */
1874 static gint
1875 gtk_tree_store_reorder_func (gconstpointer a,
1876                              gconstpointer b,
1877                              gpointer      user_data)
1878 {
1879   SortTuple *a_reorder;
1880   SortTuple *b_reorder;
1881
1882   a_reorder = (SortTuple *)a;
1883   b_reorder = (SortTuple *)b;
1884
1885   if (a_reorder->offset < b_reorder->offset)
1886     return -1;
1887   if (a_reorder->offset > b_reorder->offset)
1888     return 1;
1889
1890   return 0;
1891 }
1892
1893 /**
1894  * gtk_tree_store_reorder:
1895  * @tree_store: A #GtkTreeStore.
1896  * @parent: A #GtkTreeIter.
1897  * @new_order: An integer array indication the new order for the list.
1898  *
1899  * Reorders the children of @parent in @tree_store to follow the order
1900  * indicated by @new_order. Note that this function only works with
1901  * unsorted stores.
1902  **/
1903 void
1904 gtk_tree_store_reorder (GtkTreeStore *tree_store,
1905                         GtkTreeIter  *parent,
1906                         gint         *new_order)
1907 {
1908   gint i, length = 0;
1909   GNode *level, *node;
1910   GtkTreePath *path;
1911   SortTuple *sort_array;
1912
1913   g_return_if_fail (GTK_IS_TREE_STORE (tree_store));
1914   g_return_if_fail (!GTK_TREE_STORE_IS_SORTED (tree_store));
1915   g_return_if_fail (parent == NULL || VALID_ITER (parent, tree_store));
1916   g_return_if_fail (new_order != NULL);
1917
1918   if (!parent)
1919     level = G_NODE (tree_store->root)->children;
1920   else
1921     level = G_NODE (parent->user_data)->children;
1922
1923   /* count nodes */
1924   node = level;
1925   while (node)
1926     {
1927       length++;
1928       node = node->next;
1929     }
1930
1931   /* set up sortarray */
1932   sort_array = g_new (SortTuple, length);
1933
1934   node = level;
1935   for (i = 0; i < length; i++)
1936     {
1937       sort_array[i].offset = new_order[i];
1938       sort_array[i].node = node;
1939
1940       node = node->next;
1941     }
1942
1943   g_qsort_with_data (sort_array,
1944                      length,
1945                      sizeof (SortTuple),
1946                      gtk_tree_store_reorder_func,
1947                      NULL);
1948
1949   /* fix up level */
1950   for (i = 0; i < length - 1; i++)
1951     {
1952       sort_array[i].node->next = sort_array[i+1].node;
1953       sort_array[i+1].node->prev = sort_array[i].node;
1954     }
1955
1956   sort_array[length-1].node->next = NULL;
1957   sort_array[0].node->prev = NULL;
1958   if (parent)
1959     G_NODE (parent->user_data)->children = sort_array[0].node;
1960   else
1961     G_NODE (tree_store->root)->children = sort_array[0].node;
1962
1963   /* emit signal */
1964   if (parent)
1965     path = gtk_tree_model_get_path (GTK_TREE_MODEL (tree_store), parent);
1966   else
1967     path = gtk_tree_path_new ();
1968   gtk_tree_model_rows_reordered (GTK_TREE_MODEL (tree_store), path,
1969                                  parent, new_order);
1970   gtk_tree_path_free (path);
1971   g_free (sort_array);
1972 }
1973
1974 /**
1975  * gtk_tree_store_swap:
1976  * @tree_store: A #GtkTreeStore.
1977  * @a: A #GtkTreeIter.
1978  * @b: Another #GtkTreeIter.
1979  *
1980  * Swaps @a and @b in the same level of @tree_store. Note that this function
1981  * only works with unsorted stores.
1982  **/
1983 void
1984 gtk_tree_store_swap (GtkTreeStore *tree_store,
1985                      GtkTreeIter  *a,
1986                      GtkTreeIter  *b)
1987 {
1988   GNode *tmp, *node_a, *node_b, *parent_node;
1989   GNode *a_prev, *a_next, *b_prev, *b_next;
1990   gint i, a_count, b_count, length, *order;
1991   GtkTreePath *path_a, *path_b;
1992   GtkTreeIter parent;
1993
1994   g_return_if_fail (GTK_IS_TREE_STORE (tree_store));
1995   g_return_if_fail (VALID_ITER (a, tree_store));
1996   g_return_if_fail (VALID_ITER (b, tree_store));
1997
1998   node_a = G_NODE (a->user_data);
1999   node_b = G_NODE (b->user_data);
2000
2001   /* basic sanity checking */
2002   if (node_a == node_b)
2003     return;
2004
2005   path_a = gtk_tree_model_get_path (GTK_TREE_MODEL (tree_store), a);
2006   path_b = gtk_tree_model_get_path (GTK_TREE_MODEL (tree_store), b);
2007
2008   g_return_if_fail (path_a && path_b);
2009
2010   gtk_tree_path_up (path_a);
2011   gtk_tree_path_up (path_b);
2012
2013   if (gtk_tree_path_compare (path_a, path_b))
2014     {
2015       gtk_tree_path_free (path_a);
2016       gtk_tree_path_free (path_b);
2017
2018       g_warning ("Given childs are not in the same level\n");
2019       return;
2020     }
2021
2022   gtk_tree_model_get_iter (GTK_TREE_MODEL (tree_store), &parent, path_a);
2023   parent_node = G_NODE (parent.user_data);
2024
2025   gtk_tree_path_free (path_b);
2026
2027   /* old links which we have to keep around */
2028   a_prev = node_a->prev;
2029   a_next = node_a->next;
2030
2031   b_prev = node_b->prev;
2032   b_next = node_b->next;
2033
2034   /* fix up links if the nodes are next to eachother */
2035   if (a_prev == node_b)
2036     a_prev = node_a;
2037   if (a_next == node_b)
2038     a_next = node_a;
2039
2040   if (b_prev == node_a)
2041     b_prev = node_b;
2042   if (b_next == node_a)
2043     b_next = node_b;
2044
2045   /* counting nodes */
2046   tmp = parent_node->children;
2047   i = a_count = b_count = 0;
2048   while (tmp)
2049     {
2050       if (tmp == node_a)
2051         a_count = i;
2052       if (tmp == node_b)
2053         b_count = i;
2054
2055       tmp = tmp->next;
2056       i++;
2057     }
2058   length = i;
2059
2060   /* hacking the tree */
2061   if (!a_prev)
2062     parent_node->children = node_b;
2063   else
2064     a_prev->next = node_b;
2065
2066   if (a_next)
2067     a_next->prev = node_b;
2068
2069   if (!b_prev)
2070     parent_node->children = node_a;
2071   else
2072     b_prev->next = node_a;
2073
2074   if (b_next)
2075     b_next->prev = node_a;
2076
2077   node_a->prev = b_prev;
2078   node_a->next = b_next;
2079
2080   node_b->prev = a_prev;
2081   node_b->next = a_next;
2082
2083   /* emit signal */
2084   order = g_new (gint, length);
2085   for (i = 0; i < length; i++)
2086     if (i == a_count)
2087       order[i] = b_count;
2088     else if (i == b_count)
2089       order[i] = a_count;
2090     else
2091       order[i] = i;
2092
2093   gtk_tree_model_rows_reordered (GTK_TREE_MODEL (tree_store), path_a,
2094                                  &parent, order);
2095   gtk_tree_path_free (path_a);
2096   g_free (order);
2097 }
2098
2099 /* WARNING: this function is *incredibly* fragily. Please smashtest after
2100  * making changes here.
2101  *      -Kris
2102  */
2103 static void
2104 gtk_tree_store_move (GtkTreeStore *tree_store,
2105                      GtkTreeIter  *iter,
2106                      GtkTreeIter  *position,
2107                      gboolean      before)
2108 {
2109   GNode *parent, *node, *a, *b, *tmp, *tmp_a, *tmp_b;
2110   gint old_pos, new_pos, length, i, *order;
2111   GtkTreePath *path = NULL, *tmppath, *pos_path = NULL;
2112   GtkTreeIter parent_iter, dst_a, dst_b;
2113   gint depth = 0;
2114   gboolean handle_b = TRUE;
2115
2116   g_return_if_fail (GTK_IS_TREE_STORE (tree_store));
2117   g_return_if_fail (!GTK_TREE_STORE_IS_SORTED (tree_store));
2118   g_return_if_fail (VALID_ITER (iter, tree_store));
2119   if (position)
2120     g_return_if_fail (VALID_ITER (position, tree_store));
2121
2122   a = b = NULL;
2123
2124   /* sanity checks */
2125   if (position)
2126     {
2127       path = gtk_tree_model_get_path (GTK_TREE_MODEL (tree_store), iter);
2128       pos_path = gtk_tree_model_get_path (GTK_TREE_MODEL (tree_store),
2129                                           position);
2130
2131       /* if before:
2132        *   moving the iter before path or "path + 1" doesn't make sense
2133        * else
2134        *   moving the iter before path or "path - 1" doesn't make sense
2135        */
2136       if (!gtk_tree_path_compare (path, pos_path))
2137         goto free_paths_and_out;
2138
2139       if (before)
2140         gtk_tree_path_next (path);
2141       else
2142         gtk_tree_path_prev (path);
2143
2144       if (!gtk_tree_path_compare (path, pos_path))
2145         goto free_paths_and_out;
2146
2147       if (before)
2148         gtk_tree_path_prev (path);
2149       else
2150         gtk_tree_path_next (path);
2151
2152       if (gtk_tree_path_get_depth (path) != gtk_tree_path_get_depth (pos_path))
2153         {
2154           g_warning ("Given childs are not in the same level\n");
2155
2156           goto free_paths_and_out;
2157         }
2158
2159       tmppath = gtk_tree_path_copy (pos_path);
2160       gtk_tree_path_up (path);
2161       gtk_tree_path_up (tmppath);
2162
2163       if (gtk_tree_path_get_depth (path) > 0 &&
2164           gtk_tree_path_compare (path, tmppath))
2165         {
2166           g_warning ("Given childs are not in the same level\n");
2167
2168           gtk_tree_path_free (tmppath);
2169           goto free_paths_and_out;
2170         }
2171
2172       gtk_tree_path_free (tmppath);
2173     }
2174
2175   if (!path)
2176     {
2177       path = gtk_tree_model_get_path (GTK_TREE_MODEL (tree_store), iter);
2178       gtk_tree_path_up (path);
2179     }
2180
2181   depth = gtk_tree_path_get_depth (path);
2182
2183   if (depth)
2184     {
2185       gtk_tree_model_get_iter (GTK_TREE_MODEL (tree_store), &parent_iter, path);
2186       gtk_tree_path_free (path);
2187
2188       parent = G_NODE (parent_iter.user_data);
2189     }
2190   else
2191     parent = G_NODE (tree_store->root);
2192
2193   /* yes, I know that this can be done shorter, but I'm doing it this way
2194    * so the code is also maintainable
2195    */
2196
2197   if (before && position)
2198     {
2199       b = G_NODE (position->user_data);
2200
2201       if (gtk_tree_path_get_indices (pos_path)[gtk_tree_path_get_depth (pos_path) - 1] > 0)
2202         {
2203           gtk_tree_path_prev (pos_path);
2204           if (gtk_tree_model_get_iter (GTK_TREE_MODEL (tree_store), &dst_a, pos_path))
2205             a = G_NODE (dst_a.user_data);
2206           else
2207             a = NULL;
2208           gtk_tree_path_next (pos_path);
2209         }
2210
2211       /* if b is NULL, a is NULL too -- we are at the beginning of the list
2212        * yes and we leak memory here ...
2213        */
2214       g_return_if_fail (b);
2215     }
2216   else if (before && !position)
2217     {
2218       /* move before without position is appending */
2219       a = NULL;
2220       b = NULL;
2221     }
2222   else /* !before */
2223     {
2224       if (position)
2225         a = G_NODE (position->user_data);
2226       else
2227         a = NULL;
2228
2229       if (position)
2230         {
2231           gtk_tree_path_next (pos_path);
2232           if (gtk_tree_model_get_iter (GTK_TREE_MODEL (tree_store), &dst_b, pos_path))
2233              b = G_NODE (dst_b.user_data);
2234           else
2235              b = NULL;
2236           gtk_tree_path_prev (pos_path);
2237         }
2238       else
2239         {
2240           /* move after without position is prepending */
2241           if (depth)
2242             gtk_tree_model_iter_children (GTK_TREE_MODEL (tree_store), &dst_b,
2243                                           &parent_iter);
2244           else
2245             gtk_tree_model_iter_children (GTK_TREE_MODEL (tree_store), &dst_b,
2246                                           NULL);
2247
2248           b = G_NODE (dst_b.user_data);
2249         }
2250
2251       /* if a is NULL, a is NULL too -- we are at the end of the list
2252        * yes and we leak memory here ...
2253        */
2254       if (position)
2255         g_return_if_fail (a);
2256     }
2257
2258   /* counting nodes */
2259   tmp = parent->children;
2260
2261   length = old_pos = 0;
2262   while (tmp)
2263     {
2264       if (tmp == iter->user_data)
2265         old_pos = length;
2266
2267       tmp = tmp->next;
2268       length++;
2269     }
2270
2271   /* remove node from list */
2272   node = G_NODE (iter->user_data);
2273   tmp_a = node->prev;
2274   tmp_b = node->next;
2275
2276   if (tmp_a)
2277     tmp_a->next = tmp_b;
2278   else
2279     parent->children = tmp_b;
2280
2281   if (tmp_b)
2282     tmp_b->prev = tmp_a;
2283
2284   /* and reinsert the node */
2285   if (a)
2286     {
2287       tmp = a->next;
2288
2289       a->next = node;
2290       node->next = tmp;
2291       node->prev = a;
2292     }
2293   else if (!a && !before)
2294     {
2295       tmp = parent->children;
2296
2297       node->prev = NULL;
2298       parent->children = node;
2299
2300       node->next = tmp;
2301       tmp->prev = node;
2302
2303       handle_b = FALSE;
2304     }
2305   else if (!a && before)
2306     {
2307       if (!position)
2308         {
2309           node->parent = NULL;
2310           node->next = node->prev = NULL;
2311
2312           /* before with sibling = NULL appends */
2313           g_node_insert_before (parent, NULL, node);
2314         }
2315       else
2316         {
2317           node->parent = NULL;
2318           node->next = node->prev = NULL;
2319
2320           /* after with sibling = NULL prepends */
2321           g_node_insert_after (parent, NULL, node);
2322         }
2323     }
2324
2325   if (handle_b)
2326     {
2327       if (b)
2328         {
2329           tmp = b->prev;
2330
2331           b->prev = node;
2332           node->prev = tmp;
2333           node->next = b;
2334         }
2335       else if (!(!a && before)) /* !a && before is completely handled above */
2336         node->next = NULL;
2337     }
2338
2339   /* emit signal */
2340   if (position)
2341     new_pos = gtk_tree_path_get_indices (pos_path)[gtk_tree_path_get_depth (pos_path)-1];
2342   else if (before)
2343     {
2344       if (depth)
2345         new_pos = gtk_tree_model_iter_n_children (GTK_TREE_MODEL (tree_store),
2346                                                   &parent_iter) - 1;
2347       else
2348         new_pos = gtk_tree_model_iter_n_children (GTK_TREE_MODEL (tree_store),
2349                                                   NULL) - 1;
2350     }
2351   else
2352     new_pos = 0;
2353
2354   if (new_pos > old_pos)
2355     {
2356       if (before && position)
2357         new_pos--;
2358     }
2359   else
2360     {
2361       if (!before && position)
2362         new_pos++;
2363     }
2364
2365   order = g_new (gint, length);
2366   if (new_pos > old_pos)
2367     {
2368       for (i = 0; i < length; i++)
2369         if (i < old_pos)
2370           order[i] = i;
2371         else if (i >= old_pos && i < new_pos)
2372           order[i] = i + 1;
2373         else if (i == new_pos)
2374           order[i] = old_pos;
2375         else
2376           order[i] = i;
2377     }
2378   else
2379     {
2380       for (i = 0; i < length; i++)
2381         if (i == new_pos)
2382           order[i] = old_pos;
2383         else if (i > new_pos && i <= old_pos)
2384           order[i] = i - 1;
2385         else
2386           order[i] = i;
2387     }
2388
2389   path = gtk_tree_path_new ();
2390   gtk_tree_model_rows_reordered (GTK_TREE_MODEL (tree_store),
2391                                  path, NULL, order);
2392
2393   for (i = 0; i < length; i++)
2394     g_print ("%2d ", order[i]);
2395   g_print ("\n");
2396
2397   gtk_tree_path_free (path);
2398   if (position)
2399     gtk_tree_path_free (pos_path);
2400   g_free (order);
2401
2402   return;
2403
2404 free_paths_and_out:
2405   gtk_tree_path_free (path);
2406   gtk_tree_path_free (pos_path);
2407 }
2408
2409 /**
2410  * gtk_tree_store_move_before:
2411  * @tree_store: A #GtkTreeStore.
2412  * @iter: A #GtkTreeIter.
2413  * @position: A #GtkTreeIter or %NULL.
2414  *
2415  * Moves @iter in @tree_store to the position before @position. @iter and
2416  * @position should be in the same level. Note that this function only
2417  * works with unsorted stores. If @position is %NULL, @iter will be
2418  * moved to the end of the level.
2419  **/
2420 void
2421 gtk_tree_store_move_before (GtkTreeStore *tree_store,
2422                             GtkTreeIter  *iter,
2423                             GtkTreeIter  *position)
2424 {
2425   gtk_tree_store_move (tree_store, iter, position, TRUE);
2426 }
2427
2428 /**
2429  * gtk_tree_store_move_after:
2430  * @tree_store: A #GtkTreeStore.
2431  * @iter: A #GtkTreeIter.
2432  * @position: A #GtkTreeIter.
2433  *
2434  * Moves @iter in @tree_store to the position after @position. @iter and
2435  * @position should be in the same level. Note that this function only
2436  * works with unsorted stores. If @position is %NULL, @iter will be moved
2437  * to the start of the level.
2438  **/
2439 void
2440 gtk_tree_store_move_after (GtkTreeStore *tree_store,
2441                            GtkTreeIter  *iter,
2442                            GtkTreeIter  *position)
2443 {
2444   gtk_tree_store_move (tree_store, iter, position, FALSE);
2445 }
2446
2447 /* Sorting */
2448 static gint
2449 gtk_tree_store_compare_func (gconstpointer a,
2450                              gconstpointer b,
2451                              gpointer      user_data)
2452 {
2453   GtkTreeStore *tree_store = user_data;
2454   GNode *node_a;
2455   GNode *node_b;
2456   GtkTreeIterCompareFunc func;
2457   gpointer data;
2458
2459   GtkTreeIter iter_a;
2460   GtkTreeIter iter_b;
2461   gint retval;
2462
2463   if (tree_store->sort_column_id != -1)
2464     {
2465       GtkTreeDataSortHeader *header;
2466
2467       header = _gtk_tree_data_list_get_header (tree_store->sort_list,
2468                                                tree_store->sort_column_id);
2469       g_return_val_if_fail (header != NULL, 0);
2470       g_return_val_if_fail (header->func != NULL, 0);
2471
2472       func = header->func;
2473       data = header->data;
2474     }
2475   else
2476     {
2477       g_return_val_if_fail (tree_store->default_sort_func != NULL, 0);
2478       func = tree_store->default_sort_func;
2479       data = tree_store->default_sort_data;
2480     }
2481
2482   node_a = ((SortTuple *) a)->node;
2483   node_b = ((SortTuple *) b)->node;
2484
2485   iter_a.stamp = tree_store->stamp;
2486   iter_a.user_data = node_a;
2487   iter_b.stamp = tree_store->stamp;
2488   iter_b.user_data = node_b;
2489
2490   retval = (* func) (GTK_TREE_MODEL (user_data), &iter_a, &iter_b, data);
2491
2492   if (tree_store->order == GTK_SORT_DESCENDING)
2493     {
2494       if (retval > 0)
2495         retval = -1;
2496       else if (retval < 0)
2497         retval = 1;
2498     }
2499   return retval;
2500 }
2501
2502 static void
2503 gtk_tree_store_sort_helper (GtkTreeStore *tree_store,
2504                             GNode        *parent,
2505                             gboolean      recurse)
2506 {
2507   GtkTreeIter iter;
2508   GArray *sort_array;
2509   GNode *node;
2510   GNode *tmp_node;
2511   gint list_length;
2512   gint i;
2513   gint *new_order;
2514   GtkTreePath *path;
2515
2516   node = parent->children;
2517   if (node == NULL || node->next == NULL)
2518     return;
2519
2520   g_assert (GTK_TREE_STORE_IS_SORTED (tree_store));
2521
2522   list_length = 0;
2523   for (tmp_node = node; tmp_node; tmp_node = tmp_node->next)
2524     list_length++;
2525
2526   sort_array = g_array_sized_new (FALSE, FALSE, sizeof (SortTuple), list_length);
2527
2528   i = 0;
2529   for (tmp_node = node; tmp_node; tmp_node = tmp_node->next)
2530     {
2531       SortTuple tuple;
2532
2533       tuple.offset = i;
2534       tuple.node = tmp_node;
2535       g_array_append_val (sort_array, tuple);
2536       i++;
2537     }
2538
2539   /* Sort the array */
2540   g_array_sort_with_data (sort_array, gtk_tree_store_compare_func, tree_store);
2541
2542   for (i = 0; i < list_length - 1; i++)
2543     {
2544       g_array_index (sort_array, SortTuple, i).node->next =
2545         g_array_index (sort_array, SortTuple, i + 1).node;
2546       g_array_index (sort_array, SortTuple, i + 1).node->prev =
2547         g_array_index (sort_array, SortTuple, i).node;
2548     }
2549   g_array_index (sort_array, SortTuple, list_length - 1).node->next = NULL;
2550   g_array_index (sort_array, SortTuple, 0).node->prev = NULL;
2551   parent->children = g_array_index (sort_array, SortTuple, 0).node;
2552
2553   /* Let the world know about our new order */
2554   new_order = g_new (gint, list_length);
2555   for (i = 0; i < list_length; i++)
2556     new_order[i] = g_array_index (sort_array, SortTuple, i).offset;
2557
2558   iter.stamp = tree_store->stamp;
2559   iter.user_data = parent;
2560   path = gtk_tree_store_get_path (GTK_TREE_MODEL (tree_store), &iter);
2561   gtk_tree_model_rows_reordered (GTK_TREE_MODEL (tree_store),
2562                                  path, &iter, new_order);
2563   gtk_tree_path_free (path);
2564   g_free (new_order);
2565   g_array_free (sort_array, TRUE);
2566
2567   if (recurse)
2568     {
2569       for (tmp_node = parent->children; tmp_node; tmp_node = tmp_node->next)
2570         {
2571           if (tmp_node->children)
2572             gtk_tree_store_sort_helper (tree_store, tmp_node, TRUE);
2573         }
2574     }
2575 }
2576
2577 static void
2578 gtk_tree_store_sort (GtkTreeStore *tree_store)
2579 {
2580   if (tree_store->sort_column_id != -1)
2581     {
2582       GtkTreeDataSortHeader *header = NULL;
2583
2584       header = _gtk_tree_data_list_get_header (tree_store->sort_list, tree_store->sort_column_id);
2585
2586       /* We want to make sure that we have a function */
2587       g_return_if_fail (header != NULL);
2588       g_return_if_fail (header->func != NULL);
2589     }
2590   else
2591     {
2592       g_return_if_fail (tree_store->default_sort_func != NULL);
2593     }
2594
2595   gtk_tree_store_sort_helper (tree_store, G_NODE (tree_store->root), TRUE);
2596 }
2597
2598 static void
2599 gtk_tree_store_sort_iter_changed (GtkTreeStore *tree_store,
2600                                   GtkTreeIter  *iter,
2601                                   gint          column)
2602 {
2603   GNode *prev = NULL;
2604   GNode *next = NULL;
2605   GNode *node;
2606   GtkTreePath *tmp_path;
2607   GtkTreeIter tmp_iter;
2608   gint cmp_a = 0;
2609   gint cmp_b = 0;
2610   gint i;
2611   gint old_location;
2612   gint new_location;
2613   gint *new_order;
2614   gint length;
2615   GtkTreeIterCompareFunc func;
2616   gpointer data;
2617
2618   g_return_if_fail (G_NODE (iter->user_data)->parent != NULL);
2619
2620   tmp_iter.stamp = tree_store->stamp;
2621   if (tree_store->sort_column_id != -1)
2622     {
2623       GtkTreeDataSortHeader *header;
2624       header = _gtk_tree_data_list_get_header (tree_store->sort_list,
2625                                                tree_store->sort_column_id);
2626       g_return_if_fail (header != NULL);
2627       g_return_if_fail (header->func != NULL);
2628       func = header->func;
2629       data = header->data;
2630     }
2631   else
2632     {
2633       g_return_if_fail (tree_store->default_sort_func != NULL);
2634       func = tree_store->default_sort_func;
2635       data = tree_store->default_sort_data;
2636     }
2637
2638   /* If it's the built in function, we don't sort. */
2639   if (func == gtk_tree_data_list_compare_func &&
2640       tree_store->sort_column_id != column)
2641     return;
2642
2643   old_location = 0;
2644   node = G_NODE (iter->user_data)->parent->children;
2645   /* First we find the iter, its prev, and its next */
2646   while (node)
2647     {
2648       if (node == G_NODE (iter->user_data))
2649         break;
2650       old_location++;
2651       node = node->next;
2652     }
2653   g_assert (node != NULL);
2654
2655   prev = node->prev;
2656   next = node->next;
2657
2658   /* Check the common case, where we don't need to sort it moved. */
2659   if (prev != NULL)
2660     {
2661       tmp_iter.user_data = prev;
2662       cmp_a = (* func) (GTK_TREE_MODEL (tree_store), &tmp_iter, iter, data);
2663     }
2664
2665   if (next != NULL)
2666     {
2667       tmp_iter.user_data = next;
2668       cmp_b = (* func) (GTK_TREE_MODEL (tree_store), iter, &tmp_iter, data);
2669     }
2670
2671   if (tree_store->order == GTK_SORT_DESCENDING)
2672     {
2673       if (cmp_a < 0)
2674         cmp_a = 1;
2675       else if (cmp_a > 0)
2676         cmp_a = -1;
2677
2678       if (cmp_b < 0)
2679         cmp_b = 1;
2680       else if (cmp_b > 0)
2681         cmp_b = -1;
2682     }
2683
2684   if (prev == NULL && cmp_b <= 0)
2685     return;
2686   else if (next == NULL && cmp_a <= 0)
2687     return;
2688   else if (prev != NULL && next != NULL &&
2689            cmp_a <= 0 && cmp_b <= 0)
2690     return;
2691
2692   /* We actually need to sort it */
2693   /* First, remove the old link. */
2694
2695   if (prev)
2696     prev->next = next;
2697   else
2698     node->parent->children = next;
2699
2700   if (next)
2701     next->prev = prev;
2702
2703   node->prev = NULL;
2704   node->next = NULL;
2705
2706   /* FIXME: as an optimization, we can potentially start at next */
2707   prev = NULL;
2708   node = node->parent->children;
2709   new_location = 0;
2710   tmp_iter.user_data = node;
2711   if (tree_store->order == GTK_SORT_DESCENDING)
2712     cmp_a = (* func) (GTK_TREE_MODEL (tree_store), &tmp_iter, iter, data);
2713   else
2714     cmp_a = (* func) (GTK_TREE_MODEL (tree_store), iter, &tmp_iter, data);
2715
2716   while ((node->next) && (cmp_a > 0))
2717     {
2718       prev = node;
2719       node = node->next;
2720       new_location++;
2721       tmp_iter.user_data = node;
2722       if (tree_store->order == GTK_SORT_DESCENDING)
2723         cmp_a = (* func) (GTK_TREE_MODEL (tree_store), &tmp_iter, iter, data);
2724       else
2725         cmp_a = (* func) (GTK_TREE_MODEL (tree_store), iter, &tmp_iter, data);
2726     }
2727
2728   if ((!node->next) && (cmp_a > 0))
2729     {
2730       new_location++;
2731       node->next = G_NODE (iter->user_data);
2732       node->next->prev = node;
2733     }
2734   else if (prev)
2735     {
2736       prev->next = G_NODE (iter->user_data);
2737       prev->next->prev = prev;
2738       G_NODE (iter->user_data)->next = node;
2739       G_NODE (iter->user_data)->next->prev = G_NODE (iter->user_data);
2740     }
2741   else
2742     {
2743       G_NODE (iter->user_data)->next = G_NODE (iter->user_data)->parent->children;
2744       G_NODE (iter->user_data)->next->prev = G_NODE (iter->user_data);
2745       G_NODE (iter->user_data)->parent->children = G_NODE (iter->user_data);
2746     }
2747
2748   /* Emit the reordered signal. */
2749   length = g_node_n_children (node->parent);
2750   new_order = g_new (int, length);
2751   if (old_location < new_location)
2752     for (i = 0; i < length; i++)
2753       {
2754         if (i < old_location ||
2755             i > new_location)
2756           new_order[i] = i;
2757         else if (i >= old_location &&
2758                  i < new_location)
2759           new_order[i] = i + 1;
2760         else if (i == new_location)
2761           new_order[i] = old_location;
2762       }
2763   else
2764     for (i = 0; i < length; i++)
2765       {
2766         if (i < new_location ||
2767             i > old_location)
2768           new_order[i] = i;
2769         else if (i > new_location &&
2770                  i <= old_location)
2771           new_order[i] = i - 1;
2772         else if (i == new_location)
2773           new_order[i] = old_location;
2774       }
2775
2776   tmp_iter.user_data = node->parent;
2777   tmp_path = gtk_tree_store_get_path (GTK_TREE_MODEL (tree_store), &tmp_iter);
2778
2779   gtk_tree_model_rows_reordered (GTK_TREE_MODEL (tree_store),
2780                                  tmp_path, &tmp_iter,
2781                                  new_order);
2782
2783   gtk_tree_path_free (tmp_path);
2784   g_free (new_order);
2785 }
2786
2787
2788 static gboolean
2789 gtk_tree_store_get_sort_column_id (GtkTreeSortable  *sortable,
2790                                    gint             *sort_column_id,
2791                                    GtkSortType      *order)
2792 {
2793   GtkTreeStore *tree_store = (GtkTreeStore *) sortable;
2794
2795   g_return_val_if_fail (GTK_IS_TREE_STORE (sortable), FALSE);
2796
2797   if (tree_store->sort_column_id == -1)
2798     return FALSE;
2799
2800   if (sort_column_id)
2801     * sort_column_id = tree_store->sort_column_id;
2802   if (order)
2803     * order = tree_store->order;
2804   return TRUE;
2805
2806 }
2807
2808 static void
2809 gtk_tree_store_set_sort_column_id (GtkTreeSortable  *sortable,
2810                                    gint              sort_column_id,
2811                                    GtkSortType       order)
2812 {
2813   GtkTreeStore *tree_store = (GtkTreeStore *) sortable;
2814
2815   g_return_if_fail (GTK_IS_TREE_STORE (sortable));
2816
2817   
2818   if ((tree_store->sort_column_id == sort_column_id) &&
2819       (tree_store->order == order))
2820     return;
2821
2822   if (sort_column_id != -1)
2823     {
2824       GtkTreeDataSortHeader *header = NULL;
2825
2826       header = _gtk_tree_data_list_get_header (tree_store->sort_list, sort_column_id);
2827
2828       /* We want to make sure that we have a function */
2829       g_return_if_fail (header != NULL);
2830       g_return_if_fail (header->func != NULL);
2831     }
2832   else
2833     {
2834       g_return_if_fail (tree_store->default_sort_func != NULL);
2835     }
2836
2837   tree_store->sort_column_id = sort_column_id;
2838   tree_store->order = order;
2839
2840   gtk_tree_store_sort (tree_store);
2841
2842   gtk_tree_sortable_sort_column_changed (sortable);
2843 }
2844
2845 static void
2846 gtk_tree_store_set_sort_func (GtkTreeSortable        *sortable,
2847                               gint                    sort_column_id,
2848                               GtkTreeIterCompareFunc  func,
2849                               gpointer                data,
2850                               GtkDestroyNotify        destroy)
2851 {
2852   GtkTreeStore *tree_store = (GtkTreeStore *) sortable;
2853   GtkTreeDataSortHeader *header = NULL;
2854   GList *list;
2855
2856   g_return_if_fail (GTK_IS_TREE_STORE (sortable));
2857   g_return_if_fail (func != NULL);
2858
2859   for (list = tree_store->sort_list; list; list = list->next)
2860     {
2861       GtkTreeDataSortHeader *list_header;
2862
2863       list_header = (GtkTreeDataSortHeader*) list->data;
2864       if (list_header->sort_column_id == sort_column_id)
2865         {
2866           header = list_header;
2867           break;
2868         }
2869     }
2870
2871   if (header == NULL)
2872     {
2873       header = g_new0 (GtkTreeDataSortHeader, 1);
2874       header->sort_column_id = sort_column_id;
2875       tree_store->sort_list = g_list_append (tree_store->sort_list, header);
2876     }
2877
2878   if (header->destroy)
2879     {
2880       GtkDestroyNotify d = header->destroy;
2881
2882       header->destroy = NULL;
2883       d (header->data);
2884     }
2885
2886   header->func = func;
2887   header->data = data;
2888   header->destroy = destroy;
2889 }
2890
2891 static void
2892 gtk_tree_store_set_default_sort_func (GtkTreeSortable        *sortable,
2893                                       GtkTreeIterCompareFunc  func,
2894                                       gpointer                data,
2895                                       GtkDestroyNotify        destroy)
2896 {
2897   GtkTreeStore *tree_store = (GtkTreeStore *) sortable;
2898
2899   g_return_if_fail (GTK_IS_TREE_STORE (sortable));
2900
2901   if (tree_store->default_sort_destroy)
2902     {
2903       GtkDestroyNotify d = tree_store->default_sort_destroy;
2904
2905       tree_store->default_sort_destroy = NULL;
2906       d (tree_store->default_sort_data);
2907     }
2908
2909   tree_store->default_sort_func = func;
2910   tree_store->default_sort_data = data;
2911   tree_store->default_sort_destroy = destroy;
2912 }
2913
2914 static gboolean
2915 gtk_tree_store_has_default_sort_func (GtkTreeSortable *sortable)
2916 {
2917   GtkTreeStore *tree_store = (GtkTreeStore *) sortable;
2918
2919   g_return_val_if_fail (GTK_IS_TREE_STORE (sortable), FALSE);
2920
2921   return (tree_store->default_sort_func != NULL);
2922 }
2923
2924 static void
2925 validate_gnode (GNode* node)
2926 {
2927   GNode *iter;
2928
2929   iter = node->children;
2930   while (iter != NULL)
2931     {
2932       g_assert (iter->parent == node);
2933       if (iter->prev)
2934         g_assert (iter->prev->next == iter);
2935       validate_gnode (iter);
2936       iter = iter->next;
2937     }
2938 }
2939
2940
2941