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