src/filedata.h

   1 /*
   2  * Copyright (C) 2004 John Ellis
   3  * Copyright (C) 2008 - 2016 The Geeqie Team
   4  *
   5  * Author: John Ellis
   6  *
   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.
  11  *
  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.
  16  *
  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.
  20  */
  21
  22 #ifndef FILEDATA_H
  23 #define FILEDATA_H
  24
  25 #ifdef DEBUG
  26 #define DEBUG_FILEDATA
  27 #endif
  28
  29 #define FD_MAGICK 0x12345678u
  30
  31 gchar *text_from_size(gint64 size);
  32 gchar *text_from_size_abrev(gint64 size);
  33 const gchar *text_from_time(time_t t);
  34
  35 /* scan for sidecar files - expensive */
  36 FileData *file_data_new_group(const gchar *path_utf8);
  37
  38 /* should be used on helper files which can't have sidecars */
  39 FileData *file_data_new_no_grouping(const gchar *path_utf8);
  40
  41 /* should be used on dirs */
  42 FileData *file_data_new_dir(const gchar *path_utf8);
  43
  44 FileData *file_data_new_simple(const gchar *path_utf8);
  45
  46 #ifdef DEBUG_FILEDATA
  47 FileData *file_data_ref_debug(const gchar *file, gint line, FileData *fd);
  48 void file_data_unref_debug(const gchar *file, gint line, FileData *fd);
  49 #define file_data_ref(fd) file_data_ref_debug(__FILE__, __LINE__, fd)
  50 #define file_data_unref(fd) file_data_unref_debug(__FILE__, __LINE__, fd)
  51 #else
  52 FileData *file_data_ref(FileData *fd);
  53 void file_data_unref(FileData *fd);
  54 #endif
  55
  56 void file_data_lock(FileData *fd);
  57 void file_data_unlock(FileData *fd);
  58 void file_data_lock_list(GList *list);
  59 void file_data_unlock_list(GList *list);
  60
  61 gboolean file_data_check_changed_files(FileData *fd);
  62
  63 void file_data_increment_version(FileData *fd);
  64
  65 gboolean file_data_add_change_info(FileData *fd, FileDataChangeType type, const gchar *src, const gchar *dest);
  66 void file_data_change_info_free(FileDataChangeInfo *fdci, FileData *fd);
  67
  68 void file_data_disable_grouping(FileData *fd, gboolean disable);
  69 void file_data_disable_grouping_list(GList *fd_list, gboolean disable);
  70
  71 gint filelist_sort_compare_filedata(FileData *fa, FileData *fb);
  72 gint filelist_sort_compare_filedata_full(FileData *fa, FileData *fb, SortType method, gboolean ascend);
  73 GList *filelist_sort(GList *list, SortType method, gboolean ascend);
  74 GList *filelist_insert_sort(GList *list, FileData *fd, SortType method, gboolean ascend);
  75 GList *filelist_sort_full(GList *list, SortType method, gboolean ascend, GCompareFunc cb);
  76 GList *filelist_insert_sort_full(GList *list, gpointer data, SortType method, gboolean ascend, GCompareFunc cb);
  77
  78 gboolean filelist_read(FileData *dir_fd, GList **files, GList **dirs);
  79 gboolean filelist_read_lstat(FileData *dir_fd, GList **files, GList **dirs);
  80 void filelist_free(GList *list);
  81 GList *filelist_copy(GList *list);
  82 GList *filelist_from_path_list(GList *list);
  83 GList *filelist_to_path_list(GList *list);
  84
  85 GList *filelist_filter(GList *list, gboolean is_dir_list);
  86
  87 GList *filelist_sort_path(GList *list);
  88 GList *filelist_recursive(FileData *dir_fd);
  89 GList *filelist_recursive_full(FileData *dir_fd, SortType method, gboolean ascend);
  90
  91 typedef gboolean (* FileDataGetMarkFunc)(FileData *fd, gint n, gpointer data);
  92 typedef gboolean (* FileDataSetMarkFunc)(FileData *fd, gint n, gboolean value, gpointer data);
  93 gboolean file_data_register_mark_func(gint n, FileDataGetMarkFunc get_mark_func, FileDataSetMarkFunc set_mark_func, gpointer data, GDestroyNotify notify);
  94 void file_data_get_registered_mark_func(gint n, FileDataGetMarkFunc *get_mark_func, FileDataSetMarkFunc *set_mark_func, gpointer *data);
  95
  96
  97 gboolean file_data_get_mark(FileData *fd, gint n);
  98 guint file_data_get_marks(FileData *fd);
  99 void file_data_set_mark(FileData *fd, gint n, gboolean value);
 100 gboolean file_data_filter_marks(FileData *fd, guint filter);
 101 GList *file_data_filter_marks_list(GList *list, guint filter);
 102
 103 gboolean file_data_filter_file_filter(FileData *fd, GRegex *filter);
 104 GList *file_data_filter_file_filter_list(GList *list, GRegex *filter);
 105
 106 gint file_data_get_user_orientation(FileData *fd);
 107 void file_data_set_user_orientation(FileData *fd, gint value);
 108
 109 gchar *file_data_sc_list_to_string(FileData *fd);
 110
 111 gchar *file_data_get_sidecar_path(FileData *fd, gboolean existing_only);
 112
 113
 114 gboolean file_data_add_ci(FileData *fd, FileDataChangeType type, const gchar *src, const gchar *dest);
 115 gboolean file_data_sc_add_ci_copy(FileData *fd, const gchar *dest_path);
 116 gboolean file_data_sc_add_ci_move(FileData *fd, const gchar *dest_path);
 117 gboolean file_data_sc_add_ci_rename(FileData *fd, const gchar *dest_path);
 118 gboolean file_data_sc_add_ci_delete(FileData *fd);
 119 gboolean file_data_sc_add_ci_unspecified(FileData *fd, const gchar *dest_path);
 120
 121 gboolean file_data_sc_add_ci_delete_list(GList *fd_list);
 122 gboolean file_data_sc_add_ci_copy_list(GList *fd_list, const gchar *dest);
 123 gboolean file_data_sc_add_ci_move_list(GList *fd_list, const gchar *dest);
 124 gboolean file_data_sc_add_ci_rename_list(GList *fd_list, const gchar *dest);
 125 gboolean file_data_sc_add_ci_unspecified_list(GList *fd_list, const gchar *dest);
 126 gboolean file_data_add_ci_write_metadata_list(GList *fd_list);
 127
 128 gboolean file_data_sc_update_ci_copy_list(GList *fd_list, const gchar *dest);
 129 gboolean file_data_sc_update_ci_move_list(GList *fd_list, const gchar *dest);
 130 gboolean file_data_sc_update_ci_unspecified_list(GList *fd_list, const gchar *dest);
 131
 132
 133 gboolean file_data_sc_update_ci_copy(FileData *fd, const gchar *dest_path);
 134 gboolean file_data_sc_update_ci_move(FileData *fd, const gchar *dest_path);
 135 gboolean file_data_sc_update_ci_rename(FileData *fd, const gchar *dest_path);
 136 gboolean file_data_sc_update_ci_unspecified(FileData *fd, const gchar *dest_path);
 137
 138 gchar *file_data_get_error_string(gint error);
 139
 140 gint file_data_verify_ci(FileData *fd, GList *list);
 141 gint file_data_verify_ci_list(GList *list, gchar **desc, gboolean with_sidecars);
 142
 143 gboolean file_data_perform_ci(FileData *fd);
 144 gboolean file_data_apply_ci(FileData *fd);
 145 void file_data_free_ci(FileData *fd);
 146 void file_data_free_ci_list(GList *fd_list);
 147
 148 void file_data_set_regroup_when_finished(FileData *fd, gboolean enable);
 149
 150 gint file_data_sc_verify_ci(FileData *fd, GList *list);
 151
 152 gboolean file_data_sc_perform_ci(FileData *fd);
 153 gboolean file_data_sc_apply_ci(FileData *fd);
 154 void file_data_sc_free_ci(FileData *fd);
 155 void file_data_sc_free_ci_list(GList *fd_list);
 156
 157 GList *file_data_process_groups_in_selection(GList *list, gboolean ungroup, GList **ungrouped);
 158
 159
 160 typedef void (*FileDataNotifyFunc)(FileData *fd, NotifyType type, gpointer data);
 161 gboolean file_data_register_notify_func(FileDataNotifyFunc func, gpointer data, NotifyPriority priority);
 162 gboolean file_data_unregister_notify_func(FileDataNotifyFunc func, gpointer data);
 163 void file_data_send_notification(FileData *fd, NotifyType type);
 164
 165 gboolean file_data_register_real_time_monitor(FileData *fd);
 166 gboolean file_data_unregister_real_time_monitor(FileData *fd);
 167
 168 void read_exif_time_data(FileData *file);
 169 void read_exif_time_digitized_data(FileData *file);
 170
 171 gboolean marks_list_save(gchar *path, gboolean clear);
 172 gboolean marks_list_load(const gchar *path);
 173 void marks_clear_all();
 174 void read_rating_data(FileData *file);
 175 #endif
 176 /* vim: set shiftwidth=8 softtabstop=0 cindent cinoptions={1s: */