Re: [PATCH 2/7] emacs: hello: allow saved search display functions
authorDavid Edmondson <dme@dme.org>
Mon, 12 May 2014 14:03:41 +0000 (15:03 +0100)
committerW. Trevor King <wking@tremily.us>
Fri, 7 Nov 2014 18:02:46 +0000 (10:02 -0800)
f9/4342c456382db084f18040dfa11330a519b816 [new file with mode: 0644]

diff --git a/f9/4342c456382db084f18040dfa11330a519b816 b/f9/4342c456382db084f18040dfa11330a519b816
new file mode 100644 (file)
index 0000000..ba78512
--- /dev/null
@@ -0,0 +1,226 @@
+Return-Path: <dme@dme.org>\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 BDAB0431FC7\r
+       for <notmuch@notmuchmail.org>; Mon, 12 May 2014 07:03:55 -0700 (PDT)\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 9CpyCc9Pwv-4 for <notmuch@notmuchmail.org>;\r
+       Mon, 12 May 2014 07:03:48 -0700 (PDT)\r
+Received: from mail-wi0-f179.google.com (mail-wi0-f179.google.com\r
+       [209.85.212.179]) (using TLSv1 with cipher RC4-SHA (128/128 bits))\r
+       (No client certificate requested)\r
+       by olra.theworths.org (Postfix) with ESMTPS id 6A4C0431FC2\r
+       for <notmuch@notmuchmail.org>; Mon, 12 May 2014 07:03:48 -0700 (PDT)\r
+Received: by mail-wi0-f179.google.com with SMTP id bs8so4544564wib.0\r
+       for <notmuch@notmuchmail.org>; Mon, 12 May 2014 07:03:47 -0700 (PDT)\r
+X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed;\r
+       d=1e100.net; s=20130820;\r
+       h=x-gm-message-state:to:subject:in-reply-to:references:user-agent\r
+       :from:date:message-id:mime-version:content-type;\r
+       bh=XuLwkods7RoBbL5/MTlmcMSwWPbbHGDonFxElR8XgBA=;\r
+       b=UAIDtPh+Q8jOYRYbR5IA+2mcqj3szSf/1S8DL51aGtfRnjQJgx2rrAQeLGCFpaC9tn\r
+       XK+uEybT1+PnRckyK4e6gHbqLYXDgdEk3EC2DEIQH6ONgoxrqvs3fVKwd1AqLPe4NWdg\r
+       knNatoUx00o1OpxLp4jc9loMw8RirdqILq4P3miUiR/H0msUkKa02wMm9v1yqa+jVI5m\r
+       XvLOoJB0TLqQwyuCLb7dpUiR3PQQYwlDgfWyFOFRFeZnvVKLIuoFWfgfKOqYpb5Ky1Nt\r
+       YFh+uxOVOlHrWeV+hyyJRaGaT/yZyFJgB3qOcSpVUsKi8Qmhfk36JWBIz+nIH5oGv8Z1\r
+       54Sw==\r
+X-Gm-Message-State:\r
+ ALoCoQn+eBxQdUmA5Jq2+S0eNSBZyqQ3FgsyUErv0PNWQfageAuD/u9N79oBNxEggFj/1uFyYuDI\r
+X-Received: by 10.180.39.178 with SMTP id q18mr15976462wik.56.1399903427132;\r
+       Mon, 12 May 2014 07:03:47 -0700 (PDT)\r
+Received: from localhost ([2a01:348:1a2:1:a288:b4ff:fe8a:77d8])\r
+       by mx.google.com with ESMTPSA id ht5sm8605285wjb.49.2014.05.12.07.03.45\r
+       for <multiple recipients>\r
+       (version=TLSv1.2 cipher=ECDHE-RSA-AES128-GCM-SHA256 bits=128/128);\r
+       Mon, 12 May 2014 07:03:45 -0700 (PDT)\r
+To: Mark Walters <markwalters1009@gmail.com>, notmuch@notmuchmail.org\r
+Subject: Re: [PATCH 2/7] emacs: hello: allow saved search display functions\r
+In-Reply-To: <1399797282-20389-3-git-send-email-markwalters1009@gmail.com>\r
+References: <1399797282-20389-1-git-send-email-markwalters1009@gmail.com>\r
+       <1399797282-20389-3-git-send-email-markwalters1009@gmail.com>\r
+User-Agent: Notmuch/0.18 (http://notmuchmail.org) Emacs/24.3.1\r
+       (x86_64-pc-linux-gnu)\r
+From: David Edmondson <dme@dme.org>\r
+Date: Mon, 12 May 2014 15:03:41 +0100\r
+Message-ID: <cuniopb6qma.fsf@hotblack-desiato.hh.sledj.net>\r
+MIME-Version: 1.0\r
+Content-Type: multipart/signed; boundary="=-=-=";\r
+       micalg=pgp-sha1; protocol="application/pgp-signature"\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 14:03:55 -0000\r
+\r
+--=-=-=\r
+Content-Type: text/plain\r
+Content-Transfer-Encoding: quoted-printable\r
+\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
+-----\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) (stri=\r
+ng :format "%v")))\r
+>        (checklist :inline t\r
+>                   :format "%v"\r
+> -                 (group :format "%v" :inline t (const :format "Count-Query: " :cou=\r
+nt-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: "=\r
+ :display-function) (function :format "%v")))))\r
+> +\r
+>=20=20\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" =\r
+:query "tag:inbox")\r
+>=20=20\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
+>=20=20\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=\r
+ 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
+>=20=20\r
+>      (unless (=3D (call-process-region (point-min) (point-max) notmuch-co=\r
+mmand\r
+>                                  t t nil "count" "--batch") 0)\r
+> @@ -530,8 +539,14 @@ (defun notmuch-hello-query-counts (query-list &rest =\r
+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
+> +      result))\r
+>        query-list))))\r
+>=20=20\r
+>  (defun notmuch-hello-insert-buttons (searches)\r
+> --=20\r
+> 1.7.10.4\r
+>\r
+> _______________________________________________\r
+> notmuch mailing list\r
+> notmuch@notmuchmail.org\r
+> http://notmuchmail.org/mailman/listinfo/notmuch\r
+\r
+--=-=-=\r
+Content-Type: application/pgp-signature; name="signature.asc"\r
+\r
+-----BEGIN PGP SIGNATURE-----\r
+Version: GnuPG v1\r
+\r
+iKYEARECAGYFAlNw1L1fFIAAAAAALgAoaXNzdWVyLWZwckBub3RhdGlvbnMub3Bl\r
+bnBncC5maWZ0aGhvcnNlbWFuLm5ldDc1M0Y5NDJDMEExNjc3MDE4OURGMUYyMDY5\r
+RUNEMEFCRjA0OTY1MTYACgkQaezQq/BJZRYN3wCfbDQh4uxCmKiAgavy2XvYt9pJ\r
+LboAnjdqXDENPxF5/9CcUNhczpVCZLP9\r
+=3Ms3\r
+-----END PGP SIGNATURE-----\r
+--=-=-=--\r