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