/* gtktreemodelsort.c * Copyright (C) 2000,2001 Red Hat, Inc., Jonathan Blandford * Copyright (C) 2001,2002 Kristian Rietveld * * This library is free software; you can redistribute it and/or * modify it under the terms of the GNU Library General Public * License as published by the Free Software Foundation; either * version 2 of the License, or (at your option) any later version. * * This library is distributed in the hope that it will be useful, * but WITHOUT ANY WARRANTY; without even the implied warranty of * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU * Library General Public License for more details. * * You should have received a copy of the GNU Library General Public * License along with this library; if not, write to the * Free Software Foundation, Inc., 59 Temple Place - Suite 330, * Boston, MA 02111-1307, USA. */ /* NOTE: There is a potential for confusion in this code as to whether an iter, * path or value refers to the GtkTreeModelSort model, or the child model being * sorted. As a convention, variables referencing the child model will have an * s_ prefix before them (ie. s_iter, s_value, s_path); */ /* ITER FORMAT: * * iter->stamp = tree_model_sort->stamp * iter->user_data = SortLevel * iter->user_data2 = SortElt */ /* WARNING: this code is dangerous, can cause sleepless nights, * can cause your dog to die among other bad things * * we warned you and we're not liable for any head injuries. */ #include "gtktreemodelsort.h" #include "gtktreesortable.h" #include "gtktreestore.h" #include "gtksignal.h" #include "gtktreedatalist.h" #include #include "gtkintl.h" typedef struct _SortElt SortElt; typedef struct _SortLevel SortLevel; typedef struct _SortData SortData; typedef struct _SortTuple SortTuple; struct _SortElt { GtkTreeIter iter; SortLevel *children; gint offset; gint ref_count; gint zero_ref_count; }; struct _SortLevel { GArray *array; gint ref_count; SortElt *parent_elt; SortLevel *parent_level; }; struct _SortData { GtkTreeModelSort *tree_model_sort; GtkTreePath *parent_path; gint parent_path_depth; gint *parent_path_indices; GtkTreeIterCompareFunc sort_func; gpointer sort_data; }; struct _SortTuple { SortElt *elt; gint offset; }; /* Properties */ enum { PROP_0, /* Construct args */ PROP_MODEL }; #define GTK_TREE_MODEL_SORT_CACHE_CHILD_ITERS(tree_model_sort) \ (((GtkTreeModelSort *)tree_model_sort)->child_flags>K_TREE_MODEL_ITERS_PERSIST) #define SORT_ELT(sort_elt) ((SortElt *)sort_elt) #define SORT_LEVEL(sort_level) ((SortLevel *)sort_level) #define GET_CHILD_ITER(tree_model_sort,child_iter,sort_iter) gtk_tree_model_sort_convert_iter_to_child_iter(GTK_TREE_MODEL_SORT (tree_model_sort), child_iter, sort_iter); #define NO_SORT_FUNC ((GtkTreeIterCompareFunc) 0x1) #define VALID_ITER(iter, tree_model_sort) (iter != NULL && iter->user_data != NULL && iter->user_data2 != NULL && tree_model_sort->stamp == iter->stamp) /* general (object/interface init, etc) */ static void gtk_tree_model_sort_init (GtkTreeModelSort *tree_model_sort); static void gtk_tree_model_sort_class_init (GtkTreeModelSortClass *tree_model_sort_class); static void gtk_tree_model_sort_tree_model_init (GtkTreeModelIface *iface); static void gtk_tree_model_sort_tree_sortable_init (GtkTreeSortableIface *iface); static void gtk_tree_model_sort_finalize (GObject *object); static void gtk_tree_model_sort_set_property (GObject *object, guint prop_id, const GValue *value, GParamSpec *pspec); static void gtk_tree_model_sort_get_property (GObject *object, guint prop_id, GValue *value, GParamSpec *pspec); /* our signal handlers */ static void gtk_tree_model_sort_row_changed (GtkTreeModel *model, GtkTreePath *start_path, GtkTreeIter *start_iter, gpointer data); static void gtk_tree_model_sort_row_inserted (GtkTreeModel *model, GtkTreePath *path, GtkTreeIter *iter, gpointer data); static void gtk_tree_model_sort_row_has_child_toggled (GtkTreeModel *model, GtkTreePath *path, GtkTreeIter *iter, gpointer data); static void gtk_tree_model_sort_row_deleted (GtkTreeModel *model, GtkTreePath *path, gpointer data); static void gtk_tree_model_sort_rows_reordered (GtkTreeModel *s_model, GtkTreePath *s_path, GtkTreeIter *s_iter, gint *new_order, gpointer data); /* TreeModel interface */ static GtkTreeModelFlags gtk_tree_model_sort_get_flags (GtkTreeModel *tree_model); static gint gtk_tree_model_sort_get_n_columns (GtkTreeModel *tree_model); static GType gtk_tree_model_sort_get_column_type (GtkTreeModel *tree_model, gint index); static gboolean gtk_tree_model_sort_get_iter (GtkTreeModel *tree_model, GtkTreeIter *iter, GtkTreePath *path); static GtkTreePath *gtk_tree_model_sort_get_path (GtkTreeModel *tree_model, GtkTreeIter *iter); static void gtk_tree_model_sort_get_value (GtkTreeModel *tree_model, GtkTreeIter *iter, gint column, GValue *value); static gboolean gtk_tree_model_sort_iter_next (GtkTreeModel *tree_model, GtkTreeIter *iter); static gboolean gtk_tree_model_sort_iter_children (GtkTreeModel *tree_model, GtkTreeIter *iter, GtkTreeIter *parent); static gboolean gtk_tree_model_sort_iter_has_child (GtkTreeModel *tree_model, GtkTreeIter *iter); static gint gtk_tree_model_sort_iter_n_children (GtkTreeModel *tree_model, GtkTreeIter *iter); static gboolean gtk_tree_model_sort_iter_nth_child (GtkTreeModel *tree_model, GtkTreeIter *iter, GtkTreeIter *parent, gint n); static gboolean gtk_tree_model_sort_iter_parent (GtkTreeModel *tree_model, GtkTreeIter *iter, GtkTreeIter *child); static void gtk_tree_model_sort_ref_node (GtkTreeModel *tree_model, GtkTreeIter *iter); static void gtk_tree_model_sort_real_unref_node (GtkTreeModel *tree_model, GtkTreeIter *iter, gboolean propagate_unref); static void gtk_tree_model_sort_unref_node (GtkTreeModel *tree_model, GtkTreeIter *iter); /* TreeSortable interface */ static gboolean gtk_tree_model_sort_get_sort_column_id (GtkTreeSortable *sortable, gint *sort_column_id, GtkSortType *order); static void gtk_tree_model_sort_set_sort_column_id (GtkTreeSortable *sortable, gint sort_column_id, GtkSortType order); static void gtk_tree_model_sort_set_sort_func (GtkTreeSortable *sortable, gint sort_column_id, GtkTreeIterCompareFunc func, gpointer data, GtkDestroyNotify destroy); static void gtk_tree_model_sort_set_default_sort_func (GtkTreeSortable *sortable, GtkTreeIterCompareFunc func, gpointer data, GtkDestroyNotify destroy); static gboolean gtk_tree_model_sort_has_default_sort_func (GtkTreeSortable *sortable); /* Private functions (sort funcs, level handling and other utils) */ static void gtk_tree_model_sort_build_level (GtkTreeModelSort *tree_model_sort, SortLevel *parent_level, SortElt *parent_elt); static void gtk_tree_model_sort_free_level (GtkTreeModelSort *tree_model_sort, SortLevel *sort_level); static void gtk_tree_model_sort_increment_stamp (GtkTreeModelSort *tree_model_sort); static void gtk_tree_model_sort_sort_level (GtkTreeModelSort *tree_model_sort, SortLevel *level, gboolean recurse, gboolean emit_reordered); static void gtk_tree_model_sort_sort (GtkTreeModelSort *tree_model_sort); static gint gtk_tree_model_sort_level_find_insert (GtkTreeModelSort *tree_model_sort, SortLevel *level, GtkTreeIter *iter, gboolean skip_sort_elt); static gboolean gtk_tree_model_sort_insert_value (GtkTreeModelSort *tree_model_sort, SortLevel *level, GtkTreePath *s_path, GtkTreeIter *s_iter); static GtkTreePath *gtk_tree_model_sort_elt_get_path (SortLevel *level, SortElt *elt); static void gtk_tree_model_sort_set_model (GtkTreeModelSort *tree_model_sort, GtkTreeModel *child_model); static GtkTreePath *gtk_real_tree_model_sort_convert_child_path_to_path (GtkTreeModelSort *tree_model_sort, GtkTreePath *child_path, gboolean build_levels); static GObjectClass *parent_class = NULL; GType gtk_tree_model_sort_get_type (void) { static GType tree_model_sort_type = 0; if (!tree_model_sort_type) { static const GTypeInfo tree_model_sort_info = { sizeof (GtkTreeModelSortClass), NULL, /* base_init */ NULL, /* base_finalize */ (GClassInitFunc) gtk_tree_model_sort_class_init, NULL, /* class_finalize */ NULL, /* class_data */ sizeof (GtkTreeModelSort), 0, /* n_preallocs */ (GInstanceInitFunc) gtk_tree_model_sort_init }; static const GInterfaceInfo tree_model_info = { (GInterfaceInitFunc) gtk_tree_model_sort_tree_model_init, NULL, NULL }; static const GInterfaceInfo sortable_info = { (GInterfaceInitFunc) gtk_tree_model_sort_tree_sortable_init, NULL, NULL }; tree_model_sort_type = g_type_register_static (G_TYPE_OBJECT, "GtkTreeModelSort", &tree_model_sort_info, 0); g_type_add_interface_static (tree_model_sort_type, GTK_TYPE_TREE_MODEL, &tree_model_info); g_type_add_interface_static (tree_model_sort_type, GTK_TYPE_TREE_SORTABLE, &sortable_info); } return tree_model_sort_type; } static void gtk_tree_model_sort_init (GtkTreeModelSort *tree_model_sort) { tree_model_sort->sort_column_id = GTK_TREE_SORTABLE_DEFAULT_SORT_COLUMN_ID; tree_model_sort->stamp = 0; tree_model_sort->zero_ref_count = 0; tree_model_sort->root = NULL; tree_model_sort->sort_list = NULL; } static void gtk_tree_model_sort_class_init (GtkTreeModelSortClass *class) { GObjectClass *object_class; object_class = (GObjectClass *) class; parent_class = g_type_class_peek_parent (class); object_class->set_property = gtk_tree_model_sort_set_property; object_class->get_property = gtk_tree_model_sort_get_property; object_class->finalize = gtk_tree_model_sort_finalize; /* Properties */ g_object_class_install_property (object_class, PROP_MODEL, g_param_spec_object ("model", _("TreeModelSort Model"), _("The model for the TreeModelSort to sort"), GTK_TYPE_TREE_MODEL, G_PARAM_READWRITE | G_PARAM_CONSTRUCT_ONLY)); } static void gtk_tree_model_sort_tree_model_init (GtkTreeModelIface *iface) { iface->get_flags = gtk_tree_model_sort_get_flags; iface->get_n_columns = gtk_tree_model_sort_get_n_columns; iface->get_column_type = gtk_tree_model_sort_get_column_type; iface->get_iter = gtk_tree_model_sort_get_iter; iface->get_path = gtk_tree_model_sort_get_path; iface->get_value = gtk_tree_model_sort_get_value; iface->iter_next = gtk_tree_model_sort_iter_next; iface->iter_children = gtk_tree_model_sort_iter_children; iface->iter_has_child = gtk_tree_model_sort_iter_has_child; iface->iter_n_children = gtk_tree_model_sort_iter_n_children; iface->iter_nth_child = gtk_tree_model_sort_iter_nth_child; iface->iter_parent = gtk_tree_model_sort_iter_parent; iface->ref_node = gtk_tree_model_sort_ref_node; iface->unref_node = gtk_tree_model_sort_unref_node; } static void gtk_tree_model_sort_tree_sortable_init (GtkTreeSortableIface *iface) { iface->get_sort_column_id = gtk_tree_model_sort_get_sort_column_id; iface->set_sort_column_id = gtk_tree_model_sort_set_sort_column_id; iface->set_sort_func = gtk_tree_model_sort_set_sort_func; iface->set_default_sort_func = gtk_tree_model_sort_set_default_sort_func; iface->has_default_sort_func = gtk_tree_model_sort_has_default_sort_func; } /** * gtk_tree_model_sort_new_with_model: * @child_model: A #GtkTreeModel * * Creates a new #GtkTreeModel, with @child_model as the child_model. * * Return value: A new #GtkTreeModel. */ GtkTreeModel * gtk_tree_model_sort_new_with_model (GtkTreeModel *child_model) { GtkTreeModel *retval; g_return_val_if_fail (GTK_IS_TREE_MODEL (child_model), NULL); retval = GTK_TREE_MODEL (g_object_new (gtk_tree_model_sort_get_type (), NULL)); gtk_tree_model_sort_set_model (GTK_TREE_MODEL_SORT (retval), child_model); return retval; } /* GObject callbacks */ static void gtk_tree_model_sort_finalize (GObject *object) { GtkTreeModelSort *tree_model_sort = (GtkTreeModelSort *) object; gtk_tree_model_sort_set_model (tree_model_sort, NULL); if (tree_model_sort->root) gtk_tree_model_sort_free_level (tree_model_sort, tree_model_sort->root); if (tree_model_sort->sort_list) { _gtk_tree_data_list_header_free (tree_model_sort->sort_list); tree_model_sort->sort_list = NULL; } /* must chain up */ parent_class->finalize (object); } static void gtk_tree_model_sort_set_property (GObject *object, guint prop_id, const GValue *value, GParamSpec *pspec) { GtkTreeModelSort *tree_model_sort = GTK_TREE_MODEL_SORT (object); switch (prop_id) { case PROP_MODEL: gtk_tree_model_sort_set_model (tree_model_sort, g_value_get_object (value)); break; default: G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec); break; } } static void gtk_tree_model_sort_get_property (GObject *object, guint prop_id, GValue *value, GParamSpec *pspec) { GtkTreeModelSort *tree_model_sort = GTK_TREE_MODEL_SORT (object); switch (prop_id) { case PROP_MODEL: g_value_set_object (value, gtk_tree_model_sort_get_model(tree_model_sort)); break; default: G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec); break; } } static void gtk_tree_model_sort_row_changed (GtkTreeModel *s_model, GtkTreePath *start_s_path, GtkTreeIter *start_s_iter, gpointer data) { GtkTreeModelSort *tree_model_sort = GTK_TREE_MODEL_SORT (data); GtkTreePath *path = NULL; GtkTreeIter iter; GtkTreeIter tmpiter; SortElt tmp; SortElt *elt; SortLevel *level; gboolean free_s_path = FALSE; gint offset, index = 0, i; g_return_if_fail (start_s_path != NULL || start_s_iter != NULL); if (!start_s_path) { free_s_path = TRUE; start_s_path = gtk_tree_model_get_path (s_model, start_s_iter); } path = gtk_real_tree_model_sort_convert_child_path_to_path (tree_model_sort, start_s_path, FALSE); if (!path) { if (free_s_path) gtk_tree_path_free (start_s_path); return; } gtk_tree_model_get_iter (GTK_TREE_MODEL (data), &iter, path); level = iter.user_data; elt = iter.user_data2; if (level->array->len < 2 || (tree_model_sort->sort_column_id == GTK_TREE_SORTABLE_DEFAULT_SORT_COLUMN_ID && tree_model_sort->default_sort_func == NO_SORT_FUNC)) { if (free_s_path) gtk_tree_path_free (start_s_path); gtk_tree_model_row_changed (GTK_TREE_MODEL (data), path, &iter); gtk_tree_path_free (path); return; } if (!GTK_TREE_MODEL_SORT_CACHE_CHILD_ITERS (tree_model_sort)) { gtk_tree_model_get_iter (tree_model_sort->child_model, &tmpiter, start_s_path); } offset = elt->offset; for (i = 0; i < level->array->len; i++) if (elt->offset == g_array_index (level->array, SortElt, i).offset) index = i; memcpy (&tmp, elt, sizeof (SortElt)); g_array_remove_index (level->array, index); if (GTK_TREE_MODEL_SORT_CACHE_CHILD_ITERS (tree_model_sort)) index = gtk_tree_model_sort_level_find_insert (tree_model_sort, level, &tmp.iter, TRUE); else index = gtk_tree_model_sort_level_find_insert (tree_model_sort, level, &tmpiter, TRUE); g_array_insert_val (level->array, index, tmp); for (i = 0; i < level->array->len; i++) if (g_array_index (level->array, SortElt, i).children) g_array_index (level->array, SortElt, i).children->parent_elt = &g_array_index (level->array, SortElt, i); gtk_tree_path_up (path); gtk_tree_path_append_index (path, index); gtk_tree_model_sort_increment_stamp (tree_model_sort); gtk_tree_model_get_iter (GTK_TREE_MODEL (data), &iter, path); gtk_tree_model_row_changed (GTK_TREE_MODEL (data), path, &iter); gtk_tree_path_free (path); if (free_s_path) gtk_tree_path_free (start_s_path); } static void gtk_tree_model_sort_row_inserted (GtkTreeModel *s_model, GtkTreePath *s_path, GtkTreeIter *s_iter, gpointer data) { GtkTreeModelSort *tree_model_sort = GTK_TREE_MODEL_SORT (data); GtkTreePath *path; GtkTreeIter iter; GtkTreeIter real_s_iter; gint i = 0; gboolean free_s_path = FALSE; SortElt *elt; SortLevel *level; SortLevel *parent_level = NULL; parent_level = level = SORT_LEVEL (tree_model_sort->root); g_return_if_fail (s_path != NULL || s_iter != NULL); if (!s_path) { s_path = gtk_tree_model_get_path (s_model, s_iter); free_s_path = TRUE; } if (!s_iter) gtk_tree_model_get_iter (s_model, &real_s_iter, s_path); else real_s_iter = *s_iter; if (!tree_model_sort->root) { gtk_tree_model_sort_build_level (tree_model_sort, NULL, NULL); /* the build level already put the inserted iter in the level, so no need to handle this signal anymore */ goto done_and_submit; } /* find the parent level */ while (i < gtk_tree_path_get_depth (s_path) - 1) { gint j; if (!level) { /* level not yet build, we won't cover this signal */ goto done; } if (level->array->len < gtk_tree_path_get_indices (s_path)[i]) { g_warning ("A node was inserted with a parent that's not in the tree.\n" "This possibly means that a GtkTreeModel inserted a child node\n" "before the parent was inserted."); goto done; } elt = NULL; for (j = 0; j < level->array->len; j++) if (g_array_index (level->array, SortElt, j).offset == gtk_tree_path_get_indices (s_path)[i]) { elt = &g_array_index (level->array, SortElt, j); break; } g_return_if_fail (elt != NULL); if (!elt->children) { GtkTreePath *tmppath; GtkTreeIter tmpiter; tmpiter.stamp = tree_model_sort->stamp; tmpiter.user_data = level; tmpiter.user_data2 = elt; tmppath = gtk_tree_model_get_path (GTK_TREE_MODEL (data), &tmpiter); if (tmppath) { gtk_tree_model_row_has_child_toggled (GTK_TREE_MODEL (data), tmppath, &tmpiter); gtk_tree_path_free (tmppath); } /* not covering this signal */ goto done; } level = elt->children; parent_level = level; i++; } if (!parent_level) goto done; if (!gtk_tree_model_sort_insert_value (tree_model_sort, parent_level, s_path, &real_s_iter)) goto done; done_and_submit: path = gtk_real_tree_model_sort_convert_child_path_to_path (tree_model_sort, s_path, FALSE); if (!path) return; gtk_tree_model_sort_increment_stamp (tree_model_sort); gtk_tree_model_get_iter (GTK_TREE_MODEL (data), &iter, path); gtk_tree_model_row_inserted (GTK_TREE_MODEL (data), path, &iter); gtk_tree_path_free (path); done: if (free_s_path) gtk_tree_path_free (s_path); return; } static void gtk_tree_model_sort_row_has_child_toggled (GtkTreeModel *s_model, GtkTreePath *s_path, GtkTreeIter *s_iter, gpointer data) { GtkTreeModelSort *tree_model_sort = GTK_TREE_MODEL_SORT (data); GtkTreePath *path; GtkTreeIter iter; g_return_if_fail (s_path != NULL && s_iter != NULL); path = gtk_real_tree_model_sort_convert_child_path_to_path (tree_model_sort, s_path, FALSE); if (path == NULL) return; gtk_tree_model_get_iter (GTK_TREE_MODEL (data), &iter, path); gtk_tree_model_row_has_child_toggled (GTK_TREE_MODEL (data), path, &iter); gtk_tree_path_free (path); } /* FIXME: I still have doubts if this works */ static void gtk_tree_model_sort_row_deleted (GtkTreeModel *s_model, GtkTreePath *s_path, gpointer data) { GtkTreeModelSort *tree_model_sort = GTK_TREE_MODEL_SORT (data); GtkTreePath *path = NULL; SortElt *elt; SortLevel *level; GtkTreeIter iter; gint offset; gint i; g_return_if_fail (s_path != NULL); path = gtk_real_tree_model_sort_convert_child_path_to_path (tree_model_sort, s_path, FALSE); if (path == NULL) return; gtk_tree_model_get_iter (GTK_TREE_MODEL (data), &iter, path); level = SORT_LEVEL (iter.user_data); elt = SORT_ELT (iter.user_data2); offset = elt->offset; /* we _need_ to emit ::row_deleted before we start unreffing the node * itself. This is because of the row refs, which start unreffing nodes * when we emit ::row_deleted */ gtk_tree_model_row_deleted (GTK_TREE_MODEL (data), path); gtk_tree_model_get_iter (GTK_TREE_MODEL (data), &iter, path); while (elt->ref_count > 0) gtk_tree_model_sort_real_unref_node (GTK_TREE_MODEL (data), &iter, FALSE); if (level->ref_count == 0 && level != tree_model_sort->root) { /* This will prune the level, so I can just emit the signal and not worry * about cleaning this level up. */ gtk_tree_model_sort_increment_stamp (tree_model_sort); gtk_tree_path_free (path); return; } gtk_tree_model_sort_increment_stamp (tree_model_sort); /* Remove the row */ for (i = 0; i < level->array->len; i++) if (elt->offset == g_array_index (level->array, SortElt, i).offset) break; g_array_remove_index (level->array, i); /* update all offsets */ for (i = 0; i < level->array->len; i++) { elt = & (g_array_index (level->array, SortElt, i)); if (elt->offset > offset) elt->offset--; if (elt->children) elt->children->parent_elt = elt; } gtk_tree_path_free (path); } static void gtk_tree_model_sort_rows_reordered (GtkTreeModel *s_model, GtkTreePath *s_path, GtkTreeIter *s_iter, gint *new_order, gpointer data) { SortElt *elt; SortLevel *level; GtkTreeIter iter; gint *tmp_array; int i, j; GtkTreePath *path; GtkTreeModelSort *tree_model_sort = GTK_TREE_MODEL_SORT (data); g_return_if_fail (new_order != NULL); if (s_path == NULL || gtk_tree_path_get_indices (s_path) == NULL) { if (tree_model_sort->root == NULL) return; path = gtk_tree_path_new (); level = SORT_LEVEL (tree_model_sort->root); } else { path = gtk_real_tree_model_sort_convert_child_path_to_path (tree_model_sort, s_path, FALSE); if (path == NULL) return; gtk_tree_model_get_iter (GTK_TREE_MODEL (data), &iter, path); level = SORT_LEVEL (iter.user_data); elt = SORT_ELT (iter.user_data2); if (!elt->children) { gtk_tree_path_free (path); return; } level = elt->children; } if (level->array->len < 2) { gtk_tree_path_free (path); return; } tmp_array = g_new (int, level->array->len); for (i = 0; i < level->array->len; i++) { for (j = 0; j < level->array->len; j++) { if (g_array_index (level->array, SortElt, i).offset == new_order[j]) tmp_array[i] = j; } } for (i = 0; i < level->array->len; i++) g_array_index (level->array, SortElt, i).offset = tmp_array[i]; g_free (tmp_array); if (tree_model_sort->sort_column_id == GTK_TREE_SORTABLE_DEFAULT_SORT_COLUMN_ID && tree_model_sort->default_sort_func == NO_SORT_FUNC) { gtk_tree_model_sort_sort_level (tree_model_sort, level, FALSE, FALSE); gtk_tree_model_sort_increment_stamp (tree_model_sort); if (gtk_tree_path_get_depth (path)) { gtk_tree_model_get_iter (GTK_TREE_MODEL (tree_model_sort), &iter, path); gtk_tree_model_rows_reordered (GTK_TREE_MODEL (tree_model_sort), path, &iter, new_order); } else { gtk_tree_model_rows_reordered (GTK_TREE_MODEL (tree_model_sort), path, NULL, new_order); } } gtk_tree_path_free (path); } /* Fulfill our model requirements */ static GtkTreeModelFlags gtk_tree_model_sort_get_flags (GtkTreeModel *tree_model) { g_return_val_if_fail (GTK_IS_TREE_MODEL_SORT (tree_model), 0); return 0; } static gint gtk_tree_model_sort_get_n_columns (GtkTreeModel *tree_model) { GtkTreeModelSort *tree_model_sort = (GtkTreeModelSort *) tree_model; g_return_val_if_fail (GTK_IS_TREE_MODEL_SORT (tree_model), 0); if (tree_model_sort->child_model == 0) return 0; return gtk_tree_model_get_n_columns (tree_model_sort->child_model); } static GType gtk_tree_model_sort_get_column_type (GtkTreeModel *tree_model, gint index) { g_return_val_if_fail (GTK_IS_TREE_MODEL_SORT (tree_model), G_TYPE_INVALID); g_return_val_if_fail (GTK_TREE_MODEL_SORT (tree_model)->child_model != NULL, G_TYPE_INVALID); return gtk_tree_model_get_column_type (GTK_TREE_MODEL_SORT (tree_model)->child_model, index); } static gboolean gtk_tree_model_sort_get_iter (GtkTreeModel *tree_model, GtkTreeIter *iter, GtkTreePath *path) { GtkTreeModelSort *tree_model_sort; gint *indices; SortLevel *level; gint depth, i; g_return_val_if_fail (GTK_IS_TREE_MODEL_SORT (tree_model), FALSE); g_return_val_if_fail (GTK_TREE_MODEL_SORT (tree_model)->child_model != NULL, FALSE); tree_model_sort = (GtkTreeModelSort *) tree_model; indices = gtk_tree_path_get_indices (path); if (tree_model_sort->root == NULL) gtk_tree_model_sort_build_level (tree_model_sort, NULL, NULL); level = SORT_LEVEL (tree_model_sort->root); depth = gtk_tree_path_get_depth (path); if (depth == 0) return FALSE; for (i = 0; i < depth - 1; i++) { if ((level == NULL) || (indices[i] >= level->array->len)) return FALSE; if (g_array_index (level->array, SortElt, indices[i]).children == NULL) gtk_tree_model_sort_build_level (tree_model_sort, level, &g_array_index (level->array, SortElt, indices[i])); level = g_array_index (level->array, SortElt, indices[i]).children; } if (level == NULL) return FALSE; iter->stamp = tree_model_sort->stamp; iter->user_data = level; iter->user_data2 = &g_array_index (level->array, SortElt, indices[depth - 1]); return TRUE; } static GtkTreePath * gtk_tree_model_sort_get_path (GtkTreeModel *tree_model, GtkTreeIter *iter) { GtkTreePath *retval; SortLevel *level; SortElt *elt; g_return_val_if_fail (GTK_IS_TREE_MODEL_SORT (tree_model), NULL); g_return_val_if_fail (GTK_TREE_MODEL_SORT (tree_model)->child_model != NULL, NULL); g_return_val_if_fail (GTK_TREE_MODEL_SORT (tree_model)->stamp == iter->stamp, NULL); retval = gtk_tree_path_new (); level = iter->user_data; elt = iter->user_data2; while (level != NULL) { gtk_tree_path_prepend_index (retval, elt - (SortElt *)level->array->data); elt = level->parent_elt; level = level->parent_level; } return retval; } static void gtk_tree_model_sort_get_value (GtkTreeModel *tree_model, GtkTreeIter *iter, gint column, GValue *value) { GtkTreeIter child_iter; g_return_if_fail (GTK_IS_TREE_MODEL_SORT (tree_model)); g_return_if_fail (GTK_TREE_MODEL_SORT (tree_model)->child_model != NULL); g_return_if_fail (GTK_TREE_MODEL_SORT (tree_model)->stamp == iter->stamp); GET_CHILD_ITER (tree_model, &child_iter, iter); gtk_tree_model_get_value (GTK_TREE_MODEL_SORT (tree_model)->child_model, &child_iter, column, value); } static gboolean gtk_tree_model_sort_iter_next (GtkTreeModel *tree_model, GtkTreeIter *iter) { SortLevel *level; SortElt *elt; g_return_val_if_fail (GTK_IS_TREE_MODEL_SORT (tree_model), FALSE); g_return_val_if_fail (GTK_TREE_MODEL_SORT (tree_model)->child_model != NULL, FALSE); g_return_val_if_fail (GTK_TREE_MODEL_SORT (tree_model)->stamp == iter->stamp, FALSE); level = iter->user_data; elt = iter->user_data2; if (elt - (SortElt *)level->array->data >= level->array->len - 1) { iter->stamp = 0; return FALSE; } iter->user_data2 = elt + 1; return TRUE; } static gboolean gtk_tree_model_sort_iter_children (GtkTreeModel *tree_model, GtkTreeIter *iter, GtkTreeIter *parent) { GtkTreeModelSort *tree_model_sort = (GtkTreeModelSort *) tree_model; SortLevel *level; iter->stamp = 0; g_return_val_if_fail (GTK_IS_TREE_MODEL_SORT (tree_model), FALSE); g_return_val_if_fail (tree_model_sort->child_model != NULL, FALSE); if (parent) g_return_val_if_fail (tree_model_sort->stamp == parent->stamp, FALSE); if (parent == NULL) { if (tree_model_sort->root == NULL) gtk_tree_model_sort_build_level (tree_model_sort, NULL, NULL); if (tree_model_sort->root == NULL) return FALSE; level = tree_model_sort->root; iter->stamp = tree_model_sort->stamp; iter->user_data = level; iter->user_data2 = level->array->data; } else { if (((SortElt *)parent->user_data2)->children == NULL) gtk_tree_model_sort_build_level (tree_model_sort, (SortLevel *)parent->user_data, (SortElt *)parent->user_data2); if (((SortElt *)parent->user_data2)->children == NULL) return FALSE; iter->stamp = tree_model_sort->stamp; iter->user_data = ((SortElt *)parent->user_data2)->children; iter->user_data2 = ((SortLevel *)iter->user_data)->array->data; } return TRUE; } static gboolean gtk_tree_model_sort_iter_has_child (GtkTreeModel *tree_model, GtkTreeIter *iter) { GtkTreeIter child_iter; g_return_val_if_fail (GTK_IS_TREE_MODEL_SORT (tree_model), FALSE); g_return_val_if_fail (GTK_TREE_MODEL_SORT (tree_model)->child_model != NULL, FALSE); g_return_val_if_fail (GTK_TREE_MODEL_SORT (tree_model)->stamp == iter->stamp, FALSE); GET_CHILD_ITER (tree_model, &child_iter, iter); return gtk_tree_model_iter_has_child (GTK_TREE_MODEL_SORT (tree_model)->child_model, &child_iter); } static gint gtk_tree_model_sort_iter_n_children (GtkTreeModel *tree_model, GtkTreeIter *iter) { GtkTreeIter child_iter; g_return_val_if_fail (GTK_IS_TREE_MODEL_SORT (tree_model), 0); g_return_val_if_fail (GTK_TREE_MODEL_SORT (tree_model)->child_model != NULL, 0); if (iter) g_return_val_if_fail (GTK_TREE_MODEL_SORT (tree_model)->stamp == iter->stamp, 0); if (iter == NULL) return gtk_tree_model_iter_n_children (GTK_TREE_MODEL_SORT (tree_model)->child_model, NULL); GET_CHILD_ITER (tree_model, &child_iter, iter); return gtk_tree_model_iter_n_children (GTK_TREE_MODEL_SORT (tree_model)->child_model, &child_iter); } static gboolean gtk_tree_model_sort_iter_nth_child (GtkTreeModel *tree_model, GtkTreeIter *iter, GtkTreeIter *parent, gint n) { SortLevel *level; /* We have this for the iter == parent case */ GtkTreeIter children; g_return_val_if_fail (GTK_IS_TREE_MODEL_SORT (tree_model), FALSE); if (parent) g_return_val_if_fail (GTK_TREE_MODEL_SORT (tree_model)->stamp == parent->stamp, FALSE); /* Use this instead of has_child to force us to build the level, if needed */ if (gtk_tree_model_sort_iter_children (tree_model, &children, parent) == FALSE) { iter->stamp = 0; return FALSE; } level = children.user_data; if (n >= level->array->len) { iter->stamp = 0; return FALSE; } iter->stamp = GTK_TREE_MODEL_SORT (tree_model)->stamp; iter->user_data = level; iter->user_data2 = &g_array_index (level->array, SortElt, n); return TRUE; } static gboolean gtk_tree_model_sort_iter_parent (GtkTreeModel *tree_model, GtkTreeIter *iter, GtkTreeIter *child) { SortLevel *level; iter->stamp = 0; g_return_val_if_fail (GTK_IS_TREE_MODEL_SORT (tree_model), FALSE); g_return_val_if_fail (GTK_TREE_MODEL_SORT (tree_model)->child_model != NULL, FALSE); g_return_val_if_fail (GTK_TREE_MODEL_SORT (tree_model)->stamp == child->stamp, FALSE); level = child->user_data; if (level->parent_level) { iter->stamp = GTK_TREE_MODEL_SORT (tree_model)->stamp; iter->user_data = level->parent_level; iter->user_data2 = level->parent_elt; return TRUE; } return FALSE; } static void gtk_tree_model_sort_ref_node (GtkTreeModel *tree_model, GtkTreeIter *iter) { GtkTreeModelSort *tree_model_sort = (GtkTreeModelSort *) tree_model; GtkTreeIter child_iter; SortLevel *level; SortElt *elt; g_return_if_fail (GTK_IS_TREE_MODEL_SORT (tree_model)); g_return_if_fail (GTK_TREE_MODEL_SORT (tree_model)->child_model != NULL); g_return_if_fail (GTK_TREE_MODEL_SORT (tree_model)->stamp == iter->stamp); GET_CHILD_ITER (tree_model, &child_iter, iter); gtk_tree_model_ref_node (GTK_TREE_MODEL_SORT (tree_model)->child_model, &child_iter); level = iter->user_data; elt = iter->user_data2; elt->ref_count++; level->ref_count++; if (level->ref_count == 1) { SortLevel *parent_level = level->parent_level; SortElt *parent_elt = level->parent_elt; /* We were at zero -- time to decrement the zero_ref_count val */ do { if (parent_elt) parent_elt->zero_ref_count--; else tree_model_sort->zero_ref_count--; if (parent_level) { parent_elt = parent_level->parent_elt; parent_level = parent_level->parent_level; } } while (parent_level); } } static void gtk_tree_model_sort_real_unref_node (GtkTreeModel *tree_model, GtkTreeIter *iter, gboolean propagate_unref) { GtkTreeModelSort *tree_model_sort = (GtkTreeModelSort *) tree_model; GtkTreeIter child_iter; SortLevel *level; SortElt *elt; g_return_if_fail (GTK_IS_TREE_MODEL_SORT (tree_model)); g_return_if_fail (GTK_TREE_MODEL_SORT (tree_model)->child_model != NULL); g_return_if_fail (GTK_TREE_MODEL_SORT (tree_model)->stamp == iter->stamp); GET_CHILD_ITER (tree_model, &child_iter, iter); if (propagate_unref) gtk_tree_model_unref_node (GTK_TREE_MODEL_SORT (tree_model)->child_model, &child_iter); level = iter->user_data; elt = iter->user_data2; g_return_if_fail (elt->ref_count > 0); elt->ref_count--; level->ref_count--; if (level->ref_count == 0) { SortLevel *parent_level = level->parent_level; SortElt *parent_elt = level->parent_elt; /* We are at zero -- time to increment the zero_ref_count val */ while (parent_level) { parent_elt->zero_ref_count++; parent_elt = parent_level->parent_elt; parent_level = parent_level->parent_level; } tree_model_sort->zero_ref_count++; } } static void gtk_tree_model_sort_unref_node (GtkTreeModel *tree_model, GtkTreeIter *iter) { gtk_tree_model_sort_real_unref_node (tree_model, iter, TRUE); } /* Sortable interface */ static gboolean gtk_tree_model_sort_get_sort_column_id (GtkTreeSortable *sortable, gint *sort_column_id, GtkSortType *order) { GtkTreeModelSort *tree_model_sort = (GtkTreeModelSort *)sortable; g_return_val_if_fail (GTK_IS_TREE_MODEL_SORT (sortable), FALSE); if (tree_model_sort->sort_column_id == GTK_TREE_SORTABLE_DEFAULT_SORT_COLUMN_ID) return FALSE; if (sort_column_id) *sort_column_id = tree_model_sort->sort_column_id; if (order) *order = tree_model_sort->order; return TRUE; } static void gtk_tree_model_sort_set_sort_column_id (GtkTreeSortable *sortable, gint sort_column_id, GtkSortType order) { GtkTreeModelSort *tree_model_sort = (GtkTreeModelSort *)sortable; g_return_if_fail (GTK_IS_TREE_MODEL_SORT (sortable)); if (sort_column_id != GTK_TREE_SORTABLE_DEFAULT_SORT_COLUMN_ID) { GtkTreeDataSortHeader *header = NULL; header = _gtk_tree_data_list_get_header (tree_model_sort->sort_list, sort_column_id); /* we want to make sure that we have a function */ g_return_if_fail (header != NULL); g_return_if_fail (header->func != NULL); } else g_return_if_fail (tree_model_sort->default_sort_func != NULL); if (tree_model_sort->sort_column_id == sort_column_id) { if (sort_column_id != GTK_TREE_SORTABLE_DEFAULT_SORT_COLUMN_ID) { if (tree_model_sort->order == order) return; } else return; } tree_model_sort->sort_column_id = sort_column_id; tree_model_sort->order = order; gtk_tree_model_sort_sort (tree_model_sort); gtk_tree_sortable_sort_column_changed (sortable); } static void gtk_tree_model_sort_set_sort_func (GtkTreeSortable *sortable, gint sort_column_id, GtkTreeIterCompareFunc func, gpointer data, GtkDestroyNotify destroy) { GtkTreeModelSort *tree_model_sort = (GtkTreeModelSort *) sortable; GtkTreeDataSortHeader *header = NULL; GList *list; g_return_if_fail (GTK_IS_TREE_MODEL_SORT (sortable)); g_return_if_fail (func != NULL); for (list = tree_model_sort->sort_list; list; list = list->next) { GtkTreeDataSortHeader *list_header; list_header = (GtkTreeDataSortHeader*) list->data; if (list_header->sort_column_id == sort_column_id) { header = list_header; break; } } if (header == NULL) { header = g_new0 (GtkTreeDataSortHeader, 1); header->sort_column_id = sort_column_id; tree_model_sort->sort_list = g_list_append (tree_model_sort->sort_list, header); } if (header->destroy) { GtkDestroyNotify d = header->destroy; header->destroy = NULL; d (header->data); } header->func = func; header->data = data; header->destroy = destroy; } static void gtk_tree_model_sort_set_default_sort_func (GtkTreeSortable *sortable, GtkTreeIterCompareFunc func, gpointer data, GtkDestroyNotify destroy) { GtkTreeModelSort *tree_model_sort = (GtkTreeModelSort *)sortable; g_return_if_fail (GTK_IS_TREE_MODEL_SORT (sortable)); if (tree_model_sort->default_sort_destroy) { GtkDestroyNotify d = tree_model_sort->default_sort_destroy; tree_model_sort->default_sort_destroy = NULL; d (tree_model_sort->default_sort_data); } tree_model_sort->default_sort_func = func; tree_model_sort->default_sort_data = data; tree_model_sort->default_sort_destroy = destroy; } static gboolean gtk_tree_model_sort_has_default_sort_func (GtkTreeSortable *sortable) { GtkTreeModelSort *tree_model_sort = (GtkTreeModelSort *)sortable; g_return_val_if_fail (GTK_IS_TREE_MODEL_SORT (sortable), FALSE); return (tree_model_sort->default_sort_func != NULL); } /* sorting code - private */ static gint gtk_tree_model_sort_compare_func (gconstpointer a, gconstpointer b, gpointer user_data) { SortData *data = (SortData *)user_data; GtkTreeModelSort *tree_model_sort = data->tree_model_sort; SortTuple *sa = (SortTuple *)a; SortTuple *sb = (SortTuple *)b; GtkTreeIter iter_a, iter_b; gint retval; /* shortcut, if we've the same offsets here, they should be equal */ if (sa->offset == sb->offset) return 0; if (GTK_TREE_MODEL_SORT_CACHE_CHILD_ITERS (tree_model_sort)) { iter_a = sa->elt->iter; iter_b = sb->elt->iter; } else { data->parent_path_indices [data->parent_path_depth-1] = sa->elt->offset; gtk_tree_model_get_iter (GTK_TREE_MODEL (tree_model_sort->child_model), &iter_a, data->parent_path); data->parent_path_indices [data->parent_path_depth-1] = sb->elt->offset; gtk_tree_model_get_iter (GTK_TREE_MODEL (tree_model_sort->child_model), &iter_b, data->parent_path); } retval = (* data->sort_func) (GTK_TREE_MODEL (tree_model_sort->child_model), &iter_a, &iter_b, data->sort_data); if (tree_model_sort->order == GTK_SORT_DESCENDING) { if (retval > 0) retval = -1; else if (retval < 0) retval = 1; } return retval; } static gint gtk_tree_model_sort_offset_compare_func (gconstpointer a, gconstpointer b, gpointer user_data) { gint retval; SortTuple *sa = (SortTuple *)a; SortTuple *sb = (SortTuple *)b; SortData *data = (SortData *)user_data; if (sa->elt->offset < sb->elt->offset) retval = -1; else if (sa->elt->offset > sb->elt->offset) retval = 1; else retval = 0; if (data->tree_model_sort->order == GTK_SORT_DESCENDING) { if (retval > 0) retval = -1; else if (retval < 0) retval = 1; } return retval; } static void gtk_tree_model_sort_sort_level (GtkTreeModelSort *tree_model_sort, SortLevel *level, gboolean recurse, gboolean emit_reordered) { gint i; GArray *sort_array; GArray *new_array; gint *new_order; GtkTreeIter iter; GtkTreePath *path; SortData data; g_return_if_fail (GTK_IS_TREE_MODEL_SORT (tree_model_sort)); g_return_if_fail (level != NULL); if (level->array->len < 1 && !((SortElt *)level->array->data)->children) return; /* Set up data */ data.tree_model_sort = tree_model_sort; if (level->parent_elt) { data.parent_path = gtk_tree_model_sort_elt_get_path (level->parent_level, level->parent_elt); gtk_tree_path_append_index (data.parent_path, 0); } else { data.parent_path = gtk_tree_path_new_first (); } data.parent_path_depth = gtk_tree_path_get_depth (data.parent_path); data.parent_path_indices = gtk_tree_path_get_indices (data.parent_path); /* make the array to be sorted */ sort_array = g_array_sized_new (FALSE, FALSE, sizeof (SortTuple), level->array->len); for (i = 0; i < level->array->len; i++) { SortTuple tuple; tuple.elt = &g_array_index (level->array, SortElt, i); tuple.offset = i; g_array_append_val (sort_array, tuple); } if (tree_model_sort->sort_column_id != GTK_TREE_SORTABLE_DEFAULT_SORT_COLUMN_ID) { GtkTreeDataSortHeader *header = NULL; header = _gtk_tree_data_list_get_header (tree_model_sort->sort_list, tree_model_sort->sort_column_id); g_return_if_fail (header != NULL); g_return_if_fail (header->func != NULL); data.sort_func = header->func; data.sort_data = header->data; } else { /* absolutely SHOULD NOT happen: */ g_return_if_fail (tree_model_sort->default_sort_func != NULL); data.sort_func = tree_model_sort->default_sort_func; data.sort_data = tree_model_sort->default_sort_data; } if (data.sort_func == NO_SORT_FUNC) g_array_sort_with_data (sort_array, gtk_tree_model_sort_offset_compare_func, &data); else g_array_sort_with_data (sort_array, gtk_tree_model_sort_compare_func, &data); gtk_tree_path_free (data.parent_path); new_array = g_array_sized_new (FALSE, FALSE, sizeof (SortElt), level->array->len); new_order = g_new (gint, level->array->len); for (i = 0; i < level->array->len; i++) { SortElt *elt; elt = g_array_index (sort_array, SortTuple, i).elt; new_order[i] = g_array_index (sort_array, SortTuple, i).offset; g_array_append_val (new_array, *elt); elt = &g_array_index (new_array, SortElt, i); if (elt->children) elt->children->parent_elt = elt; } g_array_free (level->array, TRUE); level->array = new_array; g_array_free (sort_array, TRUE); if (emit_reordered) { gtk_tree_model_sort_increment_stamp (tree_model_sort); if (level->parent_elt) { iter.stamp = tree_model_sort->stamp; iter.user_data = level->parent_level; iter.user_data2 = level->parent_elt; path = gtk_tree_model_get_path (GTK_TREE_MODEL (tree_model_sort), &iter); gtk_tree_model_rows_reordered (GTK_TREE_MODEL (tree_model_sort), path, &iter, new_order); } else { /* toplevel list */ path = gtk_tree_path_new (); gtk_tree_model_rows_reordered (GTK_TREE_MODEL (tree_model_sort), path, NULL, new_order); } gtk_tree_path_free (path); } /* recurse, if possible */ if (recurse) { for (i = 0; i < level->array->len; i++) { SortElt *elt = &g_array_index (level->array, SortElt, i); if (elt->children) gtk_tree_model_sort_sort_level (tree_model_sort, elt->children, TRUE, emit_reordered); } } g_free (new_order); } static void gtk_tree_model_sort_sort (GtkTreeModelSort *tree_model_sort) { g_return_if_fail (GTK_IS_TREE_MODEL_SORT (tree_model_sort)); if (!tree_model_sort->root) return; if (tree_model_sort->sort_column_id != GTK_TREE_SORTABLE_DEFAULT_SORT_COLUMN_ID) { GtkTreeDataSortHeader *header = NULL; header = _gtk_tree_data_list_get_header (tree_model_sort->sort_list, tree_model_sort->sort_column_id); /* we want to make sure that we have a function */ g_return_if_fail (header != NULL); g_return_if_fail (header->func != NULL); } else g_return_if_fail (tree_model_sort->default_sort_func != NULL); gtk_tree_model_sort_sort_level (tree_model_sort, tree_model_sort->root, TRUE, TRUE); } /* signal helpers */ static gint gtk_tree_model_sort_level_find_insert (GtkTreeModelSort *tree_model_sort, SortLevel *level, GtkTreeIter *iter, gboolean skip_sort_elt) { gint middle; gint cmp; SortElt *tmp_elt; GtkTreeIter tmp_iter; GtkTreeIterCompareFunc func; gpointer data; GtkTreePath *path; if (tree_model_sort->sort_column_id != GTK_TREE_SORTABLE_DEFAULT_SORT_COLUMN_ID) { GtkTreeDataSortHeader *header; header = _gtk_tree_data_list_get_header (tree_model_sort->sort_list, tree_model_sort->sort_column_id); g_return_val_if_fail (header != NULL, 0); func = header->func; data = header->data; } else { func = tree_model_sort->default_sort_func; data = tree_model_sort->default_sort_data; g_return_val_if_fail (func != NO_SORT_FUNC, 0); } g_return_val_if_fail (func != NULL, 0); for (middle = 0; middle < level->array->len; middle++) { tmp_elt = &(g_array_index (level->array, SortElt, middle)); if (!skip_sort_elt && SORT_ELT (iter->user_data2) == tmp_elt) continue; path = gtk_tree_model_sort_elt_get_path (level, tmp_elt); gtk_tree_model_get_iter (tree_model_sort->child_model, &tmp_iter, path); gtk_tree_path_free (path); if (tree_model_sort->order == GTK_SORT_ASCENDING) cmp = (* func) (GTK_TREE_MODEL (tree_model_sort->child_model), &tmp_iter, iter, data); else cmp = (* func) (GTK_TREE_MODEL (tree_model_sort->child_model), iter, &tmp_iter, data); if (cmp > 0) break; } return middle; } static gboolean gtk_tree_model_sort_insert_value (GtkTreeModelSort *tree_model_sort, SortLevel *level, GtkTreePath *s_path, GtkTreeIter *s_iter) { gint offset, index, i; SortElt elt; SortElt *tmp_elt; offset = gtk_tree_path_get_indices (s_path)[gtk_tree_path_get_depth (s_path) - 1]; if (GTK_TREE_MODEL_SORT_CACHE_CHILD_ITERS (tree_model_sort)) elt.iter = *s_iter; elt.offset = offset; elt.zero_ref_count = 0; elt.ref_count = 0; elt.children = NULL; /* update all larger offsets */ tmp_elt = SORT_ELT (level->array->data); for (i = 0; i < level->array->len; i++, tmp_elt++) if (tmp_elt->offset >= offset) tmp_elt->offset++; if (tree_model_sort->sort_column_id == GTK_TREE_SORTABLE_DEFAULT_SORT_COLUMN_ID && tree_model_sort->default_sort_func == NO_SORT_FUNC) index = offset; else index = gtk_tree_model_sort_level_find_insert (tree_model_sort, level, s_iter, FALSE); g_array_insert_vals (level->array, index, &elt, 1); tmp_elt = SORT_ELT (level->array->data); for (i = 0; i < level->array->len; i++, tmp_elt++) if (tmp_elt->children) tmp_elt->children->parent_elt = tmp_elt; return TRUE; } /* sort elt stuff */ static GtkTreePath * gtk_tree_model_sort_elt_get_path (SortLevel *level, SortElt *elt) { SortLevel *walker = level; SortElt *walker2 = elt; GtkTreePath *path; g_return_val_if_fail (level != NULL, NULL); g_return_val_if_fail (elt != NULL, NULL); path = gtk_tree_path_new (); while (walker) { gtk_tree_path_prepend_index (path, walker2->offset); walker2 = walker->parent_elt; walker = walker->parent_level; } return path; } /** * gtk_tree_model_sort_set_model: * @tree_model_sort: The #GtkTreeModelSort. * @child_model: A #GtkTreeModel, or NULL. * * Sets the model of @tree_model_sort to be @model. If @model is NULL, then the * old model is unset. The sort function is unset as a result of this call. * The model will be in an unsorted state until a sort function is set. **/ static void gtk_tree_model_sort_set_model (GtkTreeModelSort *tree_model_sort, GtkTreeModel *child_model) { g_return_if_fail (GTK_IS_TREE_MODEL_SORT (tree_model_sort)); if (child_model) g_object_ref (G_OBJECT (child_model)); if (tree_model_sort->child_model) { g_signal_handler_disconnect (G_OBJECT (tree_model_sort->child_model), tree_model_sort->changed_id); g_signal_handler_disconnect (G_OBJECT (tree_model_sort->child_model), tree_model_sort->inserted_id); g_signal_handler_disconnect (G_OBJECT (tree_model_sort->child_model), tree_model_sort->has_child_toggled_id); g_signal_handler_disconnect (G_OBJECT (tree_model_sort->child_model), tree_model_sort->deleted_id); g_signal_handler_disconnect (G_OBJECT (tree_model_sort->child_model), tree_model_sort->reordered_id); /* reset our state */ if (tree_model_sort->root) gtk_tree_model_sort_free_level (tree_model_sort, tree_model_sort->root); tree_model_sort->root = NULL; _gtk_tree_data_list_header_free (tree_model_sort->sort_list); tree_model_sort->sort_list = NULL; g_object_unref (G_OBJECT (tree_model_sort->child_model)); } tree_model_sort->child_model = child_model; if (child_model) { GType *types; gint i, n_columns; g_object_ref (tree_model_sort->child_model); tree_model_sort->changed_id = g_signal_connect (child_model, "row_changed", G_CALLBACK (gtk_tree_model_sort_row_changed), tree_model_sort); tree_model_sort->inserted_id = g_signal_connect (child_model, "row_inserted", G_CALLBACK (gtk_tree_model_sort_row_inserted), tree_model_sort); tree_model_sort->has_child_toggled_id = g_signal_connect (child_model, "row_has_child_toggled", G_CALLBACK (gtk_tree_model_sort_row_has_child_toggled), tree_model_sort); tree_model_sort->deleted_id = g_signal_connect (child_model, "row_deleted", G_CALLBACK (gtk_tree_model_sort_row_deleted), tree_model_sort); tree_model_sort->reordered_id = g_signal_connect (child_model, "rows_reordered", G_CALLBACK (gtk_tree_model_sort_rows_reordered), tree_model_sort); tree_model_sort->child_flags = gtk_tree_model_get_flags (child_model); n_columns = gtk_tree_model_get_n_columns (child_model); types = g_new (GType, n_columns); for (i = 0; i < n_columns; i++) types[i] = gtk_tree_model_get_column_type (child_model, i); tree_model_sort->sort_list = _gtk_tree_data_list_header_new (n_columns, types); g_free (types); tree_model_sort->default_sort_func = NO_SORT_FUNC; tree_model_sort->stamp = g_random_int (); } } /** * gtk_tree_model_sort_get_model: * @tree_model: a #GtkTreeModelSort * * Returns the model the #GtkTreeModelSort is sorting. * * Return value: the "child model" being sorted **/ GtkTreeModel * gtk_tree_model_sort_get_model (GtkTreeModelSort *tree_model) { g_return_val_if_fail (GTK_IS_TREE_MODEL_SORT (tree_model), NULL); return tree_model->child_model; } static GtkTreePath * gtk_real_tree_model_sort_convert_child_path_to_path (GtkTreeModelSort *tree_model_sort, GtkTreePath *child_path, gboolean build_levels) { gint *child_indices; GtkTreePath *retval; SortLevel *level; gint i; g_return_val_if_fail (GTK_IS_TREE_MODEL_SORT (tree_model_sort), NULL); g_return_val_if_fail (tree_model_sort->child_model != NULL, NULL); g_return_val_if_fail (child_path != NULL, NULL); retval = gtk_tree_path_new (); child_indices = gtk_tree_path_get_indices (child_path); if (tree_model_sort->root == NULL && build_levels) gtk_tree_model_sort_build_level (tree_model_sort, NULL, NULL); level = SORT_LEVEL (tree_model_sort->root); for (i = 0; i < gtk_tree_path_get_depth (child_path); i++) { gint j; gboolean found_child = FALSE; if (!level) { gtk_tree_path_free (retval); return NULL; } if (child_indices[i] >= level->array->len) { gtk_tree_path_free (retval); return NULL; } for (j = 0; j < level->array->len; j++) { if ((g_array_index (level->array, SortElt, j)).offset == child_indices[i]) { gtk_tree_path_append_index (retval, j); if (g_array_index (level->array, SortElt, j).children == NULL && build_levels) { gtk_tree_model_sort_build_level (tree_model_sort, level, &g_array_index (level->array, SortElt, j)); } level = g_array_index (level->array, SortElt, j).children; found_child = TRUE; break; } } if (! found_child) { gtk_tree_path_free (retval); return NULL; } } return retval; } /** * gtk_tree_model_sort_convert_child_path_to_path: * @tree_model_sort: A #GtkTreeModelSort * @child_path: A #GtkTreePath to convert * * Converts @child_path to a path relative to @tree_model_sort. That is, * @child_path points to a path in the child model. The returned path will * point to the same row in the sorted model. If @child_path isn't a valid path * on the child model, then %NULL is returned. * * Return value: A newly allocated #GtkTreePath, or %NULL **/ GtkTreePath * gtk_tree_model_sort_convert_child_path_to_path (GtkTreeModelSort *tree_model_sort, GtkTreePath *child_path) { g_return_val_if_fail (GTK_IS_TREE_MODEL_SORT (tree_model_sort), NULL); g_return_val_if_fail (tree_model_sort->child_model != NULL, NULL); g_return_val_if_fail (child_path != NULL, NULL); return gtk_real_tree_model_sort_convert_child_path_to_path (tree_model_sort, child_path, TRUE); } /** * gtk_tree_model_sort_convert_child_iter_to_iter: * @tree_model_sort: A #GtkTreeModelSort * @sort_iter: An uninitialized #GtkTreeIter. * @child_iter: A valid #GtkTreeIter pointing to a row on the child model * * Sets @sort_iter to point to the row in @tree_model_sort that corresponds to * the row pointed at by @child_iter. **/ void gtk_tree_model_sort_convert_child_iter_to_iter (GtkTreeModelSort *tree_model_sort, GtkTreeIter *sort_iter, GtkTreeIter *child_iter) { GtkTreePath *child_path, *path; g_return_if_fail (GTK_IS_TREE_MODEL_SORT (tree_model_sort)); g_return_if_fail (tree_model_sort->child_model != NULL); g_return_if_fail (sort_iter != NULL); g_return_if_fail (child_iter != NULL); sort_iter->stamp = 0; child_path = gtk_tree_model_get_path (tree_model_sort->child_model, child_iter); g_return_if_fail (child_path != NULL); path = gtk_tree_model_sort_convert_child_path_to_path (tree_model_sort, child_path); gtk_tree_path_free (child_path); g_return_if_fail (path != NULL); gtk_tree_model_get_iter (GTK_TREE_MODEL (tree_model_sort), sort_iter, path); gtk_tree_path_free (path); } /** * gtk_tree_model_sort_convert_path_to_child_path: * @tree_model_sort: A #GtkTreeModelSort * @sorted_path: A #GtkTreePath to convert * * Converts @sorted_path to a path on the child model of @tree_model_sort. That * is, @sorted_path points to a location in @tree_model_sort. The returned path * will point to the same location in the model not being sorted. If @sorted_path * does not point to a location in the child model, %NULL is returned. * * Return value: A newly allocated #GtkTreePath, or %NULL **/ GtkTreePath * gtk_tree_model_sort_convert_path_to_child_path (GtkTreeModelSort *tree_model_sort, GtkTreePath *sorted_path) { gint *sorted_indices; GtkTreePath *retval; SortLevel *level; gint i; g_return_val_if_fail (GTK_IS_TREE_MODEL_SORT (tree_model_sort), NULL); g_return_val_if_fail (tree_model_sort->child_model != NULL, NULL); g_return_val_if_fail (sorted_path != NULL, NULL); retval = gtk_tree_path_new (); sorted_indices = gtk_tree_path_get_indices (sorted_path); if (tree_model_sort->root == NULL) gtk_tree_model_sort_build_level (tree_model_sort, NULL, NULL); level = SORT_LEVEL (tree_model_sort->root); for (i = 0; i < gtk_tree_path_get_depth (sorted_path); i++) { gint count = sorted_indices[i]; if ((level == NULL) || (level->array->len <= count)) { gtk_tree_path_free (retval); return NULL; } if (g_array_index (level->array, SortElt, count).children == NULL) gtk_tree_model_sort_build_level (tree_model_sort, level, &g_array_index (level->array, SortElt, count)); if (level == NULL) { gtk_tree_path_free (retval); break; } gtk_tree_path_append_index (retval, g_array_index (level->array, SortElt, count).offset); level = g_array_index (level->array, SortElt, count).children; } return retval; } /** * gtk_tree_model_sort_convert_iter_to_child_iter: * @tree_model_sort: A #GtkTreeModelSort * @child_iter: An uninitialized #GtkTreeIter * @sorted_iter: A valid #GtkTreeIter pointing to a row on @tree_model_sort. * * Sets @child_iter to point to the row pointed to by @sorted_iter. **/ void gtk_tree_model_sort_convert_iter_to_child_iter (GtkTreeModelSort *tree_model_sort, GtkTreeIter *child_iter, GtkTreeIter *sorted_iter) { g_return_if_fail (GTK_IS_TREE_MODEL_SORT (tree_model_sort)); g_return_if_fail (tree_model_sort->child_model != NULL); g_return_if_fail (child_iter != NULL); g_return_if_fail (sorted_iter != NULL); g_return_if_fail (sorted_iter->stamp == tree_model_sort->stamp); if (GTK_TREE_MODEL_SORT_CACHE_CHILD_ITERS (tree_model_sort)) { *child_iter = SORT_ELT (sorted_iter->user_data2)->iter; } else { GtkTreePath *path; path = gtk_tree_model_sort_elt_get_path (sorted_iter->user_data, sorted_iter->user_data2); gtk_tree_model_get_iter (tree_model_sort->child_model, child_iter, path); gtk_tree_path_free (path); } } static void gtk_tree_model_sort_build_level (GtkTreeModelSort *tree_model_sort, SortLevel *parent_level, SortElt *parent_elt) { GtkTreeIter iter; SortLevel *new_level; gint length = 0; gint i; g_assert (tree_model_sort->child_model != NULL); if (parent_level == NULL) { if (gtk_tree_model_get_iter_first (tree_model_sort->child_model, &iter) == FALSE) return; length = gtk_tree_model_iter_n_children (tree_model_sort->child_model, NULL); } else { GtkTreeIter parent_iter; GtkTreeIter child_parent_iter; parent_iter.stamp = tree_model_sort->stamp; parent_iter.user_data = parent_level; parent_iter.user_data2 = parent_elt; gtk_tree_model_sort_convert_iter_to_child_iter (tree_model_sort, &child_parent_iter, &parent_iter); if (gtk_tree_model_iter_children (tree_model_sort->child_model, &iter, &child_parent_iter) == FALSE) return; /* stamp may have changed */ gtk_tree_model_sort_convert_iter_to_child_iter (tree_model_sort, &child_parent_iter, &parent_iter); length = gtk_tree_model_iter_n_children (tree_model_sort->child_model, &child_parent_iter); } g_return_if_fail (length > 0); new_level = g_new (SortLevel, 1); new_level->array = g_array_sized_new (FALSE, FALSE, sizeof (SortElt), length); new_level->ref_count = 0; new_level->parent_elt = parent_elt; new_level->parent_level = parent_level; if (parent_elt) parent_elt->children = new_level; else tree_model_sort->root = new_level; /* increase the count of zero ref_counts.*/ while (parent_level) { parent_elt->zero_ref_count++; parent_elt = parent_level->parent_elt; parent_level = parent_level->parent_level; } if (new_level != tree_model_sort->root) tree_model_sort->zero_ref_count++; for (i = 0; i < length; i++) { SortElt sort_elt; sort_elt.offset = i; sort_elt.zero_ref_count = 0; sort_elt.ref_count = 0; sort_elt.children = NULL; if (GTK_TREE_MODEL_SORT_CACHE_CHILD_ITERS (tree_model_sort)) { sort_elt.iter = iter; if (gtk_tree_model_iter_next (tree_model_sort->child_model, &iter) == FALSE && i < length - 1) { g_warning ("There is a discrepency between the sort model and the child model."); return; } } g_array_append_val (new_level->array, sort_elt); } /* sort level */ gtk_tree_model_sort_sort_level (tree_model_sort, new_level, FALSE, FALSE); } static void gtk_tree_model_sort_free_level (GtkTreeModelSort *tree_model_sort, SortLevel *sort_level) { gint i; g_assert (sort_level); if (sort_level->ref_count == 0) { SortLevel *parent_level = sort_level->parent_level; SortElt *parent_elt = sort_level->parent_elt; do { if (parent_elt) parent_elt->zero_ref_count--; else tree_model_sort->zero_ref_count--; if (parent_level) { parent_elt = parent_level->parent_elt; parent_level = parent_level->parent_level; } } while (parent_level); } for (i = 0; i < sort_level->array->len; i++) { if (g_array_index (sort_level->array, SortElt, i).children) gtk_tree_model_sort_free_level (tree_model_sort, SORT_LEVEL(g_array_index (sort_level->array, SortElt, i).children)); } if (sort_level->parent_elt) sort_level->parent_elt->children = NULL; else tree_model_sort->root = NULL; g_array_free (sort_level->array, TRUE); sort_level->array = NULL; g_free (sort_level); sort_level = NULL; } static void gtk_tree_model_sort_increment_stamp (GtkTreeModelSort *tree_model_sort) { do { tree_model_sort->stamp++; } while (tree_model_sort->stamp == 0); gtk_tree_model_sort_clear_cache (tree_model_sort); } static void gtk_tree_model_sort_clear_cache_helper (GtkTreeModelSort *tree_model_sort, SortLevel *level) { gint i; g_assert (level != NULL); for (i = 0; i < level->array->len; i++) { if (g_array_index (level->array, SortElt, i).zero_ref_count > 0) gtk_tree_model_sort_clear_cache_helper (tree_model_sort, g_array_index (level->array, SortElt, i).children); } if (level->ref_count == 0 && level != tree_model_sort->root) gtk_tree_model_sort_free_level (tree_model_sort, level); } /** * gtk_tree_model_sort_reset_default_sort_func: * @tree_model_sort: A #GtkTreeModelSort * * This resets the default sort function to be in the 'unsorted' state. That * is, it is in the same order as the child model. It will re-sort the model * to be in the same order as the child model only if the #GtkTreeModelSort * is in 'unsorted' state. **/ void gtk_tree_model_sort_reset_default_sort_func (GtkTreeModelSort *tree_model_sort) { g_return_if_fail (GTK_IS_TREE_MODEL_SORT (tree_model_sort)); if (tree_model_sort->default_sort_destroy) { GtkDestroyNotify d = tree_model_sort->default_sort_destroy; tree_model_sort->default_sort_destroy = NULL; d (tree_model_sort->default_sort_data); } tree_model_sort->default_sort_func = NO_SORT_FUNC; tree_model_sort->default_sort_data = NULL; tree_model_sort->default_sort_destroy = NULL; if (tree_model_sort->sort_column_id == GTK_TREE_SORTABLE_DEFAULT_SORT_COLUMN_ID) gtk_tree_model_sort_sort (tree_model_sort); tree_model_sort->sort_column_id = GTK_TREE_SORTABLE_DEFAULT_SORT_COLUMN_ID; } /** * gtk_tree_model_sort_clear_cache: * @tree_model_sort: A #GtkTreeModelSort * * This function should almost never be called. It clears the @tree_model_sort * of any cached iterators that haven't been reffed with * gtk_tree_model_ref_node(). This might be useful if the child model being * sorted is static (and doesn't change often) and there has been a lot of * unreffed access to nodes. As a side effect of this function, all unreffed * iters will be invalid. **/ void gtk_tree_model_sort_clear_cache (GtkTreeModelSort *tree_model_sort) { g_return_if_fail (GTK_IS_TREE_MODEL_SORT (tree_model_sort)); if (tree_model_sort->zero_ref_count) gtk_tree_model_sort_clear_cache_helper (tree_model_sort, (SortLevel *)tree_model_sort->root); } static gboolean gtk_tree_model_sort_iter_is_valid_helper (GtkTreeIter *iter, SortLevel *level) { gint i; for (i = 0; i < level->array->len; i++) { SortElt *elt = &g_array_index (level->array, SortElt, i); if (iter->user_data == level && iter->user_data2 == elt) return TRUE; if (elt->children) if (gtk_tree_model_sort_iter_is_valid_helper (iter, elt->children)) return TRUE; } return FALSE; } /** * gtk_tree_model_sort_iter_is_valid: * @tree_model_sort: A #GtkTreeModelSort. * @iter: A #GtkTreeIter. * * WARNING: This function is slow. Only use it for debugging and/or testing * purposes. * * Checks if the given iter is a valid iter for this #GtkTreeModelSort. * * Return value: %TRUE if the iter is valid, %FALSE if the iter is invalid. **/ gboolean gtk_tree_model_sort_iter_is_valid (GtkTreeModelSort *tree_model_sort, GtkTreeIter *iter) { g_return_val_if_fail (GTK_IS_TREE_MODEL_SORT (tree_model_sort), FALSE); g_return_val_if_fail (iter != NULL, FALSE); if (!VALID_ITER (iter, tree_model_sort)) return FALSE; return gtk_tree_model_sort_iter_is_valid_helper (iter, tree_model_sort->root); }