code.delx.au - gnu-emacs/blob - lisp/mail/rmailkwd.el

   1 ;;; rmailkwd.el --- part of the "RMAIL" mail reader for Emacs
   2
   3 ;; Copyright (C) 1985, 1988, 1994, 2001, 2002, 2003, 2004, 2005, 2006,
   4 ;;   2007, 2008, 2009  Free Software Foundation, Inc.
   5
   6 ;; Maintainer: FSF
   7 ;; Keywords: mail
   8
   9 ;; This file is part of GNU Emacs.
  10
  11 ;; GNU Emacs is free software: you can redistribute it and/or modify
  12 ;; it under the terms of the GNU General Public License as published by
  13 ;; the Free Software Foundation, either version 3 of the License, or
  14 ;; (at your option) any later version.
  15
  16 ;; GNU Emacs is distributed in the hope that it will be useful,
  17 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
  18 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  19 ;; GNU General Public License for more details.
  20
  21 ;; You should have received a copy of the GNU General Public License
  22 ;; along with GNU Emacs.  If not, see <http://www.gnu.org/licenses/>.
  23
  24 ;;; Commentary:
  25
  26 ;;; Code:
  27
  28 (require 'rmail)
  29
  30 ;; Global to all RMAIL buffers.  It exists for the sake of completion.
  31 ;; It is better to use strings with the label functions and let them
  32 ;; worry about making the label.
  33 (defvar rmail-label-obarray (make-vector 47 0)
  34   "Obarray of labels used by Rmail.
  35 `rmail-read-label' uses this to offer completion.")
  36
  37 ;; Initialize with the standard labels.
  38 (mapc (lambda (s) (intern (cadr s) rmail-label-obarray))
  39       rmail-attr-array)
  40
  41 (defun rmail-make-label (s)
  42   "Convert string S to a downcased symbol in `rmail-label-obarray'."
  43   (intern (downcase s) rmail-label-obarray))
  44 \f
  45 ;;;###autoload
  46 (defun rmail-add-label (label)
  47   "Add LABEL to labels associated with current RMAIL message.
  48 Completes (see `rmail-read-label') over known labels when reading.
  49 LABEL may be a symbol or string."
  50   (interactive (list (rmail-read-label "Add label")))
  51   (rmail-set-label label t))
  52
  53 ;;;###autoload
  54 (defun rmail-kill-label (label)
  55   "Remove LABEL from labels associated with current RMAIL message.
  56 Completes (see `rmail-read-label') over known labels when reading.
  57 LABEL may be a symbol or string."
  58   (interactive (list (rmail-read-label "Remove label")))
  59   (rmail-set-label label nil))
  60
  61 ;;;###autoload
  62 (defun rmail-read-label (prompt)
  63   "Read a label with completion, prompting with PROMPT.
  64 Completions are chosen from `rmail-label-obarray'.  The default
  65 is `rmail-last-label', if that is non-nil.  Updates `rmail-last-label'
  66 according to the choice made, and returns a symbol."
  67   (let ((result
  68          (completing-read (concat prompt
  69                                   (if rmail-last-label
  70                                       (concat " (default "
  71                                               (symbol-name rmail-last-label)
  72                                               "): ")
  73                                     ": "))
  74                           rmail-label-obarray
  75                           nil
  76                           nil)))
  77     (if (string= result "")
  78         rmail-last-label
  79       (setq rmail-last-label (rmail-make-label result)))))
  80
  81 (declare-function rmail-summary-update-line "rmailsum" (n))
  82
  83 (defun rmail-set-label (label state &optional msg)
  84   "Set LABEL as present or absent according to STATE in message MSG.
  85 LABEL may be a symbol or string."
  86   (or (stringp label) (setq label (symbol-name label)))
  87   (with-current-buffer rmail-buffer
  88     (rmail-maybe-set-message-counters)
  89     (if (not msg) (setq msg rmail-current-message))
  90     ;; Force recalculation of summary for this message.
  91     (aset rmail-summary-vector (1- msg) nil)
  92     (let (attr-index)
  93       ;; Is this label an attribute?
  94       (dotimes (i (length rmail-attr-array))
  95         (if (string= (cadr (aref rmail-attr-array i)) label)
  96             (setq attr-index i)))
  97       (if attr-index
  98           ;; If so, set it as an attribute.
  99           (rmail-set-attribute attr-index state msg)
 100         ;; Is this keyword already present in msg's keyword list?
 101         (let* ((header (rmail-get-header rmail-keyword-header msg))
 102                (regexp (concat ", " (regexp-quote label) ","))
 103                (present (string-match regexp (concat ", " header ","))))
 104           ;; If current state is not correct,
 105           (unless (eq present state)
 106             ;; either add it or delete it.
 107             (rmail-set-header
 108              rmail-keyword-header msg
 109              (if state
 110                  ;; Add this keyword at the end.
 111                  (if (and header (not (string= header "")))
 112                      (concat header ", " label)
 113                    label)
 114                ;; Delete this keyword.
 115                (let ((before (substring header 0
 116                                         (max 0 (- (match-beginning 0) 2))))
 117                      (after (substring header
 118                                        (min (length header)
 119                                             (- (match-end 0) 1)))))
 120                  (cond ((string= before "")
 121                         after)
 122                        ((string= after "")
 123                         before)
 124                        (t (concat before ", " after))))))))))
 125     (if (rmail-summary-exists)
 126         (rmail-select-summary
 127          (rmail-summary-update-line msg)))
 128     (if (= msg rmail-current-message)
 129         (rmail-display-labels))))
 130 \f
 131 ;; Motion on messages with keywords.
 132
 133 ;;;###autoload
 134 (defun rmail-previous-labeled-message (n labels)
 135   "Show previous message with one of the labels LABELS.
 136 LABELS should be a comma-separated list of label names.
 137 If LABELS is empty, the last set of labels specified is used.
 138 With prefix argument N moves backward N messages with these labels."
 139   (interactive "p\nsMove to previous msg with labels: ")
 140   (rmail-next-labeled-message (- n) labels))
 141
 142 (declare-function mail-comma-list-regexp "mail-utils" (labels))
 143
 144 ;;;###autoload
 145 (defun rmail-next-labeled-message (n labels)
 146   "Show next message with one of the labels LABELS.
 147 LABELS should be a comma-separated list of label names.
 148 If LABELS is empty, the last set of labels specified is used.
 149 With prefix argument N moves forward N messages with these labels."
 150   (interactive "p\nsMove to next msg with labels: ")
 151   (if (string= labels "")
 152       (setq labels rmail-last-multi-labels))
 153   (or labels
 154       (error "No labels to find have been specified previously"))
 155   (set-buffer rmail-buffer)
 156   (setq rmail-last-multi-labels labels)
 157   (rmail-maybe-set-message-counters)
 158   (let ((lastwin rmail-current-message)
 159         (current rmail-current-message)
 160         (regexp (concat " \\("
 161                         (mail-comma-list-regexp labels)
 162                         "\\)\\(,\\|\\'\\)")))
 163     (while (and (> n 0) (< current rmail-total-messages))
 164       (setq current (1+ current))
 165       (if (string-match regexp (rmail-get-labels current))
 166           (setq lastwin current n (1- n))))
 167     (while (and (< n 0) (> current 1))
 168       (setq current (1- current))
 169       (if (string-match regexp (rmail-get-labels current))
 170           (setq lastwin current n (1+ n))))
 171     (if (< n 0)
 172         (error "No previous message with labels %s" labels)
 173       (if (> n 0)
 174           (error "No following message with labels %s" labels)
 175         (rmail-show-message lastwin)))))
 176
 177 (provide 'rmailkwd)
 178
 179 ;; arch-tag: 1149979c-8e47-4333-9629-cf3dc887a6a7
 180 ;;; rmailkwd.el ends here