contrib: pick: update notmuch-show calls

[notmuch] / contrib / notmuch-pick / notmuch-pick.el

diff --git a/contrib/notmuch-pick/notmuch-pick.el b/contrib/notmuch-pick/notmuch-pick.el
index 0e66efa52c153ad3d6935203aa86e27d1ba059bd..a492214d5b0a122864cdedd80c79d216fd123773 100644 (file)
--- a/contrib/notmuch-pick/notmuch-pick.el
+++ b/contrib/notmuch-pick/notmuch-pick.el
@@ -50,38 +50,31 @@
   "Showing message and thread structure."
   :group 'notmuch)
 
   "Showing message and thread structure."
   :group 'notmuch)
 

-;; This is ugly. We can't run setup-show-out until it has been defined
-;; which needs the keymap to be defined. So we defer setting up to
-;; notmuch-pick-init.

 (defcustom notmuch-pick-show-out nil
   "View selected messages in new window rather than split-pane."
   :type 'boolean
 (defcustom notmuch-pick-show-out nil
   "View selected messages in new window rather than split-pane."
   :type 'boolean

-  :group 'notmuch-pick
-  :set (lambda (symbol value)
-        (set-default symbol value)
-        (when (fboundp 'notmuch-pick-setup-show-out)
-          (notmuch-pick-setup-show-out))))
+  :group 'notmuch-pick)

 
 (defcustom notmuch-pick-result-format
   `(("date" . "%12s  ")
     ("authors" . "%-20s")
 
 (defcustom notmuch-pick-result-format
   `(("date" . "%12s  ")
     ("authors" . "%-20s")

-    ("subject" . " %-54s ")
+    ((("tree" . "%s")("subject" . "%s")) ." %-54s ")

     ("tags" . "(%s)"))
   "Result formatting for Pick. Supported fields are: date,
     ("tags" . "(%s)"))
   "Result formatting for Pick. Supported fields are: date,

-        authors, subject, tags Note: subject includes the tree
-        structure graphics, and the author string should not
-        contain whitespace (put it in the neighbouring fields
-        instead).  For example:
+        authors, subject, tree, tags.  Tree means the thread tree
+        box graphics. The field may also be a list in which case
+        the formatting rules are applied recursively and then the
+        output of all the fields in the list is inserted
+        according to format-string.
+
+Note the author string should not contain
+        whitespace (put it in the neighbouring fields instead).
+        For example:

         (setq notmuch-pick-result-format \(\(\"authors\" . \"%-40s\"\)
                                              \(\"subject\" . \"%s\"\)\)\)"
   :type '(alist :key-type (string) :value-type (string))
   :group 'notmuch-pick)
 
         (setq notmuch-pick-result-format \(\(\"authors\" . \"%-40s\"\)
                                              \(\"subject\" . \"%s\"\)\)\)"
   :type '(alist :key-type (string) :value-type (string))
   :group 'notmuch-pick)
 

-(defcustom notmuch-pick-asynchronous-parser t
-  "Use the asynchronous parser."
-  :type 'boolean
-  :group 'notmuch-pick)
-

 ;; Faces for messages that match the query.
 (defface notmuch-pick-match-date-face
   '((t :inherit default))
 ;; Faces for messages that match the query.
 (defface notmuch-pick-match-date-face
   '((t :inherit default))


@@ -108,6 +101,12 @@
   :group 'notmuch-pick
   :group 'notmuch-faces)
 
   :group 'notmuch-pick
   :group 'notmuch-faces)
 

+(defface notmuch-pick-match-tree-face
+  '((t :inherit default))
+  "Face used in pick mode for the thread tree block graphics in messages matching the query."
+  :group 'notmuch-pick
+  :group 'notmuch-faces)
+

 (defface notmuch-pick-match-tag-face
   '((((class color)
       (background dark))
 (defface notmuch-pick-match-tag-face
   '((((class color)
       (background dark))


@@ -134,6 +133,12 @@
   :group 'notmuch-pick
   :group 'notmuch-faces)
 
   :group 'notmuch-pick
   :group 'notmuch-faces)
 

+(defface notmuch-pick-no-match-tree-face
+  '((t (:foreground "gray")))
+  "Face used in pick mode for the thread tree block graphics in messages matching the query."
+  :group 'notmuch-pick
+  :group 'notmuch-faces)
+

 (defface notmuch-pick-no-match-author-face
   '((t (:foreground "gray")))
   "Face used in pick mode for the date in messages matching the query."
 (defface notmuch-pick-no-match-author-face
   '((t (:foreground "gray")))
   "Face used in pick mode for the date in messages matching the query."


@@ -146,69 +151,129 @@
   :group 'notmuch-pick
   :group 'notmuch-faces)
 
   :group 'notmuch-pick
   :group 'notmuch-faces)
 

-(defvar notmuch-pick-previous-subject "")
+(defvar notmuch-pick-previous-subject
+  "The subject of the most recent result shown during the async display")

 (make-variable-buffer-local 'notmuch-pick-previous-subject)
 
 (make-variable-buffer-local 'notmuch-pick-previous-subject)
 

-;; The basic query i.e. the key part of the search request.
-(defvar notmuch-pick-basic-query nil)
+(defvar notmuch-pick-basic-query nil
+  "A buffer local copy of argument query to the function notmuch-pick")

 (make-variable-buffer-local 'notmuch-pick-basic-query)
 (make-variable-buffer-local 'notmuch-pick-basic-query)

-;; The context of the search: i.e., useful but can be dropped.
-(defvar notmuch-pick-query-context nil)
+
+(defvar notmuch-pick-query-context nil
+  "A buffer local copy of argument query-context to the function notmuch-pick")

 (make-variable-buffer-local 'notmuch-pick-query-context)
 (make-variable-buffer-local 'notmuch-pick-query-context)

-(defvar notmuch-pick-target-msg nil)
+
+(defvar notmuch-pick-target-msg nil
+  "A buffer local copy of argument target to the function notmuch-pick")

 (make-variable-buffer-local 'notmuch-pick-target-msg)
 (make-variable-buffer-local 'notmuch-pick-target-msg)

-(defvar notmuch-pick-buffer-name nil)
-(make-variable-buffer-local 'notmuch-pick-buffer-name)
-;; This variable is the window used for the message pane. It is set
-;; in both the parent pick buffer and the child show buffer. It is
-;; used to try and close the message pane when quitting pick or the
-;; child show buffer.
-(defvar notmuch-pick-message-window nil)
+
+(defvar notmuch-pick-open-target nil
+  "A buffer local copy of argument open-target to the function notmuch-pick")
+(make-variable-buffer-local 'notmuch-pick-open-target)
+
+(defvar notmuch-pick-message-window nil
+  "The window of the message pane.
+
+It is set in both the pick buffer and the child show buffer. It
+is used to try and close the message pane when quitting pick or
+the child show buffer.")

 (make-variable-buffer-local 'notmuch-pick-message-window)
 (put 'notmuch-pick-message-window 'permanent-local t)
 (make-variable-buffer-local 'notmuch-pick-message-window)
 (put 'notmuch-pick-message-window 'permanent-local t)

-(defvar notmuch-pick-message-buffer nil)
-(make-variable-buffer-local 'notmuch-pick-message-buffer-name)
-(put 'notmuch-pick-message-buffer-name 'permanent-local t)
-(defvar notmuch-pick-process-state nil
-  "Parsing state of the search process filter.")

 
 

+(defvar notmuch-pick-message-buffer nil
+  "The buffer name of the show buffer in the message pane.
+
+This is used to try and make sure we don't close the message pane
+if the user has loaded a different buffer in that window.")
+(make-variable-buffer-local 'notmuch-pick-message-buffer)
+(put 'notmuch-pick-message-buffer 'permanent-local t)
+
+(defun notmuch-pick-to-message-pane (func)
+  "Execute FUNC in message pane.
+
+This function returns a function (so can be used as a keybinding)
+which executes function FUNC in the message pane if it is
+open (if the message pane is closed it does nothing)."
+  `(lambda ()
+      ,(concat "(In message pane) " (documentation func t))
+     (interactive)
+     (when (window-live-p notmuch-pick-message-window)
+       (with-selected-window notmuch-pick-message-window
+        (call-interactively #',func)))))
+
+(defun notmuch-pick-button-activate (&optional button)
+  "Activate BUTTON or button at point
+
+This function does not give an error if there is no button."
+  (interactive)
+  (let ((button (or button (button-at (point)))))
+    (when button (button-activate button))))
+
+(defun notmuch-pick-close-message-pane-and (func)
+  "Close message pane and execute FUNC.
+
+This function returns a function (so can be used as a keybinding)
+which closes the message pane if open and then executes function
+FUNC."
+  `(lambda ()
+      ,(concat "(Close message pane and) " (documentation func t))
+     (interactive)
+     (notmuch-pick-close-message-window)
+     (call-interactively #',func)))

 
 (defvar notmuch-pick-mode-map
   (let ((map (make-sparse-keymap)))
 
 (defvar notmuch-pick-mode-map
   (let ((map (make-sparse-keymap)))

-    (define-key map [mouse-1] 'notmuch-pick-show-message)
+    (set-keymap-parent map notmuch-common-keymap)
+    ;; The following override the global keymap.
+    ;; Override because we want to close message pane first.
+    (define-key map "?" (notmuch-pick-close-message-pane-and #'notmuch-help))
+    ;; Override because we first close message pane and then close pick buffer.

     (define-key map "q" 'notmuch-pick-quit)
     (define-key map "q" 'notmuch-pick-quit)

+    ;; Override because we close message pane after the search query is entered.
+    (define-key map "s" 'notmuch-pick-to-search)
+    ;; Override because we want to close message pane first.
+    (define-key map "m" (notmuch-pick-close-message-pane-and #'notmuch-mua-new-mail))
+
+    ;; these use notmuch-show functions directly
+    (define-key map "|" 'notmuch-show-pipe-message)
+    (define-key map "w" 'notmuch-show-save-attachments)
+    (define-key map "v" 'notmuch-show-view-all-mime-parts)
+    (define-key map "c" 'notmuch-show-stash-map)
+
+    ;; these apply to the message pane
+    (define-key map (kbd "M-TAB") (notmuch-pick-to-message-pane #'notmuch-show-previous-button))
+    (define-key map (kbd "<backtab>")  (notmuch-pick-to-message-pane #'notmuch-show-previous-button))
+    (define-key map (kbd "TAB") (notmuch-pick-to-message-pane #'notmuch-show-next-button))
+    (define-key map "e" (notmuch-pick-to-message-pane #'notmuch-pick-button-activate))
+
+    ;; bindings from show (or elsewhere) but we close the message pane first.
+    (define-key map "f" (notmuch-pick-close-message-pane-and #'notmuch-show-forward-message))
+    (define-key map "r" (notmuch-pick-close-message-pane-and #'notmuch-show-reply-sender))
+    (define-key map "R" (notmuch-pick-close-message-pane-and #'notmuch-show-reply))
+    (define-key map "V" (notmuch-pick-close-message-pane-and #'notmuch-show-view-raw-message))
+
+    ;; The main pick bindings
+    (define-key map (kbd "RET") 'notmuch-pick-show-message)
+    (define-key map [mouse-1] 'notmuch-pick-show-message)

     (define-key map "x" 'notmuch-pick-quit)
     (define-key map "x" 'notmuch-pick-quit)

-    (define-key map "?" 'notmuch-help)
+    (define-key map "A" 'notmuch-pick-archive-thread)

     (define-key map "a" 'notmuch-pick-archive-message-then-next)
     (define-key map "=" 'notmuch-pick-refresh-view)
     (define-key map "a" 'notmuch-pick-archive-message-then-next)
     (define-key map "=" 'notmuch-pick-refresh-view)

-    (define-key map "s" 'notmuch-pick-to-search)

     (define-key map "z" 'notmuch-pick-to-pick)
     (define-key map "z" 'notmuch-pick-to-pick)

-    (define-key map "m" 'notmuch-pick-new-mail)
-    (define-key map "f" 'notmuch-pick-forward-message)
-    (define-key map "r" 'notmuch-pick-reply-sender)
-    (define-key map "R" 'notmuch-pick-reply)

     (define-key map "n" 'notmuch-pick-next-matching-message)
     (define-key map "p" 'notmuch-pick-prev-matching-message)
     (define-key map "N" 'notmuch-pick-next-message)
     (define-key map "P" 'notmuch-pick-prev-message)
     (define-key map "n" 'notmuch-pick-next-matching-message)
     (define-key map "p" 'notmuch-pick-prev-matching-message)
     (define-key map "N" 'notmuch-pick-next-message)
     (define-key map "P" 'notmuch-pick-prev-message)

-    (define-key map "|" 'notmuch-pick-pipe-message)
+    (define-key map (kbd "M-p") 'notmuch-pick-prev-thread)
+    (define-key map (kbd "M-n") 'notmuch-pick-next-thread)

     (define-key map "-" 'notmuch-pick-remove-tag)
     (define-key map "+" 'notmuch-pick-add-tag)
     (define-key map "-" 'notmuch-pick-remove-tag)
     (define-key map "+" 'notmuch-pick-add-tag)

+    (define-key map "*" 'notmuch-pick-tag-thread)

     (define-key map " " 'notmuch-pick-scroll-or-next)
     (define-key map "b" 'notmuch-pick-scroll-message-window-back)
     map))
 (fset 'notmuch-pick-mode-map notmuch-pick-mode-map)
 
     (define-key map " " 'notmuch-pick-scroll-or-next)
     (define-key map "b" 'notmuch-pick-scroll-message-window-back)
     map))
 (fset 'notmuch-pick-mode-map notmuch-pick-mode-map)
 

-(defun notmuch-pick-setup-show-out ()
-  (let ((map notmuch-pick-mode-map))
-    (if notmuch-pick-show-out
-       (progn
-         (define-key map (kbd "M-RET") 'notmuch-pick-show-message)
-         (define-key map (kbd "RET") 'notmuch-pick-show-message-out))
-      (progn
-       (define-key map (kbd "RET") 'notmuch-pick-show-message)
-       (define-key map (kbd "M-RET") 'notmuch-pick-show-message-out)))))
-

 (defun notmuch-pick-get-message-properties ()
   "Return the properties of the current message as a plist.
 
 (defun notmuch-pick-get-message-properties ()
   "Return the properties of the current message as a plist.
 


@@ -219,6 +284,22 @@ Some useful entries are:
     (beginning-of-line)
     (get-text-property (point) :notmuch-message-properties)))
 
     (beginning-of-line)
     (get-text-property (point) :notmuch-message-properties)))
 

+;; XXX This should really be a lib function but we are trying to
+;; reduce impact on the code base.
+(defun notmuch-show-get-prop (prop &optional props)
+  "This is a pick overridden version of notmuch-show-get-prop
+
+It gets property PROP from PROPS or, if PROPS is nil, the current
+message in either pick or show. This means that several functions
+in notmuch-show now work unchanged in pick as they just need the
+correct message properties."
+  (let ((props (or props
+                  (cond ((eq major-mode 'notmuch-show-mode)
+                         (notmuch-show-get-message-properties))
+                        ((eq major-mode 'notmuch-pick-mode)
+                         (notmuch-pick-get-message-properties))))))
+    (plist-get props prop)))
+

 (defun notmuch-pick-set-message-properties (props)
   (save-excursion
     (beginning-of-line)
 (defun notmuch-pick-set-message-properties (props)
   (save-excursion
     (beginning-of-line)


@@ -257,13 +338,25 @@ Some useful entries are:
   (notmuch-pick-get-prop :match))
 
 (defun notmuch-pick-refresh-result ()
   (notmuch-pick-get-prop :match))
 
 (defun notmuch-pick-refresh-result ()

+  "Redisplay the current message line.
+
+This redisplays the current line based on the messages
+properties (as they are now). This is used when tags are
+updated."

   (let ((init-point (point))
        (end (line-end-position))
        (msg (notmuch-pick-get-message-properties))
        (inhibit-read-only t))
     (beginning-of-line)
   (let ((init-point (point))
        (end (line-end-position))
        (msg (notmuch-pick-get-message-properties))
        (inhibit-read-only t))
     (beginning-of-line)

-    (delete-region (point) (1+ (line-end-position)))
-    (notmuch-pick-insert-msg msg)
+    ;; This is a little tricky: we override
+    ;; notmuch-pick-previous-subject to get the decision between
+    ;; ... and a subject right and it stops notmuch-pick-insert-msg
+    ;; from overwriting the buffer local copy of
+    ;; notmuch-pick-previous-subject if this is called while the
+    ;; buffer is displaying.
+    (let ((notmuch-pick-previous-subject (notmuch-pick-get-prop :previous-subject)))
+      (delete-region (point) (1+ (line-end-position)))
+      (notmuch-pick-insert-msg msg))

     (let ((new-end (line-end-position)))
       (goto-char (if (= init-point end)
                     new-end
     (let ((new-end (line-end-position)))
       (goto-char (if (= init-point end)
                     new-end


@@ -282,7 +375,7 @@ Does NOT change the database."
 (defun notmuch-pick-tag (&optional tag-changes)
   "Change tags for the current message"
   (interactive)
 (defun notmuch-pick-tag (&optional tag-changes)
   "Change tags for the current message"
   (interactive)

-  (setq tag-changes (funcall 'notmuch-tag (notmuch-pick-get-message-id) tag-changes))
+  (setq tag-changes (notmuch-tag (notmuch-pick-get-message-id) tag-changes))

   (notmuch-pick-tag-update-display tag-changes))
 
 (defun notmuch-pick-add-tag ()
   (notmuch-pick-tag-update-display tag-changes))
 
 (defun notmuch-pick-add-tag ()


@@ -314,17 +407,6 @@ Does NOT change the database."
     (notmuch-pick-close-message-window)
     (notmuch-pick query)))
 
     (notmuch-pick-close-message-window)
     (notmuch-pick query)))
 

-;; This function should be in notmuch-hello.el but we are trying to
-;; minimise impact on the rest of the codebase.
-(defun notmuch-pick-from-hello (&optional search)
-  "Run a query and display results in experimental notmuch-pick mode"
-  (interactive)
-  (unless (null search)
-    (setq search (notmuch-hello-trim search))
-    (let ((history-delete-duplicates t))
-      (add-to-history 'notmuch-search-history search)))
-  (notmuch-pick search))
-

 ;; This function should be in notmuch-show.el but be we trying to
 ;; minimise impact on the rest of the codebase.
 (defun notmuch-pick-from-show-current-query ()
 ;; This function should be in notmuch-show.el but be we trying to
 ;; minimise impact on the rest of the codebase.
 (defun notmuch-pick-from-show-current-query ()


@@ -349,10 +431,11 @@ Does NOT change the database."
   (notmuch-pick (notmuch-search-find-thread-id)
                 notmuch-search-query-string
                nil
   (notmuch-pick (notmuch-search-find-thread-id)
                 notmuch-search-query-string
                nil

-                (notmuch-prettify-subject (notmuch-search-find-subject)))
-  (notmuch-pick-show-match-message-with-wait))
+                (notmuch-prettify-subject (notmuch-search-find-subject))
+               t))

 
 (defun notmuch-pick-message-window-kill-hook ()
 
 (defun notmuch-pick-message-window-kill-hook ()

+  "Close the message pane when exiting the show buffer."

   (let ((buffer (current-buffer)))
     (when (and (window-live-p notmuch-pick-message-window)
               (eq (window-buffer notmuch-pick-message-window) buffer))
   (let ((buffer (current-buffer)))
     (when (and (window-live-p notmuch-pick-message-window)
               (eq (window-buffer notmuch-pick-message-window) buffer))


@@ -362,7 +445,7 @@ Does NOT change the database."
       (ignore-errors
        (delete-window notmuch-pick-message-window)))))
 
       (ignore-errors
        (delete-window notmuch-pick-message-window)))))
 

-(defun notmuch-pick-show-message ()
+(defun notmuch-pick-show-message-in ()

   "Show the current message (in split-pane)."
   (interactive)
   (let ((id (notmuch-pick-get-message-id))
   "Show the current message (in split-pane)."
   (interactive)
   (let ((id (notmuch-pick-get-message-id))


@@ -378,7 +461,7 @@ Does NOT change the database."
        ;; Since we are only displaying one message do not indent.
        (let ((notmuch-show-indent-messages-width 0)
              (notmuch-show-only-matching-messages t))
        ;; Since we are only displaying one message do not indent.
        (let ((notmuch-show-indent-messages-width 0)
              (notmuch-show-only-matching-messages t))

-         (setq buffer (notmuch-show id nil nil nil))))
+         (setq buffer (notmuch-show id))))

       ;; We need the `let' as notmuch-pick-message-window is buffer local.
       (let ((window notmuch-pick-message-window))
        (with-current-buffer buffer
       ;; We need the `let' as notmuch-pick-message-window is buffer local.
       (let ((window notmuch-pick-message-window))
        (with-current-buffer buffer


@@ -397,7 +480,18 @@ Does NOT change the database."
     (when id
       ;; We close the window to kill off un-needed buffers.
       (notmuch-pick-close-message-window)
     (when id
       ;; We close the window to kill off un-needed buffers.
       (notmuch-pick-close-message-window)

-      (notmuch-show id nil nil nil))))
+      (notmuch-show id))))
+
+(defun notmuch-pick-show-message (arg)
+  "Show the current message.
+
+Shows in split pane or whole window according to value of
+`notmuch-pick-show-out'. A prefix argument reverses the choice."
+  (interactive "P")
+  (if (or (and notmuch-pick-show-out  (not arg))
+         (and (not notmuch-pick-show-out) arg))
+      (notmuch-pick-show-message-out)
+    (notmuch-pick-show-message-in)))

 
 (defun notmuch-pick-scroll-message-window ()
   "Scroll the message window (if it exists)"
 
 (defun notmuch-pick-scroll-message-window ()
   "Scroll the message window (if it exists)"


@@ -443,10 +537,9 @@ Does NOT change the database."
   "Archive the current message.
 
 Archive the current message by applying the tag changes in
   "Archive the current message.
 
 Archive the current message by applying the tag changes in

-`notmuch-archive-tags' to it (remove the \"inbox\" tag by
-default). If a prefix argument is given, the message will be
-\"unarchived\", i.e. the tag changes in `notmuch-archive-tags'
-will be reversed."
+`notmuch-archive-tags' to it. If a prefix argument is given, the
+message will be \"unarchived\", i.e. the tag changes in
+`notmuch-archive-tags' will be reversed."

   (interactive "P")
   (when notmuch-archive-tags
     (apply 'notmuch-pick-tag
   (interactive "P")
   (when notmuch-archive-tags
     (apply 'notmuch-pick-tag


@@ -463,14 +556,14 @@ will be reversed."
   (interactive)
   (forward-line)
   (when (window-live-p notmuch-pick-message-window)
   (interactive)
   (forward-line)
   (when (window-live-p notmuch-pick-message-window)

-    (notmuch-pick-show-message)))
+    (notmuch-pick-show-message-in)))

 
 (defun notmuch-pick-prev-message ()
   "Move to previous message."
   (interactive)
   (forward-line -1)
   (when (window-live-p notmuch-pick-message-window)
 
 (defun notmuch-pick-prev-message ()
   "Move to previous message."
   (interactive)
   (forward-line -1)
   (when (window-live-p notmuch-pick-message-window)

-    (notmuch-pick-show-message)))
+    (notmuch-pick-show-message-in)))

 
 (defun notmuch-pick-prev-matching-message ()
   "Move to previous matching message."
 
 (defun notmuch-pick-prev-matching-message ()
   "Move to previous matching message."


@@ -479,7 +572,7 @@ will be reversed."
   (while (and (not (bobp)) (not (notmuch-pick-get-match)))
     (forward-line -1))
   (when (window-live-p notmuch-pick-message-window)
   (while (and (not (bobp)) (not (notmuch-pick-get-match)))
     (forward-line -1))
   (when (window-live-p notmuch-pick-message-window)

-    (notmuch-pick-show-message)))
+    (notmuch-pick-show-message-in)))

 
 (defun notmuch-pick-next-matching-message ()
   "Move to next matching message."
 
 (defun notmuch-pick-next-matching-message ()
   "Move to next matching message."


@@ -488,23 +581,7 @@ will be reversed."
   (while (and (not (eobp)) (not (notmuch-pick-get-match)))
     (forward-line))
   (when (window-live-p notmuch-pick-message-window)
   (while (and (not (eobp)) (not (notmuch-pick-get-match)))
     (forward-line))
   (when (window-live-p notmuch-pick-message-window)

-    (notmuch-pick-show-message)))
-
-(defun notmuch-pick-show-match-message-with-wait ()
-  "Show the first matching message but wait for it to appear or search to finish."
-  (interactive)
-  (unless (notmuch-pick-get-match)
-    (notmuch-pick-next-matching-message))
-  (while (and (not (notmuch-pick-get-match))
-             (get-buffer-process (current-buffer)))
-    (message "waiting for message")
-    (sit-for 0.1)
-    (goto-char (point-min))
-    (unless (notmuch-pick-get-match)
-      (notmuch-pick-next-matching-message)))
-  (message nil)
-  (when (notmuch-pick-get-match)
-    (notmuch-pick-show-message)))
+    (notmuch-pick-show-message-in)))

 
 (defun notmuch-pick-refresh-view ()
   "Refresh view."
 
 (defun notmuch-pick-refresh-view ()
   "Refresh view."


@@ -512,76 +589,70 @@ will be reversed."
   (let ((inhibit-read-only t)
        (basic-query notmuch-pick-basic-query)
        (query-context notmuch-pick-query-context)
   (let ((inhibit-read-only t)
        (basic-query notmuch-pick-basic-query)
        (query-context notmuch-pick-query-context)

-       (target (notmuch-pick-get-message-id))
-       (buffer-name notmuch-pick-buffer-name))
+       (target (notmuch-pick-get-message-id)))

     (erase-buffer)
     (notmuch-pick-worker basic-query
                         query-context
     (erase-buffer)
     (notmuch-pick-worker basic-query
                         query-context

-                        target
-                        (get-buffer buffer-name))))
-
-(defmacro with-current-notmuch-pick-message (&rest body)
-  "Evaluate body with current buffer set to the text of current message"
-  `(save-excursion
-     (let ((id (notmuch-pick-get-message-id)))
-       (let ((buf (generate-new-buffer (concat "*notmuch-msg-" id "*"))))
-         (with-current-buffer buf
-           (call-process notmuch-command nil t nil "show" "--format=raw" id)
-           ,@body)
-        (kill-buffer buf)))))
-
-(defun notmuch-pick-new-mail (&optional prompt-for-sender)
-  "Compose new mail."
-  (interactive "P")
-  (notmuch-pick-close-message-window)
-  (notmuch-mua-new-mail prompt-for-sender ))
+                        target)))

 
 

-(defun notmuch-pick-forward-message (&optional prompt-for-sender)
-  "Forward the current message."
-  (interactive "P")
-  (notmuch-pick-close-message-window)
-  (with-current-notmuch-pick-message
-   (notmuch-mua-new-forward-message prompt-for-sender)))
+(defun notmuch-pick-thread-top ()
+  (when (notmuch-pick-get-message-properties)
+    (while (not (or (notmuch-pick-get-prop :first) (eobp)))
+      (forward-line -1))))

 
 

-(defun notmuch-pick-reply (&optional prompt-for-sender)
-  "Reply to the sender and all recipients of the current message."
-  (interactive "P")
-  (notmuch-pick-close-message-window)
-  (notmuch-mua-new-reply (notmuch-pick-get-message-id) prompt-for-sender t))
+(defun notmuch-pick-prev-thread ()
+  (interactive)
+  (forward-line -1)
+  (notmuch-pick-thread-top))

 
 

-(defun notmuch-pick-reply-sender (&optional prompt-for-sender)
-  "Reply to the sender of the current message."
+(defun notmuch-pick-next-thread ()
+  (interactive)
+  (forward-line 1)
+  (while (not (or (notmuch-pick-get-prop :first) (eobp)))
+    (forward-line 1)))
+
+(defun notmuch-pick-thread-mapcar (function)
+  "Iterate through all messages in the current thread
+ and call FUNCTION for side effects."
+  (save-excursion
+    (notmuch-pick-thread-top)
+    (loop collect (funcall function)
+         do (forward-line)
+         while (and (notmuch-pick-get-message-properties)
+                    (not (notmuch-pick-get-prop :first))))))
+
+(defun notmuch-pick-get-messages-ids-thread-search ()
+  "Return a search string for all message ids of messages in the current thread."
+  (mapconcat 'identity
+            (notmuch-pick-thread-mapcar 'notmuch-pick-get-message-id)
+            " or "))
+
+(defun notmuch-pick-tag-thread (&optional tag-changes)
+  "Tag all messages in the current thread"
+  (interactive)
+  (when (notmuch-pick-get-message-properties)
+    (let ((tag-changes (notmuch-tag (notmuch-pick-get-messages-ids-thread-search) tag-changes)))
+      (notmuch-pick-thread-mapcar
+       (lambda () (notmuch-pick-tag-update-display tag-changes))))))
+
+(defun notmuch-pick-archive-thread (&optional unarchive)
+  "Archive each message in thread.
+
+Archive each message currently shown by applying the tag changes
+in `notmuch-archive-tags' to each. If a prefix argument is given,
+the messages will be \"unarchived\", i.e. the tag changes in
+`notmuch-archive-tags' will be reversed.
+
+Note: This command is safe from any race condition of new messages
+being delivered to the same thread. It does not archive the
+entire thread, but only the messages shown in the current
+buffer."

   (interactive "P")
   (interactive "P")

-  (notmuch-pick-close-message-window)
-  (notmuch-mua-new-reply (notmuch-pick-get-message-id) prompt-for-sender nil))
-
-;; Shamelessly stolen from notmuch-show.el: maybe should be unified.
-(defun notmuch-pick-pipe-message (command)
-  "Pipe the contents of the current message to the given command.
-
-The given command will be executed with the raw contents of the
-current email message as stdin. Anything printed by the command
-to stdout or stderr will appear in the *notmuch-pipe* buffer.
-
-When invoked with a prefix argument, the command will receive all
-open messages in the current thread (formatted as an mbox) rather
-than only the current message."
-  (interactive "sPipe message to command: ")
-  (let ((shell-command
-        (concat notmuch-command " show --format=raw "
-                (shell-quote-argument (notmuch-pick-get-message-id)) " | " command))
-        (buf (get-buffer-create (concat "*notmuch-pipe*"))))
-    (with-current-buffer buf
-      (setq buffer-read-only nil)
-      (erase-buffer)
-      (let ((exit-code (call-process-shell-command shell-command nil buf)))
-       (goto-char (point-max))
-       (set-buffer-modified-p nil)
-       (setq buffer-read-only t)
-       (unless (zerop exit-code)
-         (switch-to-buffer-other-window buf)
-         (message (format "Command '%s' exited abnormally with code %d"
-                          shell-command exit-code)))))))
+  (when notmuch-archive-tags
+    (notmuch-pick-tag-thread
+     (notmuch-tag-change-list notmuch-archive-tags unarchive))))
+
+;; Functions below here display the pick buffer itself.

 
 (defun notmuch-pick-clean-address (address)
   "Try to clean a single email ADDRESS for display. Return
 
 (defun notmuch-pick-clean-address (address)
   "Try to clean a single email ADDRESS for display. Return


@@ -594,31 +665,43 @@ unchanged ADDRESS if parsing fails."
     ;; If we have a name return that otherwise return the address.
     (or p-name p-address)))
 
     ;; If we have a name return that otherwise return the address.
     (or p-name p-address)))
 

-(defun notmuch-pick-insert-field (field format-string msg)
+(defun notmuch-pick-format-field (field format-string msg)
+  "Format a FIELD of MSG according to FORMAT-STRING and return string"

   (let* ((headers (plist-get msg :headers))
   (let* ((headers (plist-get msg :headers))

-       (match (plist-get msg :match)))
+        (match (plist-get msg :match)))

     (cond
     (cond

+     ((listp field)
+      (format format-string (notmuch-pick-format-field-list field msg)))
+

      ((string-equal field "date")
       (let ((face (if match
                      'notmuch-pick-match-date-face
                    'notmuch-pick-no-match-date-face)))
      ((string-equal field "date")
       (let ((face (if match
                      'notmuch-pick-match-date-face
                    'notmuch-pick-no-match-date-face)))

-       (insert (propertize (format format-string (plist-get msg :date_relative))
-                           'face face))))
+       (propertize (format format-string (plist-get msg :date_relative)) 'face face)))

 
 

-     ((string-equal field "subject")
+     ((string-equal field "tree")

       (let ((tree-status (plist-get msg :tree-status))
       (let ((tree-status (plist-get msg :tree-status))

-           (bare-subject (notmuch-show-strip-re (plist-get headers :Subject)))
+           (face (if match
+                     'notmuch-pick-match-tree-face
+                   'notmuch-pick-no-match-tree-face)))
+
+       (propertize (format format-string
+                           (mapconcat #'identity (reverse tree-status) ""))
+                   'face face)))
+
+     ((string-equal field "subject")
+      (let ((bare-subject (notmuch-show-strip-re (plist-get headers :Subject)))
+           (previous-subject notmuch-pick-previous-subject)

            (face (if match
                      'notmuch-pick-match-subject-face
                    'notmuch-pick-no-match-subject-face)))
            (face (if match
                      'notmuch-pick-match-subject-face
                    'notmuch-pick-no-match-subject-face)))

-       (insert (propertize (format format-string
-                                   (concat
-                                    (mapconcat #'identity (reverse tree-status) "")
-                                    (if (string= notmuch-pick-previous-subject bare-subject)
-                                        " ..."
-                                      bare-subject)))
-                           'face face))
-       (setq notmuch-pick-previous-subject bare-subject)))
+
+       (setq notmuch-pick-previous-subject bare-subject)
+       (propertize (format format-string
+                           (if (string= previous-subject bare-subject)
+                               " ..."
+                             bare-subject))
+                   'face face)))

 
      ((string-equal field "authors")
       (let ((author (notmuch-pick-clean-address (plist-get headers :From)))
 
      ((string-equal field "authors")
       (let ((author (notmuch-pick-clean-address (plist-get headers :From)))


@@ -628,39 +711,55 @@ unchanged ADDRESS if parsing fails."
                    'notmuch-pick-no-match-author-face)))
        (when (> (length author) len)
          (setq author (substring author 0 len)))
                    'notmuch-pick-no-match-author-face)))
        (when (> (length author) len)
          (setq author (substring author 0 len)))

-       (insert (propertize (format format-string author)
-                           'face face))))
+       (propertize (format format-string author) 'face face)))

 
      ((string-equal field "tags")
       (let ((tags (plist-get msg :tags))
            (face (if match
 
      ((string-equal field "tags")
       (let ((tags (plist-get msg :tags))
            (face (if match

-                         'notmuch-pick-match-tag-face
-                       'notmuch-pick-no-match-tag-face)))
-       (when tags
-         (insert (propertize (format format-string
-                                     (mapconcat #'identity tags ", "))
-                             'face face))))))))
+                     'notmuch-pick-match-tag-face
+                   'notmuch-pick-no-match-tag-face)))
+       (propertize (format format-string
+                           (mapconcat #'identity tags ", "))
+                   'face face))))))
+
+
+(defun notmuch-pick-format-field-list (field-list msg)
+  "Format fields of MSG according to FIELD-LIST and return string"
+  (let (result-string)
+    (dolist (spec field-list result-string)
+      (let ((field-string (notmuch-pick-format-field (car spec) (cdr spec) msg)))
+       (setq result-string (concat result-string field-string))))))

 
 (defun notmuch-pick-insert-msg (msg)
   "Insert the message MSG according to notmuch-pick-result-format"
 
 (defun notmuch-pick-insert-msg (msg)
   "Insert the message MSG according to notmuch-pick-result-format"

-  (dolist (spec notmuch-pick-result-format)
-    (notmuch-pick-insert-field (car spec) (cdr spec) msg))
-  (notmuch-pick-set-message-properties msg)
-  (insert "\n"))
+  ;; We need to save the previous subject as it will get overwritten
+  ;; by the insert-field calls.
+  (let ((previous-subject notmuch-pick-previous-subject))
+    (insert (notmuch-pick-format-field-list notmuch-pick-result-format msg))
+    (notmuch-pick-set-message-properties msg)
+    (notmuch-pick-set-prop :previous-subject previous-subject)
+    (insert "\n")))

 
 (defun notmuch-pick-goto-and-insert-msg (msg)
   "Insert msg at the end of the buffer. Move point to msg if it is the target"
   (save-excursion
     (goto-char (point-max))
     (notmuch-pick-insert-msg msg))
 
 (defun notmuch-pick-goto-and-insert-msg (msg)
   "Insert msg at the end of the buffer. Move point to msg if it is the target"
   (save-excursion
     (goto-char (point-max))
     (notmuch-pick-insert-msg msg))

-  (let ((msg-id (notmuch-id-to-query (plist-get msg :id))))
-    (when (string= msg-id notmuch-pick-target-msg)
+  (let ((msg-id (notmuch-id-to-query (plist-get msg :id)))
+       (target notmuch-pick-target-msg))
+    (when (or (and (not target) (plist-get msg :match))
+             (string= msg-id target))

       (setq notmuch-pick-target-msg "found")
       (goto-char (point-max))
       (setq notmuch-pick-target-msg "found")
       (goto-char (point-max))

-      (forward-line -1))))
+      (forward-line -1)
+      (when notmuch-pick-open-target
+       (notmuch-pick-show-message-in)))))

 
 (defun notmuch-pick-insert-tree (tree depth tree-status first last)
 
 (defun notmuch-pick-insert-tree (tree depth tree-status first last)

-  "Insert the message tree TREE at depth DEPTH in the current thread."
+  "Insert the message tree TREE at depth DEPTH in the current thread.
+
+A message tree is another name for a single sub-thread: i.e., a
+message together with all its descendents."

   (let ((msg (car tree))
        (replies (cadr tree)))
 
   (let ((msg (car tree))
        (replies (cadr tree)))
 


@@ -680,6 +779,7 @@ unchanged ADDRESS if parsing fails."
        (push "├" tree-status)))
 
       (push (concat (if replies "┬" "─") "►") tree-status)
        (push "├" tree-status)))
 
       (push (concat (if replies "┬" "─") "►") tree-status)

+      (plist-put msg :first (and first (eq 0 depth)))

       (notmuch-pick-goto-and-insert-msg (plist-put msg :tree-status tree-status))
       (pop tree-status)
       (pop tree-status)
       (notmuch-pick-goto-and-insert-msg (plist-put msg :tree-status tree-status))
       (pop tree-status)
       (pop tree-status)


@@ -691,7 +791,7 @@ unchanged ADDRESS if parsing fails."
     (notmuch-pick-insert-thread replies (1+ depth) tree-status)))
 
 (defun notmuch-pick-insert-thread (thread depth tree-status)
     (notmuch-pick-insert-thread replies (1+ depth) tree-status)))
 
 (defun notmuch-pick-insert-thread (thread depth tree-status)

-  "Insert the thread THREAD at depth DEPTH >= 1 in the current forest."
+  "Insert the collection of sibling sub-threads THREAD at depth DEPTH in the current forest."

   (let ((n (length thread)))
     (loop for tree in thread
          for count from 1 to n
   (let ((n (length thread)))
     (loop for tree in thread
          for count from 1 to n


@@ -699,12 +799,17 @@ unchanged ADDRESS if parsing fails."
          do (notmuch-pick-insert-tree tree depth tree-status (eq count 1) (eq count n)))))
 
 (defun notmuch-pick-insert-forest-thread (forest-thread)
          do (notmuch-pick-insert-tree tree depth tree-status (eq count 1) (eq count n)))))
 
 (defun notmuch-pick-insert-forest-thread (forest-thread)

+  "Insert a single complete thread."

   (let (tree-status)
     ;; Reset at the start of each main thread.
     (setq notmuch-pick-previous-subject nil)
     (notmuch-pick-insert-thread forest-thread 0 tree-status)))
 
 (defun notmuch-pick-insert-forest (forest)
   (let (tree-status)
     ;; Reset at the start of each main thread.
     (setq notmuch-pick-previous-subject nil)
     (notmuch-pick-insert-thread forest-thread 0 tree-status)))
 
 (defun notmuch-pick-insert-forest (forest)

+  "Insert a forest of threads.
+
+This function inserts a collection of several complete threads as
+passed to it by notmuch-pick-process-filter."

   (mapc 'notmuch-pick-insert-forest-thread forest))
 
 (defun notmuch-pick-mode ()
   (mapc 'notmuch-pick-insert-forest-thread forest))
 
 (defun notmuch-pick-mode ()


@@ -723,6 +828,7 @@ Complete list of currently available key bindings:
 
   (interactive)
   (kill-all-local-variables)
 
   (interactive)
   (kill-all-local-variables)

+  (setq notmuch-buffer-refresh-function #'notmuch-pick-refresh-view)

   (use-local-map notmuch-pick-mode-map)
   (setq major-mode 'notmuch-pick-mode
        mode-name "notmuch-pick")
   (use-local-map notmuch-pick-mode-map)
   (setq major-mode 'notmuch-pick-mode
        mode-name "notmuch-pick")


@@ -752,15 +858,6 @@ Complete list of currently available key bindings:
                      (insert (format " (process returned %d)" exit-status)))
                    (insert "\n")))))))))
 
                      (insert (format " (process returned %d)" exit-status)))
                    (insert "\n")))))))))
 

-
-(defun notmuch-pick-show-error (string &rest objects)
-  (save-excursion
-    (goto-char (point-max))
-    (insert "Error: Unexpected output from notmuch search:\n")
-    (insert (apply #'format string objects))
-    (insert "\n")))
-
-

 (defun notmuch-pick-process-filter (proc string)
   "Process and filter the output of \"notmuch show\" (for pick)"
   (let ((results-buf (process-buffer proc))
 (defun notmuch-pick-process-filter (proc string)
   "Process and filter the output of \"notmuch show\" (for pick)"
   (let ((results-buf (process-buffer proc))


@@ -777,13 +874,17 @@ Complete list of currently available key bindings:
        (notmuch-sexp-parse-partial-list 'notmuch-pick-insert-forest-thread
                                         results-buf)))))
 
        (notmuch-sexp-parse-partial-list 'notmuch-pick-insert-forest-thread
                                         results-buf)))))
 

-(defun notmuch-pick-worker (basic-query &optional query-context target buffer)
+(defun notmuch-pick-worker (basic-query &optional query-context target open-target)
+  "Insert the actual pick search in the current buffer.
+
+This is is a helper function for notmuch-pick. The arguments are
+the same as for the function notmuch-pick."

   (interactive)
   (notmuch-pick-mode)
   (setq notmuch-pick-basic-query basic-query)
   (setq notmuch-pick-query-context query-context)
   (interactive)
   (notmuch-pick-mode)
   (setq notmuch-pick-basic-query basic-query)
   (setq notmuch-pick-query-context query-context)

-  (setq notmuch-pick-buffer-name (buffer-name buffer))

   (setq notmuch-pick-target-msg target)
   (setq notmuch-pick-target-msg target)

+  (setq notmuch-pick-open-target open-target)

 
   (erase-buffer)
   (goto-char (point-min))
 
   (erase-buffer)
   (goto-char (point-min))


@@ -793,31 +894,33 @@ Complete list of currently available key bindings:
         (message-arg "--entire-thread"))
     (if (equal (car (process-lines notmuch-command "count" search-args)) "0")
        (setq search-args basic-query))
         (message-arg "--entire-thread"))
     (if (equal (car (process-lines notmuch-command "count" search-args)) "0")
        (setq search-args basic-query))

-    (if notmuch-pick-asynchronous-parser
-       (let ((proc (start-process
-                    "notmuch-pick" buffer
-                    notmuch-command "show" "--body=false" "--format=sexp"
-                    message-arg search-args))
-             ;; Use a scratch buffer to accumulate partial output.
-              ;; This buffer will be killed by the sentinel, which
-              ;; should be called no matter how the process dies.
-              (parse-buf (generate-new-buffer " *notmuch pick parse*")))
-          (process-put proc 'parse-buf parse-buf)
-         (set-process-sentinel proc 'notmuch-pick-process-sentinel)
-         (set-process-filter proc 'notmuch-pick-process-filter)
-         (set-process-query-on-exit-flag proc nil))
-      (progn
-       (notmuch-pick-insert-forest
-        (notmuch-query-get-threads
-         (list "--body=false" message-arg search-args)))
-       (save-excursion
-         (goto-char (point-max))
-         (insert "End of search results.\n"))))))
-
-
-(defun notmuch-pick (&optional query query-context target buffer-name show-first-match)
-  "Run notmuch pick with the given `query' and display the results"
-  (interactive "sNotmuch pick: ")
+    (let ((proc (notmuch-start-notmuch
+                "notmuch-pick" (current-buffer) #'notmuch-pick-process-sentinel
+                "show" "--body=false" "--format=sexp"
+                message-arg search-args))
+         ;; Use a scratch buffer to accumulate partial output.
+         ;; This buffer will be killed by the sentinel, which
+         ;; should be called no matter how the process dies.
+         (parse-buf (generate-new-buffer " *notmuch pick parse*")))
+      (process-put proc 'parse-buf parse-buf)
+      (set-process-filter proc 'notmuch-pick-process-filter)
+      (set-process-query-on-exit-flag proc nil))))
+
+(defun notmuch-pick (&optional query query-context target buffer-name open-target)
+  "Run notmuch pick with the given `query' and display the results.
+
+The arguments are:
+  QUERY: the main query. This can be any query but in many cases will be
+      a single thread. If nil this is read interactively from the minibuffer.
+  QUERY-CONTEXT: is an additional term for the query. The query used
+      is QUERY and QUERY-CONTEXT unless that does not match any messages
+      in which case we fall back to just QUERY.
+  TARGET: A message ID (with the id: prefix) that will be made
+      current if it appears in the pick results.
+  BUFFER-NAME: the name of the buffer to show the pick tree. If
+      it is nil \"*notmuch-pick\" followed by QUERY is used.
+  OPEN-TARGET: If TRUE open the target message in the message pane."
+  (interactive)

   (if (null query)
       (setq query (notmuch-read-query "Notmuch pick: ")))
   (let ((buffer (get-buffer-create (generate-new-buffer-name
   (if (null query)
       (setq query (notmuch-read-query "Notmuch pick: ")))
   (let ((buffer (get-buffer-create (generate-new-buffer-name


@@ -825,25 +928,19 @@ Complete list of currently available key bindings:
                                        (concat "*notmuch-pick-" query "*")))))
        (inhibit-read-only t))
 
                                        (concat "*notmuch-pick-" query "*")))))
        (inhibit-read-only t))
 

-    (switch-to-buffer buffer)
-    ;; Don't track undo information for this buffer
-    (set 'buffer-undo-list t)
+    (switch-to-buffer buffer))
+  ;; Don't track undo information for this buffer
+  (set 'buffer-undo-list t)

 
 

-    (notmuch-pick-worker query query-context target buffer)
+  (notmuch-pick-worker query query-context target open-target)

 
 

-    (setq truncate-lines t)
-    (when show-first-match
-      (notmuch-pick-show-match-message-with-wait))))
+  (setq truncate-lines t))

 
 
 ;; Set up key bindings from the rest of notmuch.
 
 
 ;; Set up key bindings from the rest of notmuch.

-(define-key 'notmuch-search-mode-map "z" 'notmuch-pick)
-(define-key 'notmuch-search-mode-map "Z" 'notmuch-pick-from-search-current-query)
-(define-key 'notmuch-search-mode-map (kbd "M-RET") 'notmuch-pick-from-search-thread)
-(define-key 'notmuch-hello-mode-map "z" 'notmuch-pick-from-hello)
-(define-key 'notmuch-show-mode-map "z" 'notmuch-pick)
-(define-key 'notmuch-show-mode-map "Z" 'notmuch-pick-from-show-current-query)
-(notmuch-pick-setup-show-out)
+(define-key notmuch-common-keymap "z" 'notmuch-pick)
+(define-key notmuch-search-mode-map "Z" 'notmuch-pick-from-search-current-query)
+(define-key notmuch-show-mode-map "Z" 'notmuch-pick-from-show-current-query)

 (message "Initialised notmuch-pick")
 
 (provide 'notmuch-pick)
 (message "Initialised notmuch-pick")
 
 (provide 'notmuch-pick)