comparison lisp/mh-e/mh-utils.el @ 67756:7ff92ad99326

* mh-alias.el (mh-alias-reload): Sync docstrings with manual. * mh-comp.el (mh-letter-mode): Use 60 column width. (mh-forward, mh-insert-signature, mh-send-letter): Sync docstrings with manual. (mh-yank-cur-msg): Mention that mh-ins-buf-prefix isn't used if you have added a mail-citation-hook and neither are used if you use one of the supercite flavors of mh-yank-behavior. Sync docstrings with manual. * mh-customize.el (mh-ins-buf-prefix, mh-yank-behavior): Mention that mh-ins-buf-prefix isn't used if you have added a mail-citation-hook and neither are used if you use one of the supercite flavors of mh-yank-behavior. Sync docstrings with manual. (mail-citation-hook): Delete. Use one in sendmail.el. (mh-signature-file-name, mh-after-commands-processed-hook) (mh-alias-reloaded-hook, mh-before-commands-processed-hook) (mh-before-quit-hook, mh-before-send-letter-hook) (mh-delete-msg-hook, mh-find-path-hook, mh-folder-mode-hook) (mh-forward-hook, mh-inc-folder-hook, mh-insert-signature-hook) (mh-kill-folder-suppress-prompt-hooks, mh-letter-mode-hook) (mh-mh-to-mime-hook, mh-pick-mode-hook, mh-quit-hook) (mh-refile-msg-hook, mh-show-hook, mh-show-mode-hook) (mh-unseen-updated-hook): Sync docstrings with manual. Use "Hook run by `function'..." instead of "Invoked...". * mh-e.el (mh-last-destination, mh-last-destination-folder) (mh-last-destination-write, mh-folder-mode-map, mh-arrow-marker) (mh-delete-list, mh-refile-list, mh-folders-changed) (mh-next-direction, mh-view-ops, mh-folder-view-stack) (mh-index-data, mh-first-msg-num, mh-last-msg-num) (mh-mode-line-annotation, mh-sequence-notation-history) (mh-colors-available-flag): Move comment into docstring. (mh-delete-msg, mh-execute-commands, mh-inc-folder, mh-quit, mh-process-commands): Sync docstrings with manual. (mh-refile-msg): Small doc edit. (mh-delete-a-msg, mh-refile-a-msg): Sync docstrings with manual. Rename msg argument to message. * mh-funcs.el (mh-kill-folder): Sync docstrings with manual. * mh-e.el (mh-update-unseen): No longer say "The value of `foo-hook' is a list of functions to be called, with no arguments, ...," but rather just "The hook foo-hook is called...". * mh-mime.el (mh-mh-to-mime): Ditto * mh-pick.el (mh-pick-mode): Ditto. * mh-utils.el (mh-showing-mode): Use uppercase for argument in docstring. (mh-seq-list, mh-seen-list, mh-showing-with-headers): Move comment into docstring. (mh-show-mode, mh-show-msg, mh-find-path): Sync docstrings with manual.

67755:0cdb122ad4db

          (if mh-modeline-glyph
              (cons modeline-buffer-id-left-extent mh-modeline-glyph)
            (cons modeline-buffer-id-left-extent "XEmacs%N:"))
          (cons modeline-buffer-id-right-extent " %17b")))))

;; This holds a documentation string used by describe-mode.
(defun mh-showing-mode (&optional arg)
  "Change whether messages should be displayed.
With arg, display messages iff ARG is positive."
  (setq mh-showing-mode
        (if (null arg)
            (not mh-showing-mode)
          (> (prefix-numeric-value arg) 0))))

;; The sequences of this folder.  An alist of (seq . msgs).
(defvar mh-seq-list nil)

;; List of displayed messages to be removed from the Unseen sequence.
(defvar mh-seen-list nil)

;; If non-nil, show buffer contains message with all headers.
;; If nil, show buffer contains message processed normally.
;; Showing message with headers or normally.
(defvar mh-showing-with-headers nil)



;;; MH-E macros

  (defvar tool-bar-mode)
  (defvar tool-bar-map))

