mirror of
https://git.notmuchmail.org/git/notmuch
synced 2024-11-21 18:38:08 +01:00
emacs: Move body markup to a separate file
Move the citation and signature markup for text/plain parts to a new file (notmuch-wash.el) and call it using a hook mechanism rather than directly.
This commit is contained in:
David Edmondson
Carl Worth
parent
aab9fa307b
commit
3b3da097d8
3 changed files with 157 additions and 127 deletions
|
|
@ -5,7 +5,8 @@ emacs_sources := \
|
|||
$(dir)/notmuch-lib.el \
|
||||
$(dir)/notmuch.el \
|
||||
$(dir)/notmuch-query.el \
|
||||
$(dir)/notmuch-show.el
|
||||
$(dir)/notmuch-show.el \
|
||||
$(dir)/notmuch-wash.el
|
||||
|
||||
emacs_bytecode := $(subst .el,.elc,$(emacs_sources))
|
||||
|
||||
|
|
|
|||
|
|
@ -27,6 +27,7 @@
|
|||
|
||||
(require 'notmuch-lib)
|
||||
(require 'notmuch-query)
|
||||
(require 'notmuch-wash)
|
||||
|
||||
(declare-function notmuch-call-notmuch-process "notmuch" (&rest args))
|
||||
(declare-function notmuch-reply "notmuch" (query-string))
|
||||
|
|
@ -34,45 +35,6 @@
|
|||
(declare-function notmuch-select-tag-with-completion "notmuch" (prompt &rest search-terms))
|
||||
(declare-function notmuch-search-show-thread "notmuch" nil)
|
||||
|
||||
(defvar notmuch-show-citation-regexp
|
||||
"\\(?:^[[:space:]]>.*\n\\(?:[[:space:]]*\n[[:space:]]>.*\n\\)?\\)+"
|
||||
"Pattern to match citation lines.")
|
||||
|
||||
(defvar notmuch-show-signature-regexp
|
||||
"^\\(-- ?\\|_+\\)$"
|
||||
"Pattern to match a line that separates content from signature.")
|
||||
|
||||
(defvar notmuch-show-signature-button-format
|
||||
"[ %d-line signature. Click/Enter to toggle visibility. ]"
|
||||
"String used to construct button text for hidden signatures
|
||||
|
||||
Can use up to one integer format parameter, i.e. %d")
|
||||
|
||||
(defvar notmuch-show-citation-button-format
|
||||
"[ %d more citation lines. Click/Enter to toggle visibility. ]"
|
||||
"String used to construct button text for hidden citations.
|
||||
|
||||
Can use up to one integer format parameter, i.e. %d")
|
||||
|
||||
(defvar notmuch-show-signature-lines-max 12
|
||||
"Maximum length of signature that will be hidden by default.")
|
||||
|
||||
(defvar notmuch-show-citation-lines-prefix 3
|
||||
"Always show at least this many lines at the start of a citation.
|
||||
|
||||
If there is one more line than the sum of
|
||||
`notmuch-show-citation-lines-prefix' and
|
||||
`notmuch-show-citation-lines-suffix', show that, otherwise
|
||||
collapse remaining lines into a button.")
|
||||
|
||||
(defvar notmuch-show-citation-lines-suffix 3
|
||||
"Always show at least this many lines at the end of a citation.
|
||||
|
||||
If there is one more line than the sum of
|
||||
`notmuch-show-citation-lines-prefix' and
|
||||
`notmuch-show-citation-lines-suffix', show that, otherwise
|
||||
collapse remaining lines into a button.")
|
||||
|
||||
(defvar notmuch-show-headers '("Subject" "To" "Cc" "From" "Date")
|
||||
"Headers that should be shown in a message, in this order. Note
|
||||
that if this order is changed the headers shown when a message is
|
||||
|
|
@ -86,60 +48,13 @@ collapsed will change.")
|
|||
"A list of functions called after populating a
|
||||
`notmuch-show' buffer.")
|
||||
|
||||
(defvar notmuch-show-insert-text/plain-hook '(notmuch-wash-text/plain-citations)
|
||||
"A list of functions called to clean up text/plain body parts.")
|
||||
|
||||
(defun notmuch-show-pretty-hook ()
|
||||
(goto-address-mode 1)
|
||||
(visual-line-mode))
|
||||
|
||||
(defun notmuch-toggle-invisible-action (cite-button)
|
||||
(let ((invis-spec (button-get cite-button 'invisibility-spec)))
|
||||
(if (invisible-p invis-spec)
|
||||
(remove-from-invisibility-spec invis-spec)
|
||||
(add-to-invisibility-spec invis-spec)
|
||||
))
|
||||
(force-window-update)
|
||||
(redisplay t))
|
||||
|
||||
(define-button-type 'notmuch-button-invisibility-toggle-type
|
||||
'action 'notmuch-toggle-invisible-action
|
||||
'follow-link t
|
||||
'face 'font-lock-comment-face)
|
||||
(define-button-type 'notmuch-button-citation-toggle-type
|
||||
'help-echo "mouse-1, RET: Show citation"
|
||||
:supertype 'notmuch-button-invisibility-toggle-type)
|
||||
(define-button-type 'notmuch-button-signature-toggle-type
|
||||
'help-echo "mouse-1, RET: Show signature"
|
||||
:supertype 'notmuch-button-invisibility-toggle-type)
|
||||
(define-button-type 'notmuch-button-headers-toggle-type
|
||||
'help-echo "mouse-1, RET: Show headers"
|
||||
:supertype 'notmuch-button-invisibility-toggle-type)
|
||||
|
||||
(defun notmuch-show-region-to-button (beg end type prefix button-text)
|
||||
"Auxilary function to do the actual making of overlays and buttons
|
||||
|
||||
BEG and END are buffer locations. TYPE should a string, either
|
||||
\"citation\" or \"signature\". PREFIX is some arbitrary text to
|
||||
insert before the button, probably for indentation. BUTTON-TEXT
|
||||
is what to put on the button."
|
||||
|
||||
;; This uses some slightly tricky conversions between strings and
|
||||
;; symbols because of the way the button code works. Note that
|
||||
;; replacing intern-soft with make-symbol will cause this to fail,
|
||||
;; since the newly created symbol has no plist.
|
||||
|
||||
(let ((overlay (make-overlay beg end))
|
||||
(invis-spec (make-symbol (concat "notmuch-" type "-region")))
|
||||
(button-type (intern-soft (concat "notmuch-button-"
|
||||
type "-toggle-type"))))
|
||||
(add-to-invisibility-spec invis-spec)
|
||||
(overlay-put overlay 'invisible invis-spec)
|
||||
(goto-char (1+ end))
|
||||
(save-excursion
|
||||
(goto-char (1- beg))
|
||||
(insert prefix)
|
||||
(insert-button button-text
|
||||
'invisibility-spec invis-spec
|
||||
:type button-type))))
|
||||
|
||||
(defmacro with-current-notmuch-show-message (&rest body)
|
||||
"Evaluate body with current buffer set to the text of current message"
|
||||
`(save-excursion
|
||||
|
|
@ -296,49 +211,13 @@ message at DEPTH in the current thread."
|
|||
|
||||
;; Functions handling particular MIME parts.
|
||||
|
||||
(defun notmuch-show-markup-citations ()
|
||||
"Markup citations, and up to one signature in the buffer."
|
||||
(let ((depth 0)
|
||||
(indent "\n"))
|
||||
(goto-char (point-min))
|
||||
(beginning-of-line)
|
||||
(while (and (< (point) (point-max))
|
||||
(re-search-forward notmuch-show-citation-regexp nil t))
|
||||
(let* ((cite-start (match-beginning 0))
|
||||
(cite-end (match-end 0))
|
||||
(cite-lines (count-lines cite-start cite-end)))
|
||||
(when (> cite-lines (1+ notmuch-show-citation-lines-prefix))
|
||||
(goto-char cite-start)
|
||||
(forward-line notmuch-show-citation-lines-prefix)
|
||||
(let ((hidden-start (point-marker)))
|
||||
(goto-char cite-end)
|
||||
(notmuch-show-region-to-button
|
||||
hidden-start (point-marker)
|
||||
"citation" indent
|
||||
(format notmuch-show-citation-button-format
|
||||
(- cite-lines notmuch-show-citation-lines-prefix)))))))
|
||||
(if (and (not (eobp))
|
||||
(re-search-forward notmuch-show-signature-regexp nil t))
|
||||
(let* ((sig-start (match-beginning 0))
|
||||
(sig-end (match-end 0))
|
||||
(sig-lines (1- (count-lines sig-start (point-max)))))
|
||||
(if (<= sig-lines notmuch-show-signature-lines-max)
|
||||
(let ((sig-start-marker (make-marker))
|
||||
(sig-end-marker (make-marker)))
|
||||
(set-marker sig-start-marker sig-start)
|
||||
(set-marker sig-end-marker (point-max))
|
||||
(notmuch-show-region-to-button
|
||||
sig-start-marker sig-end-marker
|
||||
"signature" indent
|
||||
(format notmuch-show-signature-button-format sig-lines))))))))
|
||||
|
||||
(defun notmuch-show-insert-part-text/plain (part content-type depth)
|
||||
(let ((start (point)))
|
||||
(insert (plist-get part :content))
|
||||
(save-excursion
|
||||
(save-restriction
|
||||
(narrow-to-region start (point-max))
|
||||
(notmuch-show-markup-citations))))
|
||||
(run-hook-with-args 'notmuch-show-insert-text/plain-hook depth))))
|
||||
t)
|
||||
|
||||
(defun notmuch-show-insert-part-text/* (part content-type depth)
|
||||
|
|
|
|||
150
emacs/notmuch-wash.el
Normal file
150
emacs/notmuch-wash.el
Normal file
|
|
@ -0,0 +1,150 @@
|
|||
;; notmuch-wash.el --- cleaning up message bodies
|
||||
;;
|
||||
;; Copyright © Carl Worth
|
||||
;;
|
||||
;; This file is part of Notmuch.
|
||||
;;
|
||||
;; Notmuch 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 3 of the License, or
|
||||
;; (at your option) any later version.
|
||||
;;
|
||||
;; Notmuch 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 Notmuch. If not, see <http://www.gnu.org/licenses/>.
|
||||
;;
|
||||
;; Authors: Carl Worth <cworth@cworth.org>
|
||||
|
||||
(defvar notmuch-wash-signature-regexp
|
||||
"^\\(-- ?\\|_+\\)$"
|
||||
"Pattern to match a line that separates content from signature.")
|
||||
|
||||
(defvar notmuch-wash-citation-regexp
|
||||
"\\(^[[:space:]]*>.*\n\\)+"
|
||||
"Pattern to match citation lines.")
|
||||
|
||||
(defvar notmuch-wash-signature-button-format
|
||||
"[ %d-line signature. Click/Enter to toggle visibility. ]"
|
||||
"String used to construct button text for hidden signatures.
|
||||
Can use up to one integer format parameter, i.e. %d")
|
||||
|
||||
(defvar notmuch-wash-citation-button-format
|
||||
"[ %d more citation lines. Click/Enter to toggle visibility. ]"
|
||||
"String used to construct button text for hidden citations.
|
||||
Can use up to one integer format parameter, i.e. %d")
|
||||
|
||||
(defvar notmuch-wash-signature-lines-max 12
|
||||
"Maximum length of signature that will be hidden by default.")
|
||||
|
||||
(defvar notmuch-wash-citation-lines-prefix 3
|
||||
"Always show at least this many lines from the start of a citation.
|
||||
|
||||
If there is one more line than the sum of
|
||||
`notmuch-wash-citation-lines-prefix' and
|
||||
`notmuch-wash-citation-lines-suffix', show that, otherwise
|
||||
collapse the remaining lines into a button.")
|
||||
|
||||
(defvar notmuch-wash-citation-lines-suffix 3
|
||||
"Always show at least this many lines from the end of a citation.
|
||||
|
||||
If there is one more line than the sum of
|
||||
`notmuch-wash-citation-lines-prefix' and
|
||||
`notmuch-wash-citation-lines-suffix', show that, otherwise
|
||||
collapse the remaining lines into a button.")
|
||||
|
||||
(defun notmuch-wash-toggle-invisible-action (cite-button)
|
||||
(let ((invis-spec (button-get cite-button 'invisibility-spec)))
|
||||
(if (invisible-p invis-spec)
|
||||
(remove-from-invisibility-spec invis-spec)
|
||||
(add-to-invisibility-spec invis-spec)))
|
||||
(force-window-update)
|
||||
(redisplay t))
|
||||
|
||||
(define-button-type 'notmuch-wash-button-invisibility-toggle-type
|
||||
'action 'notmuch-wash-toggle-invisible-action
|
||||
'follow-link t
|
||||
'face 'font-lock-comment-face)
|
||||
|
||||
(define-button-type 'notmuch-wash-button-citation-toggle-type
|
||||
'help-echo "mouse-1, RET: Show citation"
|
||||
:supertype 'notmuch-wash-button-invisibility-toggle-type)
|
||||
|
||||
(define-button-type 'notmuch-wash-button-signature-toggle-type
|
||||
'help-echo "mouse-1, RET: Show signature"
|
||||
:supertype 'notmuch-wash-button-invisibility-toggle-type)
|
||||
|
||||
(defun notmuch-wash-region-to-button (beg end type prefix button-text)
|
||||
"Auxilary function to do the actual making of overlays and buttons
|
||||
|
||||
BEG and END are buffer locations. TYPE should a string, either
|
||||
\"citation\" or \"signature\". PREFIX is some arbitrary text to
|
||||
insert before the button, probably for indentation. BUTTON-TEXT
|
||||
is what to put on the button."
|
||||
|
||||
;; This uses some slightly tricky conversions between strings and
|
||||
;; symbols because of the way the button code works. Note that
|
||||
;; replacing intern-soft with make-symbol will cause this to fail,
|
||||
;; since the newly created symbol has no plist.
|
||||
|
||||
(let ((overlay (make-overlay beg end))
|
||||
(invis-spec (make-symbol (concat "notmuch-" type "-region")))
|
||||
(button-type (intern-soft (concat "notmuch-wash-button-"
|
||||
type "-toggle-type"))))
|
||||
(add-to-invisibility-spec invis-spec)
|
||||
(overlay-put overlay 'invisible invis-spec)
|
||||
(goto-char (1+ end))
|
||||
(save-excursion
|
||||
(goto-char (1- beg))
|
||||
(insert prefix)
|
||||
(insert-button button-text
|
||||
'invisibility-spec invis-spec
|
||||
:type button-type))))
|
||||
|
||||
(defun notmuch-wash-text/plain-citations (depth)
|
||||
"Markup citations, and up to one signature in the buffer."
|
||||
(goto-char (point-min))
|
||||
(beginning-of-line)
|
||||
(while (and (< (point) (point-max))
|
||||
(re-search-forward notmuch-wash-citation-regexp nil t))
|
||||
(let* ((cite-start (match-beginning 0))
|
||||
(cite-end (match-end 0))
|
||||
(cite-lines (count-lines cite-start cite-end)))
|
||||
(overlay-put (make-overlay cite-start cite-end) 'face 'message-cited-text-face)
|
||||
(when (> cite-lines (+ notmuch-wash-citation-lines-prefix
|
||||
notmuch-wash-citation-lines-suffix
|
||||
1))
|
||||
(goto-char cite-start)
|
||||
(forward-line notmuch-wash-citation-lines-prefix)
|
||||
(let ((hidden-start (point-marker)))
|
||||
(goto-char cite-end)
|
||||
(forward-line (- notmuch-wash-citation-lines-suffix))
|
||||
(notmuch-wash-region-to-button
|
||||
hidden-start (point-marker)
|
||||
"citation" "\n"
|
||||
(format notmuch-wash-citation-button-format
|
||||
(- cite-lines
|
||||
notmuch-wash-citation-lines-prefix
|
||||
notmuch-wash-citation-lines-suffix)))))))
|
||||
(if (and (not (eobp))
|
||||
(re-search-forward notmuch-wash-signature-regexp nil t))
|
||||
(let* ((sig-start (match-beginning 0))
|
||||
(sig-end (match-end 0))
|
||||
(sig-lines (1- (count-lines sig-start (point-max)))))
|
||||
(if (<= sig-lines notmuch-wash-signature-lines-max)
|
||||
(let ((sig-start-marker (make-marker))
|
||||
(sig-end-marker (make-marker)))
|
||||
(set-marker sig-start-marker sig-start)
|
||||
(set-marker sig-end-marker (point-max))
|
||||
(overlay-put (make-overlay sig-start-marker sig-end-marker) 'face 'message-cited-text-face)
|
||||
(notmuch-wash-region-to-button
|
||||
sig-start-marker sig-end-marker
|
||||
"signature" "\n"
|
||||
(format notmuch-wash-signature-button-format sig-lines)))))))
|
||||
|
||||
;;
|
||||
|
||||
(provide 'notmuch-wash)
|
||||
Loading…
Reference in a new issue