emacs: Add more functions to clean up text/plain parts

[notmuch] / emacs / notmuch-show.el

diff --git a/emacs/notmuch-show.el b/emacs/notmuch-show.el
index 203528fd62f8438a67b15672e99642f60d4fddd7..f5de8ae91a79fdf8679b2b6b13e2776ad208a6a8 100644 (file)
--- a/emacs/notmuch-show.el
+++ b/emacs/notmuch-show.el
@@ -37,25 +37,44 @@
 (declare-function notmuch-select-tag-with-completion "notmuch" (prompt &rest search-terms))
 (declare-function notmuch-search-show-thread "notmuch" nil)
 
-(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
-collapsed will change.")
+(defcustom notmuch-message-headers '("Subject" "To" "Cc" "Date")
+  "Headers that should be shown in a message, in this order.
+
+For an open message, all of these headers will be made visible
+according to `notmuch-message-headers-visible' or can be toggled
+with `notmuch-show-toggle-headers'. For a closed message, only
+the first header in the list will be visible."
+  :group 'notmuch
+  :type '(repeat string))
+
+(defcustom notmuch-message-headers-visible t
+  "Should the headers be visible by default?
+
+If this value is non-nil, then all of the headers defined in
+`notmuch-message-headers' will be visible by default in the display
+of each message. Otherwise, these headers will be hidden and
+`notmuch-show-toggle-headers' can be used to make the visible for
+any given message."
+  :group 'notmuch
+  :type 'boolean)
 
 (defvar notmuch-show-markup-headers-hook '(notmuch-show-colour-headers)
   "A list of functions called to decorate the headers listed in
-`notmuch-show-headers'.")
-
-(defvar notmuch-show-hook '(notmuch-show-pretty-hook)
-  "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))
+`notmuch-message-headers'.")
+
+(defcustom notmuch-show-hook nil
+  "Functions called after populating a `notmuch-show' buffer."
+  :group 'notmuch
+  :type 'hook)
+
+(defcustom notmuch-show-insert-text/plain-hook '(notmuch-wash-excerpt-citations)
+  "Functions used to improve the display of text/plain parts."
+  :group 'notmuch
+  :type 'hook
+  :options '(notmuch-wash-wrap-long-lines
+            notmuch-wash-tidy-citations
+            notmuch-wash-elide-blank-lines
+            notmuch-wash-excerpt-citations))
 
 (defmacro with-current-notmuch-show-message (&rest body)
   "Evaluate body with current buffer set to the text of current message"
@@ -198,7 +217,7 @@ message at DEPTH in the current thread."
               (if (and header-value
                        (not (string-equal "" header-value)))
                   (notmuch-show-insert-header header header-value))))
-         notmuch-show-headers)
+         notmuch-message-headers)
     (save-excursion
       (save-restriction
        (narrow-to-region start (point-max))
@@ -366,6 +385,22 @@ current buffer, if possible."
        (headers-invis-spec (notmuch-show-make-symbol "header"))
        (message-invis-spec (notmuch-show-make-symbol "message")))
 
+    ;; Set `buffer-invisibility-spec' to `nil' (a list), otherwise
+    ;; removing items from `buffer-invisibility-spec' (which is what
+    ;; `notmuch-show-headers-visible' and
+    ;; `notmuch-show-message-visible' do) is a no-op and has no
+    ;; effect. This caused threads with only matching messages to have
+    ;; those messages hidden initially because
+    ;; `buffer-invisibility-spec' stayed `t'.
+    ;;
+    ;; This needs to be set here (rather than just above the call to
+    ;; `notmuch-show-headers-visible') because some of the part
+    ;; rendering or body washing functions
+    ;; (e.g. `notmuch-wash-text/plain-citations') manipulate
+    ;; `buffer-invisibility-spec').
+    (when (eq buffer-invisibility-spec t)
+      (setq buffer-invisibility-spec nil))
+
     (setq message-start (point-marker))
 
     (notmuch-show-insert-headerline headers
@@ -416,8 +451,8 @@ current buffer, if possible."
     ;; the content).
     (notmuch-show-set-message-properties msg)
 
-    ;; Headers are hidden by default.
-    (notmuch-show-headers-visible msg nil)
+    ;; Set header visibility.
+    (notmuch-show-headers-visible msg notmuch-message-headers-visible)
 
     ;; Message visibility depends on whether it matched the search
     ;; criteria.
@@ -479,6 +514,13 @@ function is used. "
                   query-context)
          (notmuch-show-insert-forest
           (notmuch-query-get-threads basic-args))))
+
+      ;; Enable buttonisation of URLs and email addresses in the
+      ;; buffer.
+      (goto-address-mode t)
+      ;; Act on visual lines rather than logical lines.
+      (visual-line-mode t)
+
       (run-hooks 'notmuch-show-hook))
 
     ;; Move straight to the first open message