]> code.delx.au - gnu-emacs/blobdiff - lisp/mail/rmailkwd.el
Add "Package:" file headers to denote built-in packages.
[gnu-emacs] / lisp / mail / rmailkwd.el
index 2f8f24dbc5519b51f85cd15a60eaa2d0644ed0f8..5c44b5cafa2847d645fc0b5f3ff0012b5bcb79dc 100644 (file)
@@ -1,10 +1,11 @@
 ;;; rmailkwd.el --- part of the "RMAIL" mail reader for Emacs
 
-;; Copyright (C) 1985, 1988, 1994, 2001, 2002, 2003, 2004,
-;;   2005, 2006, 2007, 2008 Free Software Foundation, Inc.
+;; Copyright (C) 1985, 1988, 1994, 2001, 2002, 2003, 2004, 2005, 2006,
+;;   2007, 2008, 2009, 2010  Free Software Foundation, Inc.
 
 ;; Maintainer: FSF
 ;; Keywords: mail
+;; Package: rmail
 
 ;; This file is part of GNU Emacs.
 
 
 ;;; Code:
 
-(defvar rmail-buffer)
-(defvar rmail-current-message)
-(defvar rmail-last-label)
-(defvar rmail-last-multi-labels)
-(defvar rmail-summary-vector)
-(defvar rmail-total-messages)
+(require 'rmail)
 
-;; Global to all RMAIL buffers.  It exists primarily for the sake of
-;; completion.  It is better to use strings with the label functions
-;; and let them worry about making the label.
+;; Global to all RMAIL buffers.  It exists for the sake of completion.
+;; It is better to use strings with the label functions and let them
+;; worry about making the label.
+(defvar rmail-label-obarray (make-vector 47 0)
+  "Obarray of labels used by Rmail.
+`rmail-read-label' uses this to offer completion.")
 
-(defvar rmail-label-obarray (make-vector 47 0))
+;; Initialize with the standard labels.
+(mapc (lambda (s) (intern (cadr s) rmail-label-obarray))
+      rmail-attr-array)
 
-;; Named list of symbols representing valid message attributes in RMAIL.
-
-(defconst rmail-attributes
-  (cons 'rmail-keywords
-       (mapcar (function (lambda (s) (intern s rmail-label-obarray)))
-               '("deleted" "answered" "filed" "forwarded" "unseen" "edited"
-                 "resent"))))
-
-(defconst rmail-deleted-label (intern "deleted" rmail-label-obarray))
-
-;; Named list of symbols representing valid message keywords in RMAIL.
-
-(defvar rmail-keywords)
+(defun rmail-make-label (s)
+  "Intern string S as a downcased symbol in `rmail-label-obarray'."
+  (intern (downcase s) rmail-label-obarray))
 \f
 ;;;###autoload
-(defun rmail-add-label (string)
+(defun rmail-add-label (label)
   "Add LABEL to labels associated with current RMAIL message.
-Completion is performed over known labels when reading."
+Completes (see `rmail-read-label') over known labels when reading.
+LABEL may be a symbol or string.  Only one label is allowed."
   (interactive (list (rmail-read-label "Add label")))
-  (rmail-set-label string t))
+  (rmail-set-label label t))
 
 ;;;###autoload
-(defun rmail-kill-label (string)
+(defun rmail-kill-label (label)
   "Remove LABEL from labels associated with current RMAIL message.
-Completion is performed over known labels when reading."
+Completes (see `rmail-read-label') over known labels when reading.
+LABEL may be a symbol or string.  Only one label is allowed."
   (interactive (list (rmail-read-label "Remove label")))
-  (rmail-set-label string nil))
+  (rmail-set-label label nil))
 
 ;;;###autoload
 (defun rmail-read-label (prompt)
-  (with-current-buffer rmail-buffer
-    (if (not rmail-keywords) (rmail-parse-file-keywords))
-    (let ((result
-          (completing-read (concat prompt
-                                   (if rmail-last-label
-                                       (concat " (default "
-                                               (symbol-name rmail-last-label)
-                                               "): ")
-                                     ": "))
-                           rmail-label-obarray
-                           nil
-                           nil)))
-      (if (string= result "")
-         rmail-last-label
-       (setq rmail-last-label (rmail-make-label result t))))))
-
-(declare-function rmail-maybe-set-message-counters "rmail" ())
-(declare-function rmail-display-labels "rmail" ())
-(declare-function rmail-msgbeg "rmail" (n))
-(declare-function rmail-set-message-deleted-p "rmail" (n state))
-(declare-function rmail-message-labels-p "rmail" (msg labels))
-(declare-function rmail-show-message "rmail" (&optional n no-summary))
-(declare-function mail-comma-list-regexp "mail-utils" (labels))
-(declare-function mail-parse-comma-list "mail-utils.el" ())
-
-(defun rmail-set-label (l state &optional n)
+  "Read a label with completion, prompting with PROMPT.
+Completions are chosen from `rmail-label-obarray'.  The default
+is `rmail-last-label', if that is non-nil.  Updates `rmail-last-label'
+according to the choice made, and returns a symbol."
+  (let* ((old nil)
+        (result
+         (progn
+           ;; If the summary exists, we've already read all the
+           ;; existing labels.  If not, read the ones in this message.
+           (or (eq major-mode 'rmail-summary-mode)
+               (rmail-summary-exists)
+               (and (setq old (rmail-get-keywords))
+                    (mapc 'rmail-make-label (split-string old ", "))))
+           (completing-read (concat prompt
+                                    (if rmail-last-label
+                                        (concat " (default "
+                                                (symbol-name rmail-last-label)
+                                                "): ")
+                                      ": "))
+                            rmail-label-obarray
+                            nil
+                            nil))))
+    (if (string= result "")
+       rmail-last-label
+      (setq rmail-last-label (rmail-make-label result)))))
+
+(declare-function rmail-summary-update-line "rmailsum" (n))
+
+(defun rmail-set-label (label state &optional msg)
+  "Set LABEL as present or absent according to STATE in message MSG.
+LABEL may be a symbol or string."
+  (or (stringp label) (setq label (symbol-name label)))
+  (if (string-match "," label)
+      (error "More than one label specified"))
   (with-current-buffer rmail-buffer
     (rmail-maybe-set-message-counters)
-    (if (not n) (setq n rmail-current-message))
-    (aset rmail-summary-vector (1- n) nil)
-    (let* ((attribute (rmail-attribute-p l))
-          (keyword (and (not attribute)
-                        (or (rmail-keyword-p l)
-                            (rmail-install-keyword l))))
-          (label (or attribute keyword)))
-      (if label
-         (let ((omax (- (buffer-size) (point-max)))
-               (omin (- (buffer-size) (point-min)))
-               (buffer-read-only nil)
-               (case-fold-search t))
-           (unwind-protect
-               (save-excursion
-                 (widen)
-                 (goto-char (rmail-msgbeg n))
-                 (forward-line 1)
-                 (if (not (looking-at "[01],"))
-                     nil
-                   (let ((start (1+ (point)))
-                         (bound))
-                     (narrow-to-region (point) (progn (end-of-line) (point)))
-                     (setq bound (point-max))
-                     (search-backward ",," nil t)
-                     (if attribute
-                         (setq bound (1+ (point)))
-                       (setq start (1+ (point))))
-                     (goto-char start)
-;                    (while (re-search-forward "[ \t]*,[ \t]*" nil t)
-;                      (replace-match ","))
-;                    (goto-char start)
-                     (if (re-search-forward
-                          (concat ", " (rmail-quote-label-name label) ",")
-                          bound
-                          'move)
-                         (if (not state) (replace-match ","))
-                       (if state (insert " " (symbol-name label) ",")))
-                     (if (eq label rmail-deleted-label)
-                         (rmail-set-message-deleted-p n state)))))
-             (narrow-to-region (- (buffer-size) omin) (- (buffer-size) omax))
-             (if (= n rmail-current-message) (rmail-display-labels))))))))
-\f
-;; Commented functions aren't used by RMAIL but might be nice for user
-;; packages that do stuff with RMAIL.  Note that rmail-message-labels-p
-;; is in rmail.el now.
-
-;(defun rmail-message-label-p (label &optional n)
-;  "Returns symbol if LABEL (attribute or keyword) on NTH or current message."
-;  (rmail-message-labels-p (or n rmail-current-message) (regexp-quote label)))
-
-;(defun rmail-parse-message-labels (&optional n)
-;  "Returns labels associated with NTH or current RMAIL message.
-;The result is a list of two lists of strings.  The first is the
-;message attributes and the second is the message keywords."
-;  (let (atts keys)
-;    (save-restriction
-;      (widen)
-;      (goto-char (rmail-msgbeg (or n rmail-current-message)))
-;      (forward-line 1)
-;      (or (looking-at "[01],") (error "Malformed label line"))
-;      (forward-char 2)
-;      (while (looking-at "[ \t]*\\([^ \t\n,]+\\),")
-;      (setq atts (cons (buffer-substring (match-beginning 1) (match-end 1))
-;                        atts))
-;      (goto-char (match-end 0)))
-;      (or (looking-at ",") (error "Malformed label line"))
-;      (forward-char 1)
-;      (while (looking-at "[ \t]*\\([^ \t\n,]+\\),")
-;      (setq keys (cons (buffer-substring (match-beginning 1) (match-end 1))
-;                       keys))
-;      (goto-char (match-end 0)))
-;      (or (looking-at "[ \t]*$") (error "Malformed label line"))
-;      (list (nreverse atts) (nreverse keys)))))
-
-(defun rmail-attribute-p (s)
-  (let ((symbol (rmail-make-label s)))
-    (if (memq symbol (cdr rmail-attributes)) symbol)))
-
-(defun rmail-keyword-p (s)
-  (let ((symbol (rmail-make-label s)))
-    (if (memq symbol (cdr (rmail-keywords))) symbol)))
-
-(defun rmail-make-label (s &optional forcep)
-  (cond ((symbolp s) s)
-       (forcep (intern (downcase s) rmail-label-obarray))
-       (t  (intern-soft (downcase s) rmail-label-obarray))))
-
-(defun rmail-force-make-label (s)
-  (intern (downcase s) rmail-label-obarray))
-
-(defun rmail-quote-label-name (label)
-  (regexp-quote (symbol-name (rmail-make-label label t))))
+    (or msg (setq msg rmail-current-message))
+    ;; Force recalculation of summary for this message.
+    (aset rmail-summary-vector (1- msg) nil)
+    (let (attr-index)
+      ;; Is this label an attribute?
+      (dotimes (i (length rmail-attr-array))
+       (if (string= (cadr (aref rmail-attr-array i)) label)
+           (setq attr-index i)))
+      (if attr-index
+         ;; If so, set it as an attribute.
+         (rmail-set-attribute attr-index state msg)
+       ;; Is this keyword already present in msg's keyword list?
+       (let* ((header (rmail-get-keywords msg))
+              (regexp (concat ", " (regexp-quote label) ","))
+              (present (not (null
+                             (string-match regexp (concat ", " header ","))))))
+         ;; If current state is not correct,
+         (unless (eq present state)
+           ;; either add it or delete it.
+           (rmail-set-header
+            rmail-keyword-header msg
+            (if state
+                ;; Add this keyword at the end.
+                (if (and header (not (string= header "")))
+                    (concat header ", " label)
+                  label)
+              ;; Delete this keyword.
+              (let ((before (substring header 0
+                                       (max 0 (- (match-beginning 0) 2))))
+                    (after (substring header
+                                      (min (length header)
+                                           (- (match-end 0) 1)))))
+                (cond ((string= before "")
+                       ;; If before and after both empty, delete the header.
+                       (unless (string= after "")
+                         after))
+                      ((string= after "")
+                       before)
+                      (t (concat before ", " after))))))))))
+    (if (rmail-summary-exists)
+       (rmail-select-summary (rmail-summary-update-line msg)))
+    (if (= msg rmail-current-message)
+       (rmail-display-labels))))
 \f
 ;; Motion on messages with keywords.
 
@@ -200,12 +152,15 @@ With prefix argument N moves backward N messages with these labels."
   (interactive "p\nsMove to previous msg with labels: ")
   (rmail-next-labeled-message (- n) labels))
 
+(declare-function mail-comma-list-regexp "mail-utils" (labels))
+
 ;;;###autoload
 (defun rmail-next-labeled-message (n labels)
   "Show next message with one of the labels LABELS.
 LABELS should be a comma-separated list of label names.
 If LABELS is empty, the last set of labels specified is used.
 With prefix argument N moves forward N messages with these labels."
+  ;; FIXME show the default in the prompt.
   (interactive "p\nsMove to next msg with labels: ")
   (if (string= labels "")
       (setq labels rmail-last-multi-labels))
@@ -216,75 +171,28 @@ With prefix argument N moves forward N messages with these labels."
   (rmail-maybe-set-message-counters)
   (let ((lastwin rmail-current-message)
        (current rmail-current-message)
-       (regexp (concat ", ?\\("
+       (regexp (concat " \\("
                        (mail-comma-list-regexp labels)
-                       "\\),")))
-    (save-restriction
-      (widen)
-      (while (and (> n 0) (< current rmail-total-messages))
-       (setq current (1+ current))
-       (if (rmail-message-labels-p current regexp)
-           (setq lastwin current n (1- n))))
-      (while (and (< n 0) (> current 1))
-       (setq current (1- current))
-       (if (rmail-message-labels-p current regexp)
-           (setq lastwin current n (1+ n)))))
-    (rmail-show-message lastwin)
+                       "\\)\\(,\\|\\'\\)")))
+    (while (and (> n 0) (< current rmail-total-messages))
+      (setq current (1+ current))
+      (if (string-match regexp (rmail-get-labels current))
+         (setq lastwin current n (1- n))))
+    (while (and (< n 0) (> current 1))
+      (setq current (1- current))
+      (if (string-match regexp (rmail-get-labels current))
+         (setq lastwin current n (1+ n))))
     (if (< n 0)
-       (message "No previous message with labels %s" labels))
-    (if (> n 0)
-       (message "No following message with labels %s" labels))))
-\f
-;;; Manipulate the file's Labels option.
-
-;; Return a list of symbols for all
-;; the keywords (labels) recorded in this file's Labels option.
-(defun rmail-keywords ()
-  (or rmail-keywords (rmail-parse-file-keywords)))
+       (error "No previous message with labels %s" labels)
+      (if (> n 0)
+         (error "No following message with labels %s" labels)
+       (rmail-show-message-1 lastwin)))))
 
