contrib: pick: if no target specified go to first matching message

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

diff --git a/contrib/notmuch-pick/notmuch-pick.el b/contrib/notmuch-pick/notmuch-pick.el
index 1a553d41314d23a26e2fbb6d1e60beb271b354e5..ef16ca75c6c1662115b6e207bb768cffdbc59f3d 100644 (file)
--- a/contrib/notmuch-pick/notmuch-pick.el
+++ b/contrib/notmuch-pick/notmuch-pick.el
@@ -155,8 +155,14 @@
 ;; The context of the search: i.e., useful but can be dropped.
 (defvar notmuch-pick-query-context nil)
 (make-variable-buffer-local 'notmuch-pick-query-context)
 ;; The context of the search: i.e., useful but can be dropped.
 (defvar notmuch-pick-query-context nil)
 (make-variable-buffer-local 'notmuch-pick-query-context)

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

 (defvar notmuch-pick-buffer-name nil)
 (make-variable-buffer-local 'notmuch-pick-buffer-name)
 (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)
 (make-variable-buffer-local 'notmuch-pick-message-window)
 (put 'notmuch-pick-message-window 'permanent-local t)
 (defvar notmuch-pick-message-window nil)
 (make-variable-buffer-local 'notmuch-pick-message-window)
 (put 'notmuch-pick-message-window 'permanent-local t)


@@ -175,8 +181,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)


@@ -276,7 +282,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 +295,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 +330,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,9 +348,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

+               nil

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

+(defun notmuch-pick-message-window-kill-hook ()
+  (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)."
   (interactive)
 (defun notmuch-pick-show-message ()
   "Show the current message (in split-pane)."
   (interactive)


@@ -338,10 +376,16 @@ Does NOT change the database."
            (split-window-vertically (/ (window-height) 4)))
       (with-selected-window notmuch-pick-message-window
        ;; Since we are only displaying one message do not indent.
            (split-window-vertically (/ (window-height) 4)))
       (with-selected-window notmuch-pick-message-window
        ;; Since we are only displaying one message do not indent.

-       (let ((notmuch-show-indent-messages-width 0))
-         (setq current-prefix-arg '(4))
+       (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 nil nil nil))))

-      (notmuch-pick-tag-update-display (list "-unread"))
+      ;; 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 ()


@@ -399,10 +443,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


@@ -468,9 +511,13 @@ 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))
     (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"


@@ -600,6 +647,19 @@ unchanged ADDRESS if parsing fails."
   (notmuch-pick-set-message-properties msg)
   (insert "\n"))
 
   (notmuch-pick-set-message-properties msg)
   (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))))
+

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


@@ -621,7 +681,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)
 


@@ -640,12 +700,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))


@@ -717,16 +775,16 @@ 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)

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

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


@@ -739,7 +797,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


@@ -758,7 +816,7 @@ 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)
+(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: ")
   (if (null query)
   "Run notmuch pick with the given `query' and display the results"
   (interactive "sNotmuch pick: ")
   (if (null query)


@@ -772,7 +830,7 @@ 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)

 
     (setq truncate-lines t)
     (when show-first-match
 
     (setq truncate-lines t)
     (when show-first-match