0.9.3claws34
[claws.git] / src / folder.h
index 572e7f68b1087ee20f36e8badc77f468f432b28c..fc8f2230d6d5de35c06f92c78c66b4225492f304 100644 (file)
@@ -31,19 +31,14 @@ typedef struct _RemoteFolder                RemoteFolder;
 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)->class->type)
+#define FOLDER_TYPE(obj)       (FOLDER(obj)->klass->type)
 
-#define FOLDER_CLASS(obj)      (FOLDER(obj)->class)
+#define FOLDER_CLASS(obj)      (FOLDER(obj)->klass)
 #define LOCAL_FOLDER(obj)      ((LocalFolder *)obj)
 #define REMOTE_FOLDER(obj)     ((RemoteFolder *)obj)
 
@@ -57,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
@@ -104,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
 {
@@ -126,9 +132,16 @@ typedef void (*FolderDestroyNotify)        (Folder         *folder,
 typedef void (*FolderItemFunc)         (FolderItem     *item,
                                         gpointer        data);
 
+#include "folder_item_prefs.h"
+
+#include "prefs_account.h"
+#include "session.h"
+#include "procmsg.h"
+#include "msgcache.h"
+
 struct _Folder
 {
-       FolderClass *class;
+       FolderClass *klass;
 
        gchar *name;
        PrefsAccount *account;
@@ -153,13 +166,14 @@ struct _FolderClass
 {
        FolderType  type;
        gchar      *idstr;
+       gchar      *uistr;
 
        /* virtual functions */
 
        /* Folder funtions */
-       Folder          *(*new)                 (const gchar    *name,
+       Folder          *(*new_folder)          (const gchar    *name,
                                                 const gchar    *path);
-       void            (*destroy)              (Folder         *folder);
+       void            (*destroy_folder)       (Folder         *folder);
        void            (*scan_tree)            (Folder         *folder);
 
        gint            (*create_tree)          (Folder         *folder);
@@ -168,6 +182,8 @@ struct _FolderClass
        FolderItem      *(*item_new)            (Folder         *folder);
        void            (*item_destroy)         (Folder         *folder,
                                                 FolderItem     *item);
+       gchar           *(*item_get_path)       (Folder         *folder,
+                                                FolderItem     *item);
        FolderItem      *(*create_folder)       (Folder         *folder,
                                                 FolderItem     *parent,
                                                 const gchar    *name);
@@ -194,7 +210,7 @@ struct _FolderClass
                                                 gint            num);
        GSList          *(*get_msginfos)        (Folder         *folder,
                                                 FolderItem     *item,
-                                                GSList         *msgnum_list);
+                                                MsgNumberList  *msgnum_list);
        gchar           *(*fetch_msg)           (Folder         *folder,
                                                 FolderItem     *item,
                                                 gint            num);
@@ -202,24 +218,12 @@ struct _FolderClass
                                                 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,
@@ -227,7 +231,8 @@ struct _FolderClass
                                                 MsgInfo        *msginfo);
        void            (*change_flags)         (Folder         *folder,
                                                 FolderItem     *item,
-                                                MsgInfo        *info);
+                                                MsgInfo        *msginfo,
+                                                MsgPermFlags    newflags);
 };
 
 struct _LocalFolder
@@ -260,10 +265,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;
 
@@ -297,7 +302,7 @@ struct _FolderItem
 
        gpointer data;
 
-       PrefsFolderItem * prefs;
+       FolderItemPrefs * prefs;
 };
 
 typedef struct {
@@ -310,14 +315,23 @@ typedef struct {
        guint           ret_rcpt        : 1; /* CLAWS */
 } PersistPrefs;
 
+struct _FolderUpdateData
+{
+       Folder                  *folder;
+       FolderUpdateFlags        update_flags;
+/*
+       FolderItem              *item
+*/
+};
+
 struct _FolderItemUpdateData
 {
        FolderItem              *item;
        FolderItemUpdateFlags    update_flags;
 };
 
-void       folder_system_init          ();
-void       folder_register_class       (FolderClass    *class);
+void       folder_system_init          (void);
+void       folder_register_class       (FolderClass    *klass);
 Folder     *folder_new                 (FolderClass    *type,
                                         const gchar    *name,
                                         const gchar    *path);
@@ -357,19 +371,22 @@ 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);
+gchar *folder_get_status       (GPtrArray      *folders,
+                                gboolean        full);
 
 Folder     *folder_find_from_path              (const gchar    *path);
 Folder     *folder_find_from_name              (const gchar    *name,
-                                                FolderClass    *class);
+                                                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);
@@ -381,7 +398,6 @@ 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);
@@ -414,6 +430,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);
@@ -426,7 +445,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);
 
@@ -436,7 +455,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__ */