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