--- /dev/null
+Return-Path: <amdragon@mit.edu>\r
+X-Original-To: notmuch@notmuchmail.org\r
+Delivered-To: notmuch@notmuchmail.org\r
+Received: from localhost (localhost [127.0.0.1])\r
+ by olra.theworths.org (Postfix) with ESMTP id 3004B431FBD\r
+ for <notmuch@notmuchmail.org>; Wed, 12 Feb 2014 09:32:47 -0800 (PST)\r
+X-Virus-Scanned: Debian amavisd-new at olra.theworths.org\r
+X-Spam-Flag: NO\r
+X-Spam-Score: -0.7\r
+X-Spam-Level: \r
+X-Spam-Status: No, score=-0.7 tagged_above=-999 required=5\r
+ tests=[RCVD_IN_DNSWL_LOW=-0.7] autolearn=disabled\r
+Received: from olra.theworths.org ([127.0.0.1])\r
+ by localhost (olra.theworths.org [127.0.0.1]) (amavisd-new, port 10024)\r
+ with ESMTP id UNW9tpZ9IQPp for <notmuch@notmuchmail.org>;\r
+ Wed, 12 Feb 2014 09:32:41 -0800 (PST)\r
+Received: from dmz-mailsec-scanner-7.mit.edu (dmz-mailsec-scanner-7.mit.edu\r
+ [18.7.68.36])\r
+ (using TLSv1 with cipher DHE-RSA-AES256-SHA (256/256 bits))\r
+ (No client certificate requested)\r
+ by olra.theworths.org (Postfix) with ESMTPS id AD4A2431FAE\r
+ for <notmuch@notmuchmail.org>; Wed, 12 Feb 2014 09:32:40 -0800 (PST)\r
+X-AuditID: 12074424-f79e26d000000c70-aa-52fbb03632de\r
+Received: from mailhub-auth-4.mit.edu ( [18.7.62.39])\r
+ (using TLS with cipher AES256-SHA (256/256 bits))\r
+ (Client did not present a certificate)\r
+ by dmz-mailsec-scanner-7.mit.edu (Symantec Messaging Gateway) with SMTP\r
+ id 92.71.03184.630BBF25; Wed, 12 Feb 2014 12:32:38 -0500 (EST)\r
+Received: from outgoing.mit.edu (outgoing-auth-1.mit.edu [18.9.28.11])\r
+ by mailhub-auth-4.mit.edu (8.13.8/8.9.2) with ESMTP id s1CHWahp014667; \r
+ Wed, 12 Feb 2014 12:32:36 -0500\r
+Received: from drake.dyndns.org\r
+ (216-15-114-40.c3-0.arl-ubr1.sbo-arl.ma.cable.rcn.com\r
+ [216.15.114.40]) (authenticated bits=0)\r
+ (User authenticated as amdragon@ATHENA.MIT.EDU)\r
+ by outgoing.mit.edu (8.13.8/8.12.4) with ESMTP id s1CHWX4s032107\r
+ (version=TLSv1/SSLv3 cipher=AES256-SHA bits=256 verify=NOT);\r
+ Wed, 12 Feb 2014 12:32:35 -0500\r
+Received: from amthrax by drake.dyndns.org with local (Exim 4.77)\r
+ (envelope-from <amdragon@mit.edu>)\r
+ id 1WDdfl-0008Bz-O4; Wed, 12 Feb 2014 12:32:33 -0500\r
+From: Austin Clements <amdragon@MIT.EDU>\r
+To: notmuch@notmuchmail.org\r
+Subject: [WIP PATCH] Make keys of notmuch-tag-formats regexps and use caching\r
+Date: Wed, 12 Feb 2014 12:32:31 -0500\r
+Message-Id: <1392226351-31440-1-git-send-email-amdragon@mit.edu>\r
+X-Mailer: git-send-email 1.8.4.rc3\r
+In-Reply-To: <87r479mf4g.fsf@awakening.csail.mit.edu>\r
+References: <87r479mf4g.fsf@awakening.csail.mit.edu>\r
+X-Brightmail-Tracker:\r
+ H4sIAAAAAAAAA+NgFtrNIsWRmVeSWpSXmKPExsUixG6nrmu24XeQwbNNlhar5/JYXL85k9mB\r
+ yWPnrLvsHs9W3WIOYIrisklJzcksSy3St0vgyvjweydzwXfjimWXghoYP2t0MXJySAiYSPRd\r
+ /sAEYYtJXLi3nq2LkYtDSGA2k0T3z8lMEM5GRonvT/ZCZe4wSUxffIMFwpnLKLFgzw02kH42\r
+ AQ2JbfuXM4LYIgLSEjvvzmYFsZkFHCU+718EVMPBISzgKzHneQFImEVAVaJp4Syw1bwCDhIN\r
+ J68yQ5yhJLHw1DawVk4BU4lpax+AjRcCOrXp4zKmCYz8CxgZVjHKpuRW6eYmZuYUpybrFicn\r
+ 5uWlFuma6+VmluilppRuYgSHkYvKDsbmQ0qHGAU4GJV4eC9M/R0kxJpYVlyZe4hRkoNJSZT3\r
+ +hqgEF9SfkplRmJxRnxRaU5q8SFGCQ5mJRFeo2agHG9KYmVValE+TEqag0VJnLfW4leQkEB6\r
+ YklqdmpqQWoRTFaGg0NJgtdpPVCjYFFqempFWmZOCUKaiYMTZDgP0PAIkBre4oLE3OLMdIj8\r
+ KUZFKXFeFZCEAEgiozQPrhcW568YxYFeEeZVBqniAaYIuO5XQIOZgAanRoENLklESEk1MCqn\r
+ dCsG5clazj6ksv702nl9VyVXRk8pmm3B+Xyx+pa52xQOBC591LvtoaoNY/tWqyV/BL+mb5p5\r
+ 85vjrQw971drjsyVy1Vf9q2gzjrU9/R933sTAhkD+hJkd8wyULw6S8Np9wfWg7E3jvoH3g0V\r
+ kPsUc2axtMxelk/Pjh5jO8aY5M+s7dC2olOJpTgj0VCLuag4EQBa3NsNzgIAAA==\r
+X-BeenThere: notmuch@notmuchmail.org\r
+X-Mailman-Version: 2.1.13\r
+Precedence: list\r
+List-Id: "Use and development of the notmuch mail system."\r
+ <notmuch.notmuchmail.org>\r
+List-Unsubscribe: <http://notmuchmail.org/mailman/options/notmuch>,\r
+ <mailto:notmuch-request@notmuchmail.org?subject=unsubscribe>\r
+List-Archive: <http://notmuchmail.org/pipermail/notmuch>\r
+List-Post: <mailto:notmuch@notmuchmail.org>\r
+List-Help: <mailto:notmuch-request@notmuchmail.org?subject=help>\r
+List-Subscribe: <http://notmuchmail.org/mailman/listinfo/notmuch>,\r
+ <mailto:notmuch-request@notmuchmail.org?subject=subscribe>\r
+X-List-Received-Date: Wed, 12 Feb 2014 17:32:47 -0000\r
+\r
+This was a little hack to test the feasibility of switching\r
+notmuch-tag-formats to use regexps with caching for performance. In\r
+the end it works fine and isn't particularly complex, though there\r
+were a few gotchas:\r
+\r
+1) We have to clear the cache somehow on changes to\r
+notmuch-tag-formats. I opted to use a defcustom :set plus some\r
+documentation telling people what to do if they change it directly\r
+from Elisp. This is less automatic than I would like, but I doubt\r
+people are changing this very often and I concluded that any machinery\r
+to automatically detect changes to notmuch-tag-formats would probably\r
+outweigh the benefits of caching. Alternatively, we could require\r
+search/show/tree buffers to "opt in" to caching when they start\r
+building.\r
+\r
+2) I spent way too long trying to use assoc-default before realizing\r
+this it just wouldn't work, since there's no way to distinguish a\r
+missing key from a present key with a null cdr. assoc* from cl works\r
+fine.\r
+\r
+Performance-wise, the caching of regexp lookup makes this just as fast\r
+as assoc for unformatted tags (it would probably be faster if someone\r
+had a really big `notmuch-tag-formats') and the caching of eval\r
+results makes this much *faster* than the current code for formatted\r
+tags.\r
+\r
+ inbox (usec) unread (usec)\r
+assoc: 0.4 2.8\r
+regexp: 3.2 7.2\r
+regexp+caching: 0.4 0.4\r
+\r
+That said, even at 7.2 usec, tag formatting is still *very* fast\r
+(though regexp matching may get noticeably slower with larger\r
+`notmuch-tag-formats'). Tag formatting is nowhere near our top\r
+bottleneck.\r
+---\r
+ emacs/notmuch-tag.el | 75 +++++++++++++++++++++++++++++++++++++---------------\r
+ 1 file changed, 53 insertions(+), 22 deletions(-)\r
+\r
+diff --git a/emacs/notmuch-tag.el b/emacs/notmuch-tag.el\r
+index b60f46c..07f5772 100644\r
+--- a/emacs/notmuch-tag.el\r
++++ b/emacs/notmuch-tag.el\r
+@@ -28,35 +28,56 @@\r
+ (require 'crm)\r
+ (require 'notmuch-lib)\r
+ \r
++;; (notmuch-tag-clear-cache will be called by the defcustom\r
++;; notmuch-tag-formats, so it has to be defined first.)\r
++\r
++(defvar notmuch-tag--format-cache (make-hash-table :test 'equal)\r
++ "Cache of tag format lookup. Internal to `notmuch-tag-format-tag'.")\r
++\r
++(defun notmuch-tag-clear-cache ()\r
++ "Clear the internal cache of tag formats.\r
++\r
++This must be called after changes to `notmuch-tag-formats'."\r
++ (clrhash notmuch-tag--format-cache))\r
++\r
+ (defcustom notmuch-tag-formats\r
+ '(("unread" (propertize tag 'face '(:foreground "red")))\r
+ ("flagged" (propertize tag 'face '(:foreground "blue"))\r
+ (notmuch-tag-format-image-data tag (notmuch-tag-star-icon))))\r
+ "Custom formats for individual tags.\r
+ \r
+-This gives a list that maps from tag names to lists of formatting\r
+-expressions. The car of each element gives a tag name and the\r
+-cdr gives a list of Elisp expressions that modify the tag. If\r
+-the list is empty, the tag will simply be hidden. Otherwise,\r
+-each expression will be evaluated in order: for the first\r
+-expression, the variable `tag' will be bound to the tag name; for\r
+-each later expression, the variable `tag' will be bound to the\r
+-result of the previous expression. In this way, each expression\r
+-can build on the formatting performed by the previous expression.\r
+-The result of the last expression will displayed in place of the\r
+-tag.\r
++This is an association list that maps from tag name regexps to\r
++lists of formatting expressions. The first entry whose car\r
++regexp-matches a tag will be used to format that tag. The regexp\r
++is implicitly anchored, so to match a literal tag name, just use\r
++that tag name (if it contains special regexp characters like\r
++\".\" or \"*\", these have to be escaped). The cdr of the\r
++matching entry gives a list of Elisp expressions that modify the\r
++tag. If the list is empty, the tag will simply be hidden.\r
++Otherwise, each expression will be evaluated in order: for the\r
++first expression, the variable `tag' will be bound to the tag\r
++name; for each later expression, the variable `tag' will be bound\r
++to the result of the previous expression. In this way, each\r
++expression can build on the formatting performed by the previous\r
++expression. The result of the last expression will displayed in\r
++place of the tag.\r
+ \r
+ For example, to replace a tag with another string, simply use\r
+ that string as a formatting expression. To change the foreground\r
+ of a tag to red, use the expression\r
+ (propertize tag 'face '(:foreground \"red\"))\r
+ \r
++After modifying this variable in Elisp, be sure to call\r
++`notmuch-tag-clear-cache'. Modifying this via customize does\r
++this automatically.\r
++\r
+ See also `notmuch-tag-format-image', which can help replace tags\r
+ with images."\r
+ \r
+ :group 'notmuch-search\r
+ :group 'notmuch-show\r
+- :type '(alist :key-type (string :tag "Tag")\r
++ :set (lambda (var val) (set-default var val) (notmuch-tag-clear-cache))\r
++ :type '(alist :key-type (regexp :tag "Tag")\r
+ :extra-offset -3\r
+ :value-type\r
+ (radio :format "%v"\r
+@@ -137,16 +158,26 @@ This can be used with `notmuch-tag-format-image-data'."\r
+ \r
+ (defun notmuch-tag-format-tag (tag)\r
+ "Format TAG by looking into `notmuch-tag-formats'."\r
+- (let ((formats (assoc tag notmuch-tag-formats)))\r
+- (cond\r
+- ((null formats) ;; - Tag not in `notmuch-tag-formats',\r
+- tag) ;; the format is the tag itself.\r
+- ((null (cdr formats)) ;; - Tag was deliberately hidden,\r
+- nil) ;; no format must be returned\r
+- (t ;; - Tag was found and has formats,\r
+- (let ((tag tag)) ;; we must apply all the formats.\r
+- (dolist (format (cdr formats) tag)\r
+- (setq tag (eval format))))))))\r
++ (let ((formatted (gethash tag notmuch-tag--format-cache 'missing)))\r
++ (when (eq formatted 'missing)\r
++ (let* ((formats\r
++ (save-match-data\r
++ (assoc* tag notmuch-tag-formats\r
++ :test (lambda (key tag)\r
++ (and (eq (string-match key tag) 0)\r
++ (= (match-end 0) (length tag))))))))\r
++ (setq formatted\r
++ (cond\r
++ ((null formats) ;; - Tag not in `notmuch-tag-formats',\r
++ tag) ;; the format is the tag itself.\r
++ ((null (cdr formats)) ;; - Tag was deliberately hidden,\r
++ nil) ;; no format must be returned\r
++ (t ;; - Tag was found and has formats,\r
++ (let ((tag tag)) ;; we must apply all the formats.\r
++ (dolist (format (cdr formats) tag)\r
++ (setq tag (eval format)))))))\r
++ (puthash tag formatted notmuch-tag--format-cache)))\r
++ formatted))\r
+ \r
+ (defun notmuch-tag-format-tags (tags)\r
+ "Return a string representing formatted TAGS."\r
+-- \r
+1.8.4.rc3\r
+\r
projects / notmuch-archives.git / commitdiff