1 /* GTK - The GIMP Toolkit
2 * gtkfilesystemmodel.c: GtkTreeModel wrapping a GtkFileSystem
3 * Copyright (C) 2003, Red Hat, Inc.
5 * This library is free software; you can redistribute it and/or
6 * modify it under the terms of the GNU Lesser General Public
7 * License as published by the Free Software Foundation; either
8 * version 2 of the License, or (at your option) any later version.
10 * This library is distributed in the hope that it will be useful,
11 * but WITHOUT ANY WARRANTY; without even the implied warranty of
12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
13 * Lesser General Public License for more details.
15 * You should have received a copy of the GNU Lesser General Public
16 * License along with this library; if not, write to the
17 * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
18 * Boston, MA 02111-1307, USA.
23 #include "gtkfilesystemmodel.h"
28 #include "gtkfilesystem.h"
30 #include "gtkmarshalers.h"
31 #include "gtktreedatalist.h"
32 #include "gtktreednd.h"
33 #include "gtktreemodel.h"
38 /* priority used for all async callbacks in the main loop
39 * This should be higher than redraw priorities so multiple callbacks
40 * firing can be handled without intermediate redraws */
41 #define IO_PRIORITY G_PRIORITY_DEFAULT
43 /* random number that everyone else seems to use, too */
44 #define FILES_PER_QUERY 100
46 typedef struct _FileModelNode FileModelNode;
47 typedef struct _GtkFileSystemModelClass GtkFileSystemModelClass;
51 GFile * file; /* file represented by this node or NULL for editable */
52 GFileInfo * info; /* info for this file or NULL if unknown */
54 guint index; /* if valid, index in path - aka visible nodes before this one */
56 guint visible :1; /* if the file is currently visible */
57 guint frozen_add :1; /* true if the model was frozen and the entry has not been added yet */
59 GValue values[1]; /* actually n_columns values */
62 struct _GtkFileSystemModel
64 GObject parent_instance;
66 GFile * dir; /* directory that's displayed */
67 guint dir_thaw_source;/* GSource id for unfreezing the model */
68 char * attributes; /* attributes the file info must contain */
69 GFileMonitor * dir_monitor; /* directory that is monitored */
71 GCancellable * cancellable; /* cancellable in use for all operations - cancelled on dispose */
72 GArray * files; /* array of FileModelNode containing all our files */
73 guint n_indexes_valid;/* count of valid indexes */
74 GHashTable * file_lookup; /* file => array index table */
76 guint n_columns; /* number of columns */
77 GType * column_types; /* types of each column */
78 GtkFileSystemModelGetValue get_func; /* function to call to fill in values in columns */
79 gpointer get_data; /* data to pass to get_func */
81 GtkFileFilter * filter; /* filter to use for deciding which nodes are visible */
83 int sort_column_id; /* current sorting column */
84 GtkSortType sort_order; /* current sorting order */
85 GList * sort_list; /* list of sorting functions */
86 GtkTreeIterCompareFunc default_sort_func; /* default sort function */
87 gpointer default_sort_data; /* data to pass to default sort func */
88 GDestroyNotify default_sort_destroy; /* function to call to destroy default_sort_data */
90 guint frozen; /* number of times we're frozen */
92 gboolean filter_on_thaw :1;/* set when filtering needs to happen upon thawing */
93 gboolean sort_on_thaw :1;/* set when sorting needs to happen upon thawing */
95 guint show_hidden :1; /* whether to show hidden files */
96 guint show_folders :1;/* whether to show folders */
97 guint show_files :1; /* whether to show files */
100 #define GTK_FILE_SYSTEM_MODEL_CLASS(klass) (G_TYPE_CHECK_CLASS_CAST ((klass), GTK_TYPE_FILE_SYSTEM_MODEL, GtkFileSystemModelClass))
101 #define GTK_IS_FILE_SYSTEM_MODEL_CLASS(klass) (G_TYPE_CHECK_CLASS_TYPE ((klass), GTK_TYPE_FILE_SYSTEM_MODEL))
102 #define GTK_FILE_SYSTEM_MODEL_GET_CLASS(obj) (G_TYPE_INSTANCE_GET_CLASS ((obj), GTK_TYPE_FILE_SYSTEM_MODEL, GtkFileSystemModelClass))
104 struct _GtkFileSystemModelClass
106 GObjectClass parent_class;
110 void (*finished_loading) (GtkFileSystemModel *model, GError *error);
114 * @user_data: the model
115 * @user_data2: GUINT_TO_POINTER of array index of current entry
117 * All other fields are unused. Note that the array index does not corrspond
118 * 1:1 with the path index as entries might not be visible.
120 #define ITER_INDEX(iter) GPOINTER_TO_UINT((iter)->user_data2)
121 #define ITER_IS_VALID(model, iter) ((model) == (iter)->user_data)
122 #define ITER_INIT_FROM_INDEX(model, _iter, _index) G_STMT_START {\
123 g_assert (_index < (model)->files->len); \
124 (_iter)->user_data = (model); \
125 (_iter)->user_data2 = GUINT_TO_POINTER (_index); \
128 /*** FileModelNode ***/
130 #define NODE_SIZE(_model) (sizeof (FileModelNode) + sizeof (GValue) * (MAX ((_model)->n_columns, 1) - 1))
131 #define get_node(_model, _index) ((FileModelNode *) (((guint8 *) (_model)->files->data) + (_index) * NODE_SIZE (_model)))
132 #define node_index(_model, _node) (((guint8 *) (_node) - (guint8 *) (_model)->files->data) / NODE_SIZE (_model))
135 node_validate_indexes (GtkFileSystemModel *model, guint min_index, guint min_visible)
137 guint validate, current;
139 if (model->files->len == 0)
141 min_index = MIN (min_index, model->files->len - 1);
142 validate = model->n_indexes_valid;
144 current = get_node (model, validate - 1)->index;
147 while (validate <= min_index && current <= min_visible)
149 FileModelNode *node = get_node (model, validate);
152 node->index = current;
155 model->n_indexes_valid = validate;
159 node_get_index (GtkFileSystemModel *model, guint id)
161 if (model->n_indexes_valid <= id)
162 node_validate_indexes (model, id, G_MAXUINT);
164 return get_node (model, id)->index - 1;
168 node_invalidate_index (GtkFileSystemModel *model, guint id)
170 model->n_indexes_valid = MIN (model->n_indexes_valid, id);
174 gtk_tree_path_new_from_node (GtkFileSystemModel *model, guint id)
176 guint i = node_get_index (model, id);
178 g_assert (i < model->files->len);
180 return gtk_tree_path_new_from_indices (i, -1);
184 node_set_visible (GtkFileSystemModel *model, guint id, gboolean visible)
186 FileModelNode *node = get_node (model, id);
190 if (node->visible == visible ||
196 node->visible = TRUE;
197 node_invalidate_index (model, id);
198 path = gtk_tree_path_new_from_node (model, id);
199 ITER_INIT_FROM_INDEX (model, &iter, id);
200 gtk_tree_model_row_inserted (GTK_TREE_MODEL (model), path, &iter);
201 gtk_tree_path_free (path);
205 path = gtk_tree_path_new_from_node (model, id);
206 node->visible = FALSE;
207 node_invalidate_index (model, id);
208 gtk_tree_model_row_deleted (GTK_TREE_MODEL (model), path);
209 gtk_tree_path_free (path);
214 node_should_be_visible (GtkFileSystemModel *model, guint id)
216 FileModelNode *node = get_node (model, id);
217 GtkFileFilterInfo filter_info = { 0, };
218 GtkFileFilterFlags required;
219 gboolean is_folder, result;
220 char *mime_type = NULL;
221 char *filename = NULL;
224 if (node->info == NULL)
227 if (!model->show_hidden &&
228 (g_file_info_get_is_hidden (node->info) || g_file_info_get_is_backup (node->info)))
231 is_folder = _gtk_file_info_consider_as_directory (node->info);
234 if (model->show_folders != model->show_files &&
235 model->show_folders != is_folder)
241 if (model->filter == NULL)
245 required = gtk_file_filter_get_needed (model->filter);
247 filter_info.contains = GTK_FILE_FILTER_DISPLAY_NAME;
248 filter_info.display_name = g_file_info_get_display_name (node->info);
250 if (required & GTK_FILE_FILTER_MIME_TYPE)
252 filter_info.mime_type = g_file_info_get_attribute_string (node->info, "filechooser::mime-type");
253 if (filter_info.mime_type != NULL)
254 filter_info.contains |= GTK_FILE_FILTER_MIME_TYPE;
257 const char *s = g_file_info_get_content_type (node->info);
260 mime_type = g_content_type_get_mime_type (s);
263 filter_info.mime_type = mime_type;
264 filter_info.contains |= GTK_FILE_FILTER_MIME_TYPE;
270 if (required & GTK_FILE_FILTER_FILENAME)
272 filename = g_file_get_path (node->file);
273 if (filter_info.filename)
275 filter_info.filename = filename;
276 filter_info.contains |= GTK_FILE_FILTER_FILENAME;
280 if (required & GTK_FILE_FILTER_URI)
282 uri = g_file_get_uri (node->file);
285 filter_info.uri = uri;
286 filter_info.contains |= GTK_FILE_FILTER_URI;
290 result = gtk_file_filter_filter (model->filter, &filter_info);
299 /*** GtkTreeModel ***/
301 static GtkTreeModelFlags
302 gtk_file_system_model_get_flags (GtkTreeModel *tree_model)
304 /* GTK_TREE_MODEL_ITERS_PERSIST doesn't work with arrays :( */
305 return GTK_TREE_MODEL_LIST_ONLY;
309 gtk_file_system_model_get_n_columns (GtkTreeModel *tree_model)
311 GtkFileSystemModel *model = GTK_FILE_SYSTEM_MODEL (tree_model);
313 return model->n_columns;
317 gtk_file_system_model_get_column_type (GtkTreeModel *tree_model,
320 GtkFileSystemModel *model = GTK_FILE_SYSTEM_MODEL (tree_model);
322 g_return_val_if_fail (i >= 0 && (guint) i < model->n_columns, G_TYPE_NONE);
324 return model->column_types[i];
328 compare_indices (gconstpointer key, gconstpointer _node)
330 const FileModelNode *node = _node;
332 return GPOINTER_TO_UINT (key) - node->index;
336 gtk_file_system_model_iter_nth_child (GtkTreeModel *tree_model,
341 GtkFileSystemModel *model = GTK_FILE_SYSTEM_MODEL (tree_model);
345 g_return_val_if_fail (n >= 0, FALSE);
352 if (model->n_indexes_valid > 0 &&
353 get_node (model, model->n_indexes_valid - 1)->index >= find)
356 node = bsearch (GUINT_TO_POINTER (find),
358 model->n_indexes_valid,
364 id = node_index (model, node);
365 while (!get_node (model, id)->visible)
370 node_validate_indexes (model, G_MAXUINT, n);
371 id = model->n_indexes_valid - 1;
372 if (model->n_indexes_valid == 0 || get_node (model, id)->index != find)
376 ITER_INIT_FROM_INDEX (model, iter, id);
381 gtk_file_system_model_get_iter (GtkTreeModel *tree_model,
385 g_return_val_if_fail (gtk_tree_path_get_depth (path) > 0, FALSE);
387 return gtk_file_system_model_iter_nth_child (tree_model,
390 gtk_tree_path_get_indices (path)[0]);
394 gtk_file_system_model_get_path (GtkTreeModel *tree_model,
397 GtkFileSystemModel *model = GTK_FILE_SYSTEM_MODEL (tree_model);
399 g_return_val_if_fail (ITER_IS_VALID (model, iter), NULL);
401 return gtk_tree_path_new_from_node (model, ITER_INDEX (iter));
405 gtk_file_system_model_get_value (GtkTreeModel *tree_model,
410 GtkFileSystemModel *model = GTK_FILE_SYSTEM_MODEL (tree_model);
411 const GValue *original;
413 g_return_if_fail ((guint) column < model->n_columns);
414 g_return_if_fail (ITER_IS_VALID (model, iter));
416 original = _gtk_file_system_model_get_value (model, iter, column);
419 g_value_init (value, G_VALUE_TYPE (original));
420 g_value_copy (original, value);
423 g_value_init (value, model->column_types[column]);
427 gtk_file_system_model_iter_next (GtkTreeModel *tree_model,
430 GtkFileSystemModel *model = GTK_FILE_SYSTEM_MODEL (tree_model);
433 g_return_val_if_fail (ITER_IS_VALID (model, iter), FALSE);
435 for (i = ITER_INDEX (iter) + 1; i < model->files->len; i++)
437 FileModelNode *node = get_node (model, i);
441 ITER_INIT_FROM_INDEX (model, iter, i);
450 gtk_file_system_model_iter_children (GtkTreeModel *tree_model,
458 gtk_file_system_model_iter_has_child (GtkTreeModel *tree_model,
465 gtk_file_system_model_iter_n_children (GtkTreeModel *tree_model,
468 GtkFileSystemModel *model = GTK_FILE_SYSTEM_MODEL (tree_model);
473 return node_get_index (model, model->files->len - 1) + 1;
477 gtk_file_system_model_iter_parent (GtkTreeModel *tree_model,
485 gtk_file_system_model_ref_node (GtkTreeModel *tree_model,
488 /* FIXME: implement */
492 gtk_file_system_model_unref_node (GtkTreeModel *tree_model,
495 /* FIXME: implement */
499 gtk_file_system_model_iface_init (GtkTreeModelIface *iface)
501 iface->get_flags = gtk_file_system_model_get_flags;
502 iface->get_n_columns = gtk_file_system_model_get_n_columns;
503 iface->get_column_type = gtk_file_system_model_get_column_type;
504 iface->get_iter = gtk_file_system_model_get_iter;
505 iface->get_path = gtk_file_system_model_get_path;
506 iface->get_value = gtk_file_system_model_get_value;
507 iface->iter_next = gtk_file_system_model_iter_next;
508 iface->iter_children = gtk_file_system_model_iter_children;
509 iface->iter_has_child = gtk_file_system_model_iter_has_child;
510 iface->iter_n_children = gtk_file_system_model_iter_n_children;
511 iface->iter_nth_child = gtk_file_system_model_iter_nth_child;
512 iface->iter_parent = gtk_file_system_model_iter_parent;
513 iface->ref_node = gtk_file_system_model_ref_node;
514 iface->unref_node = gtk_file_system_model_unref_node;
517 /*** GtkTreeSortable ***/
519 typedef struct _SortData SortData;
521 GtkFileSystemModel * model;
522 GtkTreeIterCompareFunc func;
524 int order; /* -1 to invert sort order or 1 to keep it */
527 /* returns FALSE if no sort necessary */
529 sort_data_init (SortData *data, GtkFileSystemModel *model)
531 GtkTreeDataSortHeader *header;
533 if (model->files->len <= 2)
536 switch (model->sort_column_id)
538 case GTK_TREE_SORTABLE_DEFAULT_SORT_COLUMN_ID:
539 if (!model->default_sort_func)
541 data->func = model->default_sort_func;
542 data->data = model->default_sort_data;
544 case GTK_TREE_SORTABLE_UNSORTED_SORT_COLUMN_ID:
547 header = _gtk_tree_data_list_get_header (model->sort_list, model->sort_column_id);
550 data->func = header->func;
551 data->data = header->data;
555 data->order = model->sort_order == GTK_SORT_DESCENDING ? -1 : 1;
561 compare_array_element (gconstpointer a, gconstpointer b, gpointer user_data)
563 SortData *data = user_data;
564 GtkTreeIter itera, iterb;
566 ITER_INIT_FROM_INDEX (data->model, &itera, node_index (data->model, a));
567 ITER_INIT_FROM_INDEX (data->model, &iterb, node_index (data->model, b));
568 return data->func (GTK_TREE_MODEL (data->model), &itera, &iterb, data->data) * data->order;
572 gtk_file_system_model_sort (GtkFileSystemModel *model)
578 model->sort_on_thaw = TRUE;
582 if (sort_data_init (&data, model))
585 guint i, j, n_elements;
587 node_validate_indexes (model, G_MAXUINT, G_MAXUINT);
588 n_elements = node_get_index (model, model->files->len - 1) + 1;
589 model->n_indexes_valid = 0;
590 g_hash_table_remove_all (model->file_lookup);
591 g_qsort_with_data (get_node (model, 1),
592 model->files->len - 1,
594 compare_array_element,
596 g_assert (model->n_indexes_valid == 0);
597 g_assert (g_hash_table_size (model->file_lookup) == 0);
600 int *new_order = g_new (int, n_elements);
603 for (i = 0; i < model->files->len; i++)
605 FileModelNode *node = get_node (model, i);
612 new_order[j] = node->index;
616 g_assert (j == n_elements);
617 path = gtk_tree_path_new ();
618 gtk_tree_model_rows_reordered (GTK_TREE_MODEL (model),
622 gtk_tree_path_free (path);
627 model->sort_on_thaw = FALSE;
631 gtk_file_system_model_sort_node (GtkFileSystemModel *model, guint node)
634 gtk_file_system_model_sort (model);
638 gtk_file_system_model_get_sort_column_id (GtkTreeSortable *sortable,
639 gint *sort_column_id,
642 GtkFileSystemModel *model = GTK_FILE_SYSTEM_MODEL (sortable);
645 *sort_column_id = model->sort_column_id;
647 *order = model->sort_order;
649 if (model->sort_column_id == GTK_TREE_SORTABLE_DEFAULT_SORT_COLUMN_ID ||
650 model->sort_column_id == GTK_TREE_SORTABLE_UNSORTED_SORT_COLUMN_ID)
657 gtk_file_system_model_set_sort_column_id (GtkTreeSortable *sortable,
661 GtkFileSystemModel *model = GTK_FILE_SYSTEM_MODEL (sortable);
663 if ((model->sort_column_id == sort_column_id) &&
664 (model->sort_order == order))
667 if (sort_column_id != GTK_TREE_SORTABLE_UNSORTED_SORT_COLUMN_ID)
669 if (sort_column_id != GTK_TREE_SORTABLE_DEFAULT_SORT_COLUMN_ID)
671 GtkTreeDataSortHeader *header = NULL;
673 header = _gtk_tree_data_list_get_header (model->sort_list,
676 /* We want to make sure that we have a function */
677 g_return_if_fail (header != NULL);
678 g_return_if_fail (header->func != NULL);
682 g_return_if_fail (model->default_sort_func != NULL);
687 model->sort_column_id = sort_column_id;
688 model->sort_order = order;
690 gtk_tree_sortable_sort_column_changed (sortable);
692 gtk_file_system_model_sort (model);
696 gtk_file_system_model_set_sort_func (GtkTreeSortable *sortable,
698 GtkTreeIterCompareFunc func,
700 GDestroyNotify destroy)
702 GtkFileSystemModel *model = GTK_FILE_SYSTEM_MODEL (sortable);
704 model->sort_list = _gtk_tree_data_list_set_header (model->sort_list,
706 func, data, destroy);
708 if (model->sort_column_id == sort_column_id)
709 gtk_file_system_model_sort (model);
713 gtk_file_system_model_set_default_sort_func (GtkTreeSortable *sortable,
714 GtkTreeIterCompareFunc func,
716 GDestroyNotify destroy)
718 GtkFileSystemModel *model = GTK_FILE_SYSTEM_MODEL (sortable);
720 if (model->default_sort_destroy)
722 GDestroyNotify d = model->default_sort_destroy;
724 model->default_sort_destroy = NULL;
725 d (model->default_sort_data);
728 model->default_sort_func = func;
729 model->default_sort_data = data;
730 model->default_sort_destroy = destroy;
732 if (model->sort_column_id == GTK_TREE_SORTABLE_DEFAULT_SORT_COLUMN_ID)
733 gtk_file_system_model_sort (model);
737 gtk_file_system_model_has_default_sort_func (GtkTreeSortable *sortable)
739 GtkFileSystemModel *model = GTK_FILE_SYSTEM_MODEL (sortable);
741 return (model->default_sort_func != NULL);
745 gtk_file_system_model_sortable_init (GtkTreeSortableIface *iface)
747 iface->get_sort_column_id = gtk_file_system_model_get_sort_column_id;
748 iface->set_sort_column_id = gtk_file_system_model_set_sort_column_id;
749 iface->set_sort_func = gtk_file_system_model_set_sort_func;
750 iface->set_default_sort_func = gtk_file_system_model_set_default_sort_func;
751 iface->has_default_sort_func = gtk_file_system_model_has_default_sort_func;
754 /*** GtkTreeDragSource ***/
757 drag_source_row_draggable (GtkTreeDragSource *drag_source,
760 GtkFileSystemModel *model = GTK_FILE_SYSTEM_MODEL (drag_source);
763 if (!gtk_file_system_model_get_iter (GTK_TREE_MODEL (model), &iter, path))
766 return ITER_INDEX (&iter) != 0;
770 drag_source_drag_data_get (GtkTreeDragSource *drag_source,
772 GtkSelectionData *selection_data)
774 GtkFileSystemModel *model = GTK_FILE_SYSTEM_MODEL (drag_source);
779 if (!gtk_file_system_model_get_iter (GTK_TREE_MODEL (model), &iter, path))
782 node = get_node (model, ITER_INDEX (&iter));
783 if (node->file == NULL)
786 uris[0] = g_file_get_uri (node->file);
788 gtk_selection_data_set_uris (selection_data, uris);
795 drag_source_iface_init (GtkTreeDragSourceIface *iface)
797 iface->row_draggable = drag_source_row_draggable;
798 iface->drag_data_get = drag_source_drag_data_get;
799 iface->drag_data_delete = NULL;
802 /*** GtkFileSystemModel ***/
810 static guint file_system_model_signals[LAST_SIGNAL] = { 0 };
814 G_DEFINE_TYPE_WITH_CODE (GtkFileSystemModel, _gtk_file_system_model, G_TYPE_OBJECT,
815 G_IMPLEMENT_INTERFACE (GTK_TYPE_TREE_MODEL,
816 gtk_file_system_model_iface_init)
817 G_IMPLEMENT_INTERFACE (GTK_TYPE_TREE_SORTABLE,
818 gtk_file_system_model_sortable_init)
819 G_IMPLEMENT_INTERFACE (GTK_TYPE_TREE_DRAG_SOURCE,
820 drag_source_iface_init))
823 gtk_file_system_model_dispose (GObject *object)
825 GtkFileSystemModel *model = GTK_FILE_SYSTEM_MODEL (object);
827 g_cancellable_cancel (model->cancellable);
828 if (model->dir_monitor)
829 g_file_monitor_cancel (model->dir_monitor);
831 G_OBJECT_CLASS (_gtk_file_system_model_parent_class)->dispose (object);
836 gtk_file_system_model_finalize (GObject *object)
838 GtkFileSystemModel *model = GTK_FILE_SYSTEM_MODEL (object);
841 for (i = 0; i < model->files->len; i++)
843 FileModelNode *node = get_node (model, i);
845 g_object_unref (node->file);
847 g_object_unref (node->info);
849 g_array_free (model->files, TRUE);
851 g_object_unref (model->cancellable);
852 g_free (model->attributes);
854 g_object_unref (model->dir);
855 if (model->dir_monitor)
856 g_object_unref (model->dir_monitor);
857 g_hash_table_destroy (model->file_lookup);
859 g_object_unref (model->filter);
861 _gtk_tree_data_list_header_free (model->sort_list);
862 if (model->default_sort_destroy)
863 model->default_sort_destroy (model->default_sort_data);
865 G_OBJECT_CLASS (_gtk_file_system_model_parent_class)->finalize (object);
869 _gtk_file_system_model_class_init (GtkFileSystemModelClass *class)
871 GObjectClass *gobject_class = G_OBJECT_CLASS (class);
873 gobject_class->finalize = gtk_file_system_model_finalize;
874 gobject_class->dispose = gtk_file_system_model_dispose;
876 file_system_model_signals[FINISHED_LOADING] =
877 g_signal_new (I_("finished-loading"),
878 G_OBJECT_CLASS_TYPE (gobject_class),
880 G_STRUCT_OFFSET (GtkFileSystemModelClass, finished_loading),
882 _gtk_marshal_VOID__POINTER,
883 G_TYPE_NONE, 1, G_TYPE_POINTER);
887 _gtk_file_system_model_init (GtkFileSystemModel *model)
889 model->show_files = TRUE;
890 model->show_folders = TRUE;
891 model->show_hidden = FALSE;
893 model->sort_column_id = GTK_TREE_SORTABLE_UNSORTED_SORT_COLUMN_ID;
895 model->file_lookup = g_hash_table_new (g_file_hash, (GEqualFunc) g_file_equal);
896 model->cancellable = g_cancellable_new ();
902 gtk_file_system_model_closed_enumerator (GObject *object, GAsyncResult *res, gpointer data)
904 g_file_enumerator_close_finish (G_FILE_ENUMERATOR (object), res, NULL);
908 thaw_func (gpointer data)
910 GtkFileSystemModel *model = data;
912 _gtk_file_system_model_thaw_updates (model);
913 model->dir_thaw_source = 0;
919 gtk_file_system_model_got_files (GObject *object, GAsyncResult *res, gpointer data)
921 GFileEnumerator *enumerator = G_FILE_ENUMERATOR (object);
922 GtkFileSystemModel *model = data;
924 GError *error = NULL;
926 gdk_threads_enter ();
928 files = g_file_enumerator_next_files_finish (enumerator, res, &error);
932 if (model->dir_thaw_source == 0)
934 _gtk_file_system_model_freeze_updates (model);
935 model->dir_thaw_source = gdk_threads_add_timeout_full (IO_PRIORITY + 1,
942 for (walk = files; walk; walk = walk->next)
949 name = g_file_info_get_name (info);
952 /* Shouldn't happen, but the APIs allow it */
953 g_object_unref (info);
956 file = g_file_get_child (model->dir, name);
957 _gtk_file_system_model_add_file (model, file, info);
958 g_object_unref (file);
959 g_object_unref (info);
966 g_file_enumerator_close_async (enumerator,
969 gtk_file_system_model_closed_enumerator,
972 g_error_free (error);
974 g_signal_emit (model, file_system_model_signals[FINISHED_LOADING], 0, NULL);
976 if (model->dir_thaw_source != 0)
978 g_source_remove (model->dir_thaw_source);
979 model->dir_thaw_source = 0;
980 _gtk_file_system_model_thaw_updates (model);
983 g_object_unref (model);
986 g_file_enumerator_next_files_async (enumerator,
987 g_file_is_native (model->dir) ? 50 * FILES_PER_QUERY : FILES_PER_QUERY,
990 gtk_file_system_model_got_files,
993 gdk_threads_leave ();
997 gtk_file_system_model_query_done (GObject * object,
1001 GtkFileSystemModel *model = data; /* only a valid pointer if not cancelled */
1002 GFile *file = G_FILE (object);
1005 info = g_file_query_info_finish (file, res, NULL);
1009 _gtk_file_system_model_update_file (model, file, info, TRUE);
1013 gtk_file_system_model_monitor_change (GFileMonitor * monitor,
1016 GFileMonitorEvent type,
1017 GtkFileSystemModel *model)
1021 case G_FILE_MONITOR_EVENT_CREATED:
1022 case G_FILE_MONITOR_EVENT_CHANGED:
1023 case G_FILE_MONITOR_EVENT_ATTRIBUTE_CHANGED:
1024 /* We can treat all of these the same way */
1025 g_file_query_info_async (file,
1030 gtk_file_system_model_query_done,
1033 case G_FILE_MONITOR_EVENT_DELETED:
1034 _gtk_file_system_model_remove_file (model, file);
1036 case G_FILE_MONITOR_EVENT_CHANGES_DONE_HINT:
1037 /* FIXME: use freeze/thaw with this somehow? */
1038 case G_FILE_MONITOR_EVENT_PRE_UNMOUNT:
1039 case G_FILE_MONITOR_EVENT_UNMOUNTED:
1047 gtk_file_system_model_got_enumerator (GObject *dir, GAsyncResult *res, gpointer data)
1049 GtkFileSystemModel *model = data;
1050 GFileEnumerator *enumerator;
1051 GError *error = NULL;
1053 gdk_threads_enter ();
1055 enumerator = g_file_enumerate_children_finish (G_FILE (dir), res, &error);
1056 if (enumerator == NULL)
1058 g_signal_emit (model, file_system_model_signals[FINISHED_LOADING], 0, error);
1059 g_object_unref (model);
1060 g_error_free (error);
1064 g_file_enumerator_next_files_async (enumerator,
1065 g_file_is_native (model->dir) ? 50 * FILES_PER_QUERY : FILES_PER_QUERY,
1068 gtk_file_system_model_got_files,
1070 g_object_unref (enumerator);
1071 model->dir_monitor = g_file_monitor_directory (model->dir,
1075 if (model->dir_monitor)
1076 g_signal_connect (model->dir_monitor,
1078 G_CALLBACK (gtk_file_system_model_monitor_change),
1082 gdk_threads_leave ();
1086 gtk_file_system_model_set_n_columns (GtkFileSystemModel *model,
1092 g_assert (model->files == NULL);
1094 model->n_columns = n_columns;
1095 model->column_types = g_slice_alloc0 (sizeof (GType) * n_columns);
1097 for (i = 0; i < (guint) n_columns; i++)
1099 GType type = va_arg (args, GType);
1100 if (! _gtk_tree_data_list_check_type (type))
1102 g_warning ("%s: Invalid type %s\n", G_STRLOC, g_type_name (type));
1106 model->column_types[i] = type;
1109 model->sort_list = _gtk_tree_data_list_header_new (n_columns, model->column_types);
1111 model->files = g_array_new (FALSE, FALSE, NODE_SIZE (model));
1112 /* add editable node at start */
1113 g_array_set_size (model->files, 1);
1114 memset (get_node (model, 0), 0, NODE_SIZE (model));
1118 gtk_file_system_model_set_directory (GtkFileSystemModel *model,
1120 const gchar * attributes)
1122 g_return_if_fail (GTK_IS_FILE_SYSTEM_MODEL (model));
1123 g_return_if_fail (dir == NULL || G_IS_FILE (dir));
1125 model->dir = g_object_ref (dir);
1126 model->attributes = g_strdup (attributes);
1128 g_object_ref (model);
1129 g_file_enumerate_children_async (model->dir,
1134 gtk_file_system_model_got_enumerator,
1139 static GtkFileSystemModel *
1140 _gtk_file_system_model_new_valist (GtkFileSystemModelGetValue get_func,
1145 GtkFileSystemModel *model;
1147 model = g_object_new (GTK_TYPE_FILE_SYSTEM_MODEL, NULL);
1148 model->get_func = get_func;
1149 model->get_data = get_data;
1151 gtk_file_system_model_set_n_columns (model, n_columns, args);
1157 * _gtk_file_system_model_new:
1158 * @get_func: function to call for getting a value
1159 * @get_data: user data argument passed to @get_func
1160 * @n_columns: number of columns
1161 * @...: @n_columns #GType types for the columns
1163 * Creates a new #GtkFileSystemModel object. You need to add files
1164 * to the list using _gtk_file_system_model_add_file().
1166 * Return value: the newly created #GtkFileSystemModel
1168 GtkFileSystemModel *
1169 _gtk_file_system_model_new (GtkFileSystemModelGetValue get_func,
1174 GtkFileSystemModel *model;
1177 g_return_val_if_fail (get_func != NULL, NULL);
1178 g_return_val_if_fail (n_columns > 0, NULL);
1180 va_start (args, n_columns);
1181 model = _gtk_file_system_model_new_valist (get_func, get_data, n_columns, args);
1188 * _gtk_file_system_model_new_for_directory:
1189 * @directory: the directory to show.
1190 * @attributes: attributes to immediately load or %NULL for all
1192 * Creates a new #GtkFileSystemModel object. The #GtkFileSystemModel
1193 * object wraps the given @directory as a #GtkTreeModel.
1194 * The model will query the given directory with the given @attributes
1195 * and add all files inside the directory automatically. If supported,
1196 * it will also monitor the drectory and update the model's
1197 * contents to reflect changes, if the @directory supports monitoring.
1199 * Return value: the newly created #GtkFileSystemModel
1201 GtkFileSystemModel *
1202 _gtk_file_system_model_new_for_directory (GFile * dir,
1203 const gchar * attributes,
1204 GtkFileSystemModelGetValue get_func,
1209 GtkFileSystemModel *model;
1212 g_return_val_if_fail (G_IS_FILE (dir), NULL);
1213 g_return_val_if_fail (get_func != NULL, NULL);
1214 g_return_val_if_fail (n_columns > 0, NULL);
1216 va_start (args, n_columns);
1217 model = _gtk_file_system_model_new_valist (get_func, get_data, n_columns, args);
1220 gtk_file_system_model_set_directory (model, dir, attributes);
1226 gtk_file_system_model_refilter_all (GtkFileSystemModel *model)
1232 model->filter_on_thaw = TRUE;
1236 _gtk_file_system_model_freeze_updates (model);
1238 /* start at index 1, don't change the editable */
1239 for (i = 1; i < model->files->len; i++)
1241 node_set_visible (model, i, node_should_be_visible (model, i));
1244 model->filter_on_thaw = FALSE;
1245 _gtk_file_system_model_thaw_updates (model);
1249 * _gtk_file_system_model_set_show_hidden:
1250 * @model: a #GtkFileSystemModel
1251 * @show_hidden: whether hidden files should be displayed
1253 * Sets whether hidden files should be included in the #GtkTreeModel
1257 _gtk_file_system_model_set_show_hidden (GtkFileSystemModel *model,
1258 gboolean show_hidden)
1260 g_return_if_fail (GTK_IS_FILE_SYSTEM_MODEL (model));
1262 show_hidden = show_hidden != FALSE;
1264 if (show_hidden != model->show_hidden)
1266 model->show_hidden = show_hidden;
1267 gtk_file_system_model_refilter_all (model);
1272 * _gtk_file_system_model_set_show_folders:
1273 * @model: a #GtkFileSystemModel
1274 * @show_folders: whether folders should be displayed
1276 * Sets whether folders should be included in the #GtkTreeModel for
1280 _gtk_file_system_model_set_show_folders (GtkFileSystemModel *model,
1281 gboolean show_folders)
1283 g_return_if_fail (GTK_IS_FILE_SYSTEM_MODEL (model));
1285 show_folders = show_folders != FALSE;
1287 if (show_folders != model->show_folders)
1289 model->show_folders = show_folders;
1290 gtk_file_system_model_refilter_all (model);
1295 * _gtk_file_system_model_set_show_files:
1296 * @model: a #GtkFileSystemModel
1297 * @show_files: whether files (as opposed to folders) should
1300 * Sets whether files (as opposed to folders) should be included
1301 * in the #GtkTreeModel for display.
1304 _gtk_file_system_model_set_show_files (GtkFileSystemModel *model,
1305 gboolean show_files)
1307 g_return_if_fail (GTK_IS_FILE_SYSTEM_MODEL (model));
1309 show_files = show_files != FALSE;
1311 if (show_files != model->show_files)
1313 model->show_files = show_files;
1314 gtk_file_system_model_refilter_all (model);
1319 _gtk_file_system_model_get_cancellable (GtkFileSystemModel *model)
1321 g_return_val_if_fail (GTK_IS_FILE_SYSTEM_MODEL (model), NULL);
1323 return model->cancellable;
1327 * _gtk_file_system_model_get_info:
1328 * @model: a #GtkFileSystemModel
1329 * @iter: a #GtkTreeIter pointing to a row of @model
1331 * Gets the #GFileInfo structure for a particular row
1334 * Return value: a #GFileInfo structure. This structure
1335 * is owned by @model and must not be modified or freed.
1336 * If you want to keep the information for later use,
1337 * you must take a reference, since the structure may be
1338 * freed on later changes to the file system. If you have
1339 * called _gtk_file_system_model_add_editable() and the @iter
1340 * corresponds to the row that this function returned, the
1341 * return value will be NULL.
1344 _gtk_file_system_model_get_info (GtkFileSystemModel *model,
1347 FileModelNode *node;
1349 g_return_val_if_fail (GTK_IS_FILE_SYSTEM_MODEL (model), NULL);
1351 node = get_node (model, ITER_INDEX (iter));
1352 g_assert (node->info == NULL || G_IS_FILE_INFO (node->info));
1357 * _gtk_file_system_model_get_file:
1358 * @model: a #GtkFileSystemModel
1359 * @iter: a #GtkTreeIter pointing to a row of @model
1361 * Gets the file for a particular row in @model.
1363 * Return value: the file. This object is owned by @model and
1364 * or freed. If you want to save the path for later use,
1365 * you must take a ref, since the object may be freed
1366 * on later changes to the file system.
1369 _gtk_file_system_model_get_file (GtkFileSystemModel *model,
1372 FileModelNode *node;
1374 g_return_val_if_fail (GTK_IS_FILE_SYSTEM_MODEL (model), NULL);
1376 node = get_node (model, ITER_INDEX (iter));
1381 * _gtk_file_system_model_get_value:
1382 * @model: a #GtkFileSystemModel
1383 * @iter: a #GtkTreeIter pointing to a row of @model
1384 * @column: the column to get the value for
1386 * Gets the value associated with the given row @iter and @column.
1387 * If no value is available yet and the default value should be used,
1388 * %NULL is returned.
1389 * This is a performance optimization for the calls
1390 * gtk_tree_model_get() or gtk_tree_model_get_value(), which copy
1391 * the value and spend a considerable amount of time in iterator
1392 * lookups. Both of which are slow.
1394 * Returns: a pointer to the actual value as stored in @model or %NULL
1395 * if no value available yet.
1398 _gtk_file_system_model_get_value (GtkFileSystemModel *model,
1402 FileModelNode *node;
1404 g_return_val_if_fail (GTK_IS_FILE_SYSTEM_MODEL (model), NULL);
1405 g_return_val_if_fail (column >= 0 && (guint) column < model->n_columns, NULL);
1407 node = get_node (model, ITER_INDEX (iter));
1409 if (!G_VALUE_TYPE (&node->values[column]))
1411 g_value_init (&node->values[column], model->column_types[column]);
1412 if (!model->get_func (model,
1416 &node->values[column],
1419 g_value_unset (&node->values[column]);
1424 return &node->values[column];
1428 node_get_for_file (GtkFileSystemModel *model,
1433 i = GPOINTER_TO_UINT (g_hash_table_lookup (model->file_lookup, file));
1437 /* node 0 is the editable row and has no associated file or entry in the table */
1438 for (i = g_hash_table_size (model->file_lookup) + 1; i < model->files->len; i++)
1440 FileModelNode *node = get_node (model, i);
1442 g_hash_table_insert (model->file_lookup, node->file, GUINT_TO_POINTER (i));
1443 if (g_file_equal (node->file, file))
1451 _gtk_file_system_model_get_iter_for_file (GtkFileSystemModel *model,
1457 g_return_val_if_fail (GTK_IS_FILE_SYSTEM_MODEL (model), FALSE);
1458 g_return_val_if_fail (iter != NULL, FALSE);
1459 g_return_val_if_fail (G_IS_FILE (file), FALSE);
1461 i = node_get_for_file (model, file);
1466 ITER_INIT_FROM_INDEX (model, iter, i);
1471 * _gtk_file_system_model_add_file:
1473 * @file: the file to add
1474 * @info: the information to associate with the file
1476 * Adds the given @file with its associated @info to the @model.
1477 * If the model is frozen, the file will only show up after it is thawn.
1480 _gtk_file_system_model_add_file (GtkFileSystemModel *model,
1484 FileModelNode *node;
1486 g_return_if_fail (GTK_IS_FILE_SYSTEM_MODEL (model));
1487 g_return_if_fail (G_IS_FILE (file));
1488 g_return_if_fail (G_IS_FILE_INFO (info));
1490 node = g_slice_alloc0 (NODE_SIZE (model));
1491 node->file = g_object_ref (file);
1493 node->info = g_object_ref (info);
1494 node->frozen_add = model->frozen ? TRUE : FALSE;
1496 g_array_append_vals (model->files, node, 1);
1497 g_slice_free1 (NODE_SIZE (model), node);
1500 node_set_visible (model, model->files->len -1,
1501 node_should_be_visible (model, model->files->len - 1));
1502 gtk_file_system_model_sort_node (model, model->files->len -1);
1506 * _gtk_file_system_model_remove_file:
1508 * @file: file to remove from the model. The file must have been
1509 * added to the model previously
1511 * Removes the given file from the model. If the file is not part of
1512 * @model, this function does nothing.
1515 _gtk_file_system_model_remove_file (GtkFileSystemModel *model,
1518 FileModelNode *node;
1521 g_return_if_fail (GTK_IS_FILE_SYSTEM_MODEL (model));
1522 g_return_if_fail (G_IS_FILE (file));
1524 id = node_get_for_file (model, file);
1528 node = get_node (model, id);
1529 node_set_visible (model, id, FALSE);
1530 g_object_unref (node->file);
1532 g_object_unref (node->info);
1533 g_array_remove_index (model->files, id);
1537 * _gtk_file_system_model_update_file:
1540 * @info: the new file info
1541 * @requires_resort: FIXME: get rid of this argument
1543 * Tells the file system model that the file changed and that the
1544 * new @info should be used for it now. If the file is not part of
1545 * @model, it will get added automatically.
1548 _gtk_file_system_model_update_file (GtkFileSystemModel *model,
1551 gboolean requires_resort)
1553 FileModelNode *node;
1556 g_return_if_fail (GTK_IS_FILE_SYSTEM_MODEL (model));
1557 g_return_if_fail (G_IS_FILE (file));
1558 g_return_if_fail (G_IS_FILE_INFO (info));
1560 id = node_get_for_file (model, file);
1562 _gtk_file_system_model_add_file (model, file, info);
1564 node = get_node (model, id);
1566 g_object_unref (node->info);
1567 node->info = g_object_ref (info);
1568 for (i = 0; i < model->n_columns; i++)
1570 if (G_VALUE_TYPE (&node->values[i]))
1571 g_value_unset (&node->values[i]);
1579 path = gtk_tree_path_new_from_node (model, id);
1580 ITER_INIT_FROM_INDEX (model, &iter, id);
1581 gtk_tree_model_row_changed (GTK_TREE_MODEL (model), path, &iter);
1582 gtk_tree_path_free (path);
1585 if (requires_resort)
1586 gtk_file_system_model_sort_node (model, id);
1590 * _gtk_file_system_model_set_filter:
1591 * @mode: a #GtkFileSystemModel
1592 * @filter: %NULL or filter to use
1594 * Sets a filter to be used for deciding if a row should be visible or not.
1595 * Directories are always visible.
1598 _gtk_file_system_model_set_filter (GtkFileSystemModel *model,
1599 GtkFileFilter * filter)
1601 g_return_if_fail (GTK_IS_FILE_SYSTEM_MODEL (model));
1602 g_return_if_fail (filter == NULL || GTK_IS_FILE_FILTER (filter));
1605 g_object_ref (filter);
1607 g_object_unref (model->filter);
1608 model->filter = filter;
1610 gtk_file_system_model_refilter_all (model);
1614 * _gtk_file_system_model_add_editable:
1615 * @model: a #GtkFileSystemModel
1616 * @iter: Location to return the iter corresponding to the editable row
1618 * Adds an "empty" row at the beginning of the model. This does not refer to
1619 * any file, but is a temporary placeholder for a file name that the user will
1620 * type when a corresponding cell is made editable. When your code is done
1621 * using this temporary row, call _gtk_file_system_model_remove_editable().
1624 _gtk_file_system_model_add_editable (GtkFileSystemModel *model, GtkTreeIter *iter)
1626 g_return_if_fail (GTK_IS_FILE_SYSTEM_MODEL (model));
1627 g_return_if_fail (!get_node (model, 0)->visible);
1629 node_set_visible (model, 0, TRUE);
1630 ITER_INIT_FROM_INDEX (model, iter, 0);
1634 * _gtk_file_system_model_remove_editable:
1635 * @model: a #GtkFileSystemModel
1637 * Removes the "empty" row at the beginning of the model that was
1638 * created with _gtk_file_system_model_add_editable(). You should call
1639 * this function when your code is finished editing this temporary row.
1642 _gtk_file_system_model_remove_editable (GtkFileSystemModel *model)
1644 g_return_if_fail (GTK_IS_FILE_SYSTEM_MODEL (model));
1645 g_return_if_fail (get_node (model, 0)->visible);
1647 node_set_visible (model, 0, FALSE);
1651 * _gtk_file_system_model_freeze_updates:
1652 * @model: a #GtkFileSystemModel
1654 * Freezes most updates on the model, so that performing multiple
1655 * operations on the files in the model do not cause any events.
1656 * Use _gtk_file_system_model_thaw_updates() to resume proper
1657 * operations. It is fine to call this function multiple times as
1658 * long as freeze and thaw calls are balanced.
1661 _gtk_file_system_model_freeze_updates (GtkFileSystemModel *model)
1663 g_return_if_fail (GTK_IS_FILE_SYSTEM_MODEL (model));
1669 * _gtk_file_system_model_thaw_updates:
1670 * @model: a #GtkFileSystemModel
1672 * Undoes the effect of a previous call to
1673 * _gtk_file_system_model_freeze_updates()
1676 _gtk_file_system_model_thaw_updates (GtkFileSystemModel *model)
1678 gboolean stuff_added;
1680 g_return_if_fail (GTK_IS_FILE_SYSTEM_MODEL (model));
1681 g_return_if_fail (model->frozen > 0);
1684 if (model->frozen > 0)
1687 stuff_added = get_node (model, model->files->len - 1)->frozen_add;
1689 if (model->filter_on_thaw)
1690 gtk_file_system_model_refilter_all (model);
1691 if (model->sort_on_thaw)
1692 gtk_file_system_model_sort (model);
1697 for (i = 0; i < model->files->len; i++)
1699 FileModelNode *node = get_node (model, i);
1701 if (!node->frozen_add)
1703 node->frozen_add = FALSE;
1704 node_set_visible (model, i, node_should_be_visible (model, i));
1710 * _gtk_file_system_model_clear_cached_values:
1711 * @model: a #GtkFileSystemModel
1712 * @column: the column to clear or -1 for all columns
1714 * Clears the cached values in the model for the given @column. Use
1715 * this function whenever your get_value function would return different
1716 * values for a column.
1717 * The file chooser uses this for example when the icon theme changes to
1718 * invalidate the cached pixbufs.
1721 _gtk_file_system_model_clear_cache (GtkFileSystemModel *model,
1728 g_return_if_fail (GTK_IS_FILE_SYSTEM_MODEL (model));
1729 g_return_if_fail (column >= -1 && (guint) column < model->n_columns);
1739 end = model->n_columns;
1742 for (i = 0; i < model->files->len; i++)
1744 FileModelNode *node = get_node (model, i);
1746 for (column = start; column < end; column++)
1748 if (!G_VALUE_TYPE (&node->values[column]))
1751 g_value_unset (&node->values[column]);
1755 if (changed && node->visible)
1760 path = gtk_tree_path_new_from_node (model, i);
1761 ITER_INIT_FROM_INDEX (model, &iter, i);
1762 gtk_tree_model_row_changed (GTK_TREE_MODEL (model), path, &iter);
1763 gtk_tree_path_free (path);
1767 /* FIXME: resort? */
1771 * _gtk_file_system_model_add_and_query_file:
1772 * @model: a #GtkFileSystemModel
1773 * @file: the file to add
1774 * @attributes: attributes to query before adding the file
1776 * This is a conenience function that calls g_file_query_info_async() on
1777 * the given file, and when successful, adds it to the model with
1778 * _gtk_file_system_model_add_file(). Upon failure, the @file is discarded.
1781 _gtk_file_system_model_add_and_query_file (GtkFileSystemModel *model,
1783 const char * attributes)
1785 g_return_if_fail (GTK_IS_FILE_SYSTEM_MODEL (model));
1786 g_return_if_fail (G_IS_FILE (file));
1787 g_return_if_fail (attributes != NULL);
1789 g_file_query_info_async (file,
1794 gtk_file_system_model_query_done,