]> git.notmuchmail.org Git - notmuch/blobdiff - emacs/notmuch-show.el
emacs: Fix line-wrapping for help message of notmuch-show mode.
[notmuch] / emacs / notmuch-show.el
index 95874bb26bc1161d7a23dbf8363648aa5a8cb946..ff03936023f45ded9e21241591259450457d98db 100644 (file)
 (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)
+
+(defcustom notmuch-show-relative-dates t
+  "Display relative dates in the message summary line."
+  :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-convert-inline-patch-to-part
+            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"
@@ -169,7 +194,8 @@ collapsed will change.")
     (if (re-search-forward "(\\([^()]*\\))$" (line-end-position) t)
        (let ((inhibit-read-only t))
          (replace-match (concat "("
-                                (mapconcat 'identity tags " ")
+                                (propertize (mapconcat 'identity tags " ")
+                                            'face 'notmuch-tag-face)
                                 ")"))))))
 
 (defun notmuch-show-insert-headerline (headers date tags depth)
@@ -181,7 +207,8 @@ message at DEPTH in the current thread."
            " ("
            date
            ") ("
-           (mapconcat 'identity tags " ")
+           (propertize (mapconcat 'identity tags " ")
+                       'face 'notmuch-tag-face)
            ")\n")
     (overlay-put (make-overlay start (point)) 'face 'notmuch-message-summary-face)))
 
@@ -198,7 +225,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,10 +393,28 @@ 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
-                                   (or (plist-get msg :date_relative)
+                                   (or (if notmuch-show-relative-dates
+                                           (plist-get msg :date_relative)
+                                         nil)
                                        (plist-get headers :Date))
                                    (plist-get msg :tags) depth)
 
@@ -416,8 +461,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 +524,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
@@ -504,7 +556,9 @@ function is used. "
       (let ((map (make-sparse-keymap)))
        (define-key map "?" 'notmuch-help)
        (define-key map "q" 'kill-this-buffer)
+       (define-key map (kbd "<C-tab>") 'widget-backward)
        (define-key map (kbd "M-TAB") 'notmuch-show-previous-button)
+       (define-key map (kbd "<backtab>") 'notmuch-show-previous-button)
        (define-key map (kbd "TAB") 'notmuch-show-next-button)
        (define-key map "s" 'notmuch-search)
        (define-key map "m" 'notmuch-mua-mail)
@@ -526,7 +580,7 @@ function is used. "
        (define-key map "p" 'notmuch-show-previous-open-message)
        (define-key map (kbd "DEL") 'notmuch-show-rewind)
        (define-key map " " 'notmuch-show-advance-and-archive)
-       (define-key map (kbd "M-RET") 'notmuch-show-toggle-all)
+       (define-key map (kbd "M-RET") 'notmuch-show-open-or-close-all)
        (define-key map (kbd "RET") 'notmuch-show-toggle-message)
        map)
       "Keymap for \"notmuch show\" buffers.")
@@ -543,21 +597,17 @@ By default, various components of email messages, (citations,
 signatures, already-read messages), are hidden. You can make
 these parts visible by clicking with the mouse button or by
 pressing RET after positioning the cursor on a hidden part, (for
-which \\[notmuch-show-next-button] and
-\\[notmuch-show-previous-button] are helpful).
+which \\[notmuch-show-next-button] and \\[notmuch-show-previous-button] are helpful).
 
 Reading the thread sequentially is well-supported by pressing
-\\[notmuch-show-advance-and-archive]. This will scroll the
-current message (if necessary), advance to the next message, or
-advance to the next thread (if already on the last message of a
-thread).
+\\[notmuch-show-advance-and-archive]. This will scroll the current message (if necessary), advance
+to the next message, or advance to the next thread (if already on
+the last message of a thread).
 
 Other commands are available to read or manipulate the thread
-more selectively, (such as '\\[notmuch-show-next-message]' and
-'\\[notmuch-show-previous-message]' to advance to messages
-without removing any tags, and '\\[notmuch-show-archive-thread]'
-to archive an entire thread without scrolling through with
-\\[notmuch-show-advance-and-archive]).
+more selectively, (such as '\\[notmuch-show-next-message]' and '\\[notmuch-show-previous-message]' to advance to messages
+without removing any tags, and '\\[notmuch-show-archive-thread]' to archive an entire thread
+without scrolling through with \\[notmuch-show-advance-and-archive]).
 
 You can add or remove arbitary tags from the current message with
 '\\[notmuch-show-add-tag]' or '\\[notmuch-show-remove-tag]'.
@@ -791,8 +841,8 @@ any effects from previous calls to
       ;; If a small number of lines from the previous message are
       ;; visible, realign so that the top of the current message is at
       ;; the top of the screen.
-      (if (< (count-lines (window-start) (notmuch-show-message-top))
-            next-screen-context-lines)
+      (if (<= (count-screen-lines (window-start) start-of-message)
+             next-screen-context-lines)
          (progn
            (goto-char (notmuch-show-message-top))
            (notmuch-show-message-adjust)))
@@ -907,10 +957,10 @@ to stdout or stderr will appear in the *Messages* buffer."
      (not (plist-get props :message-visible))))
   (force-window-update))
 
-(defun notmuch-show-toggle-all ()
-  "Change the visibility all of the messages in the current
-thread. By default make all of the messages visible. With a
-prefix argument, make them all not visible."
+(defun notmuch-show-open-or-close-all ()
+  "Set the visibility all of the messages in the current thread.
+By default make all of the messages visible. With a prefix
+argument, hide all of the messages."
   (interactive)
   (save-excursion
     (goto-char (point-min))