From 8c14c0a5fb52694241a2bf55a442530cda901640 Mon Sep 17 00:00:00 2001 From: Mark Walters Date: Fri, 14 Feb 2014 09:15:16 +0000 Subject: [PATCH] [WIP Patch 4/7] emacs: show: mark tags changed since buffer loaded --- f1/bdc3a570df58f24f09c45b0cfe5508d4043c0e | 268 ++++++++++++++++++++++ 1 file changed, 268 insertions(+) create mode 100644 f1/bdc3a570df58f24f09c45b0cfe5508d4043c0e diff --git a/f1/bdc3a570df58f24f09c45b0cfe5508d4043c0e b/f1/bdc3a570df58f24f09c45b0cfe5508d4043c0e new file mode 100644 index 000000000..ef952bf52 --- /dev/null +++ b/f1/bdc3a570df58f24f09c45b0cfe5508d4043c0e @@ -0,0 +1,268 @@ +Return-Path: +X-Original-To: notmuch@notmuchmail.org +Delivered-To: notmuch@notmuchmail.org +Received: from localhost (localhost [127.0.0.1]) + by olra.theworths.org (Postfix) with ESMTP id 237FD431FD5 + for ; Fri, 14 Feb 2014 01:15:47 -0800 (PST) +X-Virus-Scanned: Debian amavisd-new at olra.theworths.org +X-Spam-Flag: NO +X-Spam-Score: 0.201 +X-Spam-Level: +X-Spam-Status: No, score=0.201 tagged_above=-999 required=5 + tests=[DKIM_SIGNED=0.1, DKIM_VALID=-0.1, DKIM_VALID_AU=-0.1, + FREEMAIL_ENVFROM_END_DIGIT=1, FREEMAIL_FROM=0.001, + RCVD_IN_DNSWL_LOW=-0.7] autolearn=disabled +Received: from olra.theworths.org ([127.0.0.1]) + by localhost (olra.theworths.org [127.0.0.1]) (amavisd-new, port 10024) + with ESMTP id 9XifGe3FhPLb for ; + Fri, 14 Feb 2014 01:15:39 -0800 (PST) +Received: from mail-we0-f171.google.com (mail-we0-f171.google.com + [74.125.82.171]) (using TLSv1 with cipher RC4-SHA (128/128 bits)) + (No client certificate requested) + by olra.theworths.org (Postfix) with ESMTPS id E1D51431FC0 + for ; Fri, 14 Feb 2014 01:15:33 -0800 (PST) +Received: by mail-we0-f171.google.com with SMTP id u56so8609814wes.16 + for ; Fri, 14 Feb 2014 01:15:32 -0800 (PST) +DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20120113; + h=from:to:cc:subject:date:message-id:in-reply-to:references; + bh=ZiUTQHXlTIz68ac3ytpCHHMj12hwMZv0MixshL9ukpo=; + b=lCYHcTv1fCIoQGtZsWPmn7kSy/Qhc/EQdIPuRLG8b7j250qZVCJU74Nd/VcNRwvW9F + lXB8QVX2HpxHhayO28/vgzd/aI4kW6C96ACuBoo+BcupG3IkKTjOXmXE3Bt4b27/kNvK + vTGKjUkKy5Wi6ek9k1LFJsjln3DEU1VJNwwFtTHiQ9mspNcll/QdPpUWw4df0YOnPz31 + 86XqWAjReUD3UmEkoCp30kwEhJ035nCAU9mW5v8s8a4WqeZbZs29hBePjEozIuSJrAD8 + yq/K3/E9jFbZGoQLrOBvxLsO6ujfU7zG+LKBujFxgGGvVu56NTwDPlQkHS5FYzXIyc3L + ibXQ== +X-Received: by 10.180.38.41 with SMTP id d9mr1246381wik.9.1392369332739; + Fri, 14 Feb 2014 01:15:32 -0800 (PST) +Received: from localhost (93-97-24-31.zone5.bethere.co.uk. [93.97.24.31]) + by mx.google.com with ESMTPSA id dd3sm11127826wjb.9.2014.02.14.01.15.31 + for + (version=TLSv1.2 cipher=RC4-SHA bits=128/128); + Fri, 14 Feb 2014 01:15:32 -0800 (PST) +From: Mark Walters +To: notmuch@notmuchmail.org, + Austin Clements +Subject: [WIP Patch 4/7] emacs: show: mark tags changed since buffer loaded +Date: Fri, 14 Feb 2014 09:15:16 +0000 +Message-Id: <1392369319-24508-5-git-send-email-markwalters1009@gmail.com> +X-Mailer: git-send-email 1.7.9.1 +In-Reply-To: <1392369319-24508-1-git-send-email-markwalters1009@gmail.com> +References: <1392369319-24508-1-git-send-email-markwalters1009@gmail.com> +X-BeenThere: notmuch@notmuchmail.org +X-Mailman-Version: 2.1.13 +Precedence: list +List-Id: "Use and development of the notmuch mail system." + +List-Unsubscribe: , + +List-Archive: +List-Post: +List-Help: +List-Subscribe: , + +X-List-Received-Date: Fri, 14 Feb 2014 09:15:47 -0000 + +This allows (and requires) the original-tags to be passed along with +the current-tags to be passed to notmuch-tag-format-tags. This allows +the tag formatting to show added and deleted tags.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. + +If the caller does not wish to use the new feature it can pass +current-tags for both arguments and, at this point, we do exactly that +in the three callers of this function. + +Note, we cannot tidily allow original-tags to be optional because we would +need to distinguish nil meaning "we are not specifying original-tags" +from nil meaning there were no original-tags (an empty list). + +We use this in subsequent patches to make it clear when a message was +unread when you first loaded a show 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 empty 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. + +Currently this overrides notmuch-tag-deleted-formats for the tests +setting it to '(("" nil)) so that they get removed from the display +and, thus, all tests still pass. +--- + emacs/notmuch-show.el | 4 +- + emacs/notmuch-tag.el | 65 ++++++++++++++++++++++++++++++++++++++---------- + emacs/notmuch-tree.el | 2 +- + emacs/notmuch.el | 2 +- + test/test-lib.el | 5 ++++ + 5 files changed, 60 insertions(+), 18 deletions(-) + +diff --git a/emacs/notmuch-show.el b/emacs/notmuch-show.el +index 1ac80ca..1ce56f9 100644 +--- a/emacs/notmuch-show.el ++++ b/emacs/notmuch-show.el +@@ -344,7 +344,7 @@ operation on the contents of the current buffer." + (if (re-search-forward "(\\([^()]*\\))$" (line-end-position) t) + (let ((inhibit-read-only t)) + (replace-match (concat "(" +- (notmuch-tag-format-tags tags) ++ (notmuch-tag-format-tags tags tags) + ")")))))) + + (defun notmuch-clean-address (address) +@@ -423,7 +423,7 @@ message at DEPTH in the current thread." + " (" + date + ") (" +- (notmuch-tag-format-tags tags) ++ (notmuch-tag-format-tags tags tags) + ")\n") + (overlay-put (make-overlay start (point)) 'face 'notmuch-message-summary-face))) + +diff --git a/emacs/notmuch-tag.el b/emacs/notmuch-tag.el +index add60a3..812a0f4 100644 +--- a/emacs/notmuch-tag.el ++++ b/emacs/notmuch-tag.el +@@ -192,36 +192,73 @@ This can be used with `notmuch-tag-format-image-data'." + + ") + +-(defun notmuch-tag-format-tag (tag) +- "Format TAG by looking into `notmuch-tag-formats'." +- (let ((formatted (gethash tag notmuch-tag--format-cache 'missing))) ++(defun notmuch-tag-format-tag-by-state (tag formatted-tag tag-state) ++ "Format TAG by looking into the appropriate `notmuch-tag-formats`. ++ ++Applies formats for TAG from the appropriate one of ++`notmuch-tag-formats`, `notmuch-tag-deleted-formats` and ++`notmuch-tag-added-formats` based on TAG-STATE to the partially ++formatted tag FORMATTED-TAG." ++ (let ((formatted (gethash (cons tag tag-state) notmuch-tag--format-cache 'missing))) + (when (eq formatted 'missing) +- (let* ((formats ++ (let* ((tag-formats (cond ((null tag-state) notmuch-tag-formats) ++ ((eq 'deleted tag-state) notmuch-tag-deleted-formats) ++ ((eq 'added tag-state) notmuch-tag-added-formats))) ++ (formats + (save-match-data +- (assoc* tag notmuch-tag-formats ++ (assoc* tag tag-formats + :test (lambda (tag key) + (and (eq (string-match key tag) 0) + (= (match-end 0) (length tag)))))))) + (setq formatted + (cond +- ((null formats) ;; - Tag not in `notmuch-tag-formats', +- tag) ;; the format is the tag itself. ++ ((null formats) ;; - Tag not in `tag-formats', ++ formatted-tag) ;; the format is the tag itself. + ((null (cdr formats)) ;; - Tag was deliberately hidden, + nil) ;; no format must be returned +- (t ;; - Tag was found and has formats, +- (let ((tag tag)) ;; we must apply all the formats. ++ (t ++ ;; Tag was found and has formats, we must apply all ++ ;; the formats. FORMATTED-TAG may be null so treat ++ ;; that as a special case. ++ (let ((tag (or formatted-tag ""))) + (dolist (format (cdr formats) tag) +- (setq tag (eval format))))))) +- (puthash tag formatted notmuch-tag--format-cache))) ++ (setq tag (eval format))) ++ (if (and (null formatted-tag) ++ (equal tag "")) ++ nil ++ tag))))) ++ (puthash (cons tag tag-state) formatted notmuch-tag--format-cache))) + formatted)) + +-(defun notmuch-tag-format-tags (tags &optional face) ++(defun notmuch-tag-format-tag (tags orig-tags tag) ++ "Format TAG by looking into `notmuch-tag-formats'. ++ ++TAGS and ORIG-TAGS are lists of the current tags and the original ++tags; tags which have been deleted (i.e., are in ORIG-TAGS but ++are not in TAGS) are shown using formats from ++`notmuch-tag-deleted-formats'; tags which have been added (i.e., ++are in TAGS but are not in ORIG-TAGS) are shown using formats ++from `notmuch-tag-added-formats' and tags which have not been ++changed (the normal case) are shown using formats from ++`notmuch-tag-formats'" ++ (let* ((formatted-tag (notmuch-tag-format-tag-by-state tag tag nil))) ++ (cond ((not (member tag tags)) ++ (notmuch-tag-format-tag-by-state tag formatted-tag 'deleted)) ++ ((not (member tag orig-tags)) ++ (notmuch-tag-format-tag-by-state tag formatted-tag 'added)) ++ (t ++ formatted-tag)))) ++ ++(defun notmuch-tag-format-tags (tags orig-tags &optional face) + "Return a string representing formatted TAGS." +- (let ((face (or face 'notmuch-tag-face))) ++ (let ((face (or face 'notmuch-tag-face)) ++ (all-tags (sort (delete-dups (append tags orig-tags nil)) #'string<))) + (notmuch-combine-face-text-property-string + (mapconcat #'identity + ;; nil indicated that the tag was deliberately hidden +- (delq nil (mapcar #'notmuch-tag-format-tag tags)) ++ (delq nil (mapcar ++ (apply-partially #'notmuch-tag-format-tag tags orig-tags) ++ all-tags)) + " ") + face + t))) +diff --git a/emacs/notmuch-tree.el b/emacs/notmuch-tree.el +index 4f2ac02..b37e2cd 100644 +--- a/emacs/notmuch-tree.el ++++ b/emacs/notmuch-tree.el +@@ -704,7 +704,7 @@ unchanged ADDRESS if parsing fails." + (face (if match + 'notmuch-tree-match-tag-face + 'notmuch-tree-no-match-tag-face))) +- (format format-string (notmuch-tag-format-tags tags face))))))) ++ (format format-string (notmuch-tag-format-tags tags tags face))))))) + + (defun notmuch-tree-format-field-list (field-list msg) + "Format fields of MSG according to FIELD-LIST and return string" +diff --git a/emacs/notmuch.el b/emacs/notmuch.el +index 0471750..1436e5a 100644 +--- a/emacs/notmuch.el ++++ b/emacs/notmuch.el +@@ -754,7 +754,7 @@ non-authors is found, assume that all of the authors match." + + ((string-equal field "tags") + (let ((tags (plist-get result :tags))) +- (insert (format format-string (notmuch-tag-format-tags tags))))))) ++ (insert (format format-string (notmuch-tag-format-tags tags tags))))))) + + (defun notmuch-search-show-result (result &optional pos) + "Insert RESULT at POS or the end of the buffer if POS is null." +diff --git a/test/test-lib.el b/test/test-lib.el +index 37fcb3d..437f83f 100644 +--- a/test/test-lib.el ++++ b/test/test-lib.el +@@ -165,3 +165,8 @@ nothing." + + (t + (notmuch-test-report-unexpected output expected))))) ++ ++;; For historical reasons, we hide deleted tags by default in the test ++;; suite ++(setq notmuch-tag-deleted-formats ++ '((".*" nil))) +-- +1.7.9.1 + -- 2.26.2