0.8.11claws7
[claws.git] / src / folder.h
index d0862c2cc78a9ae6d28d96968716e6d89d89e146..572e7f68b1087ee20f36e8badc77f468f432b28c 100644 (file)
 #include <glib.h>
 #include <time.h>
 
-typedef struct _Folder         Folder;
-typedef struct _LocalFolder    LocalFolder;
-typedef struct _RemoteFolder   RemoteFolder;
+typedef struct _Folder                 Folder;
+typedef struct _FolderClass            FolderClass;
+typedef struct _LocalFolder            LocalFolder;
+typedef struct _RemoteFolder           RemoteFolder;
 #if 0
-typedef struct _MaildirFolder  MaildirFolder;
+typedef struct _MaildirFolder          MaildirFolder;
 #endif
-typedef struct _FolderItem     FolderItem;
+typedef struct _FolderItem             FolderItem;
+typedef struct _FolderItemUpdateData   FolderItemUpdateData;
 
 #include "prefs_folder_item.h"
 
@@ -39,8 +41,9 @@ typedef struct _FolderItem    FolderItem;
 #include "msgcache.h"
 
 #define FOLDER(obj)            ((Folder *)obj)
-#define FOLDER_TYPE(obj)       (FOLDER(obj)->type)
+#define FOLDER_TYPE(obj)       (FOLDER(obj)->class->type)
 
+#define FOLDER_CLASS(obj)      (FOLDER(obj)->class)
 #define LOCAL_FOLDER(obj)      ((LocalFolder *)obj)
 #define REMOTE_FOLDER(obj)     ((RemoteFolder *)obj)
 
@@ -54,6 +57,8 @@ typedef struct _FolderItem    FolderItem;
 
 #define FOLDER_ITEM(obj)       ((FolderItem *)obj)
 
+#define FOLDER_ITEM_UPDATE_HOOKLIST "folder_item_update"
+
 typedef enum
 {
        F_MH,
@@ -85,8 +90,9 @@ typedef enum
        SORT_BY_SCORE,
        SORT_BY_LABEL,
        SORT_BY_MARK,
-       SORT_BY_UNREAD,
+       SORT_BY_STATUS,
        SORT_BY_MIME,
+       SORT_BY_TO,
        SORT_BY_LOCKED
 } FolderSortKey;
 
@@ -96,6 +102,21 @@ typedef enum
        SORT_DESCENDING
 } FolderSortType;
 
+typedef enum
+{
+       F_MOVE_OK,
+       F_MOVE_FAILED_DEST_IS_PARENT,
+       F_MOVE_FAILED_DEST_IS_CHILD,
+       F_MOVE_FAILED_DEST_OUTSIDE_MAILBOX,
+       F_MOVE_FAILED
+} FolderMoveStatus;
+
+typedef enum
+{
+       F_ITEM_UPDATE_MSGCNT = 1 << 0,
+       F_ITEM_UPDATE_CONTENT = 1 << 1,
+} FolderItemUpdateFlags;
+
 typedef void (*FolderUIFunc)           (Folder         *folder,
                                         FolderItem     *item,
                                         gpointer        data);
