src/typedefs.h

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