0.8.11claws12
[claws.git] / src / folder.h
index 66c9980f2cc4acb864c971b902ed38150dcbde35..7ea413cef84ace7e5711f066a66a344a152d23bc 100644 (file)
@@ -24,6 +24,7 @@
 #include <time.h>
 
 typedef struct _Folder                 Folder;
+typedef struct _FolderClass            FolderClass;
 typedef struct _LocalFolder            LocalFolder;
 typedef struct _RemoteFolder           RemoteFolder;
 #if 0
@@ -40,8 +41,9 @@ typedef struct _FolderItemUpdateData  FolderItemUpdateData;
 #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)
 
@@ -88,7 +90,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 +104,12 @@ 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
 {
@@ -126,7 +128,7 @@ typedef void (*FolderItemFunc)              (FolderItem     *item,
 
 struct _Folder
 {
-       FolderType type;
+       FolderClass *class;
 
        gchar *name;
        PrefsAccount *account;
@@ -145,77 +147,88 @@ 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)                 (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
@@ -304,7 +317,9 @@ struct _FolderItemUpdateData
        FolderItemUpdateFlags    update_flags;
 };
 
-Folder     *folder_new                 (FolderType      type,
+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,
@@ -350,11 +365,13 @@ void   folder_count_total_msgs    (guint          *new,
 
 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);
+gchar     *folder_item_get_name                (FolderItem     *item);
 
 Folder     *folder_get_default_folder  (void);
 FolderItem *folder_get_default_inbox   (void);