-;;; mail-hist.el --- Headers and message body history for outgoing mail.
+;;; mail-hist.el --- headers and message body history for outgoing mail
+
;; Copyright (C) 1994 Free Software Foundation, Inc.
-;; Author: Karl Fogel <kfogel@cs.oberlin.edu>
+;; Author: Karl Fogel <kfogel@red-bean.com>
;; Created: March, 1994
-;; Version: See variable `mail-hist-version'.
;; Keywords: mail, history
;; This file is part of GNU Emacs.
;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
;; GNU General Public License for more details.
-;;; Commentary:
-
;; 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, 675 Mass Ave, Cambridge, MA 02139, USA.
+;; 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:
;; Thanks to Jim Blandy for mentioning ring.el. It saved a lot of
;; time.
\f
;;; Code:
(require 'ring)
+(require 'sendmail)
-(defconst mail-hist-version "1.3.4"
- "The version number of this mail-hist package.")
+(defgroup mail-hist nil
+ "Headers and message body history for outgoing mail."
+ :prefix "mail-hist-"
+ :group 'mail)
;;;###autoload
(defun mail-hist-define-keys ()
(local-set-key "\M-n" 'mail-hist-next-input))
;;;###autoload
-(add-hook 'mail-mode-hook 'mail-hist-define-keys)
-
-;;;###autoload
-(add-hook 'vm-mail-mode-hook 'mail-hist-define-keys)
-
-;;;###autoload
-(add-hook 'mail-send-hook 'mail-hist-put-headers-into-history)
+(defun mail-hist-enable ()
+ (add-hook 'mail-mode-hook 'mail-hist-define-keys)
+ (add-hook 'mail-send-hook 'mail-hist-put-headers-into-history))
(defvar mail-hist-header-ring-alist nil
"Alist of form (header-name . history-ring).
Used for knowing which history list to look in when the user asks for
previous/next input.")
-(defvar mail-hist-history-size (or kill-ring-max 1729)
+(defcustom mail-hist-history-size (or kill-ring-max 1729)
"*The maximum number of elements in a mail field's history.
-Oldest elements are dumped first.")
+Oldest elements are dumped first."
+ :type 'integer
+ :group 'mail-hist)
;;;###autoload
-(defvar mail-hist-keep-history t
- "*Non-nil means keep a history for headers and text of outgoing mail.")
+(defcustom mail-hist-keep-history t
+ "*Non-nil means keep a history for headers and text of outgoing mail."
+ :type 'boolean
+ :group 'mail-hist)
;; For handling repeated history requests
(defvar mail-hist-access-count 0)
"Get name of mail header point is currently in, without the colon.
Returns nil if not in a header, implying that point is in the body of
the message."
- (if (save-excursion
- (re-search-backward
- (concat "^" (regexp-quote mail-header-separator)) nil t))
+ (if (>= (point) (mail-text-start))
nil ; then we are in the body of the message
(save-excursion
- (let* ((body-start ; limit possibility of false headers
- (save-excursion
- (re-search-forward
- (concat "^" (regexp-quote mail-header-separator)) nil t)))
+ (let* ((body-start
+ (mail-text-start))
(name-start
(re-search-backward mail-hist-header-regexp nil t))
(name-end
(and
name-start
name-end
- (downcase (buffer-substring name-start name-end)))))))
+ (downcase (buffer-substring-no-properties name-start name-end)))))))
(defsubst mail-hist-forward-header (count)
"Move forward COUNT headers (backward if COUNT is negative).
If last/first header is encountered first, stop there and returns
nil.
-Places point directly after the colon."
- (let ((boundary
- (save-excursion
- (if (re-search-forward
- (concat "^" (regexp-quote mail-header-separator)) nil t)
- (progn
- (beginning-of-line)
- (1- (point)))
- nil))))
-
- (if boundary
- (let ((unstopped t))
- (if (> count 0)
- ;; Moving forward.
- (while (> count 0)
- (setq
- unstopped
- (re-search-forward mail-hist-header-regexp boundary t))
- (setq count (1- count)))
- ;; Else moving backward.
- ;; Decrement because the current header will match too.
- (setq count (1- count))
- ;; count is negative
- (while (< count 0)
- (setq
- unstopped
- (re-search-backward mail-hist-header-regexp nil t))
- (setq count (1+ count)))
- ;; We end up behind the header, so must move to the front.
- (re-search-forward mail-hist-header-regexp boundary t))
- ;; Poof! Now we're sitting just past the colon. Finito.
- ;; Return nil if didn't go as far as asked, otherwise point
- unstopped))))
+
+Places point on the first non-whitespace on the line following the
+colon after the header name, or on the second space following that if
+the header is empty."
+ (let ((boundary (mail-header-end)))
+ (and
+ (> boundary 0)
+ (let ((unstopped t))
+ (setq boundary (save-excursion
+ (goto-char boundary)
+ (beginning-of-line)
+ (1- (point))))
+ (if (> count 0)
+ (while (> count 0)
+ (setq
+ unstopped
+ (re-search-forward mail-hist-header-regexp boundary t))
+ (setq count (1- count)))
+ ;; because the current header will match too.
+ (setq count (1- count))
+ ;; count is negative
+ (while (< count 0)
+ (setq
+ unstopped
+ (re-search-backward mail-hist-header-regexp nil t))
+ (setq count (1+ count)))
+ ;; we end up behind the header, so must move to the front
+ (re-search-forward mail-hist-header-regexp boundary t))
+ ;; Now we are right after the colon
+ (and (looking-at "\\s-") (forward-char 1))
+ ;; return nil if didn't go as far as asked, otherwise point
+ unstopped))))
(defsubst mail-hist-beginning-of-header ()
"Move to the start of the current header.
(mail-hist-beginning-of-header)
(let ((start (point)))
(or (mail-hist-forward-header 1)
- (re-search-forward
- (concat "^" (regexp-quote mail-header-separator))))
+ (goto-char (mail-header-end)))
(beginning-of-line)
(buffer-substring start (1- (point))))))
(setq header (downcase header))
(cdr (assoc header mail-hist-header-ring-alist)))
+(defcustom mail-hist-text-size-limit nil
+ "*Don't store any header or body with more than this many characters.
+If the value is nil, that means no limit on text size."
+ :type '(choice (const nil) integer)
+ :group 'mail-hist)
-(defvar mail-hist-text-size-limit nil
- "*Don't store any header or body with more than this many
-characters, plus one. Nil means there will be no limit on text size.")
-
+(defun mail-hist-text-too-long-p (text)
+ "Return non-nil if TEXT's length exceeds `mail-hist-text-size-limit'."
+ (if mail-hist-text-size-limit
+ (> (length text) mail-hist-text-size-limit)))
(defsubst mail-hist-add-header-contents-to-ring (header &optional contents)
- "Add the contents of the current HEADER to the header history ring.
-HEADER is a string; it will be downcased.
+ "Add the contents of HEADER to the header history ring.
Optional argument CONTENTS is a string which will be the contents
-\(instead of whatever's found in the header\)."
+\(instead of whatever's found in the header)."
(setq header (downcase header))
(let ((ctnts (or contents (mail-hist-current-header-contents)))
(ring (cdr (assoc header mail-hist-header-ring-alist))))
-
- ;; Possibly truncate the text. Note that
- ;; `mail-hist-text-size-limit' might be nil, in which case no
- ;; truncation would take place.
- (setq ctnts (substring ctnts 0 mail-hist-text-size-limit))
-
+ (if (mail-hist-text-too-long-p ctnts) (setq ctnts ""))
(or ring
;; If the ring doesn't exist, we'll have to make it and add it
;; to the mail-header-ring-alist:
(cons (cons header ring) mail-hist-header-ring-alist))))
(ring-insert ring ctnts)))
-
;;;###autoload
(defun mail-hist-put-headers-into-history ()
- "Put headers and contents of this message into mail header history.
+ "Put headers and contents of this message into mail header history.
Each header has its own independent history, as does the body of the
message.
-This function normally would be called when the message is sent."
+This function normally would be called when the message is sent."
(and
mail-hist-keep-history
(save-excursion
(while (mail-hist-forward-header 1)
(mail-hist-add-header-contents-to-ring
(mail-hist-current-header-name)))
- ;; We do body contents specially. This is bad. Had I thought to
- ;; include body-saving when I first wrote mail-hist, things might
- ;; be cleaner now. Sigh.
(let ((body-contents
- (save-excursion
- (goto-char (point-min))
- (re-search-forward
- (concat "^" (regexp-quote mail-header-separator)) nil)
- (forward-line 1)
- (buffer-substring (point) (point-max)))))
+ (buffer-substring (mail-text-start) (point-max))))
(mail-hist-add-header-contents-to-ring "body" body-contents)))))
-\f
-(defun mail-hist-header-virgin-p ()
- "Return non-nil if it looks like this header had no contents.
-If it has exactly one space following the colon, then we consider it
-virgin."
- (save-excursion
- (mail-hist-forward-header -1)
- (mail-hist-forward-header 1)
- (looking-at " \n")))
-(defun mail-hist-next-or-previous-input (header nextp)
- "Insert next or previous contents of this mail header or message body.
-Moves back through the history of sent mail messages. Each header has
-its own independent history, as does the body of the message."
- (if (null header) (error "Not in a header."))
+
+\f
+(defun mail-hist-retrieve-and-insert (header access-func)
+ "Helper for `mail-hist-previous-input' and `mail-hist-next-input'."
(setq header (downcase header))
(let* ((ring (cdr (assoc header mail-hist-header-ring-alist)))
(len (ring-length ring))
(repeat (eq last-command 'mail-hist-input-access)))
(if repeat
(setq mail-hist-access-count
- (funcall (if nextp 'ring-minus1 'ring-plus1)
- mail-hist-access-count len))
+ (funcall access-func mail-hist-access-count len))
(setq mail-hist-access-count 0))
(if (null ring)
(progn
(ding)
(message "No history for \"%s\"." header))
(if (ring-empty-p ring)
- (error "\"%s\" ring is empty." header)
- (if repeat
+ (error "\"%s\" ring is empty" header)
+ (and repeat
(delete-region (car mail-hist-last-bounds)
- (cdr mail-hist-last-bounds))
- ;; Else if this looks like a virgin header, we'll want to
- ;; get rid of its single space, because saved header
- ;; contents already include that space, and it's usually
- ;; desirable to have only one space between the colon and
- ;; the start of your header contents.
- (if (mail-hist-header-virgin-p)
- (delete-backward-char 1)))
+ (cdr mail-hist-last-bounds)))
(let ((start (point)))
(insert (ring-ref ring mail-hist-access-count))
(setq mail-hist-last-bounds (cons start (point)))
- (setq this-command 'mail-hist-input-access))))))
+ (setq this-command 'mail-hist-input-access)
+ ;; Special case: when flipping through message bodies, it's
+ ;; usually most useful for point to stay at the top. This
+ ;; is because the unique part of a message in a thread is
+ ;; more likely to be at the top than the bottom, as the
+ ;; bottom is often just the same quoted history for every
+ ;; message in the thread, differing only in indentation
+ ;; level.
+ (if (string-equal header "body")
+ (goto-char start)))
+ ))))
(defun mail-hist-previous-input (header)
The history only contains the contents of outgoing messages, not
received mail."
(interactive (list (or (mail-hist-current-header-name) "body")))
- (mail-hist-next-or-previous-input header nil))
+ (mail-hist-retrieve-and-insert header 'ring-plus1))
(defun mail-hist-next-input (header)
Although you can do so, it does not make much sense to call this
without having called `mail-hist-previous-header' first
-(\\[mail-hist-previous-header]).
+\(\\[mail-hist-previous-header]).
The history only contains the contents of outgoing messages, not
received mail."
(interactive (list (or (mail-hist-current-header-name) "body")))
- (mail-hist-next-or-previous-input header t))
+ (mail-hist-retrieve-and-insert header 'ring-minus1))
\f
(provide 'mail-hist)
-;; mail-hist.el ends here
+;;; arch-tag: 9ff9a07c-9dca-482d-ba87-54f42778559d
+;;; mail-hist.el ends here