config file format changed to XML
[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 struct _EditorDescription {
213         gchar *key;             /* desktop file name, not including path, including extension */
214         gchar *name;            /* Name, localized name presented to user */
215         gchar *icon;            /* Icon */
216         gchar *exec;            /* Exec */
217         gchar *menu_path;       
218         gchar *hotkey;
219         GList *ext_list;
220         gchar *file;
221         guint flags;
222         gboolean hidden;
223 };
224
225
226 struct _ImageLoader;
227
228 typedef void (* ThumbLoaderFunc)(ThumbLoader *tl, gpointer data);
229
230 typedef void (* FileUtilDoneFunc)(gboolean success, const gchar *done_path, gpointer data);
231
232 struct _ThumbLoader
233 {
234         gint standard_loader;
235
236         ImageLoader *il;
237         FileData *fd;           /* fd->pixbuf contains final (scaled) image when done */
238
239         gint cache_enable;
240         gint cache_hit;
241         gdouble percent_done;
242
243         gint max_w;
244         gint max_h;
245
246         ThumbLoaderFunc func_done;
247         ThumbLoaderFunc func_error;
248         ThumbLoaderFunc func_progress;
249
250         gpointer data;
251
252         gint idle_done_id;
253 };
254
255 struct _CollectInfo
256 {
257         FileData *fd;
258         GdkPixbuf *pixbuf;
259         guint flag_mask;
260 };
261
262 struct _CollectionData
263 {
264         gchar *path;
265         gchar *name;
266         GList *list;
267         SortType sort_method;
268
269         ThumbLoader *thumb_loader;
270         CollectInfo *thumb_info;
271
272         void (*info_updated_func)(CollectionData *, CollectInfo *, gpointer);
273         gpointer info_updated_data;
274
275         gint ref;
276
277         /* geometry */
278         gint window_read;
279         gint window_x;
280         gint window_y;
281         gint window_w;
282         gint window_h;
283
284         /* contents changed since save flag */
285         gint changed;
286
287         GHashTable *existence;
288 };
289
290 struct _CollectTable
291 {
292         GtkWidget *scrolled;
293         GtkWidget *listview;
294         gint columns;
295         gint rows;
296
297         CollectionData *cd;
298
299         GList *selection;
300         CollectInfo *prev_selection;
301
302         CollectInfo *click_info;
303
304         GtkWidget *tip_window;
305         gint tip_delay_id;
306         CollectInfo *tip_info;
307
308         GdkWindow *marker_window;
309         CollectInfo *marker_info;
310
311         GtkWidget *status_label;
312         GtkWidget *extra_label;
313
314         gint focus_row;
315         gint focus_column;
316         CollectInfo *focus_info;
317
318         GtkWidget *popup;
319         CollectInfo *drop_info;
320         GList *drop_list;
321
322         gint sync_idle_id;
323         gint drop_idle_id;
324
325         gint show_text;
326 };
327
328 struct _CollectWindow
329 {
330         GtkWidget *window;
331         CollectTable *table;
332         GtkWidget *status_box;
333         GList *list;
334
335         GtkWidget *close_dialog;
336
337         CollectionData *cd;
338 };
339
340 typedef gint (* ImageTileRequestFunc)(ImageWindow *imd, gint x, gint y,
341                                       gint width, gint height, GdkPixbuf *pixbuf, gpointer);
342 typedef void (* ImageTileDisposeFunc)(ImageWindow *imd, gint x, gint y,
343                                       gint width, gint height, GdkPixbuf *pixbuf, gpointer);
344
345 struct _ImageWindow
346 {
347         GtkWidget *widget;      /* use this to add it and show it */
348         GtkWidget *pr;
349         GtkWidget *frame;
350
351         FileData *image_fd;
352
353         gint unknown;           /* failed to load image */
354
355         ImageLoader *il;        /* FIXME - image loader should probably go to FileData, but it must first support
356                                    sending callbacks to multiple ImageWindows in parallel */
357
358         gint has_frame;
359
360         /* top level (not necessarily parent) window */
361         gint top_window_sync;   /* resize top_window when image dimensions change */
362         GtkWidget *top_window;  /* window that gets title, and window to resize when 'fitting' */
363         gchar *title;           /* window title to display left of file name */
364         gchar *title_right;     /* window title to display right of file name */
365         gint title_show_zoom;   /* option to include zoom in window title */
366
367         gint completed;
368         ImageState state;       /* mask of IMAGE_STATE_* flags about current image */
369
370         void (*func_update)(ImageWindow *imd, gpointer data);
371         void (*func_complete)(ImageWindow *imd, gint preload, gpointer data);
372         void (*func_state)(ImageWindow *imd, ImageState state, gpointer data);
373         ImageTileRequestFunc func_tile_request;
374         ImageTileDisposeFunc func_tile_dispose;
375
376         gpointer data_update;
377         gpointer data_complete;
378         gpointer data_state;
379         gpointer data_tile;
380
381         /* button, scroll functions */
382         void (*func_button)(ImageWindow *, GdkEventButton *event, gpointer);
383         void (*func_drag)(ImageWindow *, GdkEventButton *event, gdouble dx, gdouble dy, gpointer);
384         void (*func_scroll)(ImageWindow *, GdkEventScroll *event, gpointer);
385
386         gpointer data_button;
387         gpointer data_drag;
388         gpointer data_scroll;
389
390         /* scroll notification (for scroll bar implementation) */
391         void (*func_scroll_notify)(ImageWindow *, gint x, gint y, gint width, gint height, gpointer);
392
393         gpointer data_scroll_notify;
394
395         /* collection info */
396         CollectionData *collection;
397         CollectInfo *collection_info;
398
399         /* color profiles */
400         gint color_profile_enable;
401         gint color_profile_input;
402         gint color_profile_screen;
403         gint color_profile_use_image;
404         gint color_profile_from_image;
405         gpointer cm;
406
407         AlterType delay_alter_type;
408
409         FileData *read_ahead_fd;
410         ImageLoader *read_ahead_il;
411
412         gint prev_color_row;
413
414         gint auto_refresh;
415
416         gint delay_flip;
417         gint orientation;
418         gint desaturate;
419
420         gint overlay_show_zoom; /* set to true if overlay is showing zoom ratio */
421 };
422
423 #define FILEDATA_MARKS_SIZE 6
424
425 struct _FileDataChangeInfo {
426         FileDataChangeType type;
427         gchar *source;
428         gchar *dest;
429         gint error;
430 };
431
432 struct _FileData {
433         gint magick;
434         gint type;
435         gchar *original_path; /* key to file_data_pool hash table */
436         gchar *path;
437         const gchar *name;
438         const gchar *extension;
439         gchar *collate_key_name;
440         gchar *collate_key_name_nocase;
441         gint64 size;
442         time_t date;
443         mode_t mode; /* this is needed at least for notification in view_dir because it is preserved after the file/directory is deleted */
444         
445         guint marks; /* each bit represents one mark */
446         guint valid_marks; /* zero bit means that the corresponding mark needs to be reread */
447
448
449         GList *sidecar_files;
450         FileData *parent; /* parent file if this is a sidecar file, NULL otherwise */
451         FileDataChangeInfo *change; /* for rename, move ... */
452         GdkPixbuf *thumb_pixbuf;
453
454         GdkPixbuf *pixbuf; /* full-size image, only complete images, NULL during loading
455                               all FileData with non-NULL pixbuf are referenced by image_cache */
456                               
457         HistMap *histmap;
458
459         gint ref;
460         gint version; /* increased when any field in this structure is changed */
461         gint disable_grouping;
462
463         gint user_orientation;
464         gint exif_orientation;
465         
466         ExifData *exif;
467         GHashTable *modified_xmp; // hash table which contains unwritten xmp metadata in format: key->list of string values
468 };
469
470 struct _LayoutOptions
471 {
472         gchar *order;
473         gint style;
474
475         DirViewType dir_view_type;
476         FileViewType file_view_type;
477
478         gboolean show_thumbnails;
479         gboolean show_marks;
480         gboolean show_directory_date;
481
482         struct {
483                 gint w;
484                 gint h;
485                 gint x;
486                 gint y;
487                 gboolean maximized;
488                 gint hdivider_pos;
489                 gint vdivider_pos;
490         } main_window;
491
492         struct {
493                 gint w;
494                 gint h;
495                 gint x;
496                 gint y;
497                 gint vdivider_pos;
498         } float_window;
499
500         struct {
501                 gint w;
502                 gint h;
503         } properties_window;
504
505         gboolean save_window_positions;
506
507         gboolean tools_float;
508         gboolean tools_hidden;
509         gboolean tools_restore_state;
510
511         gboolean toolbar_hidden;
512         
513         gchar *home_path;
514
515         /* panels */
516         struct {
517                 struct {
518                         gboolean enabled;
519                         gint width;
520                 } info;
521
522                 struct {
523                         gboolean enabled;
524                         gint width;
525                 } exif;
526
527                 struct {
528                         gboolean enabled;
529                         gint mode_state;
530                         gint action_state;
531                         gint selection_state;
532                         gchar *action_filter;
533                 } sort;
534         } panels;
535
536 };
537
538 struct _LayoutWindow
539 {
540         LayoutOptions options;
541
542         FileData *dir_fd;
543
544         /* base */
545
546         GtkWidget *window;
547
548         GtkWidget *main_box;
549
550         GtkWidget *group_box;
551         GtkWidget *h_pane;
552         GtkWidget *v_pane;
553
554         /* menus, path selector */
555
556         GtkActionGroup *action_group;
557         GtkActionGroup *action_group_external;
558         GtkUIManager *ui_manager;
559
560         GtkWidget *path_entry;
561
562         /* image */
563
564         LayoutLocation image_location;
565
566         ImageWindow *image;
567
568         ImageWindow *split_images[MAX_SPLIT_IMAGES];
569         ImageSplitMode split_mode;
570         gint active_split_image;
571
572         GtkWidget *split_image_widget;
573         GtkSizeGroup *split_image_sizegroup;
574
575         /* tools window (float) */
576
577         GtkWidget *tools;
578         GtkWidget *tools_pane;
579
580 //      gint tools_float;
581 //      gint tools_hidden;
582
583         /* toolbar */
584
585         GtkWidget *toolbar;
586 //      gint toolbar_hidden;
587
588         GtkWidget *thumb_button;
589 //      gint thumbs_enabled;
590 //      gint marks_enabled;
591
592         GtkWidget *back_button;
593
594         /* dir view */
595
596         LayoutLocation dir_location;
597
598         ViewDir *vd;
599         GtkWidget *dir_view;
600
601 //      DirViewType dir_view_type;
602
603         /* file view */
604
605         LayoutLocation file_location;
606
607         ViewFile *vf;
608         FileViewType file_view_type;
609
610         GtkWidget *file_view;
611
612         SortType sort_method;
613         gint sort_ascend;
614
615         /* status bar */
616
617         GtkWidget *info_box;
618         GtkWidget *info_progress_bar;
619         GtkWidget *info_sort;
620         GtkWidget *info_color;
621         GtkWidget *info_status;
622         GtkWidget *info_details;
623         GtkWidget *info_zoom;
624         GtkWidget *info_write;
625
626         /* slide show */
627
628         SlideShowData *slideshow;
629
630         /* full screen */
631
632         FullScreenData *full_screen;
633
634         /* dividers */
635
636 //      gint div_h;
637 //      gint div_v;
638 //      gint div_float;
639
640         /* misc */
641
642         GtkWidget *utility_box;
643         GtkWidget *bar_sort;
644         GtkWidget *bar;
645
646 //      gint bar_sort_enabled;
647 //      gint bar_enabled;
648
649 //      gint bar_width;
650
651         GtkWidget *exif_window;
652 };
653
654 struct _ViewDir
655 {
656         DirViewType type;
657         gpointer info;
658
659         GtkWidget *widget;
660         GtkWidget *view;
661
662         FileData *dir_fd;
663
664         FileData *click_fd;
665
666         FileData *drop_fd;
667         GList *drop_list;
668         gint drop_scroll_id;
669
670         /* func list */
671         void (*select_func)(ViewDir *vd, const gchar *path, gpointer data);
672         gpointer select_data;
673
674         void (*dnd_drop_update_func)(ViewDir *vd);
675         void (*dnd_drop_leave_func)(ViewDir *vd);
676
677         LayoutWindow *layout;
678
679         GtkWidget *popup;
680
681         PixmapFolders *pf;
682 };
683
684 struct _ViewDirInfoList
685 {
686         GList *list;
687 };
688
689 struct _ViewDirInfoTree
690 {
691         gint drop_expand_id;
692         gint busy_ref;
693 };
694
695
696 struct _ViewFile
697 {
698         FileViewType type;
699         gpointer info;
700
701         GtkWidget *widget;
702         GtkWidget *listview;
703         GtkWidget *scrolled;
704         GtkWidget *filter;
705         GtkWidget *filter_check[FILEDATA_MARKS_SIZE];
706
707         FileData *dir_fd;
708         GList *list;
709
710         SortType sort_method;
711         gint sort_ascend;
712
713         /* func list */
714         void (*func_thumb_status)(ViewFile *vf, gdouble val, const gchar *text, gpointer data);
715         gpointer data_thumb_status;
716
717         void (*func_status)(ViewFile *vf, gpointer data);
718         gpointer data_status;
719
720         LayoutWindow *layout;
721
722         GtkWidget *popup;
723
724         /* thumbs updates*/
725         gint thumbs_running;
726         ThumbLoader *thumbs_loader;
727         FileData *thumbs_filedata;
728
729         /* marks */
730         gint marks_enabled;
731         gint active_mark;
732         gint clicked_mark;
733         
734         /* refresh */
735         gint refresh_idle_id;
736 };
737
738 struct _ViewFileInfoList
739 {
740         FileData *click_fd;
741         FileData *select_fd;
742
743         gint thumbs_enabled;
744
745         gint select_idle_id;
746 };
747
748 struct _IconData;
749
750 struct _ViewFileInfoIcon
751 {
752         /* table stuff */
753         gint columns;
754         gint rows;
755
756         GList *selection;
757         struct _IconData *prev_selection;
758
759         GtkWidget *tip_window;
760         gint tip_delay_id;
761         struct _IconData *tip_id;
762
763         struct _IconData *click_id;
764
765         struct _IconData *focus_id;
766         gint focus_row;
767         gint focus_column;
768
769         gint show_text;
770 };
771
772 struct _SlideShowData
773 {
774         ImageWindow *imd;
775
776         GList *filelist;
777         CollectionData *cd;
778         FileData *dir_fd;
779         LayoutWindow *layout;
780
781         GList *list;
782         GList *list_done;
783
784         FileData *slide_fd;
785
786         guint slide_count;
787         gint timeout_id;
788
789         gint from_selection;
790
791         void (*stop_func)(SlideShowData *, gpointer);
792         gpointer stop_data;
793
794         gint paused;
795 };
796
797 struct _FullScreenData
798 {
799         GtkWidget *window;
800         ImageWindow *imd;
801
802         GtkWidget *normal_window;
803         ImageWindow *normal_imd;
804
805         gint hide_mouse_id;
806         gint busy_mouse_id;
807         gint cursor_state;
808
809         gint saver_block_id;
810
811         void (*stop_func)(FullScreenData *, gpointer);
812         gpointer stop_data;
813 };
814
815 struct _PixmapFolders
816 {
817         GdkPixbuf *close;
818         GdkPixbuf *open;
819         GdkPixbuf *deny;
820         GdkPixbuf *parent;
821 };
822
823 struct _SecureSaveInfo {
824         FILE *fp; /**< file stream pointer */
825         gchar *file_name; /**< final file name */
826         gchar *tmp_file_name; /**< temporary file name */
827         gint err; /**< set to non-zero value in case of error */
828         gint secure_save; /**< use secure save for this file, internal use only */
829         gint preserve_perms; /**< whether to preserve perms, TRUE by default */
830         gint preserve_mtime; /**< whether to preserve mtime, FALSE by default */
831         gint unlink_on_error; /**< whether to remove temporary file on save failure, TRUE by default */
832 };
833
834 #endif
835 /* vim: set shiftwidth=8 softtabstop=0 cindent cinoptions={1s: */