2 * Copyright (C) 2004 John Ellis
3 * Copyright (C) 2008 - 2016 The Geeqie Team
7 * This program is free software; you can redistribute it and/or modify
8 * it under the terms of the GNU General Public License as published by
9 * the Free Software Foundation; either version 2 of the License, or
10 * (at your option) any later version.
12 * This program is distributed in the hope that it will be useful,
13 * but WITHOUT ANY WARRANTY; without even the implied warranty of
14 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 * GNU General Public License for more details.
17 * You should have received a copy of the GNU General Public License along
18 * with this program; if not, write to the Free Software Foundation, Inc.,
19 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
29 #define DEBUG_FILEDATA
32 #define FD_MAGICK 0x12345678u
34 gchar *text_from_size(gint64 size);
35 gchar *text_from_size_abrev(gint64 size);
36 const gchar *text_from_time(time_t t);
38 enum FileDataChangeType {
39 FILEDATA_CHANGE_DELETE,
41 FILEDATA_CHANGE_RENAME,
43 FILEDATA_CHANGE_UNSPECIFIED,
44 FILEDATA_CHANGE_WRITE_METADATA
48 NOTIFY_PRIORITY_HIGH = 0,
49 NOTIFY_PRIORITY_MEDIUM,
55 SELECTION_SELECTED = 1 << 0,
56 SELECTION_PRELIGHT = 1 << 1,
57 SELECTION_FOCUS = 1 << 2
60 struct FileDataChangeInfo {
61 FileDataChangeType type;
65 gboolean regroup_when_finished;
71 gchar *original_path; /**< key to file_data_pool hash table */
74 const gchar *extension;
75 gchar *extended_extension;
76 FileFormatClass format_class;
77 gchar *format_name; /**< set by the image loader */
78 gchar *collate_key_name;
79 gchar *collate_key_name_nocase;
80 gchar *collate_key_name_natural;
81 gchar *collate_key_name_nocase_natural;
85 mode_t mode; /**< this is needed at least for notification in view_dir because it is preserved after the file/directory is deleted */
86 gint sidecar_priority;
88 guint marks; /**< each bit represents one mark */
89 guint valid_marks; /**< zero bit means that the corresponding mark needs to be reread */
93 FileData *parent; /**< parent file if this is a sidecar file, NULL otherwise */
94 FileDataChangeInfo *change; /**< for rename, move ... */
95 GdkPixbuf *thumb_pixbuf;
97 GdkPixbuf *pixbuf; /**< full-size image, only complete images, NULL during loading
98 all FileData with non-NULL pixbuf are referenced by image_cache */
104 gint version; /**< increased when any field in this structure is changed */
105 gboolean disable_grouping;
107 gint user_orientation;
108 gint exif_orientation;
112 time_t exifdate_digitized;
113 GHashTable *modified_xmp; /**< hash table which contains unwritten xmp metadata in format: key->list of string values */
114 GList *cached_metadata;
116 gboolean metadata_in_idle_loaded;
122 SelectionType selected; /**< Used by view-file-icon. */
129 * @headerfile file_data_new_group
130 * scan for sidecar files - expensive
132 FileData *file_data_new_group(const gchar *path_utf8);
135 * @headerfile file_data_new_no_grouping
136 * should be used on helper files which can't have sidecars
138 FileData *file_data_new_no_grouping(const gchar *path_utf8);
141 * @headerfile file_data_new_dir
142 * should be used on dirs
144 FileData *file_data_new_dir(const gchar *path_utf8);
146 FileData *file_data_new_simple(const gchar *path_utf8);
148 #ifdef DEBUG_FILEDATA
149 FileData *file_data_ref_debug(const gchar *file, gint line, FileData *fd);
150 void file_data_unref_debug(const gchar *file, gint line, FileData *fd);
151 #define file_data_ref(fd) file_data_ref_debug(__FILE__, __LINE__, fd)
152 #define file_data_unref(fd) file_data_unref_debug(__FILE__, __LINE__, fd)
154 FileData *file_data_ref(FileData *fd);
155 void file_data_unref(FileData *fd);
158 void file_data_lock(FileData *fd);
159 void file_data_unlock(FileData *fd);
160 void file_data_lock_list(GList *list);
161 void file_data_unlock_list(GList *list);
163 gboolean file_data_check_changed_files(FileData *fd);
165 void file_data_increment_version(FileData *fd);
167 gboolean file_data_add_change_info(FileData *fd, FileDataChangeType type, const gchar *src, const gchar *dest);
168 void file_data_change_info_free(FileDataChangeInfo *fdci, FileData *fd);
170 void file_data_disable_grouping(FileData *fd, gboolean disable);
171 void file_data_disable_grouping_list(GList *fd_list, gboolean disable);
173 gint filelist_sort_compare_filedata(FileData *fa, FileData *fb);
174 gint filelist_sort_compare_filedata_full(FileData *fa, FileData *fb, SortType method, gboolean ascend);
175 GList *filelist_sort(GList *list, SortType method, gboolean ascend, gboolean case_sensitive);
176 GList *filelist_sort_full(GList *list, SortType method, gboolean ascend, gboolean case_sensitive, GCompareFunc cb);
177 GList *filelist_insert_sort_full(GList *list, gpointer data, SortType method, gboolean ascend, gboolean case_sensitive, GCompareFunc cb);
179 gboolean filelist_read(FileData *dir_fd, GList **files, GList **dirs);
180 gboolean filelist_read_lstat(FileData *dir_fd, GList **files, GList **dirs);
181 void filelist_free(GList *list);
182 GList *filelist_copy(GList *list);
183 GList *filelist_from_path_list(GList *list);
184 GList *filelist_to_path_list(GList *list);
186 GList *filelist_filter(GList *list, gboolean is_dir_list);
188 GList *filelist_sort_path(GList *list);
189 GList *filelist_recursive(FileData *dir_fd);
190 GList *filelist_recursive_full(FileData *dir_fd, SortType method, gboolean ascend, gboolean case_sensitive);
192 using FileDataGetMarkFunc = gboolean (*)(FileData *, gint, gpointer);
193 using FileDataSetMarkFunc = gboolean (*)(FileData *, gint, gboolean, gpointer);
194 gboolean file_data_register_mark_func(gint n, FileDataGetMarkFunc get_mark_func, FileDataSetMarkFunc set_mark_func, gpointer data, GDestroyNotify notify);
195 void file_data_get_registered_mark_func(gint n, FileDataGetMarkFunc *get_mark_func, FileDataSetMarkFunc *set_mark_func, gpointer *data);
198 gboolean file_data_get_mark(FileData *fd, gint n);
199 guint file_data_get_marks(FileData *fd);
200 void file_data_set_mark(FileData *fd, gint n, gboolean value);
201 gboolean file_data_filter_marks(FileData *fd, guint filter);
202 GList *file_data_filter_marks_list(GList *list, guint filter);
204 gboolean file_data_filter_file_filter(FileData *fd, GRegex *filter);
205 GList *file_data_filter_file_filter_list(GList *list, GRegex *filter);
207 GList *file_data_filter_class_list(GList *list, guint filter);
209 gchar *file_data_sc_list_to_string(FileData *fd);
211 gchar *file_data_get_sidecar_path(FileData *fd, gboolean existing_only);
214 gboolean file_data_add_ci(FileData *fd, FileDataChangeType type, const gchar *src, const gchar *dest);
215 gboolean file_data_sc_add_ci_copy(FileData *fd, const gchar *dest_path);
216 gboolean file_data_sc_add_ci_move(FileData *fd, const gchar *dest_path);
217 gboolean file_data_sc_add_ci_rename(FileData *fd, const gchar *dest_path);
218 gboolean file_data_sc_add_ci_delete(FileData *fd);
219 gboolean file_data_sc_add_ci_unspecified(FileData *fd, const gchar *dest_path);
221 gboolean file_data_sc_add_ci_delete_list(GList *fd_list);
222 gboolean file_data_sc_add_ci_copy_list(GList *fd_list, const gchar *dest);
223 gboolean file_data_sc_add_ci_move_list(GList *fd_list, const gchar *dest);
224 gboolean file_data_sc_add_ci_rename_list(GList *fd_list, const gchar *dest);
225 gboolean file_data_sc_add_ci_unspecified_list(GList *fd_list, const gchar *dest);
226 gboolean file_data_add_ci_write_metadata_list(GList *fd_list);
228 gboolean file_data_sc_update_ci_copy_list(GList *fd_list, const gchar *dest);
229 gboolean file_data_sc_update_ci_move_list(GList *fd_list, const gchar *dest);
230 gboolean file_data_sc_update_ci_unspecified_list(GList *fd_list, const gchar *dest);
233 gboolean file_data_sc_update_ci_copy(FileData *fd, const gchar *dest_path);
234 gboolean file_data_sc_update_ci_move(FileData *fd, const gchar *dest_path);
235 gboolean file_data_sc_update_ci_rename(FileData *fd, const gchar *dest_path);
236 gboolean file_data_sc_update_ci_unspecified(FileData *fd, const gchar *dest_path);
238 gchar *file_data_get_error_string(gint error);
240 gint file_data_verify_ci(FileData *fd, GList *list);
241 gint file_data_verify_ci_list(GList *list, gchar **desc, gboolean with_sidecars);
243 gboolean file_data_perform_ci(FileData *fd);
244 gboolean file_data_apply_ci(FileData *fd);
245 void file_data_free_ci(FileData *fd);
246 void file_data_free_ci_list(GList *fd_list);
248 void file_data_set_regroup_when_finished(FileData *fd, gboolean enable);
250 gint file_data_sc_verify_ci(FileData *fd, GList *list);
252 gboolean file_data_sc_perform_ci(FileData *fd);
253 gboolean file_data_sc_apply_ci(FileData *fd);
254 void file_data_sc_free_ci(FileData *fd);
255 void file_data_sc_free_ci_list(GList *fd_list);
257 GList *file_data_process_groups_in_selection(GList *list, gboolean ungroup, GList **ungrouped);
260 using FileDataNotifyFunc = void (*)(FileData *, NotifyType, gpointer);
261 gboolean file_data_register_notify_func(FileDataNotifyFunc func, gpointer data, NotifyPriority priority);
262 gboolean file_data_unregister_notify_func(FileDataNotifyFunc func, gpointer data);
263 void file_data_send_notification(FileData *fd, NotifyType type);
265 gboolean file_data_register_real_time_monitor(FileData *fd);
266 gboolean file_data_unregister_real_time_monitor(FileData *fd);
268 void read_exif_time_data(FileData *file);
269 void read_exif_time_digitized_data(FileData *file);
271 gboolean marks_list_save(gchar *path, gboolean save);
272 gboolean marks_list_load(const gchar *path);
273 void marks_clear_all();
274 void read_rating_data(FileData *file);
276 void file_data_inc_page_num(FileData *fd);
277 void file_data_dec_page_num(FileData *fd);
278 void file_data_set_page_total(FileData *fd, gint page_total);
279 void file_data_set_page_num(FileData *fd, gint page_num);
281 void file_data_dump();
283 /* vim: set shiftwidth=8 softtabstop=0 cindent cinoptions={1s: */