;;; mh-seq --- mh-e sequences support
;; Time-stamp: <95/08/19 16:45:15 gildea>
;; Copyright (C) 1993, 1995 Free Software Foundation, Inc.
;; This file is part of mh-e, 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, 675 Mass Ave, Cambridge, MA 02139, USA.
;; Internal support for mh-e package.
;;; Change Log:
;;; Internal variables:
(defvar mh-last-seq-used nil) ;Name of seq to which a msg was last added.
(defvar mh-non-seq-mode-line-annotation nil) ;Saved value of mh-mode-line-annotation when narrowed to a seq.
(defun mh-delete-seq (sequence)
"Delete the SEQUENCE."
(interactive (list (mh-read-seq-default "Delete" t)))
(mh-map-to-seq-msgs 'mh-notate-if-in-one-seq sequence ? (1+ mh-cmd-note)
(mh-undefine-sequence sequence '("all"))
(defun mh-list-sequences (folder)
"List the sequences defined in FOLDER."
(interactive (list (mh-prompt-for-folder "List sequences in"
(let ((temp-buffer mh-temp-buffer)
(message "Listing sequences ...")
(insert "Sequences in folder " folder ":\n")
(let ((name (mh-seq-name (car seq-list)))
(sort (copy-sequence (mh-seq-msgs (car seq-list))) '<))
(last-col (- (window-width) 4))
(insert (setq name-spec (format "%20s:" name)))
(if (> (current-column) last-col)
(move-to-column (length name-spec))))
(insert (format " %s" (car sorted-seq-msgs)))
(setq sorted-seq-msgs (cdr sorted-seq-msgs)))
(setq seq-list (cdr seq-list)))
(message "Listing sequences...done")))))
(defun mh-msg-is-in-seq (message)
"Display the sequences that contain MESSAGE (default: current message)."
(interactive (list (mh-get-msg-num t)))
(message "Message %d is in sequences: %s"
(mh-list-to-string (mh-seq-containing-msg message t))
(defun mh-narrow-to-seq (sequence)
"Restrict display of this folder to just messages in SEQUENCE.
Use \\<mh-folder-mode-map>\\[mh-widen] to undo this command."
(interactive (list (mh-read-seq "Narrow to" t)))
(cond ((mh-seq-to-msgs sequence)
(let ((eob (point-max)))
(mh-copy-seq-to-point sequence eob)
(narrow-to-region eob (point-max))
(setq mh-non-seq-mode-line-annotation mh-mode-line-annotation)
(setq mh-mode-line-annotation (symbol-name sequence))
(setq mh-narrowed-to-seq sequence)))
(error "No messages in sequence `%s'" (symbol-name sequence))))))
(defun mh-put-msg-in-seq (msg-or-seq sequence)
"Add MESSAGE(s) (default: displayed message) to SEQUENCE.
If optional prefix argument provided, then prompt for the message sequence."
(interactive (list (if current-prefix-arg
(mh-read-seq-default "Add messages from" t)
(mh-read-seq-default "Add to" nil)))
(if (not (mh-internal-seq sequence))
(setq mh-last-seq-used sequence))
(mh-add-msgs-to-seq (if (numberp msg-or-seq)
(defun mh-widen ()
"Remove restrictions from current folder, thereby showing all messages."
(delete-region (point-min) (point-max))
(setq mh-mode-line-annotation mh-non-seq-mode-line-annotation)
(setq mh-narrowed-to-seq nil))
;;; Commands to manipulate sequences. Sequences are stored in an alist
;;; of the form:
;;; ((seq-name msgs ...) (seq-name msgs ...) ...)
(defun mh-read-seq-default (prompt not-empty)
;; Read and return sequence name with default narrowed or previous sequence.
(mh-read-seq prompt not-empty
(car (mh-seq-containing-msg (mh-get-msg-num nil) nil)))))
(defun mh-read-seq (prompt not-empty &optional default)
;; Read and return a sequence name. Prompt with PROMPT, raise an error
;; if the sequence is empty and the NOT-EMPTY flag is non-nil, and supply
;; an optional DEFAULT sequence.
;; A reply of '%' defaults to the first sequence containing the current
(let* ((input (completing-read (format "%s %s %s" prompt "sequence:"
(format "[%s] " default)
(seq (cond ((equal input "%")
(car (mh-seq-containing-msg (mh-get-msg-num t) nil)))
((equal input "") default)
(t (intern input))))
(msgs (mh-seq-to-msgs seq)))
(if (and (null msgs) not-empty)
(error (format "No messages in sequence `%s'" seq)))
(defun mh-seq-names (seq-list)
;; Return an alist containing the names of the SEQUENCES.
(mapcar (function (lambda (entry) (list (symbol-name (mh-seq-name entry)))))
(defun mh-rename-seq (sequence new-name)
"Rename SEQUENCE to have NEW-NAME."
(interactive (list (mh-read-seq "Old" t)
(intern (read-string "New sequence name: "))))
(let ((old-seq (mh-find-seq sequence)))
(error "Sequence %s does not exist" sequence))
;; create new sequence first, since it might raise an error.
(mh-define-sequence new-name (mh-seq-msgs old-seq))
(mh-undefine-sequence sequence (mh-seq-msgs old-seq))
(rplaca old-seq new-name)))
(defun mh-map-to-seq-msgs (func seq &rest args)
;; Invoke the FUNCTION at each message in the SEQUENCE, passing the
;; remaining ARGS as arguments.
(let ((msgs (mh-seq-to-msgs seq)))
(if (mh-goto-msg (car msgs) t t)
(apply func (car msgs) args))
(setq msgs (cdr msgs))))))
(defun mh-notate-seq (seq notation offset)
;; Mark the scan listing of all messages in the SEQUENCE with the CHARACTER
;; at the given OFFSET from the beginning of the listing line.
(mh-map-to-seq-msgs 'mh-notate seq notation offset))
(defun mh-add-to-sequence (seq msgs)
;; Add to a SEQUENCE each message the list of MSGS.
(if (not (mh-folder-name-p seq))
(apply 'mh-exec-cmd "mark" mh-current-folder "-add"
"-sequence" (symbol-name seq)
(defun mh-copy-seq-to-point (seq location)
;; Copy the scan listing of the messages in SEQUENCE to after the point
;; LOCATION in the current buffer.
(mh-map-to-seq-msgs 'mh-copy-line-to-point seq location))
(defun mh-copy-line-to-point (msg location)
;; Copy the current line to the LOCATION in the current buffer.
(let ((beginning-of-line (point))
(setq end (point))
(insert-buffer-substring (current-buffer) beginning-of-line end))))