-;; Set rmail-keywords to a list of symbols for all
-;; the keywords (labels) recorded in this file's Labels option.
-(defun rmail-parse-file-keywords ()
-  (save-restriction
-    (save-excursion
-      (widen)
-      (goto-char 1)
-      (setq rmail-keywords
-           (if (search-forward "\nLabels:" (rmail-msgbeg 1) t)
-               (progn
-                 (narrow-to-region (point) (progn (end-of-line) (point)))
-                 (goto-char (point-min))
-                 (cons 'rmail-keywords
-                       (mapcar 'rmail-force-make-label
-                               (mail-parse-comma-list)))))))))
+(provide 'rmailkwd)
 
-;; Add WORD to the list in the file's Labels option.
-;; Any keyword used for the first time needs this done.
-(defun rmail-install-keyword (word)
-  (let ((keyword (rmail-make-label word t))
-       (keywords (rmail-keywords)))
-    (if (not (or (rmail-attribute-p keyword)
-                (rmail-keyword-p keyword)))
-       (let ((omin (- (buffer-size) (point-min)))
-             (omax (- (buffer-size) (point-max))))
-         (unwind-protect
-             (save-excursion
-               (widen)
-               (goto-char 1)
-               (let ((case-fold-search t)
-                     (buffer-read-only nil))
-                 (or (search-forward "\nLabels:" nil t)
-                     (progn
-                       (end-of-line)
-                       (insert "\nLabels:")))
-                 (delete-region (point) (progn (end-of-line) (point)))
-                 (setcdr keywords (cons keyword (cdr keywords)))
-                 (while (setq keywords (cdr keywords))
-                   (insert (symbol-name (car keywords)) ","))
-                 (delete-char -1)))
-           (narrow-to-region (- (buffer-size) omin)
-                             (- (buffer-size) omax)))))
-    keyword))
+;; Local Variables:
+;; generated-autoload-file: "rmail.el"
+;; End:
 
-;; arch-tag: b26b3392-99ca-4e1d-933a-dab59b04e9a8
+;; arch-tag: 1149979c-8e47-4333-9629-cf3dc887a6a7
 ;;; rmailkwd.el ends here