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