0.9.0claws55
[claws.git] / src / folder.h
index 66c9980f2cc4acb864c971b902ed38150dcbde35..5b80bc8bea8cac0cfc4ec3d09aa6aa2785f137fd 100644 (file)
 #include <time.h>
 
 typedef struct _Folder                 Folder;
+typedef struct _FolderClass            FolderClass;
 typedef struct _LocalFolder            LocalFolder;
 typedef struct _RemoteFolder           RemoteFolder;
 #if 0
 typedef struct _MaildirFolder          MaildirFolder;
 #endif
 typedef struct _FolderItem             FolderItem;
-typedef struct _FolderItemUpdateData   FolderItemUpdateData;
-
-#include "prefs_folder_item.h"
 
-#include "prefs_account.h"
-#include "session.h"
-#include "procmsg.h"
-#include "msgcache.h"
+typedef struct _FolderUpdateData       FolderUpdateData;
+typedef struct _FolderItemUpdateData   FolderItemUpdateData;
 
 #define FOLDER(obj)            ((Folder *)obj)
-#define FOLDER_TYPE(obj)       (FOLDER(obj)->type)
+#define FOLDER_TYPE(obj)       (FOLDER(obj)->klass->type)
 
+#define FOLDER_CLASS(obj)      (FOLDER(obj)->klass)
 #define LOCAL_FOLDER(obj)      ((LocalFolder *)obj)
 #define REMOTE_FOLDER(obj)     ((RemoteFolder *)obj)
 
@@ -55,6 +52,7 @@ typedef struct _FolderItemUpdateData  FolderItemUpdateData;
 
 #define FOLDER_ITEM(obj)       ((FolderItem *)obj)
 
+#define FOLDER_UPDATE_HOOKLIST "folder_update"
 #define FOLDER_ITEM_UPDATE_HOOKLIST "folder_item_update"
 
 typedef enum
@@ -88,7 +86,7 @@ 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
@@ -102,12 +100,22 @@ typedef enum
 
 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;
