X-Git-Url: https://git.notmuchmail.org/git?a=blobdiff_plain;ds=sidebyside;f=notmuch.el;h=747f60c4dad7c0cddce7bd2ff33801eefa527e49;hb=9a02b950a35a159a3b86ed052c8f1a1349c7bb72;hp=989450a697e946cdb2e0f92fb1c8ca1f32fd917f;hpb=c4ea149a9bc3a0a49d58e956cf35a96210f4ad1e;p=notmuch

diff --git a/notmuch.el b/notmuch.el
index 989450a6..747f60c4 100644
--- a/notmuch.el
+++ b/notmuch.el
@@ -39,6 +39,7 @@
     (define-key map "x" 'kill-this-buffer)
     (define-key map "+" 'notmuch-show-add-tag)
     (define-key map "-" 'notmuch-show-remove-tag)
+    (define-key map " " 'notmuch-show-advance-marking-read-and-archiving)
     map)
   "Keymap for \"notmuch show\" buffers.")
 (fset 'notmuch-show-mode-map notmuch-show-mode-map)
@@ -94,8 +95,11 @@
 
 (defun notmuch-show-remove-tag (tag)
   (interactive "sTag to remove: ")
-  (notmuch-call-notmuch-process "tag" (concat "-" tag) (concat "id:" (notmuch-show-get-message-id)))
-  (notmuch-show-set-tags (delete tag (notmuch-show-get-tags))))
+  (let ((tags (notmuch-show-get-tags)))
+    (if (member tag tags)
+	(progn
+	  (notmuch-call-notmuch-process "tag" (concat "-" tag) (concat "id:" (notmuch-show-get-message-id)))
+	  (notmuch-show-set-tags (delete tag tags))))))
 
 (defun notmuch-show-archive-thread ()
   "Archive each message currrently shown by removing the \"inbox\" tag from each.
@@ -114,61 +118,107 @@ buffer."
       (if (not (re-search-forward notmuch-show-message-begin-regexp nil t))
 	  (goto-char (point-max))))))
 