@@ -107,7 +128,7 @@ typedef void (*FolderItemFunc)              (FolderItem     *item,
 
 struct _Folder
 {
-       FolderType type;
+       FolderClass *class;
 
        gchar *name;
        PrefsAccount *account;
@@ -126,70 +147,87 @@ struct _Folder
        gpointer data;
 
        GHashTable *newsart;
+};
+
+struct _FolderClass
+{
+       FolderType  type;
+       gchar      *idstr;
 
        /* virtual functions */
-/*
-       GSList * (*get_msg_list)        (Folder         *folder,
-                                        FolderItem     *item,
-                                        gboolean        use_cache);
-*/
-       gchar *  (*fetch_msg)           (Folder         *folder,
-                                        FolderItem     *item,
-                                        gint            num);
-       MsgInfo *(*fetch_msginfo)       (Folder         *folder,
-                                        FolderItem     *item,
-                                        gint            num);
-       GSList  *(*fetch_msginfos)      (Folder         *folder,
-                                        FolderItem     *item,
-                                        GSList         *msgnum_list);
-       gint     (*add_msg)             (Folder         *folder,
-                                        FolderItem     *dest,
-                                        const gchar    *file,
-                                        gboolean        remove_source);
-       gint     (*move_msg)            (Folder         *folder,
-                                        FolderItem     *dest,
-                                        MsgInfo        *msginfo);
-       gint     (*move_msgs_with_dest) (Folder         *folder,
-                                        FolderItem     *dest,
-                                        GSList         *msglist);
-       gint     (*copy_msg)            (Folder         *folder,
-                                        FolderItem     *dest,
-                                        MsgInfo        *msginfo);
-       gint     (*copy_msgs_with_dest) (Folder         *folder,
-                                        FolderItem     *dest,
-                                        GSList         *msglist);
-       gint     (*remove_msg)          (Folder         *folder,
-                                        FolderItem     *item,
-                                        gint            num);
-       gint     (*remove_all_msg)      (Folder         *folder,
-                                        FolderItem     *item);
-       gboolean (*is_msg_changed)      (Folder         *folder,
-                                        FolderItem     *item,
-                                        MsgInfo        *msginfo);
-       gint     (*scan)                (Folder         *folder);
-       GSList  * (*get_num_list)       (Folder         *folder,
-                                        FolderItem     *item);
-       void     (*scan_tree)           (Folder         *folder);
-
-       gint     (*create_tree)         (Folder         *folder);
-       FolderItem * (*create_folder)   (Folder         *folder,
-                                        FolderItem     *parent,
-                                        const gchar    *name);
-       gint     (*rename_folder)       (Folder         *folder,
-                                        FolderItem     *item,
-                                        const gchar    *name);
-       gint     (*remove_folder)       (Folder         *folder,
-                                        FolderItem     *item);
-
-       void     (*destroy)             (Folder         *folder);
-       void     (*update_mark)         (Folder         *folder,
-                                        FolderItem     *item);
-       void     (*change_flags)        (Folder         *folder,
-                                        FolderItem     *item,
-                                        MsgInfo        *info);
-       void     (*finished_copy)       (Folder * folder, FolderItem * item);
-       void     (*finished_remove)     (Folder * folder, FolderItem * item);
-       gboolean (*check_msgnum_validity) (Folder * folder, FolderItem * item);
+
+       /* Folder funtions */
+       Folder          *(*new)                 (const gchar    *name,
+                                                const gchar    *path);
+       void            (*destroy)              (Folder         *folder);
+       void            (*scan_tree)            (Folder         *folder);
+
+       gint            (*create_tree)          (Folder         *folder);
+
+       /* FolderItem functions */
+       FolderItem      *(*item_new)            (Folder         *folder);
+       void            (*item_destroy)         (Folder         *folder,
+                                                FolderItem     *item);
+       FolderItem      *(*create_folder)       (Folder         *folder,
+                                                FolderItem     *parent,
+                                                const gchar    *name);
+       gint            (*rename_folder)        (Folder         *folder,
+                                                FolderItem     *item,
+                                                const gchar    *name);
+       gint            (*remove_folder)        (Folder         *folder,
+                                                FolderItem     *item);
+       gint            (*get_num_list)         (Folder         *folder,
+                                                FolderItem     *item,
+                                                GSList        **list);
+       void            (*update_mark)          (Folder         *folder,
+                                                FolderItem     *item);
+       void            (*finished_copy)        (Folder         *folder,
+                                                FolderItem     *item);
+       void            (*finished_remove)      (Folder         *folder,
+                                                FolderItem * item);
+       gboolean        (*check_msgnum_validity)(Folder         *folder,
+                                                FolderItem * item);
+
+       /* Message functions */
+       MsgInfo         *(*get_msginfo)         (Folder         *folder,
+                                                FolderItem     *item,
+                                                gint            num);
+       GSList          *(*get_msginfos)        (Folder         *folder,
+                                                FolderItem     *item,
+                                                GSList         *msgnum_list);
+       gchar           *(*fetch_msg)           (Folder         *folder,
+                                                FolderItem     *item,
+                                                gint            num);
+       gint            (*add_msg)              (Folder         *folder,
+                                                FolderItem     *dest,
+                                                const gchar    *file,
+                                               gboolean         remove_source);
+       gint            (*move_msg)             (Folder         *folder,
+                                                FolderItem     *dest,
+                                                MsgInfo        *msginfo);
+       gint            (*move_msgs_with_dest)  (Folder         *folder,
+                                                FolderItem     *dest,
+                                                GSList         *msglist);
+       gint            (*copy_msg)             (Folder         *folder,
+                                                FolderItem     *dest,
+                                                MsgInfo        *msginfo);
+       gint            (*copy_msgs_with_dest)  (Folder         *folder,
+                                                FolderItem     *dest,
+                                                GSList         *msglist);
+       gint            (*remove_msg)           (Folder         *folder,
+                                                FolderItem     *item,
+                                                gint            num);
+       gint            (*remove_msgs)          (Folder         *folder,
+                                                FolderItem     *item,
+                                                GSList         *msglist);
+       gint            (*remove_all_msg)       (Folder         *folder,
+                                                FolderItem     *item);
+       gboolean        (*is_msg_changed)       (Folder         *folder,
+                                                FolderItem     *item,
+                                                MsgInfo        *msginfo);
+       void            (*change_flags)         (Folder         *folder,
+                                                FolderItem     *item,
+                                                MsgInfo        *info);
 };
 
 struct _LocalFolder
@@ -225,6 +263,7 @@ struct _FolderItem
        gint new;
        gint unread;
        gint total;
+       gint unreadmarked;
 
        gint last_num;
 
@@ -234,13 +273,14 @@ struct _FolderItem
        guint no_sub         : 1; /* no child allowed?    */
        guint no_select      : 1; /* not selectable?      */
        guint collapsed      : 1; /* collapsed item       */
+       guint thread_collapsed      : 1; /* collapsed item       */
        guint threaded       : 1; /* threaded folder view */
        guint hide_read_msgs : 1; /* hide read messages   */
        guint ret_rcpt       : 1; /* return receipt       */
 
        gint op_count;
-       guint opened    : 1; /* opened by summary view */
-       guint need_update    : 1; /* folderview for this folder should be updated */
+       guint opened         : 1; /* opened by summary view */
+       FolderItemUpdateFlags update_flags; /* folderview for this folder should be updated */
 
        FolderSortKey sort_key;
        FolderSortType sort_type;
@@ -264,12 +304,21 @@ typedef struct {
        FolderSortKey   sort_key;
        FolderSortType  sort_type;
        guint           collapsed       : 1;
+       guint           thread_collapsed        : 1;
        guint           threaded        : 1;
        guint           hide_read_msgs  : 1; /* CLAWS */
        guint           ret_rcpt        : 1; /* CLAWS */
 } PersistPrefs;
 
-Folder     *folder_new                 (FolderType      type,
+struct _FolderItemUpdateData
+{
+       FolderItem              *item;
+       FolderItemUpdateFlags    update_flags;
+};
+
+void       folder_system_init          ();
+void       folder_register_class       (FolderClass    *class);
+Folder     *folder_new                 (FolderClass    *type,
                                         const gchar    *name,
                                         const gchar    *path);
 void        folder_local_folder_init   (Folder         *folder,
@@ -310,12 +359,14 @@ void   folder_func_to_all_folders (FolderItemFunc function,
                                         gpointer data);
 void   folder_count_total_msgs (guint          *new,
                                 guint          *unread,
+                                guint          *unreadmarked,
                                 guint          *total);
 
 Folder     *folder_find_from_path              (const gchar    *path);
 Folder     *folder_find_from_name              (const gchar    *name,
-                                                FolderType      type);
+                                                FolderClass    *class);
 FolderItem *folder_find_item_from_path         (const gchar    *path);
+FolderClass *folder_get_class_from_string      (const gchar    *str);
 gchar      *folder_get_identifier              (Folder         *folder);
 gchar      *folder_item_get_identifier         (FolderItem     *item);
 FolderItem *folder_find_item_from_identifier   (const gchar    *identifier);
@@ -328,15 +379,18 @@ FolderItem *folder_get_default_queue      (void);
 FolderItem *folder_get_default_trash   (void);
 FolderItem *folder_get_default_processing (void);
 void folder_set_missing_folders                (void);
+void folder_unref_account_all          (PrefsAccount   *account);
 
 gchar *folder_get_path                 (Folder         *folder);
 gchar *folder_item_get_path            (FolderItem     *item);
 
+gint   folder_item_open                        (FolderItem     *item);
+void   folder_item_close               (FolderItem     *item);
 gint   folder_item_scan                        (FolderItem     *item);
 void   folder_item_scan_foreach                (GHashTable     *table);
-MsgInfo *folder_item_fetch_msginfo     (FolderItem     *item,
+MsgInfo *folder_item_get_msginfo       (FolderItem     *item,
                                         gint            num);
-MsgInfo *folder_item_fetch_msginfo_by_id(FolderItem    *item,
+MsgInfo *folder_item_get_msginfo_by_msgid(FolderItem   *item,
                                         const gchar    *msgid);
 GSList *folder_item_get_msg_list       (FolderItem     *item);
 gchar *folder_item_fetch_msg           (FolderItem     *item,
@@ -344,6 +398,9 @@ gchar *folder_item_fetch_msg                (FolderItem     *item,
 gint   folder_item_add_msg             (FolderItem     *dest,
                                         const gchar    *file,
                                         gboolean        remove_source);
+gint   folder_item_move_to             (FolderItem     *src,
+                                        FolderItem     *dest,
+                                        FolderItem    **new_item);
 gint   folder_item_move_msg            (FolderItem     *dest,
                                         MsgInfo        *msginfo);
 gint   folder_item_move_msgs_with_dest (FolderItem     *dest,
@@ -362,7 +419,6 @@ gboolean folder_item_is_msg_changed (FolderItem     *item,
 gchar *folder_item_get_cache_file      (FolderItem     *item);
 gchar *folder_item_get_mark_file       (FolderItem     *item);
 gchar * folder_item_get_identifier(FolderItem * item);
-FolderItem * folder_find_item_from_identifier(const gchar *identifier);
 
 GHashTable *folder_persist_prefs_new   (Folder *folder);
 void folder_persist_prefs_free         (GHashTable *pptable);
@@ -376,4 +432,11 @@ void folder_item_set_default_flags (FolderItem *dest, MsgFlags *flags);
 
 void folder_item_apply_processing      (FolderItem *item);
 
+void folder_item_update                        (FolderItem *item,
+                                        FolderItemUpdateFlags update_flags);
+void folder_item_update_recursive      (FolderItem *item,
+                                        FolderItemUpdateFlags update_flags);
+void folder_item_update_freeze         ();
+void folder_item_update_thaw           ();
+
 #endif /* __FOLDER_H__ */