simplified and improved bar configuration
[geeqie.git] / src / typedefs.h
1 /*
2  * Geeqie
3  * (C) 2006 John Ellis
4  * Copyright (C) 2008 - 2009 The Geeqie Team
5  *
6  * Author: John Ellis
7  *
8  * This software is released under the GNU General Public License (GNU GPL).
9  * Please read the included file COPYING for more information.
10  * This software comes with no warranty of any kind, use at your own risk!
11  */
12
13
14 #ifndef TYPEDEFS_H
15 #define TYPEDEFS_H
16
17 typedef enum {
18         ZOOM_RESET_ORIGINAL     = 0,
19         ZOOM_RESET_FIT_WINDOW   = 1,
20         ZOOM_RESET_NONE         = 2
21 } ZoomMode;
22
23 typedef enum {
24         MOUSE_BUTTON_LEFT       = 1,
25         MOUSE_BUTTON_MIDDLE     = 2,
26         MOUSE_BUTTON_RIGHT      = 3,
27         MOUSE_BUTTON_WHEEL_UP   = 4,
28         MOUSE_BUTTON_WHEEL_DOWN = 5
29 } MouseButton;
30
31 typedef enum {
32         DIRVIEW_LIST,
33         DIRVIEW_TREE
34 } DirViewType;
35
36 typedef enum {
37         FILEVIEW_LIST,
38         FILEVIEW_ICON
39 } FileViewType;
40
41 #define CMD_COPY     "geeqie-copy-command.desktop"
42 #define CMD_MOVE     "geeqie-move-command.desktop"
43 #define CMD_RENAME   "geeqie-rename-command.desktop"
44 #define CMD_DELETE   "geeqie-delete-command.desktop"
45 #define CMD_FOLDER   "geeqie-folder-command.desktop"
46
47 typedef enum {
48         SORT_NONE,
49         SORT_NAME,
50         SORT_SIZE,
51         SORT_TIME,
52         SORT_PATH,
53         SORT_NUMBER
54 } SortType;
55
56 typedef enum {
57         ALTER_NONE,             /* do nothing */
58         ALTER_ROTATE_90,
59         ALTER_ROTATE_90_CC,     /* counterclockwise */
60         ALTER_ROTATE_180,
61         ALTER_MIRROR,
62         ALTER_FLIP,
63         ALTER_DESATURATE
64 } AlterType;
65
66 typedef enum {
67         LAYOUT_HIDE   = 0,
68         LAYOUT_LEFT   = 1 << 0,
69         LAYOUT_RIGHT  = 1 << 1,
70         LAYOUT_TOP    = 1 << 2,
71         LAYOUT_BOTTOM = 1 << 3
72 } LayoutLocation;
73
74
75 typedef enum {
76         IMAGE_STATE_NONE        = 0,
77         IMAGE_STATE_IMAGE       = 1 << 0,
78         IMAGE_STATE_LOADING     = 1 << 1,
79         IMAGE_STATE_ERROR       = 1 << 2,
80         IMAGE_STATE_COLOR_ADJ   = 1 << 3,
81         IMAGE_STATE_ROTATE_AUTO = 1 << 4,
82         IMAGE_STATE_ROTATE_USER = 1 << 5,
83         IMAGE_STATE_DELAY_FLIP  = 1 << 6
84 } ImageState;
85
86 typedef enum {
87         SPLIT_NONE = 0,
88         SPLIT_VERT,
89         SPLIT_HOR,
90         SPLIT_QUAD,
91 } ImageSplitMode;
92
93 typedef enum {
94         FILEDATA_CHANGE_DELETE,
95         FILEDATA_CHANGE_MOVE,
96         FILEDATA_CHANGE_RENAME,
97         FILEDATA_CHANGE_COPY,
98         FILEDATA_CHANGE_UNSPECIFIED,
99         FILEDATA_CHANGE_WRITE_METADATA
100 } FileDataChangeType;
101
102 typedef enum {
103         MTS_MODE_MINUS,
104         MTS_MODE_SET,
105         MTS_MODE_OR,
106         MTS_MODE_AND
107 } MarkToSelectionMode;
108
109 typedef enum {
110         STM_MODE_RESET,
111         STM_MODE_SET,
112         STM_MODE_TOGGLE
113 } SelectionToMarkMode;
114
115 typedef enum {
116         FORMAT_CLASS_UNKNOWN,
117         FORMAT_CLASS_IMAGE,
118         FORMAT_CLASS_RAWIMAGE,
119         FORMAT_CLASS_META,
120         FILE_FORMAT_CLASSES
121 } FileFormatClass;
122
123 typedef enum {
124         SS_ERR_NONE = 0,
125         SS_ERR_DISABLED, /**< secsave is disabled. */
126         SS_ERR_OUT_OF_MEM, /**< memory allocation failure */
127
128         /* see err field in SecureSaveInfo */
129         SS_ERR_OPEN_READ,
130         SS_ERR_OPEN_WRITE,
131         SS_ERR_STAT,
132         SS_ERR_ACCESS,
133         SS_ERR_MKSTEMP,
134         SS_ERR_RENAME,
135         SS_ERR_OTHER,
136 } SecureSaveErrno;
137
138 typedef enum {
139         NOTIFY_PRIORITY_HIGH = 0,
140         NOTIFY_PRIORITY_MEDIUM,
141         NOTIFY_PRIORITY_LOW
142 } NotifyPriority;
143         
144 typedef enum {
145         NOTIFY_TYPE_INTERNAL = 0, /* changed internal data only, like marks */
146         NOTIFY_TYPE_REREAD,       /* changed file size, date, etc., file name remains unchanged */
147         NOTIFY_TYPE_CHANGE        /* generic change described by fd->change */
148 } NotifyType;
149
150 typedef enum {
151         CHANGE_OK                      = 0,
152         CHANGE_WARN_DEST_EXISTS        = 1 << 0,
153         CHANGE_WARN_NO_WRITE_PERM      = 1 << 1,
154         CHANGE_WARN_SAME               = 1 << 2,
155         CHANGE_WARN_CHANGED_EXT        = 1 << 3,
156         CHANGE_ERROR_MASK              = (~0) << 4, /* the values below are fatal errors */
157         CHANGE_NO_READ_PERM            = 1 << 4,
158         CHANGE_NO_WRITE_PERM_DIR       = 1 << 5,
159         CHANGE_NO_DEST_DIR             = 1 << 6,
160         CHANGE_NO_WRITE_PERM_DEST_DIR  = 1 << 7,
161         CHANGE_NO_WRITE_PERM_DEST      = 1 << 8,
162         CHANGE_DEST_EXISTS             = 1 << 9,
163         CHANGE_NO_SRC                  = 1 << 10,
164         CHANGE_GENERIC_ERROR           = 1 << 16
165 } ChangeError;
166
167 typedef enum {
168         METADATA_PLAIN          = 0, /* format that can be edited and written back */
169         METADATA_FORMATTED      = 1  /* for display only */
170 } MetadataFormat;
171
172
173 #define MAX_SPLIT_IMAGES 4
174
175 typedef struct _ImageLoader ImageLoader;
176 typedef struct _ThumbLoader ThumbLoader;
177
178 typedef struct _CollectInfo CollectInfo;
179 typedef struct _CollectionData CollectionData;
180 typedef struct _CollectTable CollectTable;
181 typedef struct _CollectWindow CollectWindow;
182
183 typedef struct _ImageWindow ImageWindow;
184
185 typedef struct _FileData FileData;
186 typedef struct _FileDataChangeInfo FileDataChangeInfo;
187
188 typedef struct _LayoutWindow LayoutWindow;
189 typedef struct _LayoutOptions LayoutOptions;
190
191 typedef struct _ViewDir ViewDir;
192 typedef struct _ViewDirInfoList ViewDirInfoList;
193 typedef struct _ViewDirInfoTree ViewDirInfoTree;
194
195 typedef struct _ViewFile ViewFile;
196 typedef struct _ViewFileInfoList ViewFileInfoList;
197 typedef struct _ViewFileInfoIcon ViewFileInfoIcon;
198
199 typedef struct _SlideShowData SlideShowData;
200 typedef struct _FullScreenData FullScreenData;
201
202 typedef struct _PixmapFolders PixmapFolders;
203 typedef struct _Histogram Histogram;
204 typedef struct _HistMap HistMap;
205
206 typedef struct _SecureSaveInfo SecureSaveInfo;
207
208 typedef struct _ExifData ExifData;
209
210 typedef struct _EditorDescription EditorDescription;
211
212 typedef struct _CommandLine CommandLine;
213
214 struct _EditorDescription {
215         gchar *key;             /* desktop file name, not including path, including extension */
216         gchar *name;            /* Name, localized name presented to user */
217         gchar *icon;            /* Icon */
218         gchar *exec;            /* Exec */
219         gchar *menu_path;       
220         gchar *hotkey;
221         GList *ext_list;
222         gchar *file;
223         guint flags;
224         gboolean hidden;
225 };
226
227
228 struct _ImageLoader;
229
230 typedef void (* ThumbLoaderFunc)(ThumbLoader *tl, gpointer data);
231
232 typedef void (* FileUtilDoneFunc)(gboolean success, const gchar *done_path, gpointer data);
233
234 struct _ThumbLoader
235 {
236         gint standard_loader;
237
238         ImageLoader *il;
239         FileData *fd;           /* fd->pixbuf contains final (scaled) image when done */
240
241         gint cache_enable;
242         gint cache_hit;
243         gdouble percent_done;
244
245         gint max_w;
246         gint max_h;
247
248         ThumbLoaderFunc func_done;
249         ThumbLoaderFunc func_error;
250         ThumbLoaderFunc func_progress;
251
252         gpointer data;
253
254         gint idle_done_id;
255 };
256
257 struct _CollectInfo
258 {
259         FileData *fd;
260         GdkPixbuf *pixbuf;
261         guint flag_mask;
262 };
263
264 struct _CollectionData
265 {
266         gchar *path;
267         gchar *name;
268         GList *list;
269         SortType sort_method;
270
271         ThumbLoader *thumb_loader;
272         CollectInfo *thumb_info;
273
274         void (*info_updated_func)(CollectionData *, CollectInfo *, gpointer);
275         gpointer info_updated_data;
276
277         gint ref;
278
279         /* geometry */
280         gint window_read;
281         gint window_x;
282         gint window_y;
283         gint window_w;
284         gint window_h;
285
286         /* contents changed since save flag */
287         gint changed;
288
289         GHashTable *existence;
290 };
291
292 struct _CollectTable
293 {
294         GtkWidget *scrolled;
295         GtkWidget *listview;
296         gint columns;
297         gint rows;
298
299         CollectionData *cd;
300
301         GList *selection;
302         CollectInfo *prev_selection;
303
304         CollectInfo *click_info;
305
306         GtkWidget *tip_window;
307         gint tip_delay_id;
308         CollectInfo *tip_info;
309
310         GdkWindow *marker_window;
311         CollectInfo *marker_info;
312
313         GtkWidget *status_label;
314         GtkWidget *extra_label;
315
316         gint focus_row;
317         gint focus_column;
318         CollectInfo *focus_info;
319
320         GtkWidget *popup;
321         CollectInfo *drop_info;
322         GList *drop_list;
323
324         gint sync_idle_id;
325         gint drop_idle_id;
326
327         gint show_text;
328 };
329
330 struct _CollectWindow
331 {
332         GtkWidget *window;
333         CollectTable *table;
334         GtkWidget *status_box;
335         GList *list;
336
337         GtkWidget *close_dialog;
338
339         CollectionData *cd;
340 };
341
342 typedef gint (* ImageTileRequestFunc)(ImageWindow *imd, gint x, gint y,
343                                       gint width, gint height, GdkPixbuf *pixbuf, gpointer);
344 typedef void (* ImageTileDisposeFunc)(ImageWindow *imd, gint x, gint y,
345                                       gint width, gint height, GdkPixbuf *pixbuf, gpointer);
346
347 struct _ImageWindow
348 {
349         GtkWidget *widget;      /* use this to add it and show it */
350         GtkWidget *pr;
351         GtkWidget *frame;
352
353         FileData *image_fd;
354
355         gint unknown;           /* failed to load image */
356
357         ImageLoader *il;        /* FIXME - image loader should probably go to FileData, but it must first support
358                                    sending callbacks to multiple ImageWindows in parallel */
359
360         gint has_frame;
361
362         /* top level (not necessarily parent) window */
363         gint top_window_sync;   /* resize top_window when image dimensions change */
364         GtkWidget *top_window;  /* window that gets title, and window to resize when 'fitting' */
365         gchar *title;           /* window title to display left of file name */
366         gchar *title_right;     /* window title to display right of file name */
367         gint title_show_zoom;   /* option to include zoom in window title */
368
369         gint completed;
370         ImageState state;       /* mask of IMAGE_STATE_* flags about current image */
371
372         void (*func_update)(ImageWindow *imd, gpointer data);
373         void (*func_complete)(ImageWindow *imd, gint preload, gpointer data);
374         void (*func_state)(ImageWindow *imd, ImageState state, gpointer data);
375         ImageTileRequestFunc func_tile_request;
376         ImageTileDisposeFunc func_tile_dispose;
377
378         gpointer data_update;
379         gpointer data_complete;
380         gpointer data_state;
381         gpointer data_tile;
382
383         /* button, scroll functions */
384         void (*func_button)(ImageWindow *, GdkEventButton *event, gpointer);
385         void (*func_drag)(ImageWindow *, GdkEventButton *event, gdouble dx, gdouble dy, gpointer);
386         void (*func_scroll)(ImageWindow *, GdkEventScroll *event, gpointer);
387
388         gpointer data_button;
389         gpointer data_drag;
390         gpointer data_scroll;
391
392         /* scroll notification (for scroll bar implementation) */
393         void (*func_scroll_notify)(ImageWindow *, gint x, gint y, gint width, gint height, gpointer);
394
395         gpointer data_scroll_notify;
396
397         /* collection info */
398         CollectionData *collection;
399         CollectInfo *collection_info;
400
401         /* color profiles */
402         gint color_profile_enable;
403         gint color_profile_input;
404         gint color_profile_screen;
405         gint color_profile_use_image;
406         gint color_profile_from_image;
407         gpointer cm;
408
409         AlterType delay_alter_type;
410
411         FileData *read_ahead_fd;
412         ImageLoader *read_ahead_il;
413
414         gint prev_color_row;
415
416         gint auto_refresh;
417
418         gint delay_flip;
419         gint orientation;
420         gint desaturate;
421
422         gint overlay_show_zoom; /* set to true if overlay is showing zoom ratio */
423 };
424
425 #define FILEDATA_MARKS_SIZE 6
426
427 struct _FileDataChangeInfo {
428         FileDataChangeType type;
429         gchar *source;
430         gchar *dest;
431         gint error;
432 };
433
434 struct _FileData {
435         gint magick;
436         gint type;
437         gchar *original_path; /* key to file_data_pool hash table */
438         gchar *path;
439         const gchar *name;
440         const gchar *extension;
441         gchar *collate_key_name;
442         gchar *collate_key_name_nocase;
443         gint64 size;
444         time_t date;
445         mode_t mode; /* this is needed at least for notification in view_dir because it is preserved after the file/directory is deleted */
446         
447         guint marks; /* each bit represents one mark */
448         guint valid_marks; /* zero bit means that the corresponding mark needs to be reread */
449
450
451         GList *sidecar_files;
452         FileData *parent; /* parent file if this is a sidecar file, NULL otherwise */
453         FileDataChangeInfo *change; /* for rename, move ... */
454         GdkPixbuf *thumb_pixbuf;
455
456         GdkPixbuf *pixbuf; /* full-size image, only complete images, NULL during loading
457                               all FileData with non-NULL pixbuf are referenced by image_cache */
458                               
459         HistMap *histmap;
460
461         gint ref;
462         gint version; /* increased when any field in this structure is changed */
463         gint disable_grouping;
464
465         gint user_orientation;
466         gint exif_orientation;
467         
468         ExifData *exif;
469         GHashTable *modified_xmp; // hash table which contains unwritten xmp metadata in format: key->list of string values
470 };
471
472 struct _LayoutOptions
473 {
474         gchar *order;
475         gint style;
476
477         DirViewType dir_view_type;
478         FileViewType file_view_type;
479
480         gboolean show_thumbnails;
481         gboolean show_marks;
482         gboolean show_directory_date;
483
484         struct {
485                 gint w;
486                 gint h;
487                 gint x;
488                 gint y;
489                 gboolean maximized;
490                 gint hdivider_pos;
491                 gint vdivider_pos;
492         } main_window;
493
494         struct {
495                 gint w;
496                 gint h;
497                 gint x;
498                 gint y;
499                 gint vdivider_pos;
500         } float_window;
501
502         struct {
503                 gint w;
504                 gint h;
505         } properties_window;
506
507         gboolean save_window_positions;
508
509         gboolean tools_float;
510         gboolean tools_hidden;
511         gboolean tools_restore_state;
512
513         gboolean toolbar_hidden;
514         
515         gchar *home_path;
516
517         /* panels */
518         struct {
519                 struct {
520                         gboolean enabled;
521                         gint mode_state;
522                         gint action_state;
523                         gint selection_state;
524                         gchar *action_filter;
525                 } sort;
526         } panels;
527
528 };
529
530 struct _LayoutWindow
531 {
532         LayoutOptions options;
533
534         FileData *dir_fd;
535
536         /* base */
537
538         GtkWidget *window;
539
540         GtkWidget *main_box;
541
542         GtkWidget *group_box;
543         GtkWidget *h_pane;
544         GtkWidget *v_pane;
545
546         /* menus, path selector */
547
548         GtkActionGroup *action_group;
549         GtkActionGroup *action_group_external;
550         GtkUIManager *ui_manager;
551
552         GtkWidget *path_entry;
553
554         /* image */
555
556         LayoutLocation image_location;
557
558         ImageWindow *image;
559
560         ImageWindow *split_images[MAX_SPLIT_IMAGES];
561         ImageSplitMode split_mode;
562         gint active_split_image;
563
564         GtkWidget *split_image_widget;
565         GtkSizeGroup *split_image_sizegroup;
566
567         /* tools window (float) */
568
569         GtkWidget *tools;
570         GtkWidget *tools_pane;
571
572 //      gint tools_float;
573 //      gint tools_hidden;
574
575         /* toolbar */
576
577         GtkWidget *toolbar;
578 //      gint toolbar_hidden;
579
580         GtkWidget *thumb_button;
581 //      gint thumbs_enabled;
582 //      gint marks_enabled;
583
584         GtkWidget *back_button;
585
586         /* dir view */
587
588         LayoutLocation dir_location;
589
590         ViewDir *vd;
591         GtkWidget *dir_view;
592
593 //      DirViewType dir_view_type;
594
595         /* file view */
596
597         LayoutLocation file_location;
598
599         ViewFile *vf;
600         FileViewType file_view_type;
601
602         GtkWidget *file_view;
603
604         SortType sort_method;
605         gint sort_ascend;
606
607         /* status bar */
608
609         GtkWidget *info_box;
610         GtkWidget *info_progress_bar;
611         GtkWidget *info_sort;
612         GtkWidget *info_color;
613         GtkWidget *info_status;
614         GtkWidget *info_details;
615         GtkWidget *info_zoom;
616         GtkWidget *info_write;
617
618         /* slide show */
619
620         SlideShowData *slideshow;
621
622         /* full screen */
623
624         FullScreenData *full_screen;
625
626         /* dividers */
627
628 //      gint div_h;
629 //      gint div_v;
630 //      gint div_float;
631
632         /* misc */
633
634         GtkWidget *utility_box;
635         GtkWidget *bar_sort;
636         GtkWidget *bar;
637
638 //      gint bar_sort_enabled;
639 //      gint bar_enabled;
640
641 //      gint bar_width;
642
643         GtkWidget *exif_window;
644 };
645
646 struct _ViewDir
647 {
648         DirViewType type;
649         gpointer info;
650
651         GtkWidget *widget;
652         GtkWidget *view;
653
654         FileData *dir_fd;
655
656         FileData *click_fd;
657
658         FileData *drop_fd;
659         GList *drop_list;
660         gint drop_scroll_id;
661
662         /* func list */
663         void (*select_func)(ViewDir *vd, const gchar *path, gpointer data);
664         gpointer select_data;
665
666         void (*dnd_drop_update_func)(ViewDir *vd);
667         void (*dnd_drop_leave_func)(ViewDir *vd);
668
669         LayoutWindow *layout;
670
671         GtkWidget *popup;
672
673         PixmapFolders *pf;
674 };
675
676 struct _ViewDirInfoList
677 {
678         GList *list;
679 };
680
681 struct _ViewDirInfoTree
682 {
683         gint drop_expand_id;
684         gint busy_ref;
685 };
686
687
688 struct _ViewFile
689 {
690         FileViewType type;
691         gpointer info;
692
693         GtkWidget *widget;
694         GtkWidget *listview;
695         GtkWidget *scrolled;
696         GtkWidget *filter;
697         GtkWidget *filter_check[FILEDATA_MARKS_SIZE];
698
699         FileData *dir_fd;
700         GList *list;
701
702         SortType sort_method;
703         gint sort_ascend;
704
705         /* func list */
706         void (*func_thumb_status)(ViewFile *vf, gdouble val, const gchar *text, gpointer data);
707         gpointer data_thumb_status;
708
709         void (*func_status)(ViewFile *vf, gpointer data);
710         gpointer data_status;
711
712         LayoutWindow *layout;
713
714         GtkWidget *popup;
715
716         /* thumbs updates*/
717         gint thumbs_running;
718         ThumbLoader *thumbs_loader;
719         FileData *thumbs_filedata;
720
721         /* marks */
722         gint marks_enabled;
723         gint active_mark;
724         gint clicked_mark;
725         
726         /* refresh */
727         gint refresh_idle_id;
728 };
729
730 struct _ViewFileInfoList
731 {
732         FileData *click_fd;
733         FileData *select_fd;
734
735         gint thumbs_enabled;
736
737         gint select_idle_id;
738 };
739
740 struct _IconData;
741
742 struct _ViewFileInfoIcon
743 {
744         /* table stuff */
745         gint columns;
746         gint rows;
747
748         GList *selection;
749         struct _IconData *prev_selection;
750
751         GtkWidget *tip_window;
752         gint tip_delay_id;
753         struct _IconData *tip_id;
754
755         struct _IconData *click_id;
756
757         struct _IconData *focus_id;
758         gint focus_row;
759         gint focus_column;
760
761         gint show_text;
762 };
763
764 struct _SlideShowData
765 {
766         ImageWindow *imd;
767
768         GList *filelist;
769         CollectionData *cd;
770         FileData *dir_fd;
771         LayoutWindow *layout;
772
773         GList *list;
774         GList *list_done;
775
776         FileData *slide_fd;
777
778         guint slide_count;
779         gint timeout_id;
780
781         gint from_selection;
782
783         void (*stop_func)(SlideShowData *, gpointer);
784         gpointer stop_data;
785
786         gint paused;
787 };
788
789 struct _FullScreenData
790 {
791         GtkWidget *window;
792         ImageWindow *imd;
793
794         GtkWidget *normal_window;
795         ImageWindow *normal_imd;
796
797         gint hide_mouse_id;
798         gint busy_mouse_id;
799         gint cursor_state;
800
801         gint saver_block_id;
802
803         void (*stop_func)(FullScreenData *, gpointer);
804         gpointer stop_data;
805 };
806
807 struct _PixmapFolders
808 {
809         GdkPixbuf *close;
810         GdkPixbuf *open;
811         GdkPixbuf *deny;
812         GdkPixbuf *parent;
813 };
814
815 struct _SecureSaveInfo {
816         FILE *fp; /**< file stream pointer */
817         gchar *file_name; /**< final file name */
818         gchar *tmp_file_name; /**< temporary file name */
819         gint err; /**< set to non-zero value in case of error */
820         gint secure_save; /**< use secure save for this file, internal use only */
821         gint preserve_perms; /**< whether to preserve perms, TRUE by default */
822         gint preserve_mtime; /**< whether to preserve mtime, FALSE by default */
823         gint unlink_on_error; /**< whether to remove temporary file on save failure, TRUE by default */
824 };
825
826 struct _CommandLine
827 {
828         int argc;
829         gchar **argv;
830         gboolean startup_blank;
831         gboolean startup_full_screen;
832         gboolean startup_in_slideshow;
833         gboolean startup_command_line_collection;
834         gboolean tools_hide;
835         gboolean tools_show;
836         gchar *path;
837         gchar *file;
838         GList *cmd_list;
839         GList *collection_list;
840         gchar *geometry;
841 };
842
843 #endif
844 /* vim: set shiftwidth=8 softtabstop=0 cindent cinoptions={1s: */