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 typedef enum {
 141         NOTIFY_TYPE_INTERNAL = 0, /* changed internal data only, like marks */
 142         NOTIFY_TYPE_REREAD,       /* changed file size, date, etc., file name remains unchanged */
 143         NOTIFY_TYPE_CHANGE        /* generic change described by fd->change */
 144 } NotifyType;
 145
 146
 147 #define MAX_SPLIT_IMAGES 4
 148
 149 typedef struct _ImageLoader ImageLoader;
 150 typedef struct _ThumbLoader ThumbLoader;
 151
 152 typedef struct _CollectInfo CollectInfo;
 153 typedef struct _CollectionData CollectionData;
 154 typedef struct _CollectTable CollectTable;
 155 typedef struct _CollectWindow CollectWindow;
 156
 157 typedef struct _ImageWindow ImageWindow;
 158
 159 typedef struct _FileData FileData;
 160 typedef struct _FileDataChangeInfo FileDataChangeInfo;
 161
 162 typedef struct _LayoutWindow LayoutWindow;
 163
 164 typedef struct _ViewDir ViewDir;
 165 typedef struct _ViewDirInfoList ViewDirInfoList;
 166 typedef struct _ViewDirInfoTree ViewDirInfoTree;
 167
 168 typedef struct _ViewFile ViewFile;
 169 typedef struct _ViewFileInfoList ViewFileInfoList;
 170 typedef struct _ViewFileInfoIcon ViewFileInfoIcon;
 171
 172 typedef struct _SlideShowData SlideShowData;
 173 typedef struct _FullScreenData FullScreenData;
 174
 175 typedef struct _PixmapFolders PixmapFolders;
 176 typedef struct _Histogram Histogram;
 177
 178 typedef struct _SecureSaveInfo SecureSaveInfo;
 179
 180 typedef struct _ExifData ExifData;
 181
 182 typedef struct _Editor Editor;
 183 struct _Editor {
 184         gchar *name;
 185         gchar *command;
 186 };
 187
 188 struct _ImageLoader
 189 {
 190         GdkPixbuf *pixbuf;
 191         FileData *fd;
 192         gchar *path;
 193
 194         gint bytes_read;
 195         gint bytes_total;
 196
 197         gint requested_width;
 198         gint requested_height;
 199         gint shrunk;
 200
 201         gint done;
 202         gint idle_id;
 203         gint idle_priority;
 204
 205         GdkPixbufLoader *loader;
 206         gint load_fd;
 207
 208         void (*func_area_ready)(ImageLoader *, guint x, guint y, guint w, guint h, gpointer);
 209         void (*func_error)(ImageLoader *, gpointer);
 210         void (*func_done)(ImageLoader *, gpointer);
 211         void (*func_percent)(ImageLoader *, gdouble, gpointer);
 212
 213         gpointer data_area_ready;
 214         gpointer data_error;
 215         gpointer data_done;
 216         gpointer data_percent;
 217
 218         gint idle_done_id;
 219
 220         guchar *read_buffer;
 221         gint read_buffer_size;
 222         gint idle_read_loop_count;
 223 };
 224
 225 typedef void (* ThumbLoaderFunc)(ThumbLoader *tl, gpointer data);
 226
 227 struct _ThumbLoader
 228 {
 229         gint standard_loader;
 230
 231         ImageLoader *il;
 232         FileData *fd;           /* fd->pixbuf contains final (scaled) image when done */
 233
 234         gint cache_enable;
 235         gint cache_hit;
 236         gdouble percent_done;
 237
 238         gint max_w;
 239         gint max_h;
 240
 241         ThumbLoaderFunc func_done;
 242         ThumbLoaderFunc func_error;
 243         ThumbLoaderFunc func_progress;
 244
 245         gpointer data;
 246
 247         gint idle_done_id;
 248 };
 249
 250 struct _CollectInfo
 251 {
 252         FileData *fd;
 253         GdkPixbuf *pixbuf;
 254         guint flag_mask;
 255 };
 256
 257 struct _CollectionData
 258 {
 259         gchar *path;
 260         gchar *name;
 261         GList *list;
 262         SortType sort_method;
 263
 264         ThumbLoader *thumb_loader;
 265         CollectInfo *thumb_info;
 266
 267         void (*info_updated_func)(CollectionData *, CollectInfo *, gpointer);
 268         gpointer info_updated_data;
 269
 270         gint ref;
 271
 272         /* geometry */
 273         gint window_read;
 274         gint window_x;
 275         gint window_y;
 276         gint window_w;
 277         gint window_h;
 278
 279         /* contents changed since save flag */
 280         gint changed;
 281
 282         GHashTable *existence;
 283 };
 284
 285 struct _CollectTable
 286 {
 287         GtkWidget *scrolled;
 288         GtkWidget *listview;
 289         gint columns;
 290         gint rows;
 291
 292         CollectionData *cd;
 293
 294         GList *selection;
 295         CollectInfo *prev_selection;
 296
 297         CollectInfo *click_info;
 298
 299         GtkWidget *tip_window;
 300         gint tip_delay_id;
 301         CollectInfo *tip_info;
 302
 303         GdkWindow *marker_window;
 304         CollectInfo *marker_info;
 305
 306         GtkWidget *status_label;
 307         GtkWidget *extra_label;
 308
 309         gint focus_row;
 310         gint focus_column;
 311         CollectInfo *focus_info;
 312
 313         GtkWidget *popup;
 314         CollectInfo *drop_info;
 315         GList *drop_list;
 316
 317         gint sync_idle_id;
 318         gint drop_idle_id;
 319
 320         gint show_text;
 321 };
 322
 323 struct _CollectWindow
 324 {
 325         GtkWidget *window;
 326         CollectTable *table;
 327         GtkWidget *status_box;
 328         GList *list;
 329
 330         GtkWidget *close_dialog;
 331
 332         CollectionData *cd;
 333 };
 334
 335 typedef gint (* ImageTileRequestFunc)(ImageWindow *imd, gint x, gint y,
 336                                       gint width, gint height, GdkPixbuf *pixbuf, gpointer);
 337 typedef void (* ImageTileDisposeFunc)(ImageWindow *imd, gint x, gint y,
 338                                       gint width, gint height, GdkPixbuf *pixbuf, gpointer);
 339
 340 struct _ImageWindow
 341 {
 342         GtkWidget *widget;      /* use this to add it and show it */
 343         GtkWidget *pr;
 344         GtkWidget *frame;
 345
 346         FileData *image_fd;
 347
 348         gint64 size;            /* file size (bytes) */
 349         time_t mtime;           /* file modified time stamp */
 350         gint unknown;           /* failed to load image */
 351
 352         ImageLoader *il;        /* FIXME - image loader should probably go to FileData, but it must first support
 353                                    sending callbacks to multiple ImageWindows in parallel */
 354
 355         gint has_frame;
 356
 357         /* top level (not necessarily parent) window */
 358         gint top_window_sync;   /* resize top_window when image dimensions change */
 359         GtkWidget *top_window;  /* window that gets title, and window to resize when 'fitting' */
 360         gchar *title;           /* window title to display left of file name */
 361         gchar *title_right;     /* window title to display right of file name */
 362         gint title_show_zoom;   /* option to include zoom in window title */
 363
 364         gint completed;
 365         ImageState state;       /* mask of IMAGE_STATE_* flags about current image */
 366
 367         void (*func_update)(ImageWindow *imd, gpointer data);
 368         void (*func_complete)(ImageWindow *imd, gint preload, gpointer data);
 369         void (*func_state)(ImageWindow *imd, ImageState state, gpointer data);
 370         ImageTileRequestFunc func_tile_request;
 371         ImageTileDisposeFunc func_tile_dispose;
 372
 373         gpointer data_update;
 374         gpointer data_complete;
 375         gpointer data_state;
 376         gpointer data_tile;
 377
 378         /* button, scroll functions */
 379         void (*func_button)(ImageWindow *, gint button,
 380                             guint32 time, gdouble x, gdouble y, guint state, gpointer);
 381         void (*func_drag)(ImageWindow *, gint button,
 382                             guint32 time, gdouble x, gdouble y, guint state, gdouble dx, gdouble dy,gpointer);
 383         void (*func_scroll)(ImageWindow *, GdkScrollDirection direction,
 384                             guint32 time, gdouble x, gdouble y, guint state, 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_id;
 415         gint auto_refresh_interval;
 416
 417         gint delay_flip;
 418         gint orientation;
 419         gint desaturate;
 420
 421         gint overlay_show_zoom; /* set to true if overlay is showing zoom ratio */
 422 };
 423
 424 #define FILEDATA_MARKS_SIZE 6
 425
 426 struct _FileDataChangeInfo {
 427         FileDataChangeType type;
 428         gchar *source;
 429         gchar *dest;
 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         guint marks;
 444         GList *sidecar_files;
 445         FileData *parent; /* parent file if this is a sidecar file, NULL otherwise */
 446         FileDataChangeInfo *change; /* for rename, move ... */
 447         GdkPixbuf *thumb_pixbuf;
 448
 449         GdkPixbuf *pixbuf; /* full-size image, only complete images, NULL during loading
 450                               all FileData with non-NULL pixbuf are referenced by image_cache */
 451
 452         gint ref;
 453         gint version; /* increased when any field in this structure is changed */
 454         gint disable_grouping;
 455
 456         gint user_orientation;
 457         gint exif_orientation;
 458
 459         ExifData *exif;
 460 };
 461
 462 struct _LayoutWindow
 463 {
 464         FileData *dir_fd;
 465
 466         /* base */
 467
 468         GtkWidget *window;
 469
 470         GtkWidget *main_box;
 471
 472         GtkWidget *group_box;
 473         GtkWidget *h_pane;
 474         GtkWidget *v_pane;
 475
 476         /* menus, path selector */
 477
 478         GtkActionGroup *action_group;
 479         GtkUIManager *ui_manager;
 480
 481         GtkWidget *path_entry;
 482
 483         /* image */
 484
 485         LayoutLocation image_location;
 486
 487         ImageWindow *image;
 488
 489         ImageWindow *split_images[MAX_SPLIT_IMAGES];
 490         ImageSplitMode split_mode;
 491         gint active_split_image;
 492
 493         GtkWidget *split_image_widget;
 494         GtkSizeGroup *split_image_sizegroup;
 495
 496         gint connect_zoom, connect_scroll;
 497
 498         /* tools window (float) */
 499
 500         GtkWidget *tools;
 501         GtkWidget *tools_pane;
 502
 503         gint tools_float;
 504         gint tools_hidden;
 505
 506         /* toolbar */
 507
 508         GtkWidget *toolbar;
 509         gint toolbar_hidden;
 510
 511         GtkWidget *thumb_button;
 512         gint thumbs_enabled;
 513         gint marks_enabled;
 514
 515         /* dir view */
 516
 517         LayoutLocation dir_location;
 518
 519         ViewDir *vd;
 520         GtkWidget *dir_view;
 521
 522         DirViewType dir_view_type;
 523
 524         /* file view */
 525
 526         LayoutLocation file_location;
 527
 528         ViewFile *vf;
 529         FileViewType file_view_type;
 530
 531         GtkWidget *file_view;
 532
 533         SortType sort_method;
 534         gint sort_ascend;
 535
 536         /* status bar */
 537
 538         GtkWidget *info_box;
 539         GtkWidget *info_progress_bar;
 540         GtkWidget *info_sort;
 541         GtkWidget *info_color;
 542         GtkWidget *info_status;
 543         GtkWidget *info_details;
 544         GtkWidget *info_zoom;
 545
 546         /* slide show */
 547
 548         SlideShowData *slideshow;
 549
 550         /* full screen */
 551
 552         FullScreenData *full_screen;
 553
 554         /* dividers */
 555
 556         gint div_h;
 557         gint div_v;
 558         gint div_float;
 559
 560         /* misc */
 561
 562         GtkWidget *utility_box;
 563         GtkWidget *bar_sort;
 564         GtkWidget *bar_exif;
 565         GtkWidget *bar_info;
 566
 567         gint bar_sort_enabled;
 568         gint bar_exif_enabled;
 569         gint bar_info_enabled;
 570
 571         gint bar_exif_width;
 572         gint bar_exif_advanced;
 573         gint bar_info_width;
 574 };
 575
 576 struct _ViewDir
 577 {
 578         DirViewType type;
 579         gpointer info;
 580
 581         GtkWidget *widget;
 582         GtkWidget *view;
 583
 584         FileData *dir_fd;
 585
 586         FileData *click_fd;
 587
 588         FileData *drop_fd;
 589         GList *drop_list;
 590         gint drop_scroll_id;
 591
 592         /* func list */
 593         void (*select_func)(ViewDir *vd, const gchar *path, gpointer data);
 594         gpointer select_data;
 595
 596         void (*dnd_drop_update_func)(ViewDir *vd);
 597         void (*dnd_drop_leave_func)(ViewDir *vd);
 598
 599         LayoutWindow *layout;
 600
 601         GtkWidget *popup;
 602
 603         PixmapFolders *pf;
 604 };
 605
 606 struct _ViewDirInfoList
 607 {
 608         GList *list;
 609 };
 610
 611 struct _ViewDirInfoTree
 612 {
 613         gint drop_expand_id;
 614         gint busy_ref;
 615 };
 616
 617
 618 struct _ViewFile
 619 {
 620         FileViewType type;
 621         gpointer info;
 622
 623         GtkWidget *widget;
 624         GtkWidget *listview;
 625
 626         FileData *dir_fd;
 627         GList *list;
 628
 629         SortType sort_method;
 630         gint sort_ascend;
 631
 632         /* func list */
 633         void (*func_thumb_status)(ViewFile *vf, gdouble val, const gchar *text, gpointer data);
 634         gpointer data_thumb_status;
 635
 636         void (*func_status)(ViewFile *vf, gpointer data);
 637         gpointer data_status;
 638
 639         LayoutWindow *layout;
 640
 641         GtkWidget *popup;
 642
 643         /* thumbs updates*/
 644         gint thumbs_running;
 645         ThumbLoader *thumbs_loader;
 646         FileData *thumbs_filedata;
 647
 648         /* marks */
 649         gint marks_enabled;
 650         gint active_mark;
 651         gint clicked_mark;
 652
 653         /* refresh */
 654         gint refresh_idle_id;
 655 };
 656
 657 struct _ViewFileInfoList
 658 {
 659         FileData *click_fd;
 660         FileData *select_fd;
 661
 662         gint thumbs_enabled;
 663
 664         gint select_idle_id;
 665 };
 666
 667 struct _IconData;
 668
 669 struct _ViewFileInfoIcon
 670 {
 671         /* table stuff */
 672         gint columns;
 673         gint rows;
 674
 675         GList *selection;
 676         struct _IconData *prev_selection;
 677
 678         GtkWidget *tip_window;
 679         gint tip_delay_id;
 680         struct _IconData *tip_id;
 681
 682         struct _IconData *click_id;
 683
 684         struct _IconData *focus_id;
 685         gint focus_row;
 686         gint focus_column;
 687
 688         gint show_text;
 689 };
 690
 691 struct _SlideShowData
 692 {
 693         ImageWindow *imd;
 694
 695         GList *filelist;
 696         CollectionData *cd;
 697         FileData *dir_fd;
 698         LayoutWindow *layout;
 699
 700         GList *list;
 701         GList *list_done;
 702
 703         FileData *slide_fd;
 704
 705         guint slide_count;
 706         gint timeout_id;
 707
 708         gint from_selection;
 709
 710         void (*stop_func)(SlideShowData *, gpointer);
 711         gpointer stop_data;
 712
 713         gint paused;
 714 };
 715
 716 struct _FullScreenData
 717 {
 718         GtkWidget *window;
 719         ImageWindow *imd;
 720
 721         GtkWidget *normal_window;
 722         ImageWindow *normal_imd;
 723
 724         gint hide_mouse_id;
 725         gint busy_mouse_id;
 726         gint cursor_state;
 727
 728         gint saver_block_id;
 729
 730         void (*stop_func)(FullScreenData *, gpointer);
 731         gpointer stop_data;
 732 };
 733
 734 struct _PixmapFolders
 735 {
 736         GdkPixbuf *close;
 737         GdkPixbuf *open;
 738         GdkPixbuf *deny;
 739         GdkPixbuf *parent;
 740 };
 741
 742 struct _SecureSaveInfo {
 743         FILE *fp; /**< file stream pointer */
 744         gchar *file_name; /**< final file name */
 745         gchar *tmp_file_name; /**< temporary file name */
 746         gint err; /**< set to non-zero value in case of error */
 747         gint secure_save; /**< use secure save for this file, internal use only */
 748         gint preserve_perms; /**< whether to preserve perms, TRUE by default */
 749         gint preserve_mtime; /**< whether to preserve mtime, FALSE by default */
 750         gint unlink_on_error; /**< whether to remove temporary file on save failure, TRUE by default */
 751 };
 752
 753
 754 #endif