v2 of libconfig, date:foo, and named query patches
authorDavid Bremner <david@tethera.net>
Sat, 26 Mar 2016 17:57:10 +0000 (14:57 +2100)
committerW. Trevor King <wking@tremily.us>
Sat, 20 Aug 2016 23:21:24 +0000 (16:21 -0700)
3f/bf52185adb6db67f845a45ee1ac7866f9ce02a [new file with mode: 0644]

diff --git a/3f/bf52185adb6db67f845a45ee1ac7866f9ce02a b/3f/bf52185adb6db67f845a45ee1ac7866f9ce02a
new file mode 100644 (file)
index 0000000..ace2399
--- /dev/null
@@ -0,0 +1,217 @@
+Return-Path: <bremner@tesseract.cs.unb.ca>\r
+X-Original-To: notmuch@notmuchmail.org\r
+Delivered-To: notmuch@notmuchmail.org\r
+Received: from localhost (localhost [127.0.0.1])\r
+ by arlo.cworth.org (Postfix) with ESMTP id C9D196DE0318\r
+ for <notmuch@notmuchmail.org>; Sat, 26 Mar 2016 11:25:25 -0700 (PDT)\r
+X-Virus-Scanned: Debian amavisd-new at cworth.org\r
+X-Spam-Flag: NO\r
+X-Spam-Score: -0.02\r
+X-Spam-Level: \r
+X-Spam-Status: No, score=-0.02 tagged_above=-999 required=5 tests=[AWL=-0.021,\r
+  HEADER_FROM_DIFFERENT_DOMAINS=0.001] autolearn=disabled\r
+Received: from arlo.cworth.org ([127.0.0.1])\r
+ by localhost (arlo.cworth.org [127.0.0.1]) (amavisd-new, port 10024)\r
+ with ESMTP id VOy9ZL2fMUgJ for <notmuch@notmuchmail.org>;\r
+ Sat, 26 Mar 2016 11:25:18 -0700 (PDT)\r
+Received: from fethera.tethera.net (fethera.tethera.net [198.245.60.197])\r
+ by arlo.cworth.org (Postfix) with ESMTPS id 364606DE0319\r
+ for <notmuch@notmuchmail.org>; Sat, 26 Mar 2016 11:23:27 -0700 (PDT)\r
+Received: from remotemail by fethera.tethera.net with local (Exim 4.84)\r
+ (envelope-from <bremner@tesseract.cs.unb.ca>) id 1ajsTM-0000tz-DD\r
+ for notmuch@notmuchmail.org; Sat, 26 Mar 2016 13:58:04 -0400\r
+Received: (nullmailer pid 8801 invoked by uid 1000);\r
+ Sat, 26 Mar 2016 17:57:27 -0000\r
+From: David Bremner <david@tethera.net>\r
+To: notmuch@notmuchmail.org\r
+Subject: v2 of libconfig, date:foo, and named query patches\r
+Date: Sat, 26 Mar 2016 14:57:10 -0300\r
+Message-Id: <1459015043-8460-1-git-send-email-david@tethera.net>\r
+X-Mailer: git-send-email 2.6.4\r
+X-BeenThere: notmuch@notmuchmail.org\r
+X-Mailman-Version: 2.1.20\r
+Precedence: list\r
+List-Id: "Use and development of the notmuch mail system."\r
+ <notmuch.notmuchmail.org>\r
+List-Unsubscribe: <https://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: <https://notmuchmail.org/mailman/listinfo/notmuch>,\r
+ <mailto:notmuch-request@notmuchmail.org?subject=subscribe>\r
+X-List-Received-Date: Sat, 26 Mar 2016 18:25:25 -0000\r
+\r
+Sorry for the long series, but there is a lot of moving parts here.  This obsoletes\r
+\r
+      id:1458644094-13951-1-git-send-email-david@tethera.net\r
+\r
+Since that series, the only code changes are a fix for the visibility\r
+warning (see the bottom of the interdiff), essentially mimic more\r
+closely Jani's date time range parser code. There are also a bunch of added docs.  I have no doubt there are improvements that could be made here, but I fixed all of the things I knew about (and I was sure was problems).\r
+\r
+Patch 1 could be useful independently of the rest of the series, since\r
+allows compiling with xapian 1.3 out of the box.\r
+\r
+diff --git a/doc/man1/notmuch-config.rst b/doc/man1/notmuch-config.rst\r
+index 98b3c1a..c3470a8 100644\r
+--- a/doc/man1/notmuch-config.rst\r
++++ b/doc/man1/notmuch-config.rst\r
+@@ -132,6 +132,12 @@ The available configuration items are described below.\r
+     \r
+         Default: ``gpg``.\r
\r
++    **options.<name>**\r
++\r
++      Compile time option <name>. Current possibilities include\r
++      "compact" (see **notmuch-compact(1)**)\r
++      and "field_processor" (see **notmuch-search-terms(7)**).\r
++\r
+     **query.<name>**\r
\r
+         Expansion for named query called <name>. See\r
+diff --git a/doc/man1/notmuch-dump.rst b/doc/man1/notmuch-dump.rst\r
+index a37c337..eda9e07 100644\r
+--- a/doc/man1/notmuch-dump.rst\r
++++ b/doc/man1/notmuch-dump.rst\r
+@@ -71,6 +71,23 @@ Supported options for **dump** include\r
+             characters. Note also that tags with spaces will not be\r
+             correctly restored with this format.\r
\r
++    ``--include=(config|tags)``\r
++\r
++    Control what kind of metadata is included in the output.\r
++\r
++      **config**\r
++\r
++      Output configuration data stored in the database. Each line\r
++      starts with "#@ ", followed by a space seperated key-value\r
++      pair.  Both key and value are hex encoded if needed.\r
++\r
++      **tags**\r
++\r
++      Output per-message metadata, namely tags. See *format* above\r
++      for description of the output.\r
++\r
++      The default is to include both tags and configuration information\r
++\r
+     ``--output=``\ <filename>\r
+         Write output to given file instead of stdout.\r
\r
+diff --git a/doc/man1/notmuch-restore.rst b/doc/man1/notmuch-restore.rst\r
+index 362e262..87fa22e 100644\r
+--- a/doc/man1/notmuch-restore.rst\r
++++ b/doc/man1/notmuch-restore.rst\r
+@@ -50,6 +50,24 @@ Supported options for **restore** include\r
+             format, this heuristic, based the fact that batch-tag format\r
+             contains no parentheses, should be accurate.\r
\r
++    ``--include=(config|tags)``\r
++\r
++      Control what kind of metadata is restored.\r
++\r
++      **config**\r
++\r
++        Restore configuration data to the database. Each configuration line starts\r
++        with "#@ ", followed by a space seperated key-value pair.\r
++        Both key and value are hex encoded if needed.\r
++\r
++      **tags**\r
++\r
++        Output per-message metadata, namely tags. See *format* above\r
++        for more details.\r
++\r
++      The default is to restore both tags and configuration\r
++      information\r
++\r
+     ``--input=``\ <filename>\r
+         Read input from given file instead of stdin.\r
\r
+diff --git a/doc/man7/notmuch-search-terms.rst b/doc/man7/notmuch-search-terms.rst\r
+index 2fbc16d..7474f53 100644\r
+--- a/doc/man7/notmuch-search-terms.rst\r
++++ b/doc/man7/notmuch-search-terms.rst\r
+@@ -56,6 +56,8 @@ indicate user-supplied values):\r
\r
+ -  lastmod:<initial-revision>..<final-revision>\r
\r
++-  query:<name>\r
++\r
+ The **from:** prefix is used to match the name or address of the sender\r
+ of an email message.\r
\r
+@@ -132,6 +134,11 @@ were added/removed or filenames changed).  This is usually used in\r
+ conjunction with the **--uuid** argument to **notmuch search**\r
+ to find messages that have changed since an earlier query.\r
\r
++The **query:** prefix allows queries to refer to previously saved\r
++queries added with **notmuch-config(1)**. Named queries are only\r
++available if notmuch is built with **Xapian Field Processors** (see\r
++below).\r
++\r
+ Operators\r
+ ---------\r
\r
+@@ -281,9 +288,10 @@ matches from the beginning of January to the end of February.\r
+ date:<expr>..! can be used as a shorthand for date:<expr>..<expr>. The\r
+ expansion takes place before interpretation, and thus, for example,\r
+ date:monday..! matches from the beginning of Monday until the end of\r
+-Monday. (Note that entering date:<expr> without "..", for example\r
+-date:yesterday, won't work, as it's not interpreted as a range\r
+-expression at all. Again, use date:yesterday..!)\r
++Monday.\r
++With **Xapian Field Processor** support (see below), non-range\r
++date queries such as date:yesterday will work, but otherwise\r
++will give unexpected results; if in doubt use date:yesterday..!\r
\r
+ Currently, we do not support spaces in range expressions. You can\r
+ replace the spaces with '\_', or (in most cases) '-', or (in some cases)\r
+@@ -370,6 +378,22 @@ Time zones\r
\r
+ Some time zone codes, e.g. UTC, EET.\r
\r
++XAPIAN FIELD PROCESSORS\r
++=======================\r
++\r
++Certain optional features of the notmuch query processor rely on the\r
++presence of the Xapian field processor API. You can determine if your\r
++notmuch was built against a sufficiently recent version of Xapian by running\r
++\r
++::\r
++\r
++  % notmuch config get options.field_processor\r
++\r
++Currently the following features require field processor support:\r
++\r
++- non-range date queries, e.g. "date:today"\r
++- named queries e.g. "query:my_special_query"\r
++\r
+ SEE ALSO\r
+ ========\r
\r
+diff --git a/lib/database-private.h b/lib/database-private.h\r
+index f7c6f46..5ab4001 100644\r
+--- a/lib/database-private.h\r
++++ b/lib/database-private.h\r
+@@ -148,10 +148,6 @@ operator&=(_notmuch_features &a, _notmuch_features b)\r
+                                   Xapian::QueryParser::FLAG_LOVEHATE | Xapian::QueryParser::FLAG_BOOLEAN_ANY_CASE | \\r
+                                   Xapian::QueryParser::FLAG_WILDCARD | Xapian::QueryParser::FLAG_PURE_NOT)\r
\r
+-#if HAVE_XAPIAN_FIELD_PROCESSOR\r
+-class DateFieldProcessor;\r
+-class QueryFieldProcessor;\r
+-#endif\r
+ struct _notmuch_database {\r
+     notmuch_bool_t exception_reported;\r
\r
+@@ -185,8 +181,8 @@ struct _notmuch_database {\r
+     Xapian::ValueRangeProcessor *value_range_processor;\r
+     Xapian::ValueRangeProcessor *date_range_processor;\r
+ #if HAVE_XAPIAN_FIELD_PROCESSOR\r
+-    DateFieldProcessor *date_field_processor;\r
+-    QueryFieldProcessor *query_field_processor;\r
++    Xapian::FieldProcessor *date_field_processor;\r
++    Xapian::FieldProcessor *query_field_processor;\r
+ #endif\r
+     Xapian::ValueRangeProcessor *last_mod_range_processor;\r
+ };\r