From: Mark Walters Date: Wed, 12 Mar 2014 04:09:54 +0000 (+0000) Subject: [Patch v3 5/8] emacs: show: mark tags changed since buffer loaded X-Git-Url: http://git.tremily.us/?a=commitdiff_plain;h=42648187f4c21e646ec75e5bea131a5445125982;p=notmuch-archives.git [Patch v3 5/8] emacs: show: mark tags changed since buffer loaded --- diff --git a/4e/6b4adde65f59fe708ffd9a058730e05e16eb3e b/4e/6b4adde65f59fe708ffd9a058730e05e16eb3e new file mode 100644 index 000000000..a0cba1110 --- /dev/null +++ b/4e/6b4adde65f59fe708ffd9a058730e05e16eb3e @@ -0,0 +1,273 @@ +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 1C205431FC3 + for ; Tue, 11 Mar 2014 21:10:25 -0700 (PDT) +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 VWkr3qvP5T4x for ; + Tue, 11 Mar 2014 21:10:17 -0700 (PDT) +Received: from mail-wi0-f177.google.com (mail-wi0-f177.google.com + [209.85.212.177]) (using TLSv1 with cipher RC4-SHA (128/128 bits)) + (No client certificate requested) + by olra.theworths.org (Postfix) with ESMTPS id 2CED5431FC7 + for ; Tue, 11 Mar 2014 21:10:11 -0700 (PDT) +Received: by mail-wi0-f177.google.com with SMTP id cc10so1797530wib.16 + for ; Tue, 11 Mar 2014 21:10:09 -0700 (PDT) +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=1yB+/VbdMVtGTGpjjaxPfwGGbn1ezSBwdv+ZLS+lSzI=; + b=dQHwrVre6JnxsUiIrQhIfB6ctW10PBLMtpTZYhgcnro4QywkDRQdA9ibwWV/qSUksm + kiLspGaXLhcpuZpADVsNlfiwX8u3MYxAttUbFpgX5RmAGXLbWxW/zvMl7ErP1N/H4GUZ + Jn8m5h6zmHOY6SVBT7G2uhUnA7xhct8AOt08thH1qsCGTY5l+Hy3xQVSYzQOGj3DFy0W + fUxYoiUaxqNBf81MZmayGfygPBvZTdwnYMtt1+7SXOzDcvxrB0Xi88qnl7G6VHWMGwbz + 4UJVw6EpLVNkT1SejNBO1S62SRfo3ilNIMYSV7Eo+nELn002MiJCmeX5DvLVFLk15Nt5 + 1isg== +X-Received: by 10.195.13.17 with SMTP id eu17mr39966064wjd.24.1394597409868; + Tue, 11 Mar 2014 21:10:09 -0700 (PDT) +Received: from localhost (93-97-24-31.zone5.bethere.co.uk. [93.97.24.31]) + by mx.google.com with ESMTPSA id hy8sm66427140wjb.2.2014.03.11.21.10.08 + for + (version=TLSv1.2 cipher=RC4-SHA bits=128/128); + Tue, 11 Mar 2014 21:10:09 -0700 (PDT) +From: Mark Walters +To: notmuch@notmuchmail.org, + amdragon@mit.edu +Subject: [Patch v3 5/8] emacs: show: mark tags changed since buffer loaded +Date: Wed, 12 Mar 2014 04:09:54 +0000 +Message-Id: <1394597397-8486-6-git-send-email-markwalters1009@gmail.com> +X-Mailer: git-send-email 1.7.9.1 +In-Reply-To: <1394597397-8486-1-git-send-email-markwalters1009@gmail.com> +References: <1394597397-8486-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: Wed, 12 Mar 2014 04:10:25 -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. + +Since the formatting code matches regexps a user can match all deleted +tags with a ".*" in notmuch-tag-deleted-formats. For example setting +notmuch-tag-deleted-formats to '((".*" nil)) tells notmuch not to show +deleted tags at all. + +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 | 72 +++++++++++++++++++++++++++++++++++------------- + emacs/notmuch-tree.el | 2 +- + emacs/notmuch.el | 2 +- + test/test-lib.el | 5 +++ + 5 files changed, 61 insertions(+), 24 deletions(-) + +diff --git a/emacs/notmuch-show.el b/emacs/notmuch-show.el +index 019f51d..5492be4 100644 +--- a/emacs/notmuch-show.el ++++ b/emacs/notmuch-show.el +@@ -344,7 +344,7 @@ (defun notmuch-show-update-tags (tags) + (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 @@ (defun notmuch-show-insert-headerline (headers date tags depth) + " (" + 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 4698856..cfccb8e 100644 +--- a/emacs/notmuch-tag.el ++++ b/emacs/notmuch-tag.el +@@ -184,45 +184,77 @@ (defun notmuch-tag-clear-cache () + "Clear the internal cache of tag formats." + (clrhash notmuch-tag--format-cache)) + +-(defun notmuch-tag-format-tag (tag) +- "Format TAG by according to `notmuch-tag-formats'. +- +-Callers must ensure that the tag format cache has been recently cleared +-via `notmuch-tag-clear-cache' before using this function. For example, +-it would be appropriate to clear the cache just prior to filling a +-buffer that uses formatted tags." +- +- (let ((formatted (gethash tag notmuch-tag--format-cache 'missing))) ++(defun notmuch-tag-format-tag-by-state (tag formatted-tag tag-state) ++ "Format TAG according to 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 (case tag-state ++ ((list nil) notmuch-tag-formats) ++ (deleted notmuch-tag-deleted-formats) ++ (added notmuch-tag-added-formats))) ++ (formats + (save-match-data + ;; Don't use assoc-default since there's no way to + ;; distinguish a missing key from a present key with a + ;; null cdr:. +- (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 according to `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-apply-face + (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 c78d9de..8bf2fbc 100644 +--- a/emacs/notmuch-tree.el ++++ b/emacs/notmuch-tree.el +@@ -704,7 +704,7 @@ (defun notmuch-tree-format-field (field format-string msg) + (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 93a6d8b..609f408 100644 +--- a/emacs/notmuch.el ++++ b/emacs/notmuch.el +@@ -754,7 +754,7 @@ (defun notmuch-search-insert-field (field format-string result) + + ((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 @@ (defun notmuch-test-expect-equal (output expected) + + (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 +