From a8690c84abf9261f3cb4d842a7f31f8b5666d3f0 Mon Sep 17 00:00:00 2001 From: Georges Basile Stavracas Neto Date: Sat, 7 Jan 2023 09:01:29 -0500 Subject: [PATCH] filesystemmodel: Cosmetics Adjust code style, and shuffle some functions around. Remove unhelpful doc comments. --- gtk/gtkfilesystemmodel.c | 489 ++++++++++++++++++--------------------- 1 file changed, 227 insertions(+), 262 deletions(-) diff --git a/gtk/gtkfilesystemmodel.c b/gtk/gtkfilesystemmodel.c index adf8bdf201..b6ab98829a 100644 --- a/gtk/gtkfilesystemmodel.c +++ b/gtk/gtkfilesystemmodel.c @@ -46,8 +46,8 @@ struct _FileModelNode GFileInfo * info; /* info for this file or NULL if unknown */ guint row; /* if valid (see model->n_valid_indexes), visible nodes before and including - * this one - see the "Structure" comment above. - */ + * this one - see the "Structure" comment above. + */ guint visible :1; /* if the file is currently visible */ guint filtered_out :1;/* if the file is currently filtered out (i.e. it didn't pass the filters) */ @@ -67,10 +67,10 @@ struct _GtkFileSystemModel GArray * files; /* array of FileModelNode containing all our files */ guint n_nodes_valid; /* count of valid nodes (i.e. those whose node->row is accurate) */ GHashTable * file_lookup; /* mapping of GFile => array index in model->files - * This hash table doesn't always have the same number of entries as the files array; - * The hash table gets re-populated in node_get_for_file() if this mismatch is - * detected. - */ + * This hash table doesn't always have the same number of entries as the files array; + * The hash table gets re-populated in node_get_for_file() if this mismatch is + * detected. + */ GtkFileFilter * filter; /* filter to use for deciding which nodes are visible */ @@ -100,15 +100,6 @@ struct _GtkFileSystemModelClass static void freeze_updates (GtkFileSystemModel *model); static void thaw_updates (GtkFileSystemModel *model); -static guint node_get_for_file (GtkFileSystemModel *model, - GFile *file); - -static void add_file (GtkFileSystemModel *model, - GFile *file, - GFileInfo *info); -static void remove_file (GtkFileSystemModel *model, - GFile *file); - /*** FileModelNode ***/ /* Get a FileModelNode structure given an index in the model->files array of nodes */ @@ -125,7 +116,9 @@ static void remove_file (GtkFileSystemModel *model, * G_MAXUINT for both arguments for “validate everything”. */ static void -node_validate_rows (GtkFileSystemModel *model, guint up_to_index, guint up_to_row) +node_validate_rows (GtkFileSystemModel *model, + guint up_to_index, + guint up_to_row) { guint i, row; @@ -152,7 +145,8 @@ node_validate_rows (GtkFileSystemModel *model, guint up_to_index, guint up_to_ro } static guint G_GNUC_UNUSED -node_get_tree_row (GtkFileSystemModel *model, guint index) +node_get_tree_row (GtkFileSystemModel *model, + guint index) { if (model->n_nodes_valid <= index) node_validate_rows (model, index, G_MAXUINT); @@ -160,14 +154,18 @@ node_get_tree_row (GtkFileSystemModel *model, guint index) return get_node (model, index)->row - 1; } -static void -node_invalidate_index (GtkFileSystemModel *model, guint id) +static void +node_invalidate_index (GtkFileSystemModel *model, + guint id) { model->n_nodes_valid = MIN (model->n_nodes_valid, id); } static void -node_set_visible_and_filtered_out (GtkFileSystemModel *model, guint id, gboolean visible, gboolean filtered_out) +node_set_visible_and_filtered_out (GtkFileSystemModel *model, + guint id, + gboolean visible, + gboolean filtered_out) { FileModelNode *node = get_node (model, id); @@ -203,7 +201,8 @@ node_set_visible_and_filtered_out (GtkFileSystemModel *model, guint id, gboolean } static gboolean -node_should_be_filtered_out (GtkFileSystemModel *model, guint id) +node_should_be_filtered_out (GtkFileSystemModel *model, + guint id) { FileModelNode *node = get_node (model, id); @@ -219,7 +218,9 @@ node_should_be_filtered_out (GtkFileSystemModel *model, guint id) } static gboolean -node_should_be_visible (GtkFileSystemModel *model, guint id, gboolean filtered_out) +node_should_be_visible (GtkFileSystemModel *model, + guint id, + gboolean filtered_out) { FileModelNode *node = get_node (model, id); gboolean result; @@ -251,7 +252,8 @@ node_should_be_visible (GtkFileSystemModel *model, guint id, gboolean filtered_o } static void -node_compute_visibility_and_filters (GtkFileSystemModel *model, guint id) +node_compute_visibility_and_filters (GtkFileSystemModel *model, + guint id) { gboolean filtered_out; gboolean visible; @@ -262,6 +264,36 @@ node_compute_visibility_and_filters (GtkFileSystemModel *model, guint id) node_set_visible_and_filtered_out (model, id, visible, filtered_out); } +static guint +node_get_for_file (GtkFileSystemModel *model, + GFile *file) +{ + guint i; + + i = GPOINTER_TO_UINT (g_hash_table_lookup (model->file_lookup, file)); + if (i != 0) + return i; + + /* Node 0 is the editable row and has no associated file or entry in the table, so we start counting from 1. + * + * The invariant here is that the files in model->files[n] for n < g_hash_table_size (model->file_lookup) + * are already added to the hash table. this loop merely rebuilds our (file -> index) mapping on demand. + * + * If we exit the loop, the next pending batch of mappings will be resolved when this function gets called again + * with another file that is not yet in the mapping. + */ + for (i = g_hash_table_size (model->file_lookup) + 1; i < model->files->len; i++) + { + FileModelNode *node = get_node (model, i); + + g_hash_table_insert (model->file_lookup, node->file, GUINT_TO_POINTER (i)); + if (g_file_equal (node->file, file)) + return i; + } + + return 0; +} + /*** GListModel ***/ static GType @@ -312,11 +344,154 @@ enum { static guint file_system_model_signals[LAST_SIGNAL] = { 0 }; - - G_DEFINE_TYPE_WITH_CODE (GtkFileSystemModel, _gtk_file_system_model, G_TYPE_OBJECT, - G_IMPLEMENT_INTERFACE (G_TYPE_LIST_MODEL, - g_list_model_iface_init)) + G_IMPLEMENT_INTERFACE (G_TYPE_LIST_MODEL, + g_list_model_iface_init)) + +static void +freeze_updates (GtkFileSystemModel *model) +{ + g_return_if_fail (GTK_IS_FILE_SYSTEM_MODEL (model)); + + model->frozen++; +} + +static void +gtk_file_system_model_refilter_all (GtkFileSystemModel *model) +{ + guint i; + + if (model->frozen) + { + model->filter_on_thaw = TRUE; + return; + } + + freeze_updates (model); + + /* start at index 1, don't change the editable */ + for (i = 1; i < model->files->len; i++) + node_compute_visibility_and_filters (model, i); + + model->filter_on_thaw = FALSE; + thaw_updates (model); +} + +static void +thaw_updates (GtkFileSystemModel *model) +{ + gboolean stuff_added; + + g_return_if_fail (GTK_IS_FILE_SYSTEM_MODEL (model)); + g_return_if_fail (model->frozen > 0); + + model->frozen--; + if (model->frozen > 0) + return; + + stuff_added = get_node (model, model->files->len - 1)->frozen_add; + + if (model->filter_on_thaw) + gtk_file_system_model_refilter_all (model); + if (stuff_added) + { + guint i; + + for (i = 0; i < model->files->len; i++) + { + FileModelNode *node = get_node (model, i); + + if (!node->frozen_add) + continue; + node->frozen_add = FALSE; + node_compute_visibility_and_filters (model, i); + } + } +} + +static void +add_file (GtkFileSystemModel *model, + GFile *file, + GFileInfo *info) +{ + FileModelNode *node; + guint position; + + g_return_if_fail (GTK_IS_FILE_SYSTEM_MODEL (model)); + g_return_if_fail (G_IS_FILE (file)); + g_return_if_fail (G_IS_FILE_INFO (info)); + + node = g_slice_alloc0 (sizeof (FileModelNode)); + node->file = g_object_ref (file); + if (info) + { + g_file_info_set_attribute_object (info, "standard::file", G_OBJECT (file)); + node->info = g_object_ref (info); + } + node->frozen_add = model->frozen ? TRUE : FALSE; + + g_array_append_vals (model->files, node, 1); + g_slice_free1 (sizeof (FileModelNode), node); + + position = model->files->len - 1; + + if (!model->frozen) + node_compute_visibility_and_filters (model, model->files->len -1); + + /* Ignore the first item */ + g_list_model_items_changed (G_LIST_MODEL (model), position - 1, 0, 1); +} + +static void +adjust_file_lookup (GtkFileSystemModel *model, guint id, int increment) +{ + GHashTableIter iter; + gpointer key; + gpointer value; + + g_hash_table_iter_init (&iter, model->file_lookup); + + while (g_hash_table_iter_next (&iter, &key, &value)) + { + guint index = GPOINTER_TO_UINT (value); + + if (index >= id) + { + index += increment; + g_hash_table_iter_replace (&iter, GUINT_TO_POINTER (index)); + } + } +} + +static void +remove_file (GtkFileSystemModel *model, + GFile *file) +{ + FileModelNode *node; + guint id; + + g_return_if_fail (GTK_IS_FILE_SYSTEM_MODEL (model)); + g_return_if_fail (G_IS_FILE (file)); + + id = node_get_for_file (model, file); + if (id == 0) + return; + + node = get_node (model, id); + + node_invalidate_index (model, id); + + g_hash_table_remove (model->file_lookup, file); + g_object_unref (node->file); + adjust_file_lookup (model, id, -1); + + if (node->info) + g_object_unref (node->info); + + g_array_remove_index (model->files, id); + + g_list_model_items_changed (G_LIST_MODEL (model), id - 1, 1, 0); +} static void gtk_file_system_model_dispose (GObject *object) @@ -371,12 +546,12 @@ _gtk_file_system_model_class_init (GtkFileSystemModelClass *class) file_system_model_signals[FINISHED_LOADING] = g_signal_new (I_("finished-loading"), - G_OBJECT_CLASS_TYPE (gobject_class), - G_SIGNAL_RUN_LAST, - G_STRUCT_OFFSET (GtkFileSystemModelClass, finished_loading), - NULL, NULL, - NULL, - G_TYPE_NONE, 1, G_TYPE_ERROR); + G_OBJECT_CLASS_TYPE (gobject_class), + G_SIGNAL_RUN_LAST, + G_STRUCT_OFFSET (GtkFileSystemModelClass, finished_loading), + NULL, NULL, + NULL, + G_TYPE_NONE, 1, G_TYPE_ERROR); } static void @@ -394,7 +569,9 @@ _gtk_file_system_model_init (GtkFileSystemModel *model) /*** API ***/ static void -gtk_file_system_model_closed_enumerator (GObject *object, GAsyncResult *res, gpointer data) +gtk_file_system_model_closed_enumerator (GObject *object, + GAsyncResult *res, + gpointer data) { g_file_enumerator_close_finish (G_FILE_ENUMERATOR (object), res, NULL); } @@ -411,7 +588,9 @@ thaw_func (gpointer data) } static void -gtk_file_system_model_got_files (GObject *object, GAsyncResult *res, gpointer data) +gtk_file_system_model_got_files (GObject *object, + GAsyncResult *res, + gpointer data) { GFileEnumerator *enumerator = G_FILE_ENUMERATOR (object); GtkFileSystemModel *model = data; @@ -437,7 +616,7 @@ gtk_file_system_model_got_files (GObject *object, GAsyncResult *res, gpointer da const char *name; GFileInfo *info; GFile *file; - + info = walk->data; name = g_file_info_get_name (info); if (name == NULL) @@ -454,11 +633,11 @@ gtk_file_system_model_got_files (GObject *object, GAsyncResult *res, gpointer da g_list_free (files); g_file_enumerator_next_files_async (enumerator, - g_file_is_native (model->dir) ? 50 * FILES_PER_QUERY : FILES_PER_QUERY, - IO_PRIORITY, - model->cancellable, - gtk_file_system_model_got_files, - model); + g_file_is_native (model->dir) ? 50 * FILES_PER_QUERY : FILES_PER_QUERY, + IO_PRIORITY, + model->cancellable, + gtk_file_system_model_got_files, + model); } else { @@ -513,7 +692,7 @@ _gtk_file_system_model_update_file (GtkFileSystemModel *model, /* Helper for gtk_file_system_model_query_done and * gtk_file_system_model_one_query_done */ static void -query_done_helper (GObject * object, +query_done_helper (GObject *object, GAsyncResult *res, gpointer data, gboolean do_thaw_updates) @@ -619,7 +798,7 @@ gtk_file_system_model_got_enumerator (GObject *dir, GAsyncResult *res, gpointer static void gtk_file_system_model_set_directory (GtkFileSystemModel *model, GFile * dir, - const char * attributes) + const char * attributes) { g_assert (G_IS_FILE (dir)); @@ -689,27 +868,6 @@ _gtk_file_system_model_new_for_directory (GFile *dir, return model; } -static void -gtk_file_system_model_refilter_all (GtkFileSystemModel *model) -{ - guint i; - - if (model->frozen) - { - model->filter_on_thaw = TRUE; - return; - } - - freeze_updates (model); - - /* start at index 1, don't change the editable */ - for (i = 1; i < model->files->len; i++) - node_compute_visibility_and_filters (model, i); - - model->filter_on_thaw = FALSE; - thaw_updates (model); -} - /** * _gtk_file_system_model_set_show_hidden: * @model: a `GtkFileSystemModel` @@ -720,7 +878,7 @@ gtk_file_system_model_refilter_all (GtkFileSystemModel *model) **/ void _gtk_file_system_model_set_show_hidden (GtkFileSystemModel *model, - gboolean show_hidden) + gboolean show_hidden) { g_return_if_fail (GTK_IS_FILE_SYSTEM_MODEL (model)); @@ -743,7 +901,7 @@ _gtk_file_system_model_set_show_hidden (GtkFileSystemModel *model, */ void _gtk_file_system_model_set_show_folders (GtkFileSystemModel *model, - gboolean show_folders) + gboolean show_folders) { g_return_if_fail (GTK_IS_FILE_SYSTEM_MODEL (model)); @@ -766,7 +924,7 @@ _gtk_file_system_model_set_show_folders (GtkFileSystemModel *model, */ void _gtk_file_system_model_set_show_files (GtkFileSystemModel *model, - gboolean show_files) + gboolean show_files) { g_return_if_fail (GTK_IS_FILE_SYSTEM_MODEL (model)); @@ -790,7 +948,7 @@ _gtk_file_system_model_set_show_files (GtkFileSystemModel *model, */ void _gtk_file_system_model_set_filter_folders (GtkFileSystemModel *model, - gboolean filter_folders) + gboolean filter_folders) { g_return_if_fail (GTK_IS_FILE_SYSTEM_MODEL (model)); @@ -822,36 +980,6 @@ _gtk_file_system_model_get_cancellable (GtkFileSystemModel *model) return model->cancellable; } -static guint -node_get_for_file (GtkFileSystemModel *model, - GFile * file) -{ - guint i; - - i = GPOINTER_TO_UINT (g_hash_table_lookup (model->file_lookup, file)); - if (i != 0) - return i; - - /* Node 0 is the editable row and has no associated file or entry in the table, so we start counting from 1. - * - * The invariant here is that the files in model->files[n] for n < g_hash_table_size (model->file_lookup) - * are already added to the hash table. this loop merely rebuilds our (file -> index) mapping on demand. - * - * If we exit the loop, the next pending batch of mappings will be resolved when this function gets called again - * with another file that is not yet in the mapping. - */ - for (i = g_hash_table_size (model->file_lookup) + 1; i < model->files->len; i++) - { - FileModelNode *node = get_node (model, i); - - g_hash_table_insert (model->file_lookup, node->file, GUINT_TO_POINTER (i)); - if (g_file_equal (node->file, file)) - return i; - } - - return 0; -} - GFileInfo * _gtk_file_system_model_get_info_for_file (GtkFileSystemModel *model, GFile *file) @@ -871,114 +999,6 @@ _gtk_file_system_model_get_info_for_file (GtkFileSystemModel *model, return node->info; } -/* When an element is added or removed to the model->files array, we need to - * update the model->file_lookup mappings of (node, index), as the indexes - * change. This function adds the specified increment to the index in that pair - * if the index is equal or after the specified id. We use this to slide the - * mappings up or down when a node is added or removed, respectively. - */ -static void -adjust_file_lookup (GtkFileSystemModel *model, guint id, int increment) -{ - GHashTableIter iter; - gpointer key; - gpointer value; - - g_hash_table_iter_init (&iter, model->file_lookup); - - while (g_hash_table_iter_next (&iter, &key, &value)) - { - guint index = GPOINTER_TO_UINT (value); - - if (index >= id) - { - index += increment; - g_hash_table_iter_replace (&iter, GUINT_TO_POINTER (index)); - } - } -} - -/** - * add_file: - * @model: the model - * @file: the file to add - * @info: the information to associate with the file - * - * Adds the given @file with its associated @info to the @model. - * If the model is frozen, the file will only show up after it is thawn. - **/ -static void -add_file (GtkFileSystemModel *model, - GFile *file, - GFileInfo *info) -{ - FileModelNode *node; - guint position; - - g_return_if_fail (GTK_IS_FILE_SYSTEM_MODEL (model)); - g_return_if_fail (G_IS_FILE (file)); - g_return_if_fail (G_IS_FILE_INFO (info)); - - node = g_slice_alloc0 (sizeof (FileModelNode)); - node->file = g_object_ref (file); - if (info) - { - g_file_info_set_attribute_object (info, "standard::file", G_OBJECT (file)); - node->info = g_object_ref (info); - } - node->frozen_add = model->frozen ? TRUE : FALSE; - - g_array_append_vals (model->files, node, 1); - g_slice_free1 (sizeof (FileModelNode), node); - - position = model->files->len - 1; - - if (!model->frozen) - node_compute_visibility_and_filters (model, model->files->len -1); - - /* Ignore the first item */ - g_list_model_items_changed (G_LIST_MODEL (model), position - 1, 0, 1); -} - -/** - * remove_file: - * @model: the model - * @file: file to remove from the model. The file must have been - * added to the model previously - * - * Removes the given file from the model. If the file is not part of - * @model, this function does nothing. - **/ -static void -remove_file (GtkFileSystemModel *model, - GFile *file) -{ - FileModelNode *node; - guint id; - - g_return_if_fail (GTK_IS_FILE_SYSTEM_MODEL (model)); - g_return_if_fail (G_IS_FILE (file)); - - id = node_get_for_file (model, file); - if (id == 0) - return; - - node = get_node (model, id); - - node_invalidate_index (model, id); - - g_hash_table_remove (model->file_lookup, file); - g_object_unref (node->file); - adjust_file_lookup (model, id, -1); - - if (node->info) - g_object_unref (node->info); - - g_array_remove_index (model->files, id); - - g_list_model_items_changed (G_LIST_MODEL (model), id - 1, 1, 0); -} - /** * _gtk_file_system_model_update_files: * @model: the model @@ -1017,7 +1037,7 @@ _gtk_file_system_model_update_files (GtkFileSystemModel *model, **/ void _gtk_file_system_model_set_filter (GtkFileSystemModel *model, - GtkFileFilter * filter) + GtkFileFilter * filter) { g_return_if_fail (GTK_IS_FILE_SYSTEM_MODEL (model)); g_return_if_fail (filter == NULL || GTK_IS_FILE_FILTER (filter)); @@ -1027,61 +1047,6 @@ _gtk_file_system_model_set_filter (GtkFileSystemModel *model, gtk_file_system_model_refilter_all (model); } -/** - * freeze_updates: - * @model: a `GtkFileSystemModel` - * - * Freezes most updates on the model, so that performing multiple operations on - * the files in the model do not cause any events. Use thaw_updates() to resume - * proper operations. It is fine to call this function multiple times as long as - * freeze and thaw calls are balanced. - **/ -static void -freeze_updates (GtkFileSystemModel *model) -{ - g_return_if_fail (GTK_IS_FILE_SYSTEM_MODEL (model)); - - model->frozen++; -} - -/** - * thaw_updates: - * @model: a `GtkFileSystemModel` - * - * Undoes the effect of a previous call to freeze_updates() - **/ -static void -thaw_updates (GtkFileSystemModel *model) -{ - gboolean stuff_added; - - g_return_if_fail (GTK_IS_FILE_SYSTEM_MODEL (model)); - g_return_if_fail (model->frozen > 0); - - model->frozen--; - if (model->frozen > 0) - return; - - stuff_added = get_node (model, model->files->len - 1)->frozen_add; - - if (model->filter_on_thaw) - gtk_file_system_model_refilter_all (model); - if (stuff_added) - { - guint i; - - for (i = 0; i < model->files->len; i++) - { - FileModelNode *node = get_node (model, i); - - if (!node->frozen_add) - continue; - node->frozen_add = FALSE; - node_compute_visibility_and_filters (model, i); - } - } -} - /** * _gtk_file_system_model_add_and_query_file: * @model: a `GtkFileSystemModel` -- 2.30.2