(declare-function notmuch-show "notmuch-show" (&rest args))
(declare-function notmuch-tag "notmuch" (query &rest tags))
(declare-function notmuch-show-strip-re "notmuch-show" (subject))
-(declare-function notmuch-show-clean-address "notmuch-show" (parsed-address))
(declare-function notmuch-show-spaces-n "notmuch-show" (n))
(declare-function notmuch-read-query "notmuch" (prompt))
(declare-function notmuch-read-tag-changes "notmuch" (&optional initial-input &rest search-terms))
: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))
: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)
-;; 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)
-;; 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)
-(defvar notmuch-pick-buffer-name nil)
-(make-variable-buffer-local 'notmuch-pick-buffer-name)
-(defvar notmuch-pick-message-window 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-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)
-(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)))
(define-key map [mouse-1] 'notmuch-pick-show-message)
+ ;; 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 "m" (notmuch-pick-close-message-pane-and #'notmuch-mua-new-mail))
+ (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))
+ (define-key map "?" (notmuch-pick-close-message-pane-and #'notmuch-help))
+
+ ;; The main pick bindings
(define-key map "q" 'notmuch-pick-quit)
(define-key map "x" 'notmuch-pick-quit)
- (define-key map "?" 'notmuch-help)
- (define-key map "a" 'notmuch-pick-archive-message)
+ (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 "s" 'notmuch-search)
- (define-key map "z" 'notmuch-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 "s" 'notmuch-pick-to-search)
+ (define-key map "z" 'notmuch-pick-to-pick)
(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-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)
(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
(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-get-message-id ()
"Return the message id of the current message."
- (concat "id:\"" (notmuch-pick-get-prop :id) "\""))
+ (let ((id (notmuch-pick-get-prop :id)))
+ (if id
+ (notmuch-id-to-query id)
+ nil)))
(defun notmuch-pick-get-match ()
"Return whether the current message is a match."
(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)
- (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
(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 ()
(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)
(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.
(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)."
(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")))
- (setq notmuch-pick-message-buffer buffer)))
+ ;; 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 ()
"Show the current message (in whole window)."
(kill-buffer notmuch-pick-message-buffer))
t))
-(defun notmuch-pick-archive-message ()
+(defun notmuch-pick-archive-message (&optional unarchive)
+ "Archive the current message.
+
+Archive the current message by applying the tag changes in
+`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
+ (notmuch-tag-change-list notmuch-archive-tags unarchive))))
+
+(defun notmuch-pick-archive-message-then-next (&optional unarchive)
"Archive the current message and move to next matching message."
- (interactive)
- (notmuch-pick-tag "-inbox")
+ (interactive "P")
+ (notmuch-pick-archive-message unarchive)
(notmuch-pick-next-matching-message))
(defun notmuch-pick-next-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))
- (not (eq notmuch-pick-process-state 'end)))
- (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)
- (buffer-name notmuch-pick-buffer-name))
+ (target (notmuch-pick-get-message-id)))
(erase-buffer)
- (notmuch-pick-worker basic-query query-context (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 ))
+ (notmuch-pick-worker basic-query
+ query-context
+ 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-next-thread ()
+ (interactive)
+ (forward-line 1)
+ (while (not (or (notmuch-pick-get-prop :first) (eobp)))
+ (forward-line 1)))
-(defun notmuch-pick-reply-sender (&optional prompt-for-sender)
- "Reply to the sender of the current message."
+(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")
- (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)))))))
-
-;; Shamelessly stolen from notmuch-show.el: should be unified.
+ (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
+ "Try to clean a single email ADDRESS for display. Return
+AUTHOR_NAME if present, otherwise return AUTHOR_EMAIL. Return
unchanged ADDRESS if parsing fails."
- (condition-case nil
- (let (p-name p-address)
- ;; It would be convenient to use `mail-header-parse-address',
- ;; but that expects un-decoded mailbox parts, whereas our
- ;; mailbox parts are already decoded (and hence may contain
- ;; UTF-8). Given that notmuch should handle most of the awkward
- ;; cases, some simple string deconstruction should be sufficient
- ;; here.
- (cond
- ;; "User <user@dom.ain>" style.
- ((string-match "\\(.*\\) <\\(.*\\)>" address)
- (setq p-name (match-string 1 address)
- p-address (match-string 2 address)))
-
- ;; "<user@dom.ain>" style.
- ((string-match "<\\(.*\\)>" address)
- (setq p-address (match-string 1 address)))
-
- ;; Everything else.
- (t
- (setq p-address address)))
-
- (when p-name
- ;; Remove elements of the mailbox part that are not relevant for
- ;; display, even if they are required during transport:
- ;;
- ;; Backslashes.
- (setq p-name (replace-regexp-in-string "\\\\" "" p-name))
-
- ;; Outer single and double quotes, which might be nested.
- (loop
- with start-of-loop
- do (setq start-of-loop p-name)
-
- when (string-match "^\"\\(.*\\)\"$" p-name)
- do (setq p-name (match-string 1 p-name))
-
- when (string-match "^'\\(.*\\)'$" p-name)
- do (setq p-name (match-string 1 p-name))
-
- until (string= start-of-loop p-name)))
-
- ;; If the address is 'foo@bar.com <foo@bar.com>' then show just
- ;; 'foo@bar.com'.
- (when (string= p-name p-address)
- (setq p-name nil))
-
- ;; If we have a name return that otherwise return the address.
- (if (not p-name)
- p-address
- p-name))
- (error address)))
+ (let* ((clean-address (notmuch-clean-address address))
+ (p-address (car clean-address))
+ (p-name (cdr clean-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)
(let* ((headers (plist-get msg :headers))
(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."
+ "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)))
(push "├" tree-status)))
(push (concat (if replies "┬" "─") "►") tree-status)
- (notmuch-pick-insert-msg (plist-put msg :tree-status 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-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
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))))
+ "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)
+ "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 ()
(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")))
-
-
-(defvar notmuch-pick-json-parser nil
- "Incremental JSON parser for the search process filter.")
-
(defun notmuch-pick-process-filter (proc string)
"Process and filter the output of \"notmuch show\" (for pick)"
(let ((results-buf (process-buffer proc))
;; Insert new data
(save-excursion
(goto-char (point-max))
- (insert string)))
- (with-current-buffer results-buf
- (save-excursion
- (goto-char (point-max))
- (while (not done)
- (condition-case nil
- (case notmuch-pick-process-state
- ((begin)
- ;; Enter the results list
- (if (eq (notmuch-json-begin-compound
- notmuch-pick-json-parser) 'retry)
- (setq done t)
- (setq notmuch-pick-process-state 'result)))
- ((result)
- ;; Parse a result
- (let ((result (notmuch-json-read notmuch-pick-json-parser)))
- (case result
- ((retry) (setq done t))
- ((end) (setq notmuch-pick-process-state 'end))
- (otherwise (notmuch-pick-insert-forest-thread result)))))
- ((end)
- ;; Any trailing data is unexpected
- (with-current-buffer parse-buf
- (skip-chars-forward " \t\r\n")
- (if (eobp)
- (setq done t)
- (signal 'json-error nil)))))
- (json-error
- ;; Do our best to resynchronize and ensure forward
- ;; progress
- (notmuch-pick-show-error
- "%s"
- (with-current-buffer parse-buf
- (let ((bad (buffer-substring (line-beginning-position)
- (line-end-position))))
- (forward-line)
- bad))))))
- ;; Clear out what we've parsed
- (with-current-buffer parse-buf
- (delete-region (point-min) (point))))))))
-
-(defun notmuch-pick-worker (basic-query &optional query-context buffer)
+ (insert string))
+ (notmuch-sexp-parse-partial-list 'notmuch-pick-insert-forest-thread
+ results-buf)))))
+
+(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)
- (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))
(message-arg "--entire-thread"))
(if (equal (car (process-lines notmuch-command "count" search-args)) "0")
(setq search-args basic-query))
- (message "starting parser %s"
- (format-time-string "%r"))
- (if notmuch-pick-asynchronous-parser
- (let ((proc (start-process
- "notmuch-pick" buffer
- notmuch-command "show" "--body=false" "--format=json"
- 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*")))
- (set (make-local-variable 'notmuch-pick-process-state) 'begin)
- (set (make-local-variable 'notmuch-pick-json-parser)
- (notmuch-json-create-parser parse-buf))
- (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"))
- (message "sync parser finished %s"
- (format-time-string "%r"))))))
-
-
-(defun notmuch-pick (&optional query query-context buffer-name show-first-match)
- "Run notmuch pick with the given `query' and display the results"
+ (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 "sNotmuch pick: ")
(if (null query)
(setq query (notmuch-read-query "Notmuch pick: ")))
(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 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.
projects / notmuch / blobdiff