* src/folder.[ch]
[claws.git] / src / folder.h
index 78cf114fb31c4f145db7a5d2b4e48921c660bae1..2620c893dbbed9964ec083abb32ccbe30bdc1cd5 100644 (file)
@@ -36,6 +36,7 @@ typedef struct _FolderItem    FolderItem;
 #include "prefs_account.h"
 #include "session.h"
 #include "procmsg.h"
+#include "msgcache.h"
 
 #define FOLDER(obj)            ((Folder *)obj)
 #define FOLDER_TYPE(obj)       (FOLDER(obj)->type)
@@ -73,12 +74,36 @@ typedef enum
        F_TRASH
 } SpecialFolderItemType;
 
+typedef enum
+{
+       SORT_BY_NONE,
+       SORT_BY_NUMBER,
+       SORT_BY_SIZE,
+       SORT_BY_DATE,
+       SORT_BY_FROM,
+       SORT_BY_SUBJECT,
+       SORT_BY_SCORE,
+       SORT_BY_LABEL,
+       SORT_BY_MARK,
+       SORT_BY_UNREAD,
+       SORT_BY_MIME,
+       SORT_BY_LOCKED
+} FolderSortKey;
+
+typedef enum
+{
+       SORT_ASCENDING,
+       SORT_DESCENDING
+} FolderSortType;
+
 typedef void (*FolderUIFunc)           (Folder         *folder,
                                         FolderItem     *item,
                                         gpointer        data);
 typedef void (*FolderDestroyNotify)    (Folder         *folder,
                                         FolderItem     *item,
                                         gpointer        data);
+typedef void (*FolderItemFunc)         (FolderItem     *item,
+                                        gpointer        data);
 
 struct _Folder
 {
@@ -103,12 +128,23 @@ struct _Folder
        GHashTable *newsart;
 
        /* 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 *(*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,
@@ -128,12 +164,16 @@ struct _Folder
        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     (*scan)                (Folder         *folder,
+       gint     (*scan)                (Folder         *folder);
+       GSList  * (*get_num_list)       (Folder         *folder,
                                         FolderItem     *item);
        void     (*scan_tree)           (Folder         *folder);
 
@@ -146,13 +186,16 @@ struct _Folder
                                         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);
+       void     (*finished_remove)     (Folder * folder, FolderItem * item);
+       gboolean (*check_msgnum_validity) (Folder * folder, FolderItem * item);
 };
 
 struct _LocalFolder
@@ -182,7 +225,6 @@ struct _FolderItem
 
        gchar *name;
        gchar *path;
-       PrefsAccount *account;
 
        time_t mtime;
 
@@ -192,6 +234,8 @@ struct _FolderItem
 
        gint last_num;
 
+       MsgCache *cache;
+
        /* special flags */
        guint no_sub         : 1; /* no child allowed?    */
        guint no_select      : 1; /* not selectable?      */
@@ -202,11 +246,19 @@ struct _FolderItem
 
        gint op_count;
        guint opened    : 1; /* opened by summary view */
+       guint need_update    : 1; /* folderview for this folder should be updated */
+
+       FolderSortKey sort_key;
+       FolderSortType sort_type;
 
        FolderItem *parent;
 
        Folder *folder;
 
+       PrefsAccount *account;
+
+       gboolean apply_sub;
+       
        GSList *mark_queue;
 
        gpointer data;
@@ -215,10 +267,12 @@ struct _FolderItem
 };
 
 typedef struct {
-       guint   collapsed       : 1;
-       guint   threaded        : 1;
-       guint   hide_read_msgs  : 1; /* CLAWS */
-       guint   ret_rcpt        : 1; /* CLAWS */
+       FolderSortKey   sort_key;
+       FolderSortType  sort_type;
+       guint           collapsed       : 1;
+       guint           threaded        : 1;
+       guint           hide_read_msgs  : 1; /* CLAWS */
+       guint           ret_rcpt        : 1; /* CLAWS */
 } PersistPrefs;
 
 Folder     *folder_new                 (FolderType      type,
@@ -235,7 +289,8 @@ void        folder_destroy          (Folder         *folder);
 void        folder_local_folder_destroy        (LocalFolder    *lfolder);
 void        folder_remote_folder_destroy(RemoteFolder  *rfolder);
 
-FolderItem *folder_item_new    (const gchar    *name,
+FolderItem *folder_item_new    (Folder         *folder,
+                                const gchar    *name,
                                 const gchar    *path);
 void        folder_item_append (FolderItem     *parent,
                                 FolderItem     *item);
@@ -254,7 +309,11 @@ void   folder_add          (Folder         *folder);
 GList *folder_get_list         (void);
 gint   folder_read_list                (void);
 void   folder_write_list       (void);
+void   folder_scan_tree                (Folder *folder);
+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          *total);
@@ -275,10 +334,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);
-void   folder_item_scan                        (FolderItem     *item);
+
+gint   folder_item_scan                        (FolderItem     *item);
 void   folder_item_scan_foreach                (GHashTable     *table);
+MsgInfo *folder_item_fetch_msginfo     (FolderItem     *item,
+                                        gint            num);
+MsgInfo *folder_item_fetch_msginfo_by_id(FolderItem    *item,
+                                        const gchar    *msgid);
+GSList *folder_item_get_msg_list       (FolderItem     *item);
 gchar *folder_item_fetch_msg           (FolderItem     *item,
                                         gint            num);
 gint   folder_item_add_msg             (FolderItem     *dest,
@@ -310,5 +377,10 @@ 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_item_write_cache           (FolderItem *item);
+void folder_item_set_default_flags     (FolderItem *dest, MsgFlags *flags);
+
+void folder_item_apply_processing      (FolderItem *item);
 
 #endif /* __FOLDER_H__ */