+(defun notmuch-show-move-to-current-message-summary-line ()
+  "Move to the beginning of the one-line summary of the current message.
+
+This gives us a stable place to move to and work from since the
+summary line is always visible. This is important since moving to
+an invisible location is unreliable, (the main command loop moves
+point either forward or backward to the next visible character
+when a command ends with point on an invisible character).
+
+Emits an error if point is not within a valid message, (that is
+not pattern of `notmuch-show-message-begin-regexp' could be found
+by searching backward)."
+  (beginning-of-line)
+  (if (not (looking-at notmuch-show-message-begin-regexp))
+      (if (re-search-backward notmuch-show-message-begin-regexp nil t)
+	  (forward-line 2)
+	(error "Not within a valid message."))
+    (forward-line 2)))
+
 (defun notmuch-show-next-message ()
-  "Advance point to the beginning of the next message in the buffer.
+  "Advance to the beginning of the next message in the buffer.
 
-Does nothing if already on the last message."
+Moves to the beginning of the current message if already on the
+last message in the buffer."
   (interactive)
-  ; First, ensure we get off the current message marker
-  (if (not (eobp))
-      (forward-char))
+  (notmuch-show-move-to-current-message-summary-line)
   (re-search-forward notmuch-show-message-begin-regexp nil t)
-  ; This dance might look pointless, but it's important. I originally
-  ; just had (beginning-of-line) here which looked right on the
-  ; display but actually put point all the way back to the first
-  ; character of the first invisible line. That is, it put point into
-  ; the closing markers of the previous message rather than at the
-  ; beginning of the current message. And that in turn meant that
-  ; looking up the current message-ID would actually return the
-  ; previous message ID.
-  ;
-  ; So this dance ensures that we're actually on the current message
-  ; when it looks like we are.
-  (end-of-visible-line)
-  (beginning-of-line)
+  (notmuch-show-move-to-current-message-summary-line)
   (recenter 0))
 
+(defun notmuch-show-find-next-message ()
+  "Returns the position of the next message in the buffer.
+
+Or the beginning of the current message if already within the last
+message in the buffer."
+  ; save-excursion doesn't save our window position
+  ; save-window-excursion doesn't save point
+  ; Looks like we have to use both.
+  (save-excursion
+    (save-window-excursion
+      (notmuch-show-next-message)
+      (point))))
+
 (defun notmuch-show-previous-message ()
   "Backup to the beginning of the previous message in the buffer.
 
-Does nothing if already on the first message in the buffer."
+If within a message rather than at the beginning of it, then
+simply move to the beginning of the current message."
   (interactive)
-  ; First, ensure we get off the current message marker
-  (if (not (bobp))
-      (previous-line))
-  (re-search-backward notmuch-show-message-begin-regexp nil t)
-  ; This dance might look pointless, but it's important. I originally
-  ; just had (beginning-of-line) here which looked right on the
-  ; display but actually put point all the way back to the first
-  ; character of the first invisible line. That is, it put point into
-  ; the closing markers of the previous message rather than at the
-  ; beginning of the current message. And that in turn meant that
-  ; looking up the current message-ID would actually return the
-  ; previous message ID.
-  ;
-  ; So this dance ensures that we're actually on the current message
-  ; when it looks like we are.
-  (end-of-visible-line)
-  (beginning-of-line)
-  (recenter 0))
+  (let ((start (point)))
+    (notmuch-show-move-to-current-message-summary-line)
+    (if (not (< (point) start))
+	; Go backward twice to skip the current message's marker
+	(progn
+	  (re-search-backward notmuch-show-message-begin-regexp nil t)
+	  (re-search-backward notmuch-show-message-begin-regexp nil t)
+	  (notmuch-show-move-to-current-message-summary-line)
+	  ))
+    (recenter 0)))
 
 (defun notmuch-show-mark-read-then-next-message ()
-  "Remove uread tag from current message, then advance to next message."
+  "Remove unread tag from current message, then advance to next message."
   (interactive)
-  (if (member "unread" (notmuch-show-get-tags))
-      (notmuch-show-remove-tag "unread"))
+  (notmuch-show-remove-tag "unread")
   (notmuch-show-next-message))
 
+(defun notmuch-show-advance-marking-read-and-archiving ()
+  "Advance through buffer, marking read and archiving.
+
+This command is intended to be one of the simplest ways to
+process a thread of email. It does the following:
+
+If the current message in the thread is not yet fully visible,
+scroll by a near screenful to read more of the message.
+
+Otherwise, (the end of the current message is already within the
+current window), remove the \"unread\" tag from the current
+message and advance to the next message.
+
+Finally, if there is no further message to advance to, and this
+last message is already read, then archive the entire current
+thread, (remove the \"inbox\" tag from each message). Also kill
+this buffer, and display the next thread from the search from
+which this thread was originally shown."
+  (interactive)
+  (let ((next (notmuch-show-find-next-message))
+	(unread (member "unread" (notmuch-show-get-tags))))
+    (if (and (not unread)
+	     (equal next (point)))
+	(progn
+	  (notmuch-show-archive-thread)
+	  (let ((parent-buffer notmuch-show-parent-buffer))
+	    (kill-this-buffer)
+	    (if parent-buffer
+		(progn
+		  (switch-to-buffer parent-buffer)
+		  (notmuch-search-show-thread)))))
+      (if (< (notmuch-show-find-next-message) (window-end))
+	  (notmuch-show-mark-read-then-next-message)
+	(scroll-up nil)))))
+
 (defun notmuch-show-markup-citations-region (beg end)
   (goto-char beg)
   (beginning-of-line)
@@ -199,10 +249,10 @@ Does nothing if already on the first message in the buffer."
   (let ((beg (point)))
     (re-search-forward notmuch-show-body-end-regexp)
     (let ((end (match-beginning 0)))
+      (notmuch-show-markup-citations-region beg end)
       (if (not (member "unread" (notmuch-show-get-tags)))
 	  (overlay-put (make-overlay beg end)
-		       'invisible 'notmuch-show-body-read))
-      (notmuch-show-markup-citations-region beg end))))
+		       'invisible 'notmuch-show-body-read)))))
 
 (defun notmuch-show-markup-header ()
   (re-search-forward notmuch-show-header-begin-regexp)
@@ -283,7 +333,30 @@ Does nothing if already on the first message in the buffer."
 
 ;;;###autoload
 (defun notmuch-show-mode ()
-  "Major mode for handling the output of \"notmuch show\""
+  "Major mode for viewing a thread with notmuch.
+
+This buffer contains the results of the \"notmuch show\" command
+for displaying a single thread of email from your email archives.
+
+By default, various components of email messages, (citations,
+signatures, already-read messages), are invisible to help you
+focus on the most important things, (new text from unread
+messages). See the various commands below for toggling the
+visibility of hidden components.
+
+The `notmuch-show-next-message' and
+`notmuch-show-previous-message' commands, (bound to 'n' and 'p by
+default), allow you to navigate to the next and previous
+messages. Each time you navigate away from a message with
+`notmuch-show-next-message' the current message will have its
+\"unread\" tag removed.
+
+You can add or remove tags from the current message with '+' and
+'-'.  You can also archive all messages in the current
+view, (remove the \"inbox\" tag from each), with
+`notmuch-show-archive-thread' (bound to 'a' by default).
+
+\\{notmuch-show-mode-map}"
   (interactive)
   (kill-all-local-variables)
   (set (make-local-variable 'notmuch-show-headers-visible) t)
@@ -300,12 +373,17 @@ Does nothing if already on the first message in the buffer."
 	mode-name "notmuch-show")
   (setq buffer-read-only t))
 
-(defun notmuch-show (thread-id)
-  "Run \"notmuch show\" with the given thread ID and display results."
+(defun notmuch-show (thread-id &optional parent-buffer)
+  "Run \"notmuch show\" with the given thread ID and display results.
+
+The optional PARENT-BUFFER is the notmuch-search buffer from
+which this notmuch-show command was executed, (so that the next
+thread from that buffer can be show when done with this one)."
   (interactive "sNotmuch show: ")
   (let ((buffer (get-buffer-create (concat "*notmuch-show-" thread-id "*"))))
     (switch-to-buffer buffer)
     (notmuch-show-mode)
+    (set (make-local-variable 'notmuch-show-parent-buffer) parent-buffer)
     (let ((proc (get-buffer-process (current-buffer)))
 	  (inhibit-read-only t))
       (if proc
@@ -330,7 +408,7 @@ Does nothing if already on the first message in the buffer."
     (define-key map "s" 'notmuch-search)
     (define-key map "t" 'notmuch-search-filter-by-tag)
     (define-key map "x" 'kill-this-buffer)
-    (define-key map "\r" 'notmuch-search-show-thread)
+    (define-key map (kbd "RET") 'notmuch-search-show-thread)
     (define-key map "+" 'notmuch-search-add-tag)
     (define-key map "-" 'notmuch-search-remove-tag)
     (define-key map "<" 'beginning-of-buffer)
@@ -351,7 +429,24 @@ Does nothing if already on the first message in the buffer."
 
 ;;;###autoload
 (defun notmuch-search-mode ()
-  "Major mode for handling the output of \"notmuch search\""
+  "Major mode for searching mail with notmuch.
+
+This buffer contains the results of a \"notmuch search\" of your
+email archives. Each line in the buffer represents a single
+thread giving a relative date for the thread and a subject.
+
+Pressing RET on any line displays that thread. The '+' and '-'
+keys can be used to add or remove tags from a thread. The 'a' key
+is a convenience key for archiving a thread (removing the
+\"inbox\" tag).
+
+Other useful commands are `notmuch-search-filter' for filtering
+the current search based on an additional query string,
+`notmuch-search-filter-by-tag' for filtering to include only
+messages with a given tag, and `notmuch-search' to execute a new,
+global search.
+
+\\{notmuch-search-mode-map}"
   (interactive)
   (kill-all-local-variables)
   (make-local-variable 'notmuch-search-query-string)
@@ -397,7 +492,9 @@ Does nothing if already on the first message in the buffer."
 
 (defun notmuch-search-show-thread ()
   (interactive)
-  (notmuch-show (notmuch-search-find-thread-id)))
+  (let ((thread-id (notmuch-search-find-thread-id)))
+    (forward-line)
+    (notmuch-show thread-id (current-buffer))))
 
 (defun notmuch-call-notmuch-process (&rest args)
   (let ((error-buffer (get-buffer-create "*Notmuch errors*")))
@@ -445,8 +542,12 @@ Does nothing if already on the first message in the buffer."
   (notmuch-search-set-tags (delete tag (notmuch-search-get-tags))))
 
 (defun notmuch-search-archive-thread ()
+  "Archive the current thread (remove its \"inbox\" tag).
+
+This function advances point to the next line when finished."
   (interactive)
-  (notmuch-search-remove-tag "inbox"))
+  (notmuch-search-remove-tag "inbox")
+  (forward-line))
 
 (defun notmuch-search (query)
   "Run \"notmuch search\" with the given query string and display results."