add 'Selective download'
[claws.git] / src / matcher.h
1 #ifndef MATCHER_H
2
3 #define MATCHER_H
4
5 #include <sys/types.h>
6 #include <regex.h>
7 #include <glib.h>
8 #include "procmsg.h"
9
10 struct _MatcherProp {
11         int matchtype;
12         int criteria;
13         gchar * header;
14         gchar * unesc_header;           /* cache unescaped header... */
15         gchar * expr;
16         gchar * unesc_expr;             /* cache unescaped expression... */
17         int value;
18         regex_t * preg;
19         int error;
20         gboolean result;
21 };
22
23 typedef struct _MatcherProp MatcherProp;
24
25 struct _MatcherList {
26         GSList * matchers;
27         gboolean bool_and;
28 };
29
30 typedef struct _MatcherList MatcherList;
31
32
33 enum {
34         /* match */
35         MATCHCRITERIA_ALL,
36         MATCHCRITERIA_UNREAD, MATCHCRITERIA_NOT_UNREAD,
37         MATCHCRITERIA_NEW, MATCHCRITERIA_NOT_NEW,
38         MATCHCRITERIA_MARKED, MATCHCRITERIA_NOT_MARKED,
39         MATCHCRITERIA_DELETED, MATCHCRITERIA_NOT_DELETED,
40         MATCHCRITERIA_REPLIED, MATCHCRITERIA_NOT_REPLIED,
41         MATCHCRITERIA_FORWARDED, MATCHCRITERIA_NOT_FORWARDED,
42         MATCHCRITERIA_SUBJECT, MATCHCRITERIA_NOT_SUBJECT,
43         MATCHCRITERIA_FROM, MATCHCRITERIA_NOT_FROM,
44         MATCHCRITERIA_TO, MATCHCRITERIA_NOT_TO,
45         MATCHCRITERIA_CC, MATCHCRITERIA_NOT_CC,
46         MATCHCRITERIA_TO_OR_CC, MATCHCRITERIA_NOT_TO_AND_NOT_CC,
47         MATCHCRITERIA_AGE_GREATER, MATCHCRITERIA_AGE_LOWER,
48         MATCHCRITERIA_NEWSGROUPS, MATCHCRITERIA_NOT_NEWSGROUPS,
49         MATCHCRITERIA_INREPLYTO, MATCHCRITERIA_NOT_INREPLYTO,
50         MATCHCRITERIA_REFERENCES, MATCHCRITERIA_NOT_REFERENCES,
51         MATCHCRITERIA_SCORE_GREATER, MATCHCRITERIA_SCORE_LOWER,
52         MATCHCRITERIA_HEADER, MATCHCRITERIA_NOT_HEADER,
53         MATCHCRITERIA_HEADERS_PART, MATCHCRITERIA_NOT_HEADERS_PART,
54         MATCHCRITERIA_MESSAGE, MATCHCRITERIA_NOT_MESSAGE,
55         MATCHCRITERIA_BODY_PART, MATCHCRITERIA_NOT_BODY_PART,
56         MATCHCRITERIA_EXECUTE, MATCHCRITERIA_NOT_EXECUTE,
57         MATCHCRITERIA_SCORE_EQUAL,
58         /* match type */
59         MATCHTYPE_MATCHCASE,
60         MATCHTYPE_MATCH,
61         MATCHTYPE_REGEXPCASE,
62         MATCHTYPE_REGEXP,
63         /* actions */
64         MATCHACTION_SCORE,
65         MATCHACTION_EXECUTE,
66         MATCHACTION_MOVE,
67         MATCHACTION_COPY,
68         MATCHACTION_DELETE,
69         MATCHACTION_MARK,
70         MATCHACTION_UNMARK,
71         MATCHACTION_MARK_AS_READ,
72         MATCHACTION_MARK_AS_UNREAD,
73         MATCHACTION_FORWARD,
74         MATCHACTION_FORWARD_AS_ATTACHMENT,
75         MATCHACTION_COLOR,
76         MATCHACTION_BOUNCE,
77         MATCHACTION_DELETE_ON_SERVER,
78         /* boolean operations */
79         MATCHERBOOL_OR,
80         MATCHERBOOL_AND,
81 };
82
83 gchar * get_matchparser_tab_str(gint id);
84 MatcherProp * matcherprop_new(gint criteria, gchar * header,
85                               gint matchtype, gchar * expr,
86                               int age);
87 void matcherprop_free(MatcherProp * prop);
88 MatcherProp * matcherprop_parse(gchar ** str);
89
90 gboolean matcherprop_match(MatcherProp * prop, MsgInfo * info);
91
92 MatcherList * matcherlist_new(GSList * matchers, gboolean bool_and);
93 void matcherlist_free(MatcherList * cond);
94 MatcherList * matcherlist_parse(gchar ** str);
95
96 gboolean matcherlist_match(MatcherList * cond, MsgInfo * info);
97
98 gint matcher_parse_keyword(gchar ** str);
99 gint matcher_parse_number(gchar ** str);
100 gboolean matcher_parse_boolean_op(gchar ** str);
101 gchar * matcher_parse_regexp(gchar ** str);
102 gchar * matcher_parse_str(gchar ** str);
103 gchar * matcher_unescape_str(gchar *str);
104 gchar * matcherprop_to_string(MatcherProp * matcher);
105 gchar * matcherlist_to_string(MatcherList * matchers);
106 gchar * matching_build_command(gchar * cmd, MsgInfo * info);
107
108
109 void prefs_matcher_read_config(void);
110 void prefs_matcher_write_config(void);
111
112
113 #endif