Re: [PATCH v2 0/9] JSON-based search-mode
authorAustin Clements <amdragon@MIT.EDU>
Fri, 6 Jul 2012 00:29:41 +0000 (20:29 +2000)
committerW. Trevor King <wking@tremily.us>
Fri, 7 Nov 2014 17:48:02 +0000 (09:48 -0800)
fb/37e86373a8fcb31ea0a63392ebd36275e66447 [new file with mode: 0644]

diff --git a/fb/37e86373a8fcb31ea0a63392ebd36275e66447 b/fb/37e86373a8fcb31ea0a63392ebd36275e66447
new file mode 100644 (file)
index 0000000..ff4883d
--- /dev/null
@@ -0,0 +1,299 @@
+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 06E74431FB6\r
+       for <notmuch@notmuchmail.org>; Thu,  5 Jul 2012 17:29:49 -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 qi5oD58q+Za7 for <notmuch@notmuchmail.org>;\r
+       Thu,  5 Jul 2012 17:29:48 -0700 (PDT)\r
+Received: from dmz-mailsec-scanner-3.mit.edu (DMZ-MAILSEC-SCANNER-3.MIT.EDU\r
+       [18.9.25.14])\r
+       by olra.theworths.org (Postfix) with ESMTP id E6BE1431FAE\r
+       for <notmuch@notmuchmail.org>; Thu,  5 Jul 2012 17:29:47 -0700 (PDT)\r
+X-AuditID: 1209190e-b7fb56d0000008b2-b4-4ff6317a344e\r
+Received: from mailhub-auth-3.mit.edu ( [18.9.21.43])\r
+       by dmz-mailsec-scanner-3.mit.edu (Symantec Messaging Gateway) with SMTP\r
+       id 9E.60.02226.A7136FF4; Thu,  5 Jul 2012 20:29:46 -0400 (EDT)\r
+Received: from outgoing.mit.edu (OUTGOING-AUTH.MIT.EDU [18.7.22.103])\r
+       by mailhub-auth-3.mit.edu (8.13.8/8.9.2) with ESMTP id q660Tjd2002667; \r
+       Thu, 5 Jul 2012 20:29:45 -0400\r
+Received: from awakening.csail.mit.edu (awakening.csail.mit.edu [18.26.4.91])\r
+       (authenticated bits=0)\r
+       (User authenticated as amdragon@ATHENA.MIT.EDU)\r
+       by outgoing.mit.edu (8.13.6/8.12.4) with ESMTP id q660Tfn6015427\r
+       (version=TLSv1/SSLv3 cipher=AES256-SHA bits=256 verify=NOT);\r
+       Thu, 5 Jul 2012 20:29:42 -0400 (EDT)\r
+Received: from amthrax by awakening.csail.mit.edu with local (Exim 4.77)\r
+       (envelope-from <amdragon@mit.edu>)\r
+       id 1SmwQX-00057a-77; Thu, 05 Jul 2012 20:29:41 -0400\r
+Date: Thu, 5 Jul 2012 20:29:41 -0400\r
+From: Austin Clements <amdragon@MIT.EDU>\r
+To: Mark Walters <markwalters1009@gmail.com>\r
+Subject: Re: [PATCH v2 0/9] JSON-based search-mode\r
+Message-ID: <20120706002941.GB18195@mit.edu>\r
+References: <1341354059-29396-1-git-send-email-amdragon@mit.edu>\r
+       <1341521547-15502-1-git-send-email-amdragon@mit.edu>\r
+       <87y5mx3mtd.fsf@qmul.ac.uk>\r
+MIME-Version: 1.0\r
+Content-Type: text/plain; charset=us-ascii\r
+Content-Disposition: inline\r
+In-Reply-To: <87y5mx3mtd.fsf@qmul.ac.uk>\r
+User-Agent: Mutt/1.5.21 (2010-09-15)\r
+X-Brightmail-Tracker:\r
+ H4sIAAAAAAAAA+NgFprJKsWRmVeSWpSXmKPExsUixCmqrVtl+M3f4HSLlMXquTwW12/OZLZ4\r
+       s3IeqwOzx85Zd9k9Dn9dyOLxbNUt5gDmKC6blNSczLLUIn27BK6M/S0XGAv+elQsmXuRuYFx\r
+       l0UXIyeHhICJRP+GvYwQtpjEhXvr2boYuTiEBPYxShy+cwvKWc8o8WPHb3YI5wSTRFfzWlYI\r
+       ZwmjRPfq6yxdjBwcLAIqEm/P14CMYhPQkNi2fznYWBEBHYnbhxawg9jMAvoSK0/OZAaxhQWM\r
+       JPY17GYBsXmBaua1/IeaOZVRYvrOdjaIhKDEyZlPWCCatSRu/HvJBLKLWUBaYvk/DpAwJ9Cu\r
+       3T/uge0SBTphysltbBMYhWYh6Z6FpHsWQvcCRuZVjLIpuVW6uYmZOcWpybrFyYl5ealFusZ6\r
+       uZkleqkppZsYwaEuybeD8etBpUOMAhyMSjy8xrlf/IVYE8uKK3MPMUpyMCmJ8j7W/+YvxJeU\r
+       n1KZkVicEV9UmpNafIhRgoNZSYS3N+OrvxBvSmJlVWpRPkxKmoNFSZz3SspNfyGB9MSS1OzU\r
+       1ILUIpisDAeHkgTvSgOgoYJFqempFWmZOSUIaSYOTpDhPEDDF4LU8BYXJOYWZ6ZD5E8x6nKs\r
+       e3PkBqMQS15+XqqUOO9qkCIBkKKM0jy4ObAU9YpRHOgtYd61IFU8wPQGN+kV0BImoCV5iz+B\r
+       LClJREhJNTCGf+rov/p+xbnY8yvTZqWwHTr3vrN9hjZvlemxwDuqhlLc58/y+ykfjj99e9Ep\r
+       hw1Xbt3avOHlhr+/eae1+ujpTlt68Naqz4WvsxW3nBbwDmD1+/vYLqDjwJYvf66xzV7NJXI/\r
+       85FI+oETjR3fJv8Oy9/9dlvp62cuFjoL9hncV1isF+oR2HfQXYmlOCPRUIu5qDgRACGTIdYs        AwAA\r
+Cc: tomi.ollila@iki.fi, notmuch@notmuchmail.org\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: Fri, 06 Jul 2012 00:29:49 -0000\r
+\r
+Quoth Mark Walters on Jul 05 at 10:44 pm:\r
+> On Thu, 05 Jul 2012, Austin Clements <amdragon@MIT.EDU> wrote:\r
+> > This should account for all of Mark's and Tomi's comments.  This\r
+> > version\r
+> > * renames the "format" variables to "format-string" and "spec" to be\r
+> >   less confusing,\r
+> > * reverts to the original behavior of ignoring the user's format\r
+> >   specification for tags (since we make assumptions about this format\r
+> >   elsewhere),\r
+> > * swaps the error helper and search-target patches to fix the\r
+> >   temporary issue with error message placement,\r
+> > * adds documentation on point movement in the JSON parser,\r
+> > * breaks out the JSON EOF testing function,\r
+> > * beefs up a few commit messages,\r
+> > * and adds a NEWS patch.\r
+> >\r
+> > For ease of reviewing, the diff diff is below.\r
+> >\r
+> > I've written most of a follow-on patch series that cleans up the\r
+> > handling of metadata and tag changes by attaching the JSON result\r
+> > object to the result.  This means we don't need a proliferation of\r
+> > text properties to store the result metadata, and we can make updates\r
+> > to a result (e.g., tag changes) by updating this result object and\r
+> > then re-rendering the result line from scratch, rather than trying to\r
+> > update the result line in place.  This makes it possible to obey user\r
+> > formatting for the tag list and has other perks like recoloring\r
+> > results when their tags change.  I'll send it along once this patch\r
+> > series is accepted.\r
+> >\r
+> > diff --git a/NEWS b/NEWS\r
+> > index d29ec5b..a1a6e93 100644\r
+> > --- a/NEWS\r
+> > +++ b/NEWS\r
+> > @@ -14,6 +14,23 @@ Maildir tag synchronization\r
+> >    messages (typically causing new messages to not receive the "unread"\r
+> >    tag).\r
+> >  \r
+> > +Emacs Interface\r
+> > +---------------\r
+> > +\r
+> > +Search now uses the JSON format internally\r
+> > +\r
+> > +  This should address problems with unusual characters in authors and\r
+> > +  subject lines that could confuse the old text-based search parser.\r
+> > +\r
+> > +The date shown in search results is no longer padded before applying\r
+> > +user-specified formatting\r
+> > +\r
+> > +  Previously, the date in the search results was padded to fixed width\r
+> > +  before being formatted with `notmuch-search-result-format`.  It is\r
+> > +  no longer padded.  The default format has been updated, but if\r
+> > +  you've customized this variable, you may have to change your date\r
+> > +  format from `"%s "` to `"%12s "`.\r
+> > +\r
+> >  Notmuch 0.13.2 (2012-06-02)\r
+> >  ===========================\r
+> >  \r
+> > diff --git a/emacs/notmuch-lib.el b/emacs/notmuch-lib.el\r
+> > index f7cda33..9e04d97 100644\r
+> > --- a/emacs/notmuch-lib.el\r
+> > +++ b/emacs/notmuch-lib.el\r
+> > @@ -399,8 +399,9 @@ resynchronize after an error by moving point."\r
+> >  \r
+> >  Returns 'retry if there is insufficient input to parse the\r
+> >  beginning of the compound.  If this is able to parse the\r
+> > -beginning of a compound, it returns t and later calls to\r
+> > -`notmuch-json-read' will return the compound's elements.\r
+> > +beginning of a compound, it moves point past the token that opens\r
+> > +the compound and returns t.  Later calls to `notmuch-json-read'\r
+> > +will return the compound's elements.\r
+> >  \r
+> >  Entering JSON objects is current unimplemented."\r
+> >  \r
+> > @@ -423,7 +424,8 @@ Entering JSON objects is current unimplemented."\r
+> >  Returns 'retry if there is insufficient input to parse a complete\r
+> >  JSON value.  If the parser is currently inside a compound value\r
+> >  and the next token ends the list or object, returns 'end.\r
+> > -Otherwise, returns the value."\r
+> > +Otherwise, moves point to just past the end of the value and\r
+> > +returns the value."\r
+> \r
+> I think that point can move when 'retry is returned (past terminators\r
+> and commas for example). It might also be worth saying that it returns\r
+> the next value passing command and terminators and whitespace after\r
+> point.\r
+\r
+How about\r
+\r
+Returns 'retry if there is insufficient input to parse a complete JSON\r
+value (though it may still move point over separators or whitespace).\r
+If the parser is currently inside a compound value and the next token\r
+ends the list or object, this moves point just past the terminator and\r
+returns 'end.  Otherwise, this moves point to just past the end of the\r
+value and returns the value.\r
+\r
+?\r
+\r
+> >  \r
+> >    (with-current-buffer (notmuch-json-buffer jp)\r
+> >      (or\r
+> > @@ -474,11 +476,22 @@ Otherwise, returns the value."\r
+> >           (notmuch-json-partial-pos jp) nil\r
+> >           (notmuch-json-partial-state jp) nil)\r
+> >     ;; Parse the value\r
+> > -   (let* ((json-object-type 'plist)\r
+> > -          (json-array-type 'list)\r
+> > -          (json-false nil))\r
+> > +   (let ((json-object-type 'plist)\r
+> > +         (json-array-type 'list)\r
+> > +         (json-false nil))\r
+> >       (json-read)))))))\r
+> >  \r
+> > +(defun notmuch-json-eof (jp)\r
+> > +  "Signal a json-error if there is more input in JP's buffer.\r
+> \r
+> Would `data' be better than `input' (to distinguish allowed whitespace\r
+> from disallowed data)?\r
+\r
+Ah, yes.\r
+\r
+  "Signal a json-error if there is more data in JP's buffer.\r
+\r
+Moves point to the beginning of any trailing data or to the end\r
+of the buffer if there is only trailing whitespace."\r
+\r
+?\r
+\r
+> > +Moves point to the beginning of any trailing garbage or to the\r
+> > +end of the buffer if there is no trailing garbage."\r
+> > +\r
+> > +  (with-current-buffer (notmuch-json-buffer jp)\r
+> > +    (skip-chars-forward " \t\r\n")\r
+> > +    (unless (eobp)\r
+> > +      (signal 'json-error (list "Trailing garbage following JSON data")))))\r
+> > +\r
+> >  (provide 'notmuch-lib)\r
+> >  \r
+> >  ;; Local Variables:\r
+> > diff --git a/emacs/notmuch.el b/emacs/notmuch.el\r
+> > index 2a09a98..fabb7c0 100644\r
+> > --- a/emacs/notmuch.el\r
+> > +++ b/emacs/notmuch.el\r
+> > @@ -702,28 +702,29 @@ non-authors is found, assume that all of the authors match."\r
+> >      (overlay-put overlay 'isearch-open-invisible #'delete-overlay)))\r
+> >        (insert padding))))\r
+> >  \r
+> > -(defun notmuch-search-insert-field (field format result)\r
+> > +(defun notmuch-search-insert-field (field format-string result)\r
+> >    (cond\r
+> >     ((string-equal field "date")\r
+> > -    (insert (propertize (format format (plist-get result :date_relative))\r
+> > +    (insert (propertize (format format-string (plist-get result :date_relative))\r
+> >                    'face 'notmuch-search-date)))\r
+> >     ((string-equal field "count")\r
+> > -    (insert (propertize (format format (format "[%s/%s]"\r
+> > -                                         (plist-get result :matched)\r
+> > -                                         (plist-get result :total)))\r
+> > +    (insert (propertize (format format-string\r
+> > +                          (format "[%s/%s]" (plist-get result :matched)\r
+> > +                                  (plist-get result :total)))\r
+> >                    'face 'notmuch-search-count)))\r
+> >     ((string-equal field "subject")\r
+> > -    (insert (propertize (format format (plist-get result :subject))\r
+> > +    (insert (propertize (format format-string (plist-get result :subject))\r
+> >                    'face 'notmuch-search-subject)))\r
+> >  \r
+> >     ((string-equal field "authors")\r
+> > -    (notmuch-search-insert-authors format (plist-get result :authors)))\r
+> > +    (notmuch-search-insert-authors format-string (plist-get result :authors)))\r
+> >  \r
+> >     ((string-equal field "tags")\r
+> > -    (insert\r
+> > -     (format format (propertize\r
+> > -               (mapconcat 'identity (plist-get result :tags) " ")\r
+> > -               'font-lock-face 'notmuch-tag-face))))))\r
+> > +    ;; Ignore format-string here because notmuch-search-set-tags\r
+> > +    ;; depends on the format of this\r
+> > +    (insert (concat "(" (propertize\r
+> > +                   (mapconcat 'identity (plist-get result :tags) " ")\r
+> > +                   'font-lock-face 'notmuch-tag-face) ")")))))\r
+> >  \r
+> >  (defun notmuch-search-show-result (result)\r
+> >    ;; Ignore excluded matches\r
+> > @@ -731,8 +732,8 @@ non-authors is found, assume that all of the authors match."\r
+> >      (let ((beg (point-max)))\r
+> >        (save-excursion\r
+> >    (goto-char beg)\r
+> > -  (dolist (format notmuch-search-result-format)\r
+> > -    (notmuch-search-insert-field (car format) (cdr format) result))\r
+> > +  (dolist (spec notmuch-search-result-format)\r
+> > +    (notmuch-search-insert-field (car spec) (cdr spec) result))\r
+> >    (insert "\n")\r
+> >    (notmuch-search-color-line beg (point) (plist-get result :tags))\r
+> >    (put-text-property beg (point) 'notmuch-search-thread-id\r
+> > @@ -790,11 +791,8 @@ non-authors is found, assume that all of the authors match."\r
+> >                 (otherwise (notmuch-search-show-result result)))))\r
+> >            ((end)\r
+> >             ;; Any trailing data is unexpected\r
+> > -           (with-current-buffer parse-buf\r
+> > -             (skip-chars-forward " \t\r\n")\r
+> > -             (if (eobp)\r
+> > -                 (setq done t)\r
+> > -               (signal 'json-error nil)))))\r
+> > +           (notmuch-json-eof notmuch-search-json-parser)\r
+> > +           (setq done t)))\r
+> \r
+> I think this used to only set `done' if there was not trailing data but\r
+> now does so anyway?\r
+\r
+It still won't set done if there's trailing data because\r
+notmuch-json-eof will signal an error, which will unwind to the\r
+condition-case (which will then consume said trailing data and done\r
+will get set on the next time through the loop).\r
+\r
+> Best wishes\r
+> \r
+> Mark\r
+> \r
+> >        (json-error\r
+> >         ;; Do our best to resynchronize and ensure forward\r
+> >         ;; progress\r