src/typedefs.h

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