summaryrefslogtreecommitdiffstats
path: root/src/rulequery.h
diff options
context:
space:
mode:
authorDanilo M. <danix@danix.xyz>2026-08-13 11:00:07 +0200
committerDanilo M. <danix@danix.xyz>2026-08-13 11:00:07 +0200
commita3651eac1528a2b90cfb8e26934facf856ae3531 (patch)
treef356ae6eba375590b74b040d6ce904180cb9cf01 /src/rulequery.h
parentdf6461fa9136f2110c8a24567a3e4a32432a9476 (diff)
downloadqtmaildir-a3651eac1528a2b90cfb8e26934facf856ae3531.tar.gz
qtmaildir-a3651eac1528a2b90cfb8e26934facf856ae3531.zip
feat(rulequery): compile a single term
Diffstat (limited to 'src/rulequery.h')
-rw-r--r--src/rulequery.h65
1 files changed, 65 insertions, 0 deletions
diff --git a/src/rulequery.h b/src/rulequery.h
new file mode 100644
index 0000000..9d487d2
--- /dev/null
+++ b/src/rulequery.h
@@ -0,0 +1,65 @@
+/*
+ * qtmaildir - a Qt6 mail client for notmuch-indexed Maildirs
+ * Copyright (C) 2026 Danilo M. <danix@danix.xyz>
+ *
+ * This program is free software; you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License version 2 as
+ * published by the Free Software Foundation.
+ *
+ * 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, write to the Free Software
+ * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
+ */
+
+#pragma once
+
+#include <QList>
+#include <QString>
+
+/// One row in the builder: a field, an operator, and a value.
+struct RuleTerm
+{
+ enum Field { From, To, Cc, Subject, Tag, Folder, Attachment, Date };
+
+ enum Op {
+ Contains, ContainsNot, ///< Unquoted term, optionally negated.
+ Is, IsNot, ///< Quoted phrase, optionally negated.
+ Has, HasNot, ///< attachment: only.
+ Before, After ///< date: only. "not before" is "after", so
+ ///< these carry no negated twin.
+ };
+
+ Field field = From;
+ Op op = Contains;
+ QString value;
+};
+
+bool operator==(const RuleTerm &a, const RuleTerm &b);
+
+/// A tagging rule's query, as rows.
+///
+/// The STRING is the stored format, shared with mailctl and executed by the
+/// notmuch post-new hook. This type is a view over it, never the store: a
+/// query it cannot represent must still open, save and run unchanged.
+struct RuleQuery
+{
+ enum Join { All, Any }; ///< and / or, over the positive terms only.
+
+ Join join = All;
+ QList<RuleTerm> terms; ///< Positive section.
+ QList<RuleTerm> exclusions; ///< The "but not" block, joined `and not`.
+
+ /// False when the query cannot be shown as rows. NOT an error and NOT a
+ /// claim that the query is invalid: the rule opens in text mode.
+ bool parsed = false;
+
+ static RuleQuery parse(const QString &query);
+ QString compile() const;
+};
+
+bool operator==(const RuleQuery &a, const RuleQuery &b);