(define-derived-mode mh-show-mode text-mode "MH-Show"
  "Major mode for showing messages in MH-E.\\<mh-show-mode-map>
The value of `mh-show-mode-hook' is a list of functions to
be called, with no arguments, upon entry to this mode.
See also `mh-folder-mode'.

\\{mh-show-mode-map}"
  (set (make-local-variable 'mail-header-separator) mh-mail-header-separator)
  (setq paragraph-start (default-value 'paragraph-start))

           (min 10 (/ (frame-height) 6)))
      4))

(defun mh-show-msg (msg)
  "Show MSG.
The value of `mh-show-hook' is a list of functions to be called, with no
arguments, after the message has been displayed."
  (if (not msg)
      (setq msg (mh-get-msg-num t)))
  (mh-showing-mode t)
  (setq mh-page-to-next-msg-flag nil)
  (let ((folder mh-current-folder)

(defvar mh-find-path-run nil
  "Non-nil if `mh-find-path' has been run already.")

(defun mh-find-path ()
  "Set variables from user's MH profile.
Set `mh-user-path', `mh-draft-folder', `mh-unseen-seq', `mh-previous-seq',
`mh-inbox' from user's MH profile.
The value of `mh-find-path-hook' is a list of functions to be called, with no
arguments, after these variable have been set."
  (mh-variants)
  (unless mh-find-path-run
    (setq mh-find-path-run t)
    (save-excursion
      ;; Be sure profile is fully expanded before switching buffers

67756:7ff92ad99326

          (if mh-modeline-glyph
              (cons modeline-buffer-id-left-extent mh-modeline-glyph)
            (cons modeline-buffer-id-left-extent "XEmacs%N:"))
          (cons modeline-buffer-id-right-extent " %17b")))))

(defun mh-showing-mode (&optional arg)
  "Change whether messages should be displayed.

With ARG, display messages iff ARG is positive."
  (setq mh-showing-mode
        (if (null arg)
            (not mh-showing-mode)
          (> (prefix-numeric-value arg) 0))))

(defvar mh-seq-list nil
  "Alist of this folder's sequences.
Elements have the form (SEQUENCE . MESSAGES).")

(defvar mh-seen-list nil
  "List of displayed messages to be removed from the \"Unseen\" sequence.")

(defvar mh-showing-with-headers nil
  "If non-nil, MH-Show buffer contains message with all header fields.
If nil, MH-Show buffer contains message processed normally.")



;;; MH-E macros

  (defvar tool-bar-mode)
  (defvar tool-bar-map))

(define-derived-mode mh-show-mode text-mode "MH-Show"
  "Major mode for showing messages in MH-E.\\<mh-show-mode-map>

The hook `mh-show-mode-hook' is called upon entry to this mode.

See also `mh-folder-mode'.

\\{mh-show-mode-map}"
  (set (make-local-variable 'mail-header-separator) mh-mail-header-separator)
  (setq paragraph-start (default-value 'paragraph-start))

           (min 10 (/ (frame-height) 6)))
      4))

(defun mh-show-msg (msg)
  "Show MSG.

The hook `mh-show-hook' is called after the message has been
displayed."
  (if (not msg)
      (setq msg (mh-get-msg-num t)))
  (mh-showing-mode t)
  (setq mh-page-to-next-msg-flag nil)
  (let ((folder mh-current-folder)

(defvar mh-find-path-run nil
  "Non-nil if `mh-find-path' has been run already.")

(defun mh-find-path ()
  "Set variables from user's MH profile.

This function sets `mh-user-path' from your \"Path:\" MH profile
component (but defaults to \"Mail\" if one isn't present),
`mh-draft-folder' from \"Draft-Folder:\", `mh-unseen-seq' from
\"Unseen-Sequence:\", `mh-previous-seq' from \"Previous-Sequence:\",
and `mh-inbox' from \"Inbox:\" (defaults to \"+inbox\").

The hook `mh-find-path-hook' is run after these variables have been
set. This hook can be used the change the value of these variables if
you need to run with different values between MH and MH-E."
  (mh-variants)
  (unless mh-find-path-run
    (setq mh-find-path-run t)
    (save-excursion
      ;; Be sure profile is fully expanded before switching buffers