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"
82 ALTER_NONE, /* do nothing */
84 ALTER_ROTATE_90_CC, /* counterclockwise */
93 LAYOUT_RIGHT = 1 << 1,
95 LAYOUT_BOTTOM = 1 << 3
100 IMAGE_STATE_NONE = 0,
101 IMAGE_STATE_IMAGE = 1 << 0,
102 IMAGE_STATE_LOADING = 1 << 1,
103 IMAGE_STATE_ERROR = 1 << 2,
104 IMAGE_STATE_COLOR_ADJ = 1 << 3,
105 IMAGE_STATE_ROTATE_AUTO = 1 << 4,
106 IMAGE_STATE_ROTATE_USER = 1 << 5,
107 IMAGE_STATE_DELAY_FLIP = 1 << 6
118 FILEDATA_CHANGE_DELETE,
119 FILEDATA_CHANGE_MOVE,
120 FILEDATA_CHANGE_RENAME,
121 FILEDATA_CHANGE_COPY,
122 FILEDATA_CHANGE_UNSPECIFIED,
123 FILEDATA_CHANGE_WRITE_METADATA
124 } FileDataChangeType;
131 } MarkToSelectionMode;
137 } SelectionToMarkMode;
140 FORMAT_CLASS_UNKNOWN,
142 FORMAT_CLASS_RAWIMAGE,
150 SS_ERR_DISABLED, /**< secsave is disabled. */
151 SS_ERR_OUT_OF_MEM, /**< memory allocation failure */
153 /* see err field in SecureSaveInfo */
164 NOTIFY_PRIORITY_HIGH = 0,
165 NOTIFY_PRIORITY_MEDIUM,
170 NOTIFY_MARKS = 1 << 1, /* changed marks */
171 NOTIFY_PIXBUF = 1 << 2, /* image was read into fd->pixbuf */
172 NOTIFY_HISTMAP = 1 << 3, /* histmap was read into fd->histmap */
173 NOTIFY_ORIENTATION = 1 << 4, /* image was rotated */
174 NOTIFY_METADATA = 1 << 5, /* changed image metadata, not yet written */
175 NOTIFY_GROUPING = 1 << 6, /* change in fd->sidecar_files or fd->parent */
176 NOTIFY_REREAD = 1 << 7, /* changed file size, date, etc., file name remains unchanged */
177 NOTIFY_CHANGE = 1 << 8 /* generic change described by fd->change */
182 CHANGE_WARN_DEST_EXISTS = 1 << 0,
183 CHANGE_WARN_NO_WRITE_PERM = 1 << 1,
184 CHANGE_WARN_SAME = 1 << 2,
185 CHANGE_WARN_CHANGED_EXT = 1 << 3,
186 CHANGE_WARN_UNSAVED_META = 1 << 4,
187 CHANGE_WARN_NO_WRITE_PERM_DEST_DIR = 1 << 5,
188 CHANGE_ERROR_MASK = (~0U) << 8, /* the values below are fatal errors */
189 CHANGE_NO_READ_PERM = 1 << 8,
190 CHANGE_NO_WRITE_PERM_DIR = 1 << 9,
191 CHANGE_NO_DEST_DIR = 1 << 10,
192 CHANGE_DUPLICATE_DEST = 1 << 11,
193 CHANGE_NO_WRITE_PERM_DEST = 1 << 12,
194 CHANGE_DEST_EXISTS = 1 << 13,
195 CHANGE_NO_SRC = 1 << 14,
196 CHANGE_GENERIC_ERROR = 1 << 16
200 METADATA_PLAIN = 0, /* format that can be edited and written back */
201 METADATA_FORMATTED = 1 /* for display only */
205 STARTUP_PATH_CURRENT = 0,
217 PR_STEREO_NONE = 0, /* do nothing */
218 PR_STEREO_DUAL = 1 << 0, /* independent stereo buffers, for example nvidia opengl */
219 PR_STEREO_FIXED = 1 << 1, /* custom position */
220 PR_STEREO_HORIZ = 1 << 2, /* side by side */
221 PR_STEREO_VERT = 1 << 3, /* above below */
222 PR_STEREO_RIGHT = 1 << 4, /* render right buffer */
223 PR_STEREO_ANAGLYPH_RC = 1 << 5, /* anaglyph red-cyan */
224 PR_STEREO_ANAGLYPH_GM = 1 << 6, /* anaglyph green-magenta */
225 PR_STEREO_ANAGLYPH_YB = 1 << 7, /* anaglyph yellow-blue */
226 PR_STEREO_ANAGLYPH_GRAY_RC = 1 << 8, /* anaglyph gray red-cyan*/
227 PR_STEREO_ANAGLYPH_GRAY_GM = 1 << 9, /* anaglyph gray green-magenta */
228 PR_STEREO_ANAGLYPH_GRAY_YB = 1 << 10, /* anaglyph gray yellow-blue */
229 PR_STEREO_ANAGLYPH_DB_RC = 1 << 11, /* anaglyph dubois red-cyan */
230 PR_STEREO_ANAGLYPH_DB_GM = 1 << 12, /* anaglyph dubois green-magenta */
231 PR_STEREO_ANAGLYPH_DB_YB = 1 << 13, /* anaglyph dubois yellow-blue */
232 PR_STEREO_ANAGLYPH = PR_STEREO_ANAGLYPH_RC |
233 PR_STEREO_ANAGLYPH_GM |
234 PR_STEREO_ANAGLYPH_YB |
235 PR_STEREO_ANAGLYPH_GRAY_RC |
236 PR_STEREO_ANAGLYPH_GRAY_GM |
237 PR_STEREO_ANAGLYPH_GRAY_YB |
238 PR_STEREO_ANAGLYPH_DB_RC |
239 PR_STEREO_ANAGLYPH_DB_GM |
240 PR_STEREO_ANAGLYPH_DB_YB, /* anaglyph mask */
242 PR_STEREO_MIRROR_LEFT = 1 << 14, /* mirror */
243 PR_STEREO_FLIP_LEFT = 1 << 15, /* flip */
245 PR_STEREO_MIRROR_RIGHT = 1 << 16, /* mirror */
246 PR_STEREO_FLIP_RIGHT = 1 << 17, /* flip */
248 PR_STEREO_MIRROR = PR_STEREO_MIRROR_LEFT | PR_STEREO_MIRROR_RIGHT, /* mirror mask*/
249 PR_STEREO_FLIP = PR_STEREO_FLIP_LEFT | PR_STEREO_FLIP_RIGHT, /* flip mask*/
250 PR_STEREO_SWAP = 1 << 18, /* swap left and right buffers */
251 PR_STEREO_TEMP_DISABLE = 1 << 19, /* temporarily disable stereo mode if source image is not stereo */
252 PR_STEREO_HALF = 1 << 20
253 } PixbufRendererStereoMode;
256 STEREO_PIXBUF_DEFAULT = 0,
257 STEREO_PIXBUF_SBS = 1,
258 STEREO_PIXBUF_CROSS = 2,
259 STEREO_PIXBUF_NONE = 3
262 #define MAX_SPLIT_IMAGES 4
266 SELECTION_SELECTED = 1 << 0,
267 SELECTION_PRELIGHT = 1 << 1,
268 SELECTION_FOCUS = 1 << 2
271 typedef struct _ImageLoader ImageLoader;
272 typedef struct _ThumbLoader ThumbLoader;
274 typedef struct _AnimationData AnimationData;
276 typedef struct _CollectInfo CollectInfo;
277 typedef struct _CollectionData CollectionData;
278 typedef struct _CollectTable CollectTable;
279 typedef struct _CollectWindow CollectWindow;
281 typedef struct _ImageWindow ImageWindow;
283 typedef struct _FileData FileData;
284 typedef struct _FileDataChangeInfo FileDataChangeInfo;
286 typedef struct _LayoutWindow LayoutWindow;
287 typedef struct _LayoutOptions LayoutOptions;
289 typedef struct _ViewDir ViewDir;
290 typedef struct _ViewDirInfoList ViewDirInfoList;
291 typedef struct _ViewDirInfoTree ViewDirInfoTree;
293 typedef struct _ViewFile ViewFile;
294 typedef struct _ViewFileInfoList ViewFileInfoList;
295 typedef struct _ViewFileInfoIcon ViewFileInfoIcon;
297 typedef struct _SlideShowData SlideShowData;
298 typedef struct _FullScreenData FullScreenData;
300 typedef struct _PixmapFolders PixmapFolders;
301 typedef struct _Histogram Histogram;
302 typedef struct _HistMap HistMap;
304 typedef struct _SecureSaveInfo SecureSaveInfo;
306 typedef struct _ExifData ExifData;
308 typedef struct _EditorDescription EditorDescription;
310 typedef struct _CommandLine CommandLine;
313 gint histogram_channel; /* drawing mode for histogram */
314 gint histogram_mode; /* logarithmical or not */
315 guint vgrid; /* number of vertical divisions, 0 for none */
316 guint hgrid; /* number of horizontal divisions, 0 for none */
322 } grid_color; /* grid color */
330 typedef void (* ThumbLoaderFunc)(ThumbLoader *tl, gpointer data);
332 typedef void (* FileUtilDoneFunc)(gboolean success, const gchar *done_path, gpointer data);
336 gboolean standard_loader;
339 FileData *fd; /* fd->pixbuf contains final (scaled) image when done */
341 gboolean cache_enable;
343 gdouble percent_done;
348 ThumbLoaderFunc func_done;
349 ThumbLoaderFunc func_error;
350 ThumbLoaderFunc func_progress;
354 guint idle_done_id; /* event source id */
357 struct _AnimationData
360 GdkPixbufAnimation *gpa;
361 GdkPixbufAnimationIter *iter;
375 struct _CollectionData
380 SortType sort_method;
382 ThumbLoader *thumb_loader;
383 CollectInfo *thumb_info;
385 void (*info_updated_func)(CollectionData *, CollectInfo *, gpointer);
386 gpointer info_updated_data;
397 /* contents changed since save flag */
400 GHashTable *existence;
413 CollectInfo *prev_selection;
415 CollectInfo *click_info;
417 GtkWidget *tip_window;
418 guint tip_delay_id; /* event source id */
419 CollectInfo *tip_info;
421 GdkWindow *marker_window;
422 CollectInfo *marker_info;
424 GtkWidget *status_label;
425 GtkWidget *extra_label;
429 CollectInfo *focus_info;
432 CollectInfo *drop_info;
435 guint sync_idle_id; /* event source id */
436 guint drop_idle_id; /* event source id */
440 /* file list for edit menu */
441 GList *editmenu_fd_list;
444 struct _CollectWindow
448 GtkWidget *status_box;
450 GtkWidget *close_dialog;
455 typedef gint (* ImageTileRequestFunc)(ImageWindow *imd, gint x, gint y,
456 gint width, gint height, GdkPixbuf *pixbuf, gpointer);
457 typedef void (* ImageTileDisposeFunc)(ImageWindow *imd, gint x, gint y,
458 gint width, gint height, GdkPixbuf *pixbuf, gpointer);
462 GtkWidget *widget; /* use this to add it and show it */
468 gboolean unknown; /* failed to load image */
470 ImageLoader *il; /* FIXME - image loader should probably go to FileData, but it must first support
471 sending callbacks to multiple ImageWindows in parallel */
473 gint has_frame; /* not boolean, see image_new() */
475 /* top level (not necessarily parent) window */
476 gboolean top_window_sync; /* resize top_window when image dimensions change */
477 GtkWidget *top_window; /* window that gets title, and window to resize when 'fitting' */
478 gchar *title; /* window title to display left of file name */
479 gchar *title_right; /* window title to display right of file name */
480 gboolean title_show_zoom; /* option to include zoom in window title */
483 ImageState state; /* mask of IMAGE_STATE_* flags about current image */
485 void (*func_update)(ImageWindow *imd, gpointer data);
486 void (*func_complete)(ImageWindow *imd, gint preload, gpointer data);
487 void (*func_state)(ImageWindow *imd, ImageState state, gpointer data);
488 ImageTileRequestFunc func_tile_request;
489 ImageTileDisposeFunc func_tile_dispose;
491 gpointer data_update;
492 gpointer data_complete;
496 /* button, scroll functions */
497 void (*func_button)(ImageWindow *, GdkEventButton *event, gpointer);
498 void (*func_drag)(ImageWindow *, GdkEventMotion *event, gdouble dx, gdouble dy, gpointer);
499 void (*func_scroll)(ImageWindow *, GdkEventScroll *event, gpointer);
500 void (*func_focus_in)(ImageWindow *, gpointer);
502 gpointer data_button;
504 gpointer data_scroll;
505 gpointer data_focus_in;
507 /* scroll notification (for scroll bar implementation) */
508 void (*func_scroll_notify)(ImageWindow *, gint x, gint y, gint width, gint height, gpointer);
510 gpointer data_scroll_notify;
512 /* collection info */
513 CollectionData *collection;
514 CollectInfo *collection_info;
517 gboolean color_profile_enable;
518 gint color_profile_input;
519 gboolean color_profile_use_image;
520 gint color_profile_from_image;
523 AlterType delay_alter_type;
525 FileData *read_ahead_fd;
526 ImageLoader *read_ahead_il;
530 gboolean auto_refresh;
537 gboolean mouse_wheel_mode;
540 #define FILEDATA_MARKS_SIZE 10
542 struct _FileDataChangeInfo {
543 FileDataChangeType type;
547 gboolean regroup_when_finished;
553 gchar *original_path; /* key to file_data_pool hash table */
556 const gchar *extension;
557 gchar *extended_extension;
558 FileFormatClass format_class;
559 gchar *collate_key_name;
560 gchar *collate_key_name_nocase;
564 mode_t mode; /* this is needed at least for notification in view_dir because it is preserved after the file/directory is deleted */
565 gint sidecar_priority;
567 guint marks; /* each bit represents one mark */
568 guint valid_marks; /* zero bit means that the corresponding mark needs to be reread */
571 GList *sidecar_files;
572 FileData *parent; /* parent file if this is a sidecar file, NULL otherwise */
573 FileDataChangeInfo *change; /* for rename, move ... */
574 GdkPixbuf *thumb_pixbuf;
576 GdkPixbuf *pixbuf; /* full-size image, only complete images, NULL during loading
577 all FileData with non-NULL pixbuf are referenced by image_cache */
583 gint version; /* increased when any field in this structure is changed */
584 gboolean disable_grouping;
586 gint user_orientation;
587 gint exif_orientation;
591 GHashTable *modified_xmp; // hash table which contains unwritten xmp metadata in format: key->list of string values
592 GList *cached_metadata;
595 SelectionType selected; // Used by view_file_icon.
598 struct _LayoutOptions
605 DirViewType dir_view_type;
606 FileViewType file_view_type;
608 gboolean show_thumbnails;
610 gboolean show_directory_date;
611 gboolean show_info_pixel;
642 gint histogram_channel;
653 gboolean tools_float;
654 gboolean tools_hidden;
655 gboolean toolbar_hidden;
660 gboolean tools_float;
661 gboolean tools_hidden;
668 StartUpPath startup_path;
670 gboolean exit_on_close;
677 LayoutOptions options;
687 GtkWidget *group_box;
691 /* menus, path selector */
693 GtkActionGroup *action_group;
694 GtkActionGroup *action_group_editors;
696 GtkUIManager *ui_manager;
697 guint toolbar_merge_id[TOOLBAR_COUNT];
698 GList *toolbar_actions[TOOLBAR_COUNT];
700 GtkWidget *path_entry;
704 LayoutLocation image_location;
708 ImageWindow *split_images[MAX_SPLIT_IMAGES];
709 ImageSplitMode split_mode;
710 gint active_split_image;
712 GtkWidget *split_image_widget;
713 GtkSizeGroup *split_image_sizegroup;
715 /* tools window (float) */
718 GtkWidget *tools_pane;
721 // gint tools_hidden;
723 GtkWidget *menu_bar; /* referenced by lw, exist during whole lw lifetime */
726 GtkWidget *toolbar[TOOLBAR_COUNT]; /* referenced by lw, exist during whole lw lifetime */
727 // gint toolbar_hidden;
729 // GtkWidget *thumb_button;
730 // gint thumbs_enabled;
731 // gint marks_enabled;
733 GtkWidget *back_button;
737 LayoutLocation dir_location;
742 // DirViewType dir_view_type;
746 LayoutLocation file_location;
749 // FileViewType file_view_type;
751 GtkWidget *file_view;
753 SortType sort_method;
754 gboolean sort_ascend;
759 GtkWidget *info_progress_bar;
760 GtkWidget *info_sort;
761 GtkWidget *info_status;
762 GtkWidget *info_details;
763 GtkWidget *info_zoom;
764 GtkWidget *info_pixel;
768 SlideShowData *slideshow;
772 FullScreenData *full_screen;
782 GtkWidget *utility_box; /* referenced by lw, exist during whole lw lifetime */
783 GtkWidget *utility_paned; /* between image and bar */
787 gboolean bar_sort_enabled; /* Set during start-up, and checked when the editors have loaded */
792 GtkWidget *exif_window;
794 AnimationData *animation;
796 GtkWidget *log_window;
813 guint drop_scroll_id; /* event source id */
816 void (*select_func)(ViewDir *vd, FileData *fd, gpointer data);
817 gpointer select_data;
819 void (*dnd_drop_update_func)(ViewDir *vd);
820 void (*dnd_drop_leave_func)(ViewDir *vd);
822 LayoutWindow *layout;
829 struct _ViewDirInfoList
834 struct _ViewDirInfoTree
836 guint drop_expand_id; /* event source id */
844 // TODO(xsdg): Turn this into a union (see VFLIST and VFICON from view_file.h).
851 GtkWidget *filter_check[FILEDATA_MARKS_SIZE];
856 SortType sort_method;
857 gboolean sort_ascend;
860 void (*func_thumb_status)(ViewFile *vf, gdouble val, const gchar *text, gpointer data);
861 gpointer data_thumb_status;
863 void (*func_status)(ViewFile *vf, gpointer data);
864 gpointer data_status;
866 LayoutWindow *layout;
871 gboolean thumbs_running;
872 ThumbLoader *thumbs_loader;
873 FileData *thumbs_filedata;
876 gboolean marks_enabled;
881 guint refresh_idle_id; /* event source id */
882 time_t time_refresh_set; /* time when refresh_idle_id was set */
884 /* file list for edit menu */
885 GList *editmenu_fd_list;
888 struct _ViewFileInfoList
893 gboolean thumbs_enabled;
895 guint select_idle_id; /* event source id */
898 struct _ViewFileInfoIcon
905 FileData *prev_selection;
907 GtkWidget *tip_window;
908 guint tip_delay_id; /* event source id */
920 struct _SlideShowData
922 LayoutWindow *lw; /* use this window to display the slideshow */
923 ImageWindow *imd; /* use this window only if lw is not available,
924 FIXME: it is probably required only by img-view.c and should be dropped with it */
936 guint timeout_id; /* event source id */
938 gboolean from_selection;
940 void (*stop_func)(SlideShowData *, gpointer);
946 struct _FullScreenData
951 GtkWidget *normal_window;
952 ImageWindow *normal_imd;
954 guint hide_mouse_id; /* event source id */
955 guint busy_mouse_id; /* event source id */
959 guint saver_block_id; /* event source id */
961 void (*stop_func)(FullScreenData *, gpointer);
964 gboolean same_region; /* the returned region will overlap the current location of widget. */
967 struct _PixmapFolders
975 struct _SecureSaveInfo {
976 FILE *fp; /**< file stream pointer */
977 gchar *file_name; /**< final file name */
978 gchar *tmp_file_name; /**< temporary file name */
979 gint err; /**< set to non-zero value in case of error */
980 gboolean secure_save; /**< use secure save for this file, internal use only */
981 gboolean preserve_perms; /**< whether to preserve perms, TRUE by default */
982 gboolean preserve_mtime; /**< whether to preserve mtime, FALSE by default */
983 gboolean unlink_on_error; /**< whether to remove temporary file on save failure, TRUE by default */
990 gboolean startup_blank;
991 gboolean startup_full_screen;
992 gboolean startup_in_slideshow;
993 gboolean startup_command_line_collection;
996 gboolean log_window_show;
1000 GList *collection_list;
1004 SecureSaveInfo *ssi;
1008 /* vim: set shiftwidth=8 softtabstop=0 cindent cinoptions={1s: */