+       F_MOVE_OK = 0,
+       F_MOVE_FAILED_DEST_IS_PARENT = -1,
+       F_MOVE_FAILED_DEST_IS_CHILD = -2,
+       F_MOVE_FAILED_DEST_OUTSIDE_MAILBOX = -3,
+       F_MOVE_FAILED = -4,
+} FolderItemMoveResult;
+
+typedef enum
+{
+       FOLDER_TREE_CHANGED = 1 << 0,
+/*
+       maybe enhance with:
+       FOLDER_NEW_FOLDERITEM
+       FOLDER_REMOVE_FOLDERITEM
+*/
+} FolderUpdateFlags;
 
 typedef enum
 {
@@ -124,9 +132,16 @@ typedef void (*FolderDestroyNotify)        (Folder         *folder,
 typedef void (*FolderItemFunc)         (FolderItem     *item,
                                         gpointer        data);
 
+#include "prefs_folder_item.h"
+
+#include "prefs_account.h"
+#include "session.h"
+#include "procmsg.h"
+#include "msgcache.h"
+
 struct _Folder
 {
-       FolderType type;
+       FolderClass *klass;
 
        gchar *name;
        PrefsAccount *account;
@@ -145,77 +160,77 @@ struct _Folder
        gpointer data;
 
        GHashTable *newsart;
+};
+
+struct _FolderClass
+{
+       FolderType  type;
+       gchar      *idstr;
+       gchar      *uistr;
 
        /* virtual functions */
-/*
-       GSList * (*get_msg_list)        (Folder         *folder,
-                                        FolderItem     *item,
-                                        gboolean        use_cache);
-*/
-       FolderItem *(*item_new)         (Folder         *folder);
-       void     (*item_destroy)        (Folder         *folder,
-                                        FolderItem     *item);
-       gchar *  (*fetch_msg)           (Folder         *folder,
-                                        FolderItem     *item,
-                                        gint            num);
-       MsgInfo * (*get_msginfo)        (Folder         *folder,
-                                        FolderItem     *item,
-                                        gint            num);
-       GSList  * (*get_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_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);
-       gint     (*scan)                (Folder         *folder);
-       gint     (*get_num_list)        (Folder         *folder,
-                                        FolderItem     *item,
-                                        GSList        **list);
-       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_folder)          (const gchar    *name,
+                                                const gchar    *path);
+       void            (*destroy_folder)       (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,
+                                                MsgNumberList  *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            (*copy_msg)             (Folder         *folder,
+                                                FolderItem     *dest,
+                                                MsgInfo        *msginfo);
+       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);
+       void            (*change_flags)         (Folder         *folder,
+                                                FolderItem     *item,
+                                                MsgInfo        *msginfo,
+                                                MsgPermFlags    newflags);
 };
 
 struct _LocalFolder
@@ -248,10 +263,10 @@ struct _FolderItem
 
        time_t mtime;
 
-       gint new;
-       gint unread;
-       gint total;
-       gint unreadmarked;
+       gint new_msgs;
+       gint unread_msgs;
+       gint total_msgs;
+       gint unreadmarked_msgs;
 
        gint last_num;
 
@@ -298,13 +313,24 @@ typedef struct {
        guint           ret_rcpt        : 1; /* CLAWS */
 } PersistPrefs;
 
+struct _FolderUpdateData
+{
+       Folder                  *folder;
+       FolderUpdateFlags        update_flags;
+/*
+       FolderItem              *item
+*/
+};
+
 struct _FolderItemUpdateData
 {
        FolderItem              *item;
        FolderItemUpdateFlags    update_flags;
 };
 
-Folder     *folder_new                 (FolderType      type,
+void       folder_system_init          (void);
+void       folder_register_class       (FolderClass    *klass);
+Folder     *folder_new                 (FolderClass    *type,
                                         const gchar    *name,
                                         const gchar    *path);
 void        folder_local_folder_init   (Folder         *folder,
@@ -343,18 +369,20 @@ FolderItem *folder_create_folder(FolderItem       *parent, const gchar *name);
 void   folder_update_op_count          (void);
 void   folder_func_to_all_folders      (FolderItemFunc function,
                                         gpointer data);
-void   folder_count_total_msgs (guint          *new,
-                                guint          *unread,
-                                guint          *unreadmarked,
-                                guint          *total);
+void   folder_count_total_msgs (guint          *new_msgs,
+                                guint          *unread_msgs,
+                                guint          *unreadmarked_msgs,
+                                guint          *total_msgs);
 
 Folder     *folder_find_from_path              (const gchar    *path);
 Folder     *folder_find_from_name              (const gchar    *name,
-                                                FolderType      type);
+                                                FolderClass    *klass);
 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);
+gchar     *folder_item_get_name                (FolderItem     *item);
 
 Folder     *folder_get_default_folder  (void);
 FolderItem *folder_get_default_inbox   (void);
@@ -399,6 +427,9 @@ gint   folder_item_remove_msg               (FolderItem     *item,
 gint   folder_item_remove_msgs         (FolderItem     *item,
                                         GSList         *msglist);
 gint   folder_item_remove_all_msg      (FolderItem     *item);
+void   folder_item_change_msg_flags    (FolderItem     *item,
+                                        MsgInfo        *msginfo,
+                                        MsgPermFlags    newflags);
 gboolean folder_item_is_msg_changed    (FolderItem     *item,
                                         MsgInfo        *msginfo);
 gchar *folder_item_get_cache_file      (FolderItem     *item);
@@ -411,7 +442,7 @@ const PersistPrefs *folder_get_persist_prefs
                                        (GHashTable *pptable, const char *name);
 
 void folder_item_restore_persist_prefs (FolderItem *item, GHashTable *pptable);
-void folder_clean_cache_memory         ();
+void folder_clean_cache_memory         (void);
 void folder_item_write_cache           (FolderItem *item);
 void folder_item_set_default_flags     (FolderItem *dest, MsgFlags *flags);
 
@@ -421,7 +452,7 @@ 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           ();
+void folder_item_update_freeze         (void);
+void folder_item_update_thaw           (void);
 
 #endif /* __FOLDER_H__ */