2 * Copyright (C) 2006 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.
26 ZOOM_RESET_ORIGINAL = 0,
27 ZOOM_RESET_FIT_WINDOW = 1,
37 MOUSE_BUTTON_LEFT = 1,
38 MOUSE_BUTTON_MIDDLE = 2,
39 MOUSE_BUTTON_RIGHT = 3,
40 MOUSE_BUTTON_WHEEL_UP = 4,
41 MOUSE_BUTTON_WHEEL_DOWN = 5,
42 MOUSE_BUTTON_BACK = 8,
43 MOUSE_BUTTON_FORWARD = 9
50 // Keep this up to date!
51 DIRVIEW_LAST = DIRVIEW_TREE
58 // Keep this up to date!
59 FILEVIEW_LAST = FILEVIEW_ICON
62 #define CMD_COPY "geeqie-copy-command.desktop"
63 #define CMD_MOVE "geeqie-move-command.desktop"
64 #define CMD_RENAME "geeqie-rename-command.desktop"
65 #define CMD_DELETE "geeqie-delete-command.desktop"
66 #define CMD_FOLDER "geeqie-folder-command.desktop"
77 SORT_EXIFTIMEDIGITIZED,
83 ALTER_NONE, /* do nothing */
85 ALTER_ROTATE_90_CC, /* counterclockwise */
94 LAYOUT_RIGHT = 1 << 1,
96 LAYOUT_BOTTOM = 1 << 3
101 IMAGE_STATE_NONE = 0,
102 IMAGE_STATE_IMAGE = 1 << 0,
103 IMAGE_STATE_LOADING = 1 << 1,
104 IMAGE_STATE_ERROR = 1 << 2,
105 IMAGE_STATE_COLOR_ADJ = 1 << 3,
106 IMAGE_STATE_ROTATE_AUTO = 1 << 4,
107 IMAGE_STATE_ROTATE_USER = 1 << 5,
108 IMAGE_STATE_DELAY_FLIP = 1 << 6
119 FILEDATA_CHANGE_DELETE,
120 FILEDATA_CHANGE_MOVE,
121 FILEDATA_CHANGE_RENAME,
122 FILEDATA_CHANGE_COPY,
123 FILEDATA_CHANGE_UNSPECIFIED,
124 FILEDATA_CHANGE_WRITE_METADATA
125 } FileDataChangeType;
132 } MarkToSelectionMode;
138 } SelectionToMarkMode;
141 FORMAT_CLASS_UNKNOWN,
143 FORMAT_CLASS_RAWIMAGE,
149 extern gchar *format_class_list[];
153 SS_ERR_DISABLED, /**< secsave is disabled. */
154 SS_ERR_OUT_OF_MEM, /**< memory allocation failure */
156 /* see err field in SecureSaveInfo */
167 NOTIFY_PRIORITY_HIGH = 0,
168 NOTIFY_PRIORITY_MEDIUM,
173 NOTIFY_MARKS = 1 << 1, /* changed marks */
174 NOTIFY_PIXBUF = 1 << 2, /* image was read into fd->pixbuf */
175 NOTIFY_HISTMAP = 1 << 3, /* histmap was read into fd->histmap */
176 NOTIFY_ORIENTATION = 1 << 4, /* image was rotated */
177 NOTIFY_METADATA = 1 << 5, /* changed image metadata, not yet written */
178 NOTIFY_GROUPING = 1 << 6, /* change in fd->sidecar_files or fd->parent */
179 NOTIFY_REREAD = 1 << 7, /* changed file size, date, etc., file name remains unchanged */
180 NOTIFY_CHANGE = 1 << 8 /* generic change described by fd->change */
185 CHANGE_WARN_DEST_EXISTS = 1 << 0,
186 CHANGE_WARN_NO_WRITE_PERM = 1 << 1,
187 CHANGE_WARN_SAME = 1 << 2,
188 CHANGE_WARN_CHANGED_EXT = 1 << 3,
189 CHANGE_WARN_UNSAVED_META = 1 << 4,
190 CHANGE_WARN_NO_WRITE_PERM_DEST_DIR = 1 << 5,
191 CHANGE_ERROR_MASK = (~0U) << 8, /* the values below are fatal errors */
192 CHANGE_NO_READ_PERM = 1 << 8,
193 CHANGE_NO_WRITE_PERM_DIR = 1 << 9,
194 CHANGE_NO_DEST_DIR = 1 << 10,
195 CHANGE_DUPLICATE_DEST = 1 << 11,
196 CHANGE_NO_WRITE_PERM_DEST = 1 << 12,
197 CHANGE_DEST_EXISTS = 1 << 13,
198 CHANGE_NO_SRC = 1 << 14,
199 CHANGE_GENERIC_ERROR = 1 << 16
203 METADATA_PLAIN = 0, /* format that can be edited and written back */
204 METADATA_FORMATTED = 1 /* for display only */
208 STARTUP_PATH_CURRENT = 0,
220 PR_STEREO_NONE = 0, /* do nothing */
221 PR_STEREO_DUAL = 1 << 0, /* independent stereo buffers, for example nvidia opengl */
222 PR_STEREO_FIXED = 1 << 1, /* custom position */
223 PR_STEREO_HORIZ = 1 << 2, /* side by side */
224 PR_STEREO_VERT = 1 << 3, /* above below */
225 PR_STEREO_RIGHT = 1 << 4, /* render right buffer */
226 PR_STEREO_ANAGLYPH_RC = 1 << 5, /* anaglyph red-cyan */
227 PR_STEREO_ANAGLYPH_GM = 1 << 6, /* anaglyph green-magenta */
228 PR_STEREO_ANAGLYPH_YB = 1 << 7, /* anaglyph yellow-blue */
229 PR_STEREO_ANAGLYPH_GRAY_RC = 1 << 8, /* anaglyph gray red-cyan*/
230 PR_STEREO_ANAGLYPH_GRAY_GM = 1 << 9, /* anaglyph gray green-magenta */
231 PR_STEREO_ANAGLYPH_GRAY_YB = 1 << 10, /* anaglyph gray yellow-blue */
232 PR_STEREO_ANAGLYPH_DB_RC = 1 << 11, /* anaglyph dubois red-cyan */
233 PR_STEREO_ANAGLYPH_DB_GM = 1 << 12, /* anaglyph dubois green-magenta */
234 PR_STEREO_ANAGLYPH_DB_YB = 1 << 13, /* anaglyph dubois yellow-blue */
235 PR_STEREO_ANAGLYPH = PR_STEREO_ANAGLYPH_RC |
236 PR_STEREO_ANAGLYPH_GM |
237 PR_STEREO_ANAGLYPH_YB |
238 PR_STEREO_ANAGLYPH_GRAY_RC |
239 PR_STEREO_ANAGLYPH_GRAY_GM |
240 PR_STEREO_ANAGLYPH_GRAY_YB |
241 PR_STEREO_ANAGLYPH_DB_RC |
242 PR_STEREO_ANAGLYPH_DB_GM |
243 PR_STEREO_ANAGLYPH_DB_YB, /* anaglyph mask */
245 PR_STEREO_MIRROR_LEFT = 1 << 14, /* mirror */
246 PR_STEREO_FLIP_LEFT = 1 << 15, /* flip */
248 PR_STEREO_MIRROR_RIGHT = 1 << 16, /* mirror */
249 PR_STEREO_FLIP_RIGHT = 1 << 17, /* flip */
251 PR_STEREO_MIRROR = PR_STEREO_MIRROR_LEFT | PR_STEREO_MIRROR_RIGHT, /* mirror mask*/
252 PR_STEREO_FLIP = PR_STEREO_FLIP_LEFT | PR_STEREO_FLIP_RIGHT, /* flip mask*/
253 PR_STEREO_SWAP = 1 << 18, /* swap left and right buffers */
254 PR_STEREO_TEMP_DISABLE = 1 << 19, /* temporarily disable stereo mode if source image is not stereo */
255 PR_STEREO_HALF = 1 << 20
256 } PixbufRendererStereoMode;
259 STEREO_PIXBUF_DEFAULT = 0,
260 STEREO_PIXBUF_SBS = 1,
261 STEREO_PIXBUF_CROSS = 2,
262 STEREO_PIXBUF_NONE = 3
265 #define MAX_SPLIT_IMAGES 4
269 SELECTION_SELECTED = 1 << 0,
270 SELECTION_PRELIGHT = 1 << 1,
271 SELECTION_FOCUS = 1 << 2
274 typedef struct _ImageLoader ImageLoader;
275 typedef struct _ThumbLoader ThumbLoader;
277 typedef struct _AnimationData AnimationData;
279 typedef struct _CollectInfo CollectInfo;
280 typedef struct _CollectionData CollectionData;
281 typedef struct _CollectTable CollectTable;
282 typedef struct _CollectWindow CollectWindow;
284 typedef struct _ImageWindow ImageWindow;
286 typedef struct _FileData FileData;
287 typedef struct _FileDataChangeInfo FileDataChangeInfo;
289 typedef struct _LayoutWindow LayoutWindow;
290 typedef struct _LayoutOptions LayoutOptions;
292 typedef struct _ViewDir ViewDir;
293 typedef struct _ViewDirInfoList ViewDirInfoList;
294 typedef struct _ViewDirInfoTree ViewDirInfoTree;
296 typedef struct _ViewFile ViewFile;
297 typedef struct _ViewFileInfoList ViewFileInfoList;
298 typedef struct _ViewFileInfoIcon ViewFileInfoIcon;
300 typedef struct _SlideShowData SlideShowData;
301 typedef struct _FullScreenData FullScreenData;
303 typedef struct _PixmapFolders PixmapFolders;
304 typedef struct _Histogram Histogram;
305 typedef struct _HistMap HistMap;
307 typedef struct _SecureSaveInfo SecureSaveInfo;
309 typedef struct _ExifData ExifData;
311 typedef struct _EditorDescription EditorDescription;
313 typedef struct _CommandLine CommandLine;
316 gint histogram_channel; /* drawing mode for histogram */
317 gint histogram_mode; /* logarithmical or not */
318 guint vgrid; /* number of vertical divisions, 0 for none */
319 guint hgrid; /* number of horizontal divisions, 0 for none */
325 } grid_color; /* grid color */
333 typedef void (* ThumbLoaderFunc)(ThumbLoader *tl, gpointer data);
335 typedef void (* FileUtilDoneFunc)(gboolean success, const gchar *done_path, gpointer data);
339 gboolean standard_loader;
342 FileData *fd; /* fd->pixbuf contains final (scaled) image when done */
344 gboolean cache_enable;
346 gdouble percent_done;
351 ThumbLoaderFunc func_done;
352 ThumbLoaderFunc func_error;
353 ThumbLoaderFunc func_progress;
357 guint idle_done_id; /* event source id */
360 struct _AnimationData
363 GdkPixbufAnimation *gpa;
364 GdkPixbufAnimationIter *iter;
378 struct _CollectionData
383 SortType sort_method;
385 ThumbLoader *thumb_loader;
386 CollectInfo *thumb_info;
388 void (*info_updated_func)(CollectionData *, CollectInfo *, gpointer);
389 gpointer info_updated_data;
400 /* contents changed since save flag */
403 GHashTable *existence;
416 CollectInfo *prev_selection;
418 CollectInfo *click_info;
420 GtkWidget *tip_window;
421 guint tip_delay_id; /* event source id */
422 CollectInfo *tip_info;
424 GdkWindow *marker_window;
425 CollectInfo *marker_info;
427 GtkWidget *status_label;
428 GtkWidget *extra_label;
432 CollectInfo *focus_info;
435 CollectInfo *drop_info;
438 guint sync_idle_id; /* event source id */
439 guint drop_idle_id; /* event source id */
444 /* file list for edit menu */
445 GList *editmenu_fd_list;
448 struct _CollectWindow
452 GtkWidget *status_box;
454 GtkWidget *close_dialog;
459 typedef gint (* ImageTileRequestFunc)(ImageWindow *imd, gint x, gint y,
460 gint width, gint height, GdkPixbuf *pixbuf, gpointer);
461 typedef void (* ImageTileDisposeFunc)(ImageWindow *imd, gint x, gint y,
462 gint width, gint height, GdkPixbuf *pixbuf, gpointer);
466 GtkWidget *widget; /* use this to add it and show it */
472 gboolean unknown; /* failed to load image */
474 ImageLoader *il; /* FIXME - image loader should probably go to FileData, but it must first support
475 sending callbacks to multiple ImageWindows in parallel */
477 gint has_frame; /* not boolean, see image_new() */
479 /* top level (not necessarily parent) window */
480 gboolean top_window_sync; /* resize top_window when image dimensions change */
481 GtkWidget *top_window; /* window that gets title, and window to resize when 'fitting' */
482 gchar *title; /* window title to display left of file name */
483 gchar *title_right; /* window title to display right of file name */
484 gboolean title_show_zoom; /* option to include zoom in window title */
487 ImageState state; /* mask of IMAGE_STATE_* flags about current image */
489 void (*func_update)(ImageWindow *imd, gpointer data);
490 void (*func_complete)(ImageWindow *imd, gint preload, gpointer data);
491 void (*func_state)(ImageWindow *imd, ImageState state, gpointer data);
492 ImageTileRequestFunc func_tile_request;
493 ImageTileDisposeFunc func_tile_dispose;
495 gpointer data_update;
496 gpointer data_complete;
500 /* button, scroll functions */
501 void (*func_button)(ImageWindow *, GdkEventButton *event, gpointer);
502 void (*func_drag)(ImageWindow *, GdkEventMotion *event, gdouble dx, gdouble dy, gpointer);
503 void (*func_scroll)(ImageWindow *, GdkEventScroll *event, gpointer);
504 void (*func_focus_in)(ImageWindow *, gpointer);
506 gpointer data_button;
508 gpointer data_scroll;
509 gpointer data_focus_in;
511 /* scroll notification (for scroll bar implementation) */
512 void (*func_scroll_notify)(ImageWindow *, gint x, gint y, gint width, gint height, gpointer);
514 gpointer data_scroll_notify;
516 /* collection info */
517 CollectionData *collection;
518 CollectInfo *collection_info;
521 gboolean color_profile_enable;
522 gint color_profile_input;
523 gboolean color_profile_use_image;
524 gint color_profile_from_image;
527 AlterType delay_alter_type;
529 FileData *read_ahead_fd;
530 ImageLoader *read_ahead_il;
534 gboolean auto_refresh;
541 gboolean mouse_wheel_mode;
544 #define FILEDATA_MARKS_SIZE 10
546 struct _FileDataChangeInfo {
547 FileDataChangeType type;
551 gboolean regroup_when_finished;
557 gchar *original_path; /* key to file_data_pool hash table */
560 const gchar *extension;
561 gchar *extended_extension;
562 FileFormatClass format_class;
563 gchar *collate_key_name;
564 gchar *collate_key_name_nocase;
568 mode_t mode; /* this is needed at least for notification in view_dir because it is preserved after the file/directory is deleted */
569 gint sidecar_priority;
571 guint marks; /* each bit represents one mark */
572 guint valid_marks; /* zero bit means that the corresponding mark needs to be reread */
575 GList *sidecar_files;
576 FileData *parent; /* parent file if this is a sidecar file, NULL otherwise */
577 FileDataChangeInfo *change; /* for rename, move ... */
578 GdkPixbuf *thumb_pixbuf;
580 GdkPixbuf *pixbuf; /* full-size image, only complete images, NULL during loading
581 all FileData with non-NULL pixbuf are referenced by image_cache */
587 gint version; /* increased when any field in this structure is changed */
588 gboolean disable_grouping;
590 gint user_orientation;
591 gint exif_orientation;
595 time_t exifdate_digitized;
596 GHashTable *modified_xmp; // hash table which contains unwritten xmp metadata in format: key->list of string values
597 GList *cached_metadata;
599 gboolean metadata_in_idle_loaded;
605 SelectionType selected; // Used by view_file_icon.
608 struct _LayoutOptions
615 DirViewType dir_view_type;
616 FileViewType file_view_type;
618 gboolean show_thumbnails;
620 gboolean show_directory_date;
621 gboolean show_info_pixel;
652 gint histogram_channel;
663 gboolean tools_float;
664 gboolean tools_hidden;
665 gboolean toolbar_hidden;
670 gboolean tools_float;
671 gboolean tools_hidden;
678 StartUpPath startup_path;
680 gboolean exit_on_close;
687 LayoutOptions options;
697 GtkWidget *group_box;
701 /* menus, path selector */
703 GtkActionGroup *action_group;
704 GtkActionGroup *action_group_editors;
706 GtkUIManager *ui_manager;
707 guint toolbar_merge_id[TOOLBAR_COUNT];
708 GList *toolbar_actions[TOOLBAR_COUNT];
710 GtkWidget *path_entry;
714 LayoutLocation image_location;
718 ImageWindow *split_images[MAX_SPLIT_IMAGES];
719 ImageSplitMode split_mode;
720 gint active_split_image;
722 GtkWidget *split_image_widget;
723 GtkSizeGroup *split_image_sizegroup;
725 /* tools window (float) */
728 GtkWidget *tools_pane;
731 // gint tools_hidden;
733 GtkWidget *menu_bar; /* referenced by lw, exist during whole lw lifetime */
736 GtkWidget *toolbar[TOOLBAR_COUNT]; /* referenced by lw, exist during whole lw lifetime */
737 // gint toolbar_hidden;
739 // GtkWidget *thumb_button;
740 // gint thumbs_enabled;
741 // gint marks_enabled;
743 GtkWidget *back_button;
747 LayoutLocation dir_location;
752 // DirViewType dir_view_type;
756 LayoutLocation file_location;
759 // FileViewType file_view_type;
761 GtkWidget *file_view;
763 SortType sort_method;
764 gboolean sort_ascend;
769 GtkWidget *info_progress_bar;
770 GtkWidget *info_sort;
771 GtkWidget *info_status;
772 GtkWidget *info_details;
773 GtkWidget *info_zoom;
774 GtkWidget *info_pixel;
778 SlideShowData *slideshow;
782 FullScreenData *full_screen;
792 GtkWidget *utility_box; /* referenced by lw, exist during whole lw lifetime */
793 GtkWidget *utility_paned; /* between image and bar */
797 gboolean bar_sort_enabled; /* Set during start-up, and checked when the editors have loaded */
802 GtkWidget *exif_window;
804 AnimationData *animation;
806 GtkWidget *log_window;
823 guint drop_scroll_id; /* event source id */
826 void (*select_func)(ViewDir *vd, FileData *fd, gpointer data);
827 gpointer select_data;
829 void (*dnd_drop_update_func)(ViewDir *vd);
830 void (*dnd_drop_leave_func)(ViewDir *vd);
832 LayoutWindow *layout;
839 struct _ViewDirInfoList
844 struct _ViewDirInfoTree
846 guint drop_expand_id; /* event source id */
854 // TODO(xsdg): Turn this into a union (see VFLIST and VFICON from view_file.h).
861 GtkWidget *filter_check[FILEDATA_MARKS_SIZE];
866 SortType sort_method;
867 gboolean sort_ascend;
870 void (*func_thumb_status)(ViewFile *vf, gdouble val, const gchar *text, gpointer data);
871 gpointer data_thumb_status;
873 void (*func_status)(ViewFile *vf, gpointer data);
874 gpointer data_status;
876 LayoutWindow *layout;
881 gboolean thumbs_running;
882 ThumbLoader *thumbs_loader;
883 FileData *thumbs_filedata;
886 gboolean marks_enabled;
891 guint refresh_idle_id; /* event source id */
892 time_t time_refresh_set; /* time when refresh_idle_id was set */
894 /* file list for edit menu */
895 GList *editmenu_fd_list;
897 guint read_metadata_in_idle_id;
900 struct _ViewFileInfoList
905 gboolean thumbs_enabled;
907 guint select_idle_id; /* event source id */
910 struct _ViewFileInfoIcon
917 FileData *prev_selection;
919 GtkWidget *tip_window;
920 guint tip_delay_id; /* event source id */
932 struct _SlideShowData
934 LayoutWindow *lw; /* use this window to display the slideshow */
935 ImageWindow *imd; /* use this window only if lw is not available,
936 FIXME: it is probably required only by img-view.c and should be dropped with it */
948 guint timeout_id; /* event source id */
950 gboolean from_selection;
952 void (*stop_func)(SlideShowData *, gpointer);
958 struct _FullScreenData
963 GtkWidget *normal_window;
964 ImageWindow *normal_imd;
966 guint hide_mouse_id; /* event source id */
967 guint busy_mouse_id; /* event source id */
971 guint saver_block_id; /* event source id */
973 void (*stop_func)(FullScreenData *, gpointer);
976 gboolean same_region; /* the returned region will overlap the current location of widget. */
979 struct _PixmapFolders
987 struct _SecureSaveInfo {
988 FILE *fp; /**< file stream pointer */
989 gchar *file_name; /**< final file name */
990 gchar *tmp_file_name; /**< temporary file name */
991 gint err; /**< set to non-zero value in case of error */
992 gboolean secure_save; /**< use secure save for this file, internal use only */
993 gboolean preserve_perms; /**< whether to preserve perms, TRUE by default */
994 gboolean preserve_mtime; /**< whether to preserve mtime, FALSE by default */
995 gboolean unlink_on_error; /**< whether to remove temporary file on save failure, TRUE by default */
1002 gboolean startup_blank;
1003 gboolean startup_full_screen;
1004 gboolean startup_in_slideshow;
1005 gboolean startup_command_line_collection;
1006 gboolean tools_hide;
1007 gboolean tools_show;
1008 gboolean log_window_show;
1012 GList *collection_list;
1016 SecureSaveInfo *ssi;
1020 /* vim: set shiftwidth=8 softtabstop=0 cindent cinoptions={1s: */