Re: [PATCH 2/7] emacs: hello: allow saved search display functions
authorMark Walters <markwalters1009@gmail.com>
Mon, 12 May 2014 15:20:00 +0000 (16:20 +0100)
committerW. Trevor King <wking@tremily.us>
Fri, 7 Nov 2014 18:02:46 +0000 (10:02 -0800)
cf/1b69f8afc42b151a75cb0c904aabba9338629d [new file with mode: 0644]

diff --git a/cf/1b69f8afc42b151a75cb0c904aabba9338629d b/cf/1b69f8afc42b151a75cb0c904aabba9338629d
new file mode 100644 (file)
index 0000000..4d47fa8
--- /dev/null
@@ -0,0 +1,225 @@
+Return-Path: <markwalters1009@gmail.com>\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 212C9431FC7\r
+       for <notmuch@notmuchmail.org>; Mon, 12 May 2014 08:20:12 -0700 (PDT)\r
+X-Virus-Scanned: Debian amavisd-new at olra.theworths.org\r
+X-Spam-Flag: NO\r
+X-Spam-Score: 0.201\r
+X-Spam-Level: \r
+X-Spam-Status: No, score=0.201 tagged_above=-999 required=5\r
+       tests=[DKIM_SIGNED=0.1, DKIM_VALID=-0.1, DKIM_VALID_AU=-0.1,\r
+       FREEMAIL_ENVFROM_END_DIGIT=1, FREEMAIL_FROM=0.001,\r
+       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 8yFOV68n9+Qm for <notmuch@notmuchmail.org>;\r
+       Mon, 12 May 2014 08:20:04 -0700 (PDT)\r
+Received: from mail-wi0-f174.google.com (mail-wi0-f174.google.com\r
+       [209.85.212.174]) (using TLSv1 with cipher RC4-SHA (128/128 bits))\r
+       (No client certificate requested)\r
+       by olra.theworths.org (Postfix) with ESMTPS id C1564431FC2\r
+       for <notmuch@notmuchmail.org>; Mon, 12 May 2014 08:20:03 -0700 (PDT)\r
+Received: by mail-wi0-f174.google.com with SMTP id r20so4675740wiv.13\r
+       for <notmuch@notmuchmail.org>; Mon, 12 May 2014 08:20:02 -0700 (PDT)\r
+DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20120113;\r
+       h=from:to:subject:in-reply-to:references:user-agent:date:message-id\r
+       :mime-version:content-type;\r
+       bh=pH/7PJmg15Y0qTNgcT9K1L+wfwcZljTuiyBU+1duR7w=;\r
+       b=OyeoRB6Ibxcei6qPncM6mCMnjpkCZtwgHcOhSAkINVBxJy45JAJb/L3Nll6M+wFpRn\r
+       /Z4k23buXc6Q6avdqjXJTYcr3znJzF+bPGbVIuDA+lhxJtq5xBbGRczGlq88yDaKYoR0\r
+       zSCzP+3hoIzxzITqcH2s4ejiuxrWaVQT9g1ZZSsFvwpmlct2vX89LoFc1e0WKT3NcXtL\r
+       kNdxlJUvMPjFyWhvLjWVrToLJmU/Pm0aBIth/rKhEyEv1RrEbr7IrYm9v1TvnZeKkcZ0\r
+       JarmQAcn+6ZFtLUHJXARTsGdZOuaWxdLhxc0Kajz61ByVtQoUtXaJb051+YEMeMuV5X3\r
+       DHwA==\r
+X-Received: by 10.194.92.7 with SMTP id ci7mr22184509wjb.7.1399908002480;\r
+       Mon, 12 May 2014 08:20:02 -0700 (PDT)\r
+Received: from localhost (5751dfa2.skybroadband.com. [87.81.223.162])\r
+       by mx.google.com with ESMTPSA id dg7sm18329407wjc.4.2014.05.12.08.20.01\r
+       for <multiple recipients>\r
+       (version=TLSv1.2 cipher=RC4-SHA bits=128/128);\r
+       Mon, 12 May 2014 08:20:01 -0700 (PDT)\r
+From: Mark Walters <markwalters1009@gmail.com>\r
+To: David Edmondson <dme@dme.org>, notmuch@notmuchmail.org\r
+Subject: Re: [PATCH 2/7] emacs: hello: allow saved search display functions\r
+In-Reply-To: <cuniopb6qma.fsf@hotblack-desiato.hh.sledj.net>\r
+References: <1399797282-20389-1-git-send-email-markwalters1009@gmail.com>\r
+       <1399797282-20389-3-git-send-email-markwalters1009@gmail.com>\r
+       <cuniopb6qma.fsf@hotblack-desiato.hh.sledj.net>\r
+User-Agent: Notmuch/0.15.2+615~g78e3a93 (http://notmuchmail.org) Emacs/23.4.1\r
+       (x86_64-pc-linux-gnu)\r
+Date: Mon, 12 May 2014 16:20:00 +0100\r
+Message-ID: <871tvzkorj.fsf@qmul.ac.uk>\r
+MIME-Version: 1.0\r
+Content-Type: text/plain; charset=us-ascii\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: Mon, 12 May 2014 15:20:12 -0000\r
+\r
+On Mon, 12 May 2014, David Edmondson <dme@dme.org> wrote:\r
+> On Sun, May 11 2014, Mark Walters wrote:\r
+>> Extend the saved search plist to include a :display-function property\r
+>> that can customise the display of the saved search. It can change the\r
+>> count string displayed and the name string. Thus the user can\r
+>> customise so that a particular search:\r
+>>\r
+>> does not show a count (and is thus hello is faster), shows a thread\r
+>> count, show a combined message/thread count, changes colour of the\r
+>> search button based on new messages arriving etc.\r
+>>\r
+>> The display function should use (&rest args) to take a keyword list of\r
+>> arguments. The advantage of this is that it is easy to add extra\r
+>> arguments in a backwards compatible way (existing user scripts will\r
+>> still work).\r
+>>\r
+>> If a user uses this it will not take advantage of the batch counting\r
+>> currently done so will make things slower over remote links (except in\r
+>> cases where no query is done!).\r
+>>\r
+>> It also deletes the :count-query option from the customise for saved\r
+>> searches as this method is much more general. The code still supports\r
+>> the :count-query option though (just the defcustom does not).\r
+>> ---\r
+>>  emacs/notmuch-hello.el |   47 +++++++++++++++++++++++++++++++----------------\r
+>>  1 file changed, 31 insertions(+), 16 deletions(-)\r
+>>\r
+>> diff --git a/emacs/notmuch-hello.el b/emacs/notmuch-hello.el\r
+>> index 0a7004c..7075860 100644\r
+>> --- a/emacs/notmuch-hello.el\r
+>> +++ b/emacs/notmuch-hello.el\r
+>> @@ -85,12 +85,13 @@ (define-widget 'notmuch-saved-search-plist 'list\r
+>>             (group :format "%v" :inline t (const :format "  Query: " :query) (string :format "%v")))\r
+>>       (checklist :inline t\r
+>>                  :format "%v"\r
+>> -                (group :format "%v" :inline t (const :format "Count-Query: " :count-query) (string :format "%v"))\r
+>>                  (group :format "%v" :inline t (const :format "" :sort-order)\r
+>>                         (choice :tag " Sort Order"\r
+>>                                 (const :tag "Default" nil)\r
+>>                                 (const :tag "Oldest-first" oldest-first)\r
+>> -                               (const :tag "Newest-first" newest-first))))))\r
+>> +                               (const :tag "Newest-first" newest-first)))\r
+>> +                (group :format "%v" :inline t (const :format "Display-function: " :display-function) (function :format "%v")))))\r
+>> +\r
+>>  \r
+>>  (defcustom notmuch-saved-searches '((:name "inbox" :query "tag:inbox")\r
+>>                                 (:name "unread" :query "tag:unread"))\r
+>> @@ -101,12 +102,19 @@ (defcustom notmuch-saved-searches '((:name "inbox" :query "tag:inbox")\r
+>>  \r
+>>    :name            Name of the search (required).\r
+>>    :query           Search to run (required).\r
+>> -  :count-query     Optional extra query to generate the count\r
+>> -                   shown. If not present then the :query property\r
+>> -                   is used.\r
+>>    :sort-order      Specify the sort order to be used for the search.\r
+>>                     Possible values are 'oldest-first 'newest-first or\r
+>>                     nil. Nil means use the default sort order.\r
+>> +  :display-function Optional function to generate the count and\r
+>> +                   name to be displayed. The function takes a\r
+>> +                   keyword list of arguments (it should use\r
+>> +                   &rest). Keywords include :current for the\r
+>> +                   current saved search plist and :options. If\r
+>> +                   this function is not set then the default\r
+>> +                   display of message count and name is used. The\r
+>> +                   function should return an updated saved search\r
+>> +                   plist including :name and :count as the name\r
+>> +                   and count-string to be displayed.\r
+>>  \r
+>>  Other accepted forms are a cons cell of the form (NAME . QUERY)\r
+>>  or a list of the form (NAME QUERY COUNT-QUERY)."\r
+>> @@ -507,15 +515,16 @@ (defun notmuch-hello-query-counts (query-list &rest options)\r
+>>  `notmuch-hello-insert-searches'."\r
+>>    (with-temp-buffer\r
+>>      (dolist (elem query-list nil)\r
+>> -      (let ((count-query (or (notmuch-saved-search-get elem :count-query)\r
+>> -                        (notmuch-saved-search-get elem :query))))\r
+>> -   (insert\r
+>> -    (replace-regexp-in-string\r
+>> -     "\n" " "\r
+>> -     (notmuch-hello-filtered-query count-query\r
+>> -                                   (or (plist-get options :filter-count)\r
+>> -                                       (plist-get options :filter))))\r
+>> -     "\n")))\r
+>> +      (unless (notmuch-saved-search-get elem :display-function)\r
+>> +   (let ((count-query (or (notmuch-saved-search-get elem :count-query)\r
+>> +                          (notmuch-saved-search-get elem :query))))\r
+>> +     (insert\r
+>> +      (replace-regexp-in-string\r
+>> +       "\n" " "\r
+>> +       (notmuch-hello-filtered-query count-query\r
+>> +                                     (or (plist-get options :filter-count)\r
+>> +                                         (plist-get options :filter))))\r
+>> +      "\n"))))\r
+>>  \r
+>>      (unless (= (call-process-region (point-min) (point-max) notmuch-command\r
+>>                                 t t nil "count" "--batch") 0)\r
+>> @@ -530,8 +539,14 @@ (defun notmuch-hello-query-counts (query-list &rest options)\r
+>>       #'identity\r
+>>       (mapcar\r
+>>        (lambda (elem)\r
+>> -   (let* ((elem-plist (notmuch-hello-saved-search-to-plist elem)))\r
+>> -     (notmuch-hello-batch-message-count elem-plist options)))\r
+>> +   (let* ((elem-plist (notmuch-hello-saved-search-to-plist elem))\r
+>> +          (display-function (plist-get elem-plist :display-function))\r
+>> +          (result (if display-function\r
+>> +                       (funcall display-function\r
+>> +                                :current elem-plist\r
+>> +                                :option options)\r
+>> +                     (notmuch-hello-batch-message-count elem-plist\r
+>>                       options))))\r
+>\r
+> If `notmuch-hello-batch-message-count' were re-written to operate as a\r
+> display-function, this could be replaced with something like:\r
+>\r
+>      (let* ((elem-plist (notmuch-hello-saved-search-to-plist elem))\r
+>             (result (funcall (or (plist-get elem-plist :display-function)\r
+>                                  #'notmuch-hello-batch-message-count)\r
+>                              :current elem-plist\r
+>                              :option options))\r
+>\r
+\r
+The reason I didn't do this is that things would break if a user\r
+manually configured display function to be\r
+#'notmuch-hello-batch-message-count as the query would not have been\r
+batched. Thus my version made the distinction fundamental. But perhaps\r
+the batch queuing code could queue the query if either there is no\r
+display function or the display-function is\r
+notmuch-hello-batch-message-count, but that seems a bit gross. \r
+\r
+I also played with calling each display function in the batch phase too\r
+and then they could queue any message counts they wanted. But I thought\r
+that might be too complex. OTOH being able to do display\r
+match/match-and-unread might be nice and could be batched with the\r
+correct infrastructure.\r
+\r
+Any thoughts?\r
+\r
+Best wishes\r
+\r
+Mark\r
+\r
+\r
+\r
+\r
+\r
+>> +     result))\r
+>>        query-list))))\r
+>>  \r
+>>  (defun notmuch-hello-insert-buttons (searches)\r
+>> -- \r
+>> 1.7.10.4\r
+>>\r
+>> _______________________________________________\r
+>> notmuch mailing list\r
+>> notmuch@notmuchmail.org\r
+>> http://notmuchmail.org/mailman/listinfo/notmuch\r