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