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