notmuch/lib/parse-time-vrp.h
Jani Nikula 90cd1bac4e lib: add date range query support
Add a custom value range processor to enable date and time searches of
the form date:since..until, where "since" and "until" are expressions
understood by the previously added date/time parser, to restrict the
results to messages within a particular time range (based on the Date:
header).

If "since" or "until" describes date/time at an accuracy of days or
less, the values are rounded according to the accuracy, towards past
for "since" and towards future for "until". For example,
date:november..yesterday would match from the beginning of November
until the end of yesterday. Expressions such as date:today..today
means since the beginning of today until the end of today.

Open-ended ranges are supported (since Xapian 1.2.1), i.e. you can
specify date:..until or date:since.. to not limit the start or end
date, respectively.

CAVEATS:

Xapian does not support spaces in range expressions. You can replace
the spaces with '_', or (in most cases) '-', or (in some cases) leave
the spaces out altogether.

Entering date:expr without ".." (for example date:yesterday) will not
work as you might expect. You can achieve the expected result by
duplicating the expr both sides of ".." (for example
date:yesterday..yesterday).

Open-ended ranges won't work with pre-1.2.1 Xapian, but they don't
produce an error either.

Signed-off-by: Jani Nikula <jani@nikula.org>
2012-10-31 16:55:32 -03:00

40 lines
1.3 KiB
C++

/* parse-time-vrp.h - date range query glue
*
* This file is part of notmuch.
*
* Copyright © 2012 Jani Nikula
*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation, either version 3 of the License, or
* (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program. If not, see http://www.gnu.org/licenses/ .
*
* Author: Jani Nikula <jani@nikula.org>
*/
#ifndef NOTMUCH_PARSE_TIME_VRP_H
#define NOTMUCH_PARSE_TIME_VRP_H
#include <xapian.h>
/* see *ValueRangeProcessor in xapian-core/include/xapian/queryparser.h */
class ParseTimeValueRangeProcessor : public Xapian::ValueRangeProcessor {
protected:
Xapian::valueno valno;
public:
ParseTimeValueRangeProcessor (Xapian::valueno slot_)
: valno(slot_) { }
Xapian::valueno operator() (std::string &begin, std::string &end);
};
#endif /* NOTMUCH_PARSE_TIME_VRP_H */