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.
25 #include <sys/types.h>
27 #include <gdk-pixbuf/gdk-pixbuf.h>
38 #define DEBUG_FILEDATA
41 #define FD_MAGICK 0x12345678u
43 gchar *text_from_size(gint64 size);
44 gchar *text_from_size_abrev(gint64 size);
45 const gchar *text_from_time(time_t t);
47 enum FileDataChangeType {
48 FILEDATA_CHANGE_DELETE,
50 FILEDATA_CHANGE_RENAME,
52 FILEDATA_CHANGE_UNSPECIFIED,
53 FILEDATA_CHANGE_WRITE_METADATA
57 NOTIFY_PRIORITY_HIGH = 0,
58 NOTIFY_PRIORITY_MEDIUM,
64 SELECTION_SELECTED = 1 << 0,
65 SELECTION_PRELIGHT = 1 << 1,
66 SELECTION_FOCUS = 1 << 2
69 struct FileDataChangeInfo {
70 FileDataChangeType type;
74 gboolean regroup_when_finished;
80 gchar *original_path; /**< key to file_data_pool hash table */
83 const gchar *extension;
84 gchar *extended_extension;
85 FileFormatClass format_class;
86 gchar *format_name; /**< set by the image loader */
87 gchar *collate_key_name;
88 gchar *collate_key_name_nocase;
89 gchar *collate_key_name_natural;
90 gchar *collate_key_name_nocase_natural;
94 mode_t mode; /**< this is needed at least for notification in view_dir because it is preserved after the file/directory is deleted */
95 gint sidecar_priority;
97 guint marks; /**< each bit represents one mark */
98 guint valid_marks; /**< zero bit means that the corresponding mark needs to be reread */
101 GList *sidecar_files;
102 FileData *parent; /**< parent file if this is a sidecar file, NULL otherwise */
103 FileDataChangeInfo *change; /**< for rename, move ... */
104 GdkPixbuf *thumb_pixbuf;
106 GdkPixbuf *pixbuf; /**< full-size image, only complete images, NULL during loading
107 all FileData with non-NULL pixbuf are referenced by image_cache */
113 gint version; /**< increased when any field in this structure is changed */
114 gboolean disable_grouping;
116 gint user_orientation;
117 gint exif_orientation;
121 time_t exifdate_digitized;
122 GHashTable *modified_xmp; /**< hash table which contains unwritten xmp metadata in format: key->list of string values */
123 GList *cached_metadata;
125 gboolean metadata_in_idle_loaded;
131 SelectionType selected; /**< Used by view-file-icon. */
138 * @headerfile file_data_new_group
139 * scan for sidecar files - expensive
141 FileData *file_data_new_group(const gchar *path_utf8);
144 * @headerfile file_data_new_no_grouping
145 * should be used on helper files which can't have sidecars
147 FileData *file_data_new_no_grouping(const gchar *path_utf8);
150 * @headerfile file_data_new_dir
151 * should be used on dirs
153 FileData *file_data_new_dir(const gchar *path_utf8);
155 FileData *file_data_new_simple(const gchar *path_utf8);
157 #ifdef DEBUG_FILEDATA
158 FileData *file_data_ref_debug(const gchar *file, gint line, FileData *fd);
159 void file_data_unref_debug(const gchar *file, gint line, FileData *fd);
160 #define file_data_ref(fd) file_data_ref_debug(__FILE__, __LINE__, fd)
161 #define file_data_unref(fd) file_data_unref_debug(__FILE__, __LINE__, fd)
163 FileData *file_data_ref(FileData *fd);
164 void file_data_unref(FileData *fd);
167 void file_data_lock(FileData *fd);
168 void file_data_unlock(FileData *fd);
169 void file_data_lock_list(GList *list);
170 void file_data_unlock_list(GList *list);
172 gboolean file_data_check_changed_files(FileData *fd);
174 void file_data_increment_version(FileData *fd);
176 gboolean file_data_add_change_info(FileData *fd, FileDataChangeType type, const gchar *src, const gchar *dest);
177 void file_data_change_info_free(FileDataChangeInfo *fdci, FileData *fd);
179 void file_data_disable_grouping(FileData *fd, gboolean disable);
180 void file_data_disable_grouping_list(GList *fd_list, gboolean disable);
182 gint filelist_sort_compare_filedata(FileData *fa, FileData *fb);
183 gint filelist_sort_compare_filedata_full(FileData *fa, FileData *fb, SortType method, gboolean ascend);
184 GList *filelist_sort(GList *list, SortType method, gboolean ascend, gboolean case_sensitive);
185 GList *filelist_sort_full(GList *list, SortType method, gboolean ascend, gboolean case_sensitive, GCompareFunc cb);
186 GList *filelist_insert_sort_full(GList *list, gpointer data, SortType method, gboolean ascend, gboolean case_sensitive, GCompareFunc cb);
188 gboolean filelist_read(FileData *dir_fd, GList **files, GList **dirs);
189 gboolean filelist_read_lstat(FileData *dir_fd, GList **files, GList **dirs);
190 void filelist_free(GList *list);
191 GList *filelist_copy(GList *list);
192 GList *filelist_from_path_list(GList *list);
193 GList *filelist_to_path_list(GList *list);
195 GList *filelist_filter(GList *list, gboolean is_dir_list);
197 GList *filelist_sort_path(GList *list);
198 GList *filelist_recursive(FileData *dir_fd);
199 GList *filelist_recursive_full(FileData *dir_fd, SortType method, gboolean ascend, gboolean case_sensitive);
201 using FileDataGetMarkFunc = gboolean (*)(FileData *, gint, gpointer);
202 using FileDataSetMarkFunc = gboolean (*)(FileData *, gint, gboolean, gpointer);
203 gboolean file_data_register_mark_func(gint n, FileDataGetMarkFunc get_mark_func, FileDataSetMarkFunc set_mark_func, gpointer data, GDestroyNotify notify);
204 void file_data_get_registered_mark_func(gint n, FileDataGetMarkFunc *get_mark_func, FileDataSetMarkFunc *set_mark_func, gpointer *data);
207 gboolean file_data_get_mark(FileData *fd, gint n);
208 guint file_data_get_marks(FileData *fd);
209 void file_data_set_mark(FileData *fd, gint n, gboolean value);
210 gboolean file_data_filter_marks(FileData *fd, guint filter);
211 GList *file_data_filter_marks_list(GList *list, guint filter);
213 gboolean file_data_mark_to_selection(FileData *fd, gint mark, MarkToSelectionMode mode, gboolean selected);
214 void file_data_selection_to_mark(FileData *fd, gint mark, SelectionToMarkMode mode);
216 gboolean file_data_filter_file_filter(FileData *fd, GRegex *filter);
217 GList *file_data_filter_file_filter_list(GList *list, GRegex *filter);
219 GList *file_data_filter_class_list(GList *list, guint filter);
221 gchar *file_data_sc_list_to_string(FileData *fd);
223 gchar *file_data_get_sidecar_path(FileData *fd, gboolean existing_only);
226 gboolean file_data_add_ci(FileData *fd, FileDataChangeType type, const gchar *src, const gchar *dest);
227 gboolean file_data_sc_add_ci_copy(FileData *fd, const gchar *dest_path);
228 gboolean file_data_sc_add_ci_move(FileData *fd, const gchar *dest_path);
229 gboolean file_data_sc_add_ci_rename(FileData *fd, const gchar *dest_path);
230 gboolean file_data_sc_add_ci_delete(FileData *fd);
231 gboolean file_data_sc_add_ci_unspecified(FileData *fd, const gchar *dest_path);
233 gboolean file_data_sc_add_ci_delete_list(GList *fd_list);
234 gboolean file_data_sc_add_ci_copy_list(GList *fd_list, const gchar *dest);
235 gboolean file_data_sc_add_ci_move_list(GList *fd_list, const gchar *dest);
236 gboolean file_data_sc_add_ci_rename_list(GList *fd_list, const gchar *dest);
237 gboolean file_data_sc_add_ci_unspecified_list(GList *fd_list, const gchar *dest);
238 gboolean file_data_add_ci_write_metadata_list(GList *fd_list);
240 gboolean file_data_sc_update_ci_copy_list(GList *fd_list, const gchar *dest);
241 gboolean file_data_sc_update_ci_move_list(GList *fd_list, const gchar *dest);
242 gboolean file_data_sc_update_ci_unspecified_list(GList *fd_list, const gchar *dest);
245 gboolean file_data_sc_update_ci_copy(FileData *fd, const gchar *dest_path);
246 gboolean file_data_sc_update_ci_move(FileData *fd, const gchar *dest_path);
247 gboolean file_data_sc_update_ci_rename(FileData *fd, const gchar *dest_path);
248 gboolean file_data_sc_update_ci_unspecified(FileData *fd, const gchar *dest_path);
250 gchar *file_data_get_error_string(gint error);
252 gint file_data_verify_ci(FileData *fd, GList *list);
253 gint file_data_verify_ci_list(GList *list, gchar **desc, gboolean with_sidecars);
255 gboolean file_data_perform_ci(FileData *fd);
256 gboolean file_data_apply_ci(FileData *fd);
257 void file_data_free_ci(FileData *fd);
258 void file_data_free_ci_list(GList *fd_list);
260 void file_data_set_regroup_when_finished(FileData *fd, gboolean enable);
262 gint file_data_sc_verify_ci(FileData *fd, GList *list);
264 gboolean file_data_sc_perform_ci(FileData *fd);
265 gboolean file_data_sc_apply_ci(FileData *fd);
266 void file_data_sc_free_ci(FileData *fd);
267 void file_data_sc_free_ci_list(GList *fd_list);
269 GList *file_data_process_groups_in_selection(GList *list, gboolean ungroup, GList **ungrouped);
272 using FileDataNotifyFunc = void (*)(FileData *, NotifyType, gpointer);
273 gboolean file_data_register_notify_func(FileDataNotifyFunc func, gpointer data, NotifyPriority priority);
274 gboolean file_data_unregister_notify_func(FileDataNotifyFunc func, gpointer data);
275 void file_data_send_notification(FileData *fd, NotifyType type);
277 gboolean file_data_register_real_time_monitor(FileData *fd);
278 gboolean file_data_unregister_real_time_monitor(FileData *fd);
280 void read_exif_time_data(FileData *file);
281 void read_exif_time_digitized_data(FileData *file);
283 gboolean marks_list_save(gchar *path, gboolean save);
284 gboolean marks_list_load(const gchar *path);
285 void marks_clear_all();
286 void read_rating_data(FileData *file);
288 void file_data_inc_page_num(FileData *fd);
289 void file_data_dec_page_num(FileData *fd);
290 void file_data_set_page_total(FileData *fd, gint page_total);
291 void file_data_set_page_num(FileData *fd, gint page_num);
293 void file_data_dump();
295 /* vim: set shiftwidth=8 softtabstop=0 cindent cinoptions={1s: */