* [PATCH WIP v4 0/3] emacs: show: redesign unread/read logic
@ 2013-12-10 8:57 Mark Walters
2013-12-10 8:57 ` [PATCH WIP v4 1/3] emacs: show: mark tags changed since buffer loaded Mark Walters
` (2 more replies)
0 siblings, 3 replies; 4+ messages in thread
From: Mark Walters @ 2013-12-10 8:57 UTC (permalink / raw)
To: notmuch
This is v4 of this WIP set; v3 is at id:1386273871-24214-1-git-send-email-markwalters1009@gmail.com
This is still WIP: in particular lots of tests fail (for the obvious
reason that unread is being removed differently). I don't think it's
worth updating them until we have some consensus on how this should
work.
The main change from v3 is to make the added/deleted tag handling
cleaner, and to do something sensible on terminals (where
strike-through is not available). The cleaner handling means it is
easy for a user to revert to the current behaviour (deleted tags
immediately disappear). However, it is much more general and fits
neatly into the existing tag formatting framework.
This is all done in patch 1/3. (The patch is much smaller than it
looks: a large chunk of it is just code-movement). This patch is
independent of the later one; it does still break the tests as the
deleted "unread" tags are no longer removed just shown with
strike-through or inverse-video.
Patches 2 and 3 are unchanged from before. They implement the new
unread handling as described in the previous thread.
As with the earlier versions *all* feedback is gratefully received
including "I HATE IT" (though reasons are nice!)
Best wishes
Mark
Mark Walters (3):
emacs: show: mark tags changed since buffer loaded
emacs: show: add an update seen function to post-command-hook
emacs: show: make `seen' mean user viewed whole message
emacs/notmuch-show.el | 123 +++++++++++++++++++++++++++++++++++++++++--------
emacs/notmuch-tag.el | 105 ++++++++++++++++++++++++++++++------------
2 files changed, 178 insertions(+), 50 deletions(-)
--
1.7.9.1
^ permalink raw reply [flat|nested] 4+ messages in thread
* [PATCH WIP v4 1/3] emacs: show: mark tags changed since buffer loaded
2013-12-10 8:57 [PATCH WIP v4 0/3] emacs: show: redesign unread/read logic Mark Walters
@ 2013-12-10 8:57 ` Mark Walters
2013-12-10 8:57 ` [PATCH WIP v4 2/3] emacs: show: add an update seen function to post-command-hook Mark Walters
2013-12-10 8:57 ` [PATCH WIP v4 3/3] emacs: show: make `seen' mean user viewed whole message Mark Walters
2 siblings, 0 replies; 4+ messages in thread
From: Mark Walters @ 2013-12-10 8:57 UTC (permalink / raw)
To: notmuch
This shows any tags changed in the show buffer since it was loaded or
refreshed. By default a removed tag is displayed with strike-through
in red (if strike-through is not available, eg on a terminal, inverse
video is used instead) and an added tag is displayed underlined in
green.
One nice feature is that this makes it clear when a message was unread
when you first loaded the buffer (previously the unread tag could be
removed before a user realised that it had been unread).
The code adds into the existing tag formatting code. The user can
specify exactly how a tag should be displayed normally, when deleted,
or when added. For convenience an entry for the entry string in the
notmuch-tag-formats (and the corresponding notmuch-tag-deleted-formats
notmuch-tag-added-formats) is applied to all tags which do not have an
explicit match.
This means that a user can tell notmuch not to show deleted tags at
all by setting notmuch-tag-deleted-formats to
'(("" nil))
or not to show any deleted tags except "unread" by setting it to
'(("" nil)
("unread" (propertize tag 'face '(strike-through "red"))))
All the variables are customizable; however, more complicated cases
like changing the face depending on the type of display will require
custom lisp.
---
emacs/notmuch-show.el | 22 ++++++++--
emacs/notmuch-tag.el | 105 +++++++++++++++++++++++++++++++++++--------------
2 files changed, 92 insertions(+), 35 deletions(-)
diff --git a/emacs/notmuch-show.el b/emacs/notmuch-show.el
index 1ac80ca..30e84b1 100644
--- a/emacs/notmuch-show.el
+++ b/emacs/notmuch-show.el
@@ -341,11 +341,21 @@ operation on the contents of the current buffer."
"Update the displayed tags of the current message."
(save-excursion
(goto-char (notmuch-show-message-top))
- (if (re-search-forward "(\\([^()]*\\))$" (line-end-position) t)
- (let ((inhibit-read-only t))
- (replace-match (concat "("
- (notmuch-tag-format-tags tags)
- ")"))))))
+ (let* ((orig-tags (notmuch-show-get-prop :orig-tags))
+ (all-tags (sort (delete-dups (append tags orig-tags)) #'string<))
+ (display-tags (mapcar (lambda (tag) (cond ((and (member tag tags) (member tag orig-tags))
+ tag)
+ ((not (member tag tags))
+ (cons tag 'deleted))
+ ((not (member tag orig-tags))
+ (cons tag 'added))))
+ all-tags)))
+
+ (if (re-search-forward "(\\([^()]*\\))$" (line-end-position) t)
+ (let ((inhibit-read-only t))
+ (replace-match (concat "("
+ (notmuch-tag-format-tags display-tags)
+ ")")))))))
(defun notmuch-clean-address (address)
"Try to clean a single email ADDRESS for display. Return a cons
@@ -1167,6 +1177,8 @@ function is used."
(jit-lock-register #'notmuch-show-buttonise-links)
+ (notmuch-show-mapc (lambda () (notmuch-show-set-prop :orig-tags (notmuch-show-get-tags))))
+
;; Set the header line to the subject of the first message.
(setq header-line-format (notmuch-sanitize (notmuch-show-strip-re (notmuch-show-get-subject))))
diff --git a/emacs/notmuch-tag.el b/emacs/notmuch-tag.el
index b60f46c..81ce287 100644
--- a/emacs/notmuch-tag.el
+++ b/emacs/notmuch-tag.el
@@ -28,34 +28,8 @@
(require 'crm)
(require 'notmuch-lib)
-(defcustom notmuch-tag-formats
- '(("unread" (propertize tag 'face '(:foreground "red")))
- ("flagged" (propertize tag 'face '(:foreground "blue"))
- (notmuch-tag-format-image-data tag (notmuch-tag-star-icon))))
- "Custom formats for individual tags.
-
-This gives a list that maps from tag names to lists of formatting
-expressions. The car of each element gives a tag name and the
-cdr gives a list of Elisp expressions that modify the tag. If
-the list is empty, the tag will simply be hidden. Otherwise,
-each expression will be evaluated in order: for the first
-expression, the variable `tag' will be bound to the tag name; for
-each later expression, the variable `tag' will be bound to the
-result of the previous expression. In this way, each expression
-can build on the formatting performed by the previous expression.
-The result of the last expression will displayed in place of the
-tag.
-
-For example, to replace a tag with another string, simply use
-that string as a formatting expression. To change the foreground
-of a tag to red, use the expression
- (propertize tag 'face '(:foreground \"red\"))
-
-See also `notmuch-tag-format-image', which can help replace tags
-with images."
-
- :group 'notmuch-search
- :group 'notmuch-show
+(define-widget 'notmuch-tag-format-type 'lazy
+ "Customize widget for notmuch-tag-format and friends"
:type '(alist :key-type (string :tag "Tag")
:extra-offset -3
:value-type
@@ -82,6 +56,61 @@ with images."
(string :tag "Custom")))
(sexp :tag "Custom")))))
+(defcustom notmuch-tag-formats
+ '(("unread" (propertize tag 'face '(:foreground "red")))
+ ("flagged" (propertize tag 'face '(:foreground "blue"))
+ (notmuch-tag-format-image-data tag (notmuch-tag-star-icon))))
+ "Custom formats for individual tags.
+
+This gives a list that maps from tag names to lists of formatting
+expressions. The car of each element gives a tag name and the
+cdr gives a list of Elisp expressions that modify the tag. If the
+car is an empty string it matches all tags that do not have an
+explicit match. If the list is empty, the tag will simply be
+hidden. Otherwise, each expression will be evaluated in order:
+for the first expression, the variable `tag' will be bound to the
+tag name; for each later expression, the variable `tag' will be
+bound to the result of the previous expression. In this way,
+each expression can build on the formatting performed by the
+previous expression. The result of the last expression will
+displayed in place of the tag.
+
+For example, to replace a tag with another string, simply use
+that string as a formatting expression. To change the foreground
+of a tag to red, use the expression
+ (propertize tag 'face '(:foreground \"red\"))
+
+See also `notmuch-tag-format-image', which can help replace tags
+with images."
+ :group 'notmuch-search
+ :group 'notmuch-show
+ :type 'notmuch-tag-format-type)
+
+(defcustom notmuch-tag-deleted-formats
+ '(("" (propertize tag 'face
+ (if (display-supports-face-attributes-p '(:strike-through "red"))
+ '(:strike-through "red")
+ '(:inverse-video t)))))
+ "Custom formats for tags when deleted.
+
+By default this shows deleted tags with strike-through in red,
+unless strike-through is not available (e.g., emacs is running in
+a terminal) in which case it uses inverse video. To hide deleted
+tags completely set this to
+ '((\"\" nil))
+
+See `notmuch-tag-formats' for full documentation."
+ :group 'notmuch-show
+ :type 'notmuch-tag-format-type)
+
+(defcustom notmuch-tag-added-formats
+ '(("" (propertize tag 'face '(:underline "green"))))
+ "Custom formats for tags when added.
+
+See `notmuch-tag-formats' for full documentation."
+ :group 'notmuch-show
+ :type 'notmuch-tag-format-type)
+
(defun notmuch-tag-format-image-data (tag data)
"Replace TAG with image DATA, if available.
@@ -136,8 +165,24 @@ This can be used with `notmuch-tag-format-image-data'."
</svg>")
(defun notmuch-tag-format-tag (tag)
- "Format TAG by looking into `notmuch-tag-formats'."
- (let ((formats (assoc tag notmuch-tag-formats)))
+ "Format TAG by looking into `notmuch-tag-formats'.
+
+TAG can either be a string for a tag or a cons cell. In the
+latter case the car of the cons cell is the tag string, the cdr
+should be 'deleted or 'added to indicate whether the tag has been
+deleted or added. The format for tag is looked up in
+`notmuch-tag-formats' or `notmuch-tag-deleted-formats' or
+`notmuch-tag-added-formats' as appropriate."
+ (let* ((status (if (consp tag) (cdr tag)))
+ (tag (if (consp tag) (car tag) tag))
+ (status-formats (cond
+ ((eq status 'deleted)
+ notmuch-tag-deleted-formats)
+ ((eq status 'added)
+ notmuch-tag-added-formats)
+ (t notmuch-tag-formats)))
+ (formats (or (append (assoc tag status-formats))
+ (append (assoc "" status-formats)))))
(cond
((null formats) ;; - Tag not in `notmuch-tag-formats',
tag) ;; the format is the tag itself.
--
1.7.9.1
^ permalink raw reply related [flat|nested] 4+ messages in thread
* [PATCH WIP v4 2/3] emacs: show: add an update seen function to post-command-hook
2013-12-10 8:57 [PATCH WIP v4 0/3] emacs: show: redesign unread/read logic Mark Walters
2013-12-10 8:57 ` [PATCH WIP v4 1/3] emacs: show: mark tags changed since buffer loaded Mark Walters
@ 2013-12-10 8:57 ` Mark Walters
2013-12-10 8:57 ` [PATCH WIP v4 3/3] emacs: show: make `seen' mean user viewed whole message Mark Walters
2 siblings, 0 replies; 4+ messages in thread
From: Mark Walters @ 2013-12-10 8:57 UTC (permalink / raw)
To: notmuch
Add a function stub for updating seen messages to the
post-command-hook. This dummy function gets called with parameters the
start and end of the current window and can decide what to mark seen
based on that.
Since this is in the post-command-hook it should get called after most
user actions (exceptions include user resizing the window) so it
should be possible to make sure the seen status gets updated whether
the user uses notmuch commands like next-message or normal emacs
commands like scroll-up.
It also removes all of the old mark read/seen points to give a clean
slate for testing new mark read/seen algorithms.
---
emacs/notmuch-show.el | 32 +++++++++++++++++---------------
1 files changed, 17 insertions(+), 15 deletions(-)
diff --git a/emacs/notmuch-show.el b/emacs/notmuch-show.el
index 30e84b1..51366e9 100644
--- a/emacs/notmuch-show.el
+++ b/emacs/notmuch-show.el
@@ -1152,6 +1152,8 @@ function is used."
(let ((inhibit-read-only t))
(notmuch-show-mode)
+ (add-hook 'post-command-hook #'notmuch-show-command-hook nil t)
+
;; Don't track undo information for this buffer
(set 'buffer-undo-list t)
@@ -1539,6 +1541,16 @@ marked as unread, i.e. the tag changes in
(apply 'notmuch-show-tag-message
(notmuch-tag-change-list notmuch-show-mark-read-tags unread))))
+(defun notmuch-show-do-seen (start end)
+ "Update seen status for all messages between start and end."
+ )
+
+(defun notmuch-show-command-hook ()
+ (when (eq major-mode 'notmuch-show-mode)
+ ;; We need to redisplay to get window-start and window-end correct.
+ (redisplay)
+ (notmuch-show-do-seen (window-start) (window-end))))
+
;; Functions for getting attributes of several messages in the current
;; thread.
@@ -1674,9 +1686,7 @@ If a prefix argument is given and this is the last message in the
thread, navigate to the next thread in the parent search buffer."
(interactive "P")
(if (notmuch-show-goto-message-next)
- (progn
- (notmuch-show-mark-read)
- (notmuch-show-message-adjust))
+ (notmuch-show-message-adjust)
(if pop-at-end
(notmuch-show-next-thread)
(goto-char (point-max)))))
@@ -1687,7 +1697,6 @@ thread, navigate to the next thread in the parent search buffer."
(if (= (point) (notmuch-show-message-top))
(notmuch-show-goto-message-previous)
(notmuch-show-move-to-message-top))
- (notmuch-show-mark-read)
(notmuch-show-message-adjust))
(defun notmuch-show-next-open-message (&optional pop-at-end)
@@ -1702,9 +1711,7 @@ to show, nil otherwise."
(while (and (setq r (notmuch-show-goto-message-next))
(not (notmuch-show-message-visible-p))))
(if r
- (progn
- (notmuch-show-mark-read)
- (notmuch-show-message-adjust))
+ (notmuch-show-message-adjust)
(if pop-at-end
(notmuch-show-next-thread)
(goto-char (point-max))))
@@ -1717,9 +1724,7 @@ to show, nil otherwise."
(while (and (setq r (notmuch-show-goto-message-next))
(not (notmuch-show-get-prop :match))))
(if r
- (progn
- (notmuch-show-mark-read)
- (notmuch-show-message-adjust))
+ (notmuch-show-message-adjust)
(goto-char (point-max)))))
(defun notmuch-show-open-if-matched ()
@@ -1730,8 +1735,7 @@ to show, nil otherwise."
(defun notmuch-show-goto-first-wanted-message ()
"Move to the first open message and mark it read"
(goto-char (point-min))
- (if (notmuch-show-message-visible-p)
- (notmuch-show-mark-read)
+ (unless (notmuch-show-message-visible-p)
(notmuch-show-next-open-message))
(when (eobp)
;; There are no matched non-excluded messages so open all matched
@@ -1739,8 +1743,7 @@ to show, nil otherwise."
(notmuch-show-mapc 'notmuch-show-open-if-matched)
(force-window-update)
(goto-char (point-min))
- (if (notmuch-show-message-visible-p)
- (notmuch-show-mark-read)
+ (unless (notmuch-show-message-visible-p)
(notmuch-show-next-open-message))))
(defun notmuch-show-previous-open-message ()
@@ -1750,7 +1753,6 @@ to show, nil otherwise."
(notmuch-show-goto-message-previous)
(notmuch-show-move-to-message-top))
(not (notmuch-show-message-visible-p))))
- (notmuch-show-mark-read)
(notmuch-show-message-adjust))
(defun notmuch-show-view-raw-message ()
--
1.7.9.1
^ permalink raw reply related [flat|nested] 4+ messages in thread
* [PATCH WIP v4 3/3] emacs: show: make `seen' mean user viewed whole message
2013-12-10 8:57 [PATCH WIP v4 0/3] emacs: show: redesign unread/read logic Mark Walters
2013-12-10 8:57 ` [PATCH WIP v4 1/3] emacs: show: mark tags changed since buffer loaded Mark Walters
2013-12-10 8:57 ` [PATCH WIP v4 2/3] emacs: show: add an update seen function to post-command-hook Mark Walters
@ 2013-12-10 8:57 ` Mark Walters
2 siblings, 0 replies; 4+ messages in thread
From: Mark Walters @ 2013-12-10 8:57 UTC (permalink / raw)
To: notmuch
This changes `seen' to mean that the user viewed `enough' of the whole
message: more precisely, a message is deemed seen if the top of the
message and either the bottom of the message or a point at least some
customisable number of lines into the message have each been visible
in the buffer at some point.
This is placed into the post-command-hook infrastructure introudced in
the previous patch.
---
emacs/notmuch-show.el | 73 +++++++++++++++++++++++++++++++++++++++++++++++-
1 files changed, 71 insertions(+), 2 deletions(-)
diff --git a/emacs/notmuch-show.el b/emacs/notmuch-show.el
index 51366e9..4850bd0 100644
--- a/emacs/notmuch-show.el
+++ b/emacs/notmuch-show.el
@@ -211,6 +211,19 @@ For example, if you wanted to remove an \"unread\" tag and add a
:type '(repeat string)
:group 'notmuch-show)
+(defcustom notmuch-show-seen-lines-needed 0.75
+ "Control which messages get marked seen.
+
+A message is marked seen if both the top of the message and a
+point far \"enough\" down in the message have each been visible
+in the buffer at some point. This parameter controls the
+definition of enough. Seeing the bottom of message is always
+deemed enough, but additionally...it an integer n then at least n
+lines of message must be visible in the window. If it is a float
+x then at least that proportion of the window must contain the
+message."
+ :type 'number
+ :group 'notmuch-show)
(defmacro with-current-notmuch-show-message (&rest body)
"Evaluate body with current buffer set to the text of current message"
@@ -1541,9 +1554,65 @@ marked as unread, i.e. the tag changes in
(apply 'notmuch-show-tag-message
(notmuch-tag-change-list notmuch-show-mark-read-tags unread))))
+(defun notmuch-show-update-seen (top-or-bottom)
+ "Update seen status of current message
+
+Mark that we have seen the TOP-OR-BOTTOM of current message."
+ (let* ((current (notmuch-show-get-prop :seen-local))
+ new)
+ (unless (eq current 'both)
+ (if (eq top-or-bottom 'top)
+ (if (eq current 'bottom)
+ (setq new 'both)
+ (setq new 'top))
+ (if (eq current 'top)
+ (setq new 'both)
+ (setq new 'bottom)))
+ (unless (eq current new)
+ (notmuch-show-set-prop :seen-local new))
+ (when (eq new 'both)
+ (notmuch-show-mark-read)))))
+
+(defun notmuch-show-do-message-seen (start end)
+ "Update seen status for the current message.
+
+A message is seen if both the top and enough of the rest of the
+message have been visible in the buffer. Enough means either the
+bottom of the message or a point in the message more than
+LINES-NEEDED lines into the message. LINES-NEEDED is
+`notmuch-show-seen-lines-needed` if that is an integer and that
+times the current window height if it is a float."
+ (let* ((lines-needed (if (integerp notmuch-show-seen-lines-needed)
+ notmuch-show-seen-lines-needed
+ (truncate (* notmuch-show-seen-lines-needed (window-body-height)))))
+ (top (notmuch-show-message-top))
+ (bottom (notmuch-show-message-bottom)))
+ (when (notmuch-show-message-visible-p)
+ (when (>= top start)
+ (notmuch-show-update-seen 'top))
+ (when (or (<= bottom end)
+ (> (count-screen-lines top end) lines-needed))
+ (notmuch-show-update-seen 'bottom)))))
+
(defun notmuch-show-do-seen (start end)
- "Update seen status for all messages between start and end."
- )
+ "Update seen status for all messages between start and end.
+
+A message is seen if both the top and enough of the rest of the
+message have been visible in the buffer. See
+`notmuch-show-do-message-seen` for the definition of enough. Seen
+is a buffer local property. The unread status is removed from all
+seen messages when the user quits the show buffer."
+ (save-excursion
+ (goto-char start)
+ (while (and (or (notmuch-show-do-message-seen start end) t)
+ (< (notmuch-show-message-bottom) end)
+ (notmuch-show-goto-message-next)))
+
+ ;; This is a work around because emacs gives weird answers for
+ ;; window-end if the buffer ends with invisible text.
+ (when (and (pos-visible-in-window-p (point-max))
+ (notmuch-show-message-visible-p))
+ (notmuch-show-update-seen 'bottom))))
(defun notmuch-show-command-hook ()
(when (eq major-mode 'notmuch-show-mode)
--
1.7.9.1
^ permalink raw reply related [flat|nested] 4+ messages in thread
end of thread, other threads:[~2013-12-10 8:57 UTC | newest]
Thread overview: 4+ messages (download: mbox.gz follow: Atom feed
-- links below jump to the message on this page --
2013-12-10 8:57 [PATCH WIP v4 0/3] emacs: show: redesign unread/read logic Mark Walters
2013-12-10 8:57 ` [PATCH WIP v4 1/3] emacs: show: mark tags changed since buffer loaded Mark Walters
2013-12-10 8:57 ` [PATCH WIP v4 2/3] emacs: show: add an update seen function to post-command-hook Mark Walters
2013-12-10 8:57 ` [PATCH WIP v4 3/3] emacs: show: make `seen' mean user viewed whole message Mark Walters
Code repositories for project(s) associated with this public inbox
https://yhetil.org/notmuch.git/
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for read-only IMAP folder(s) and NNTP newsgroup(s).