[bpt/emacs.git] / lisp / mail / rmailkwd.el

;;; rmailkwd.el --- part of the "RMAIL" mail reader for Emacs

;; Copyright (C) 1985, 1988, 1994, 2001 Free Software Foundation, Inc.

;; Maintainer: FSF
;; Keywords: mail

;; This file is part of GNU Emacs.

;; GNU Emacs is free software; you can redistribute it and/or modify
;; it under the terms of the GNU General Public License as published by
;; the Free Software Foundation; either version 2, or (at your option)
;; any later version.

;; GNU Emacs is distributed in the hope that it will be useful,
;; but WITHOUT ANY WARRANTY; without even the implied warranty of
;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
;; GNU General Public License for more details.

;; You should have received a copy of the GNU General Public License
;; along with GNU Emacs; see the file COPYING.  If not, write to the
;; Free Software Foundation, Inc., 59 Temple Place - Suite 330,
;; Boston, MA 02111-1307, USA.

;;; Commentary:

;;; Code:

;; 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.

(defvar rmail-label-obarray (make-vector 47 0))

;; 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)
\f
;;;###autoload
(defun rmail-add-label (string)
  "Add LABEL to labels associated with current RMAIL message.
Completion is performed over known labels when reading."
  (interactive (list (rmail-read-label "Add label")))
  (rmail-set-label string t))

;;;###autoload
(defun rmail-kill-label (string)
  "Remove LABEL from labels associated with current RMAIL message.
Completion is performed over known labels when reading."
  (interactive (list (rmail-read-label "Remove label")))
  (rmail-set-label string 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))))))

(defun rmail-set-label (l state &optional n)
  (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))))
\f
;; Motion on messages with keywords.

;;;###autoload
(defun rmail-previous-labeled-message (n labels)
  "Show previous 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 backward N messages with these labels."
  (interactive "p\nsMove to previous msg with labels: ")
  (rmail-next-labeled-message (- n) 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."
  (interactive "p\nsMove to next msg with labels: ")
  (if (string= labels "")
      (setq labels rmail-last-multi-labels))
  (or labels
      (error "No labels to find have been specified previously"))
  (set-buffer rmail-buffer)
  (setq rmail-last-multi-labels labels)
  (rmail-maybe-set-message-counters)
  (let ((lastwin rmail-current-message)
	(current rmail-current-message)
	(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)
    (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)))

;; 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)))))))))

;; 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))

;;; rmailkwd.el ends here
Commit	Line	Data
55535639	1	;;; rmailkwd.el --- part of the "RMAIL" mail reader for Emacs
c88ab9ce	2
eba7fdff	3	;; Copyright (C) 1985, 1988, 1994, 2001 Free Software Foundation, Inc.
9750e079	4
e5167999	5	;; Maintainer: FSF
d7b4d18f	6	;; Keywords: mail
e5167999	7
a2535589 JA	8	;; This file is part of GNU Emacs.
	9
	10	;; GNU Emacs is free software; you can redistribute it and/or modify
	11	;; it under the terms of the GNU General Public License as published by
e5167999	12	;; the Free Software Foundation; either version 2, or (at your option)
a2535589 JA	13	;; any later version.
	14
	15	;; GNU Emacs is distributed in the hope that it will be useful,
	16	;; but WITHOUT ANY WARRANTY; without even the implied warranty of
	17	;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
	18	;; GNU General Public License for more details.
	19
	20	;; You should have received a copy of the GNU General Public License
b578f267 EN	21	;; along with GNU Emacs; see the file COPYING. If not, write to the
	22	;; Free Software Foundation, Inc., 59 Temple Place - Suite 330,
	23	;; Boston, MA 02111-1307, USA.
a2535589	24
55535639 PJ	25	;;; Commentary:
55535639 PJ	26
e5167999	27	;;; Code:
a2535589 JA	28
	29	;; Global to all RMAIL buffers. It exists primarily for the sake of
	30	;; completion. It is better to use strings with the label functions
	31	;; and let them worry about making the label.
	32
	33	(defvar rmail-label-obarray (make-vector 47 0))
	34
	35	;; Named list of symbols representing valid message attributes in RMAIL.
	36
	37	(defconst rmail-attributes
	38	(cons 'rmail-keywords
06562727 KH	39	(mapcar (function (lambda (s) (intern s rmail-label-obarray)))
	40	'("deleted" "answered" "filed" "forwarded" "unseen" "edited"
	41	"resent"))))
a2535589 JA	42
	43	(defconst rmail-deleted-label (intern "deleted" rmail-label-obarray))
	44
	45	;; Named list of symbols representing valid message keywords in RMAIL.
	46
013da4a5	47	(defvar rmail-keywords)
a2535589	48	\f
3457b06a	49	;;;###autoload
a2535589 JA	50	(defun rmail-add-label (string)
	51	"Add LABEL to labels associated with current RMAIL message.
	52	Completion is performed over known labels when reading."
	53	(interactive (list (rmail-read-label "Add label")))
	54	(rmail-set-label string t))
	55
3457b06a	56	;;;###autoload
a2535589 JA	57	(defun rmail-kill-label (string)
	58	"Remove LABEL from labels associated with current RMAIL message.
	59	Completion is performed over known labels when reading."
	60	(interactive (list (rmail-read-label "Remove label")))
	61	(rmail-set-label string nil))
	62
3457b06a	63	;;;###autoload
a2535589	64	(defun rmail-read-label (prompt)
eba7fdff GM	65	(with-current-buffer rmail-buffer
	66	(if (not rmail-keywords) (rmail-parse-file-keywords))
	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 t))))))
a2535589 JA	80
a2535589 JA	81	(defun rmail-set-label (l state &optional n)
eba7fdff GM	82	(with-current-buffer rmail-buffer
	83	(rmail-maybe-set-message-counters)
	84	(if (not n) (setq n rmail-current-message))
	85	(aset rmail-summary-vector (1- n) nil)
	86	(let* ((attribute (rmail-attribute-p l))
	87	(keyword (and (not attribute)
	88	(or (rmail-keyword-p l)
	89	(rmail-install-keyword l))))
	90	(label (or attribute keyword)))
	91	(if label
	92	(let ((omax (- (buffer-size) (point-max)))
	93	(omin (- (buffer-size) (point-min)))
	94	(buffer-read-only nil)
	95	(case-fold-search t))
	96	(unwind-protect
	97	(save-excursion
	98	(widen)
	99	(goto-char (rmail-msgbeg n))
	100	(forward-line 1)
	101	(if (not (looking-at "[01],"))
	102	nil
	103	(let ((start (1+ (point)))
	104	(bound))
	105	(narrow-to-region (point) (progn (end-of-line) (point)))
	106	(setq bound (point-max))
	107	(search-backward ",," nil t)
	108	(if attribute
	109	(setq bound (1+ (point)))
	110	(setq start (1+ (point))))
	111	(goto-char start)
	112	; (while (re-search-forward "[ \t],[ \t]" nil t)
	113	; (replace-match ","))
	114	; (goto-char start)
	115	(if (re-search-forward
a2535589 JA	116	(concat ", " (rmail-quote-label-name label) ",")
	117	bound
	118	'move)
eba7fdff GM	119	(if (not state) (replace-match ","))
	120	(if state (insert " " (symbol-name label) ",")))
	121	(if (eq label rmail-deleted-label)
	122	(rmail-set-message-deleted-p n state)))))
	123	(narrow-to-region (- (buffer-size) omin) (- (buffer-size) omax))
	124	(if (= n rmail-current-message) (rmail-display-labels))))))))
a2535589 JA	125	\f
	126	;; Commented functions aren't used by RMAIL but might be nice for user
	127	;; packages that do stuff with RMAIL. Note that rmail-message-labels-p
ac13660a	128	;; is in rmail.el now.
a2535589	129
a2535589 JA	130	;(defun rmail-message-label-p (label &optional n)
a2535589 JA	131	; "Returns symbol if LABEL (attribute or keyword) on NTH or current message."
745d9433	132	; (rmail-message-labels-p (or n rmail-current-message) (regexp-quote label)))
a2535589 JA	133
	134	;(defun rmail-parse-message-labels (&optional n)
	135	; "Returns labels associated with NTH or current RMAIL message.
745d9433 KH	136	;The result is a list of two lists of strings. The first is the
	137	;message attributes and the second is the message keywords."
	138	; (let (atts keys)
	139	; (save-restriction
	140	; (widen)
	141	; (goto-char (rmail-msgbeg (or n rmail-current-message)))
	142	; (forward-line 1)
	143	; (or (looking-at "[01],") (error "Malformed label line"))
	144	; (forward-char 2)
	145	; (while (looking-at "[ \t]*\\([^ \t\n,]+\\),")
	146	; (setq atts (cons (buffer-substring (match-beginning 1) (match-end 1))
	147	; atts))
	148	; (goto-char (match-end 0)))
	149	; (or (looking-at ",") (error "Malformed label line"))
	150	; (forward-char 1)
	151	; (while (looking-at "[ \t]*\\([^ \t\n,]+\\),")
	152	; (setq keys (cons (buffer-substring (match-beginning 1) (match-end 1))
	153	; keys))
	154	; (goto-char (match-end 0)))
	155	; (or (looking-at "[ \t]*$") (error "Malformed label line"))
	156	; (list (nreverse atts) (nreverse keys)))))
a2535589 JA	157
	158	(defun rmail-attribute-p (s)
	159	(let ((symbol (rmail-make-label s)))
	160	(if (memq symbol (cdr rmail-attributes)) symbol)))
	161
	162	(defun rmail-keyword-p (s)
	163	(let ((symbol (rmail-make-label s)))
	164	(if (memq symbol (cdr (rmail-keywords))) symbol)))
	165
	166	(defun rmail-make-label (s &optional forcep)
	167	(cond ((symbolp s) s)
	168	(forcep (intern (downcase s) rmail-label-obarray))
	169	(t (intern-soft (downcase s) rmail-label-obarray))))
	170
	171	(defun rmail-force-make-label (s)
	172	(intern (downcase s) rmail-label-obarray))
	173
	174	(defun rmail-quote-label-name (label)
	175	(regexp-quote (symbol-name (rmail-make-label label t))))
	176	\f
	177	;; Motion on messages with keywords.
	178
3457b06a	179	;;;###autoload
ac13660a JB	180	(defun rmail-previous-labeled-message (n labels)
	181	"Show previous message with one of the labels LABELS.
	182	LABELS should be a comma-separated list of label names.
	183	If LABELS is empty, the last set of labels specified is used.
a2535589 JA	184	With prefix argument N moves backward N messages with these labels."
a2535589 JA	185	(interactive "p\nsMove to previous msg with labels: ")
ac13660a	186	(rmail-next-labeled-message (- n) labels))
a2535589	187
3457b06a	188	;;;###autoload
a2535589	189	(defun rmail-next-labeled-message (n labels)
ac13660a JB	190	"Show next message with one of the labels LABELS.
	191	LABELS should be a comma-separated list of label names.
	192	If LABELS is empty, the last set of labels specified is used.
a2535589 JA	193	With prefix argument N moves forward N messages with these labels."
	194	(interactive "p\nsMove to next msg with labels: ")
	195	(if (string= labels "")
	196	(setq labels rmail-last-multi-labels))
	197	(or labels
	198	(error "No labels to find have been specified previously"))
eba7fdff	199	(set-buffer rmail-buffer)
a2535589 JA	200	(setq rmail-last-multi-labels labels)
	201	(rmail-maybe-set-message-counters)
	202	(let ((lastwin rmail-current-message)
	203	(current rmail-current-message)
	204	(regexp (concat ", ?\\("
	205	(mail-comma-list-regexp labels)
	206	"\\),")))
	207	(save-restriction
	208	(widen)
	209	(while (and (> n 0) (< current rmail-total-messages))
	210	(setq current (1+ current))
	211	(if (rmail-message-labels-p current regexp)
	212	(setq lastwin current n (1- n))))
	213	(while (and (< n 0) (> current 1))
	214	(setq current (1- current))
	215	(if (rmail-message-labels-p current regexp)
	216	(setq lastwin current n (1+ n)))))
	217	(rmail-show-message lastwin)
	218	(if (< n 0)
	219	(message "No previous message with labels %s" labels))
	220	(if (> n 0)
	221	(message "No following message with labels %s" labels))))
	222	\f
	223	;;; Manipulate the file's Labels option.
	224
	225	;; Return a list of symbols for all
	226	;; the keywords (labels) recorded in this file's Labels option.
	227	(defun rmail-keywords ()
	228	(or rmail-keywords (rmail-parse-file-keywords)))
	229
	230	;; Set rmail-keywords to a list of symbols for all
	231	;; the keywords (labels) recorded in this file's Labels option.
	232	(defun rmail-parse-file-keywords ()
	233	(save-restriction
	234	(save-excursion
	235	(widen)
	236	(goto-char 1)
	237	(setq rmail-keywords
	238	(if (search-forward "\nLabels:" (rmail-msgbeg 1) t)
	239	(progn
	240	(narrow-to-region (point) (progn (end-of-line) (point)))
	241	(goto-char (point-min))
	242	(cons 'rmail-keywords
	243	(mapcar 'rmail-force-make-label
	244	(mail-parse-comma-list)))))))))
	245
	246	;; Add WORD to the list in the file's Labels option.
	247	;; Any keyword used for the first time needs this done.
	248	(defun rmail-install-keyword (word)
	249	(let ((keyword (rmail-make-label word t))
	250	(keywords (rmail-keywords)))
	251	(if (not (or (rmail-attribute-p keyword)
	252	(rmail-keyword-p keyword)))
	253	(let ((omin (- (buffer-size) (point-min)))
	254	(omax (- (buffer-size) (point-max))))
	255	(unwind-protect
	256	(save-excursion
	257	(widen)
	258	(goto-char 1)
	259	(let ((case-fold-search t)
	260	(buffer-read-only nil))
	261	(or (search-forward "\nLabels:" nil t)
	262	(progn
	263	(end-of-line)
264	(insert "\nLabels:")))
265	(delete-region (point) (progn (end-of-line) (point)))
266	(setcdr keywords (cons keyword (cdr keywords)))
267	(while (setq keywords (cdr keywords))
268	(insert (symbol-name (car keywords)) ","))
269	(delete-char -1)))
270	(narrow-to-region (- (buffer-size) omin)
271	(- (buffer-size) omax)))))
272	keyword))
c88ab9ce ER	273
c88ab9ce ER	274	;;; rmailkwd.el ends here