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