pick: contrib: document notmuch-pick-message-window-kill-hook

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

diff --git a/contrib/notmuch-pick/notmuch-pick.el b/contrib/notmuch-pick/notmuch-pick.el
index 9d3999bf0f0cc2ee7258e6f393791a21494fbb70..fd68fc65e236e57e5bc253f0d01b42e644d9f394 100644 (file)
--- a/contrib/notmuch-pick/notmuch-pick.el
+++ b/contrib/notmuch-pick/notmuch-pick.el
@@ -146,26 +146,46 @@
   :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-buffer-name 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)
+
+(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-buffer-name nil
+  "A buffer local copy of argument buffer-name to the function notmuch-pick")

 (make-variable-buffer-local 'notmuch-pick-buffer-name)
 (make-variable-buffer-local 'notmuch-pick-buffer-name)

-(defvar notmuch-pick-message-window nil)
+
+(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)

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


@@ -175,8 +195,8 @@
     (define-key map "?" 'notmuch-help)
     (define-key map "a" 'notmuch-pick-archive-message-then-next)
     (define-key map "=" 'notmuch-pick-refresh-view)
     (define-key map "?" 'notmuch-help)
     (define-key map "a" 'notmuch-pick-archive-message-then-next)
     (define-key map "=" 'notmuch-pick-refresh-view)

-    (define-key map "s" 'notmuch-search)
-    (define-key map "z" 'notmuch-pick)
+    (define-key map "s" 'notmuch-pick-to-search)
+    (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 "m" 'notmuch-pick-new-mail)
     (define-key map "f" 'notmuch-pick-forward-message)
     (define-key map "r" 'notmuch-pick-reply-sender)


@@ -194,6 +214,11 @@
 (fset 'notmuch-pick-mode-map notmuch-pick-mode-map)
 
 (defun notmuch-pick-setup-show-out ()
 (fset 'notmuch-pick-mode-map notmuch-pick-mode-map)
 
 (defun notmuch-pick-setup-show-out ()

+  "Set up the keymap for showing a thread
+
+This uses the value of the defcustom notmuch-pick-show-out to
+decide whether to show a message in the message pane or in the
+whole window."

   (let ((map notmuch-pick-mode-map))
     (if notmuch-pick-show-out
        (progn
   (let ((map notmuch-pick-mode-map))
     (if notmuch-pick-show-out
        (progn


@@ -251,13 +276,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


@@ -276,7 +313,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 ()


@@ -289,6 +326,25 @@ Does NOT change the database."
   (interactive)
   (notmuch-pick-tag "-"))
 
   (interactive)
   (notmuch-pick-tag "-"))
 

+;; The next two functions close the message window before searching or
+;; picking but they do so after the user has entered the query (in
+;; case the user was basing the query on something in the message
+;; window).
+
+(defun notmuch-pick-to-search ()
+  "Run \"notmuch search\" with the given `query' and display results."
+  (interactive)
+  (let ((query (notmuch-read-query "Notmuch search: ")))
+    (notmuch-pick-close-message-window)
+    (notmuch-search query)))
+
+(defun notmuch-pick-to-pick ()
+  "Run a query and display results in experimental notmuch-pick mode"
+  (interactive)
+  (let ((query (notmuch-read-query "Notmuch pick: ")))
+    (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)
 ;; 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)


@@ -305,7 +361,9 @@ Does NOT change the database."
 (defun notmuch-pick-from-show-current-query ()
   "Call notmuch pick with the current query"
   (interactive)
 (defun notmuch-pick-from-show-current-query ()
   "Call notmuch pick with the current query"
   (interactive)

-  (notmuch-pick notmuch-show-thread-id notmuch-show-query-context))
+  (notmuch-pick notmuch-show-thread-id
+               notmuch-show-query-context
+               (notmuch-show-get-message-id)))

 
 ;; This function should be in notmuch.el but be we trying to minimise
 ;; impact on the rest of the codebase.
 
 ;; This function should be in notmuch.el but be we trying to minimise
 ;; impact on the rest of the codebase.


@@ -321,8 +379,20 @@ Does NOT change the database."
   (interactive)
   (notmuch-pick (notmuch-search-find-thread-id)
                 notmuch-search-query-string
   (interactive)
   (notmuch-pick (notmuch-search-find-thread-id)
                 notmuch-search-query-string

-                (notmuch-prettify-subject (notmuch-search-find-subject)))
-  (notmuch-pick-show-match-message-with-wait))
+               nil
+                (notmuch-prettify-subject (notmuch-search-find-subject))
+               t))
+
+(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))
+      ;; We do not want an error if this is the sole window in the
+      ;; frame and I do not know how to test for that in emacs pre
+      ;; 24. Hence we just ignore-errors.
+      (ignore-errors
+       (delete-window notmuch-pick-message-window)))))

 
 (defun notmuch-pick-show-message ()
   "Show the current message (in split-pane)."
 
 (defun notmuch-pick-show-message ()
   "Show the current message (in split-pane)."


@@ -337,9 +407,17 @@ Does NOT change the database."
       (setq notmuch-pick-message-window
            (split-window-vertically (/ (window-height) 4)))
       (with-selected-window notmuch-pick-message-window
       (setq notmuch-pick-message-window
            (split-window-vertically (/ (window-height) 4)))
       (with-selected-window notmuch-pick-message-window

-       (setq current-prefix-arg '(4))
-       (setq buffer (notmuch-show id nil nil nil)))
-      (notmuch-pick-tag-update-display (list "-unread"))
+       ;; 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))))
+      ;; We need the `let' as notmuch-pick-message-window is buffer local.
+      (let ((window notmuch-pick-message-window))
+       (with-current-buffer buffer
+         (setq notmuch-pick-message-window window)
+         (add-hook 'kill-buffer-hook 'notmuch-pick-message-window-kill-hook)))
+      (when notmuch-show-mark-read-tags
+       (notmuch-pick-tag-update-display notmuch-show-mark-read-tags))

       (setq notmuch-pick-message-buffer buffer))))
 
 (defun notmuch-pick-show-message-out ()
       (setq notmuch-pick-message-buffer buffer))))
 
 (defun notmuch-pick-show-message-out ()


@@ -397,10 +475,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


@@ -444,31 +521,19 @@ will be reversed."
   (when (window-live-p notmuch-pick-message-window)
     (notmuch-pick-show-message)))
 
   (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)))
-

 (defun notmuch-pick-refresh-view ()
   "Refresh view."
   (interactive)
   (let ((inhibit-read-only t)
        (basic-query notmuch-pick-basic-query)
        (query-context notmuch-pick-query-context)
 (defun notmuch-pick-refresh-view ()
   "Refresh view."
   (interactive)
   (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))
     (erase-buffer)
        (buffer-name notmuch-pick-buffer-name))
     (erase-buffer)

-    (notmuch-pick-worker basic-query query-context (get-buffer buffer-name))))
+    (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"
 
 (defmacro with-current-notmuch-pick-message (&rest body)
   "Evaluate body with current buffer set to the text of current message"


@@ -593,10 +658,29 @@ unchanged ADDRESS if parsing fails."
 
 (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))
+    (dolist (spec notmuch-pick-result-format)
+      (notmuch-pick-insert-field (car spec) (cdr spec) 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))
+  (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))
+      (forward-line -1)
+      (when notmuch-pick-open-target
+       (notmuch-pick-show-message)))))

 
 (defun notmuch-pick-insert-tree (tree depth tree-status first last)
   "Insert the message tree TREE at depth DEPTH in the current thread."
 
 (defun notmuch-pick-insert-tree (tree depth tree-status first last)
   "Insert the message tree TREE at depth DEPTH in the current thread."


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

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

       (pop tree-status)
       (pop tree-status)
 
       (pop tree-status)
       (pop tree-status)
 


@@ -638,12 +722,10 @@ 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)

-  (save-excursion
-    (goto-char (point-max))
-    (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))))
+  (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)
   (mapc 'notmuch-pick-insert-forest-thread forest))
 
 (defun notmuch-pick-insert-forest (forest)
   (mapc 'notmuch-pick-insert-forest-thread forest))


@@ -693,15 +775,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))


@@ -715,16 +788,17 @@ Complete list of currently available key bindings:
         (save-excursion
           (goto-char (point-max))
           (insert string))
         (save-excursion
           (goto-char (point-max))
           (insert string))

-       (notmuch-json-parse-partial-list 'notmuch-pick-insert-forest-thread
-                                        'notmuch-pick-show-error
+       (notmuch-sexp-parse-partial-list 'notmuch-pick-insert-forest-thread

                                         results-buf)))))
 
                                         results-buf)))))
 

-(defun notmuch-pick-worker (basic-query &optional query-context buffer)
+(defun notmuch-pick-worker (basic-query &optional query-context target buffer open-target)

   (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))
   (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-open-target open-target)

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


@@ -737,7 +811,7 @@ Complete list of currently available key bindings:
     (if notmuch-pick-asynchronous-parser
        (let ((proc (start-process
                     "notmuch-pick" buffer
     (if notmuch-pick-asynchronous-parser
        (let ((proc (start-process
                     "notmuch-pick" buffer

-                    notmuch-command "show" "--body=false" "--format=json"
+                    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
                     message-arg search-args))
              ;; Use a scratch buffer to accumulate partial output.
               ;; This buffer will be killed by the sentinel, which


@@ -756,8 +830,20 @@ Complete list of currently available key bindings:
          (insert "End of search results.\n"))))))
 
 
          (insert "End of search results.\n"))))))
 
 

-(defun notmuch-pick (&optional query query-context buffer-name show-first-match)
-  "Run notmuch pick with the given `query' and display the results"
+(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 "sNotmuch pick: ")
   (if (null query)
       (setq query (notmuch-read-query "Notmuch pick: ")))
   (interactive "sNotmuch pick: ")
   (if (null query)
       (setq query (notmuch-read-query "Notmuch pick: ")))


@@ -770,11 +856,9 @@ Complete list of currently available key bindings:
     ;; Don't track undo information for this buffer
     (set 'buffer-undo-list t)
 
     ;; Don't track undo information for this buffer
     (set 'buffer-undo-list t)
 

-    (notmuch-pick-worker query query-context buffer)
+    (notmuch-pick-worker query query-context target buffer 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.