(eval-when-compile (require 'cl))
(require 'luna)
+(require 'modb-entity)
(eval-and-compile
(luna-define-class modb-generic () (location ; location for save.
(luna-define-generic elmo-msgdb-length (msgdb)
"Return number of messages in the MSGDB")
+(luna-define-generic elmo-msgdb-flag-available-p (msgdb flag)
+ "Return non-nil when FLAG is available.")
+
(luna-define-generic elmo-msgdb-flags (msgdb number)
"Return a list of flag which corresponds to the message with NUMBER.")
MSGDB is the ELMO msgdb.
NUMBER is a message number to set flag.
FLAG is a symbol which is one of the following:
-`new' ... Message which is new.
-`read' ... Message which is already read.
-`important' ... Message which is marked as important.
-`answered' ... Message which is marked as answered.
-`cached' ... Message which is cached.")
+ `new' ... Message which is new.
+ `unread' ... Message which is not read.
+ `important' ... Message which is important.
+ `answered' ... Message which is answered.
+ `cached' ... Message which is cached.
+'sugar' flag:
+ `read' ... Message which is already read.
+ `uncached' ... Message which is not cached.")
(luna-define-generic elmo-msgdb-unset-flag (msgdb number flag)
"Unset message flag.
MSGDB is the ELMO msgdb.
NUMBER is a message number to set flag.
FLAG is a symbol which is one of the following:
-`new' ... Message which is new.
-`read' ... Message which is already read.
-`important' ... Message which is marked as important.
-`answered' ... Message which is marked as answered.
-`cached' ... Message which is cached.")
+ `new' ... Message which is new.
+ `unread' ... Message which is not read.
+ `important' ... Message which is important.
+ `answered' ... Message which is answered.
+ `cached' ... Message which is cached.
+'sugar' flag:
+ `read' ... Message which is already read.
+ `uncached' ... Message which is not cached.
+ `all' ... Remove all flags.")
+
+(luna-define-generic elmo-msgdb-flag-count (msgdb)
+ "Return a list of cons cell as (flag . count).
+The count is number of message which is set flag in the MSGDB.")
(luna-define-generic elmo-msgdb-list-messages (msgdb)
"Return a list of message numbers in the MSGDB.")
(luna-define-generic elmo-msgdb-list-flagged (msgdb flag)
"Return a list of message numbers which is set FLAG in the MSGDB.")
-;;; (luna-define-generic elmo-msgdb-search (msgdb condition &optional numbers)
-;;; "Search and return list of message numbers.
-;;; MSGDB is the ELMO msgdb structure.
-;;; CONDITION is a condition structure for searching.
-;;; If optional argument NUMBERS is specified and is a list of message numbers,
-;;; messages are searched from the list.")
+(luna-define-generic elmo-msgdb-search (msgdb condition &optional numbers)
+ "Search and return list of message numbers.
+MSGDB is the ELMO msgdb structure.
+CONDITION is a condition structure for searching.
+If optional argument NUMBERS is specified and is a list of message numbers,
+messages are searched from the list.
+Return t if the condition is unsupported.")
+
+(luna-define-generic elmo-msgdb-match-condition (msgdb condition number
+ &optional numbers)
+ "Check whether the condition of the message is satisfied or not.
+MSGDB is the msgdb to search from.
+CONDITION is the search condition.
+NUMBER is the message number to check.
+If optional argument NUMBERS is specified and is a list of message numbers,
+messages are searched from the list.
+Return CONDITION itself if no entity exists in msgdb.")
(luna-define-generic elmo-msgdb-append-entity (msgdb entity &optional flags)
"Append a ENTITY with FLAGS into the MSGDB.
Return non-nil if message-id of entity is duplicated.")
(luna-define-generic elmo-msgdb-delete-messages (msgdb numbers)
- "Delete messages which are contained NUMBERS from MSGDB.")
+ "Delete messages which are contained NUMBERS from MSGDB.
+Return non-nil if messages is deleted successfully.")
-(luna-define-generic elmo-msgdb-sort-entities (msgdb predicate &optional app-data)
+(luna-define-generic elmo-msgdb-sort-entities (msgdb predicate
+ &optional app-data)
"Sort entities of MSGDB, comparing with PREDICATE.
PREDICATE is called with two entities and APP-DATA.
Should return non-nil if the first entity is \"less\" than the second.")
+(luna-define-generic elmo-msgdb-message-number (msgdb message-id)
+ "Get message number from MSGDB which corresponds to MESSAGE-ID.")
+
+(luna-define-method elmo-msgdb-message-number ((msgdb modb-generic)
+ message-id)
+ (elmo-message-entity-number
+ (elmo-msgdb-message-entity msgdb message-id)))
+
(luna-define-generic elmo-msgdb-message-entity (msgdb key)
"Return the message-entity structure which matches to the KEY.
KEY is a number or a string.
A number is for message number in the MSGDB.
A string is for message-id of the message.")
+(luna-define-generic elmo-msgdb-message-field (msgdb number field)
+ "Get message field value in the MSGDB.
+NUMBER is a number of the message.
+FIELD is a symbol of the field.")
+
+(luna-define-method elmo-msgdb-message-field ((msgdb modb-generic)
+ number field)
+ (elmo-message-entity-field (elmo-msgdb-message-entity msgdb number)
+ field))
+
+(luna-define-generic elmo-msgdb-message-entity-handler (msgdb)
+ "Get modb entity handler instance which corresponds to the MSGDB.")
+
;;; generic implement
;;
(luna-define-method elmo-msgdb-load ((msgdb modb-generic))
(luna-define-method elmo-msgdb-length ((msgdb modb-generic))
0)
+(luna-define-method elmo-msgdb-search ((msgdb modb-generic)
+ condition &optional numbers)
+ t)
+
+(luna-define-method elmo-msgdb-match-condition ((msgdb modb-generic)
+ condition
+ number
+ &optional numbers)
+ (let ((entity (elmo-msgdb-message-entity msgdb number)))
+ (if entity
+ (elmo-msgdb-message-match-condition
+ (elmo-msgdb-message-entity-handler msgdb)
+ condition
+ entity
+ (elmo-msgdb-flags msgdb number)
+ (or numbers (elmo-msgdb-list-messages msgdb)))
+ condition)))
+
+(luna-define-method elmo-msgdb-message-entity-handler ((msgdb modb-generic))
+ (or modb-entity-default-cache-internal
+ (setq modb-entity-default-cache-internal
+ (luna-make-entity modb-entity-default-handler))))
+
;; for on demand loading
(provide 'modb-generic)
projects / elisp / wanderlust.git / blobdiff