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