2007-07-27 [paul] 2.10.0cvs74
[claws.git] / src / matcher.h
1 /*
2  * Sylpheed -- a GTK+ based, lightweight, and fast e-mail client
3  * Copyright (C) 2002 by the Claws Mail Team and Hiroyuki Yamamoto
4  *
5  * This program is free software; you can redistribute it and/or modify
6  * it under the terms of the GNU General Public License as published by
7  * the Free Software Foundation; either version 3 of the License, or
8  * (at your option) any later version.
9  *
10  * This program is distributed in the hope that it will be useful,
11  * but WITHOUT ANY WARRANTY; without even the implied warranty of
12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
13  * GNU General Public License for more details.
14  *
15  * You should have received a copy of the GNU General Public License
16  * along with this program. If not, see <http://www.gnu.org/licenses/>.
17  * 
18  */
19
20 #ifndef MATCHER_H
21 #define MATCHER_H
22
23 #include <sys/types.h>
24 #include <regex.h>
25 #include <glib.h>
26 #include "procmsg.h"
27
28 /* constants generated by yacc */
29 #if !defined(YYBISON) && !defined(MATCHER_ALL)
30 #       include "matcher_parser_lex.h"
31 #       include "matcher_parser_parse.h"
32 #endif
33
34 struct _MatcherProp {
35         int matchtype;
36         int criteria;
37         gchar *header;
38         gchar *expr;
39         int value;
40         regex_t *preg;
41         int error;
42         gboolean result;
43         gboolean done;
44 };
45
46 typedef struct _MatcherProp MatcherProp;
47
48 struct _MatcherList {
49         GSList *matchers;
50         gboolean bool_and;
51 };
52
53 typedef struct _MatcherList MatcherList;
54
55
56 /* map MATCHCRITERIA_ to yacc's MATCHER_ */
57 #define MC_(name) \
58         MATCHCRITERIA_ ## name = MATCHER_ ## name
59
60 /* map MATCHTYPE_ to yacc's MATCHER_ */
61 #define MT_(name) \
62         MATCHTYPE_ ## name = MATCHER_ ## name
63
64 /* map MATCHACTION_ to yacc's MATCHER_ */
65 #define MA_(name) \
66         MATCHACTION_ ## name = MATCHER_ ## name
67
68 /* map MATCHBOOL_ to yacc's MATCHER_ */
69 #define MB_(name) \
70         MATCHERBOOL_ ## name = MATCHER_ ## name
71
72 enum {
73         /* match */
74         MC_(ALL),
75         MC_(UNREAD), MC_(NOT_UNREAD),
76         MC_(NEW), MC_(NOT_NEW),
77         MC_(MARKED), MC_(NOT_MARKED),
78         MC_(DELETED), MC_(NOT_DELETED),
79         MC_(REPLIED), MC_(NOT_REPLIED),
80         MC_(FORWARDED), MC_(NOT_FORWARDED),
81         MC_(LOCKED), MC_(NOT_LOCKED),
82         MC_(SPAM),MC_(NOT_SPAM),
83         MC_(PARTIAL), MC_(NOT_PARTIAL),
84         MC_(COLORLABEL), MC_(NOT_COLORLABEL),
85         MC_(IGNORE_THREAD), MC_(NOT_IGNORE_THREAD),
86         MC_(WATCH_THREAD), MC_(NOT_WATCH_THREAD),
87         MC_(SUBJECT), MC_(NOT_SUBJECT),
88         MC_(FROM), MC_(NOT_FROM),
89         MC_(TO), MC_(NOT_TO),
90         MC_(CC), MC_(NOT_CC),
91         MC_(TO_OR_CC), MC_(NOT_TO_AND_NOT_CC),
92         MC_(AGE_GREATER), MC_(AGE_LOWER),
93         MC_(NEWSGROUPS), MC_(NOT_NEWSGROUPS),
94         MC_(INREPLYTO), MC_(NOT_INREPLYTO),
95         MC_(REFERENCES), MC_(NOT_REFERENCES),
96         MC_(SCORE_GREATER), MC_(SCORE_LOWER),
97         MC_(HEADER), MC_(NOT_HEADER),
98         MC_(HEADERS_PART), MC_(NOT_HEADERS_PART),
99         MC_(MESSAGE), MC_(NOT_MESSAGE),
100         MC_(BODY_PART), MC_(NOT_BODY_PART),
101         MC_(TEST), MC_(NOT_TEST),
102         MC_(SCORE_EQUAL),
103         MC_(SIZE_GREATER), 
104         MC_(SIZE_SMALLER),
105         MC_(SIZE_EQUAL),
106         MC_(FOUND_IN_ADDRESSBOOK),MC_(NOT_FOUND_IN_ADDRESSBOOK),
107         MC_(TAG),MC_(NOT_TAG),
108         MC_(TAGGED),MC_(NOT_TAGGED),
109
110         /* match type */
111         MT_(MATCHCASE),
112         MT_(MATCH),
113         MT_(REGEXPCASE),
114         MT_(REGEXP),
115         /* actions */
116         MA_(SCORE),
117         MA_(EXECUTE),
118         MA_(MOVE),
119         MA_(COPY),
120         MA_(DELETE),
121         MA_(MARK),
122         MA_(UNMARK),
123         MA_(LOCK),
124         MA_(UNLOCK),
125         MA_(MARK_AS_READ),
126         MA_(MARK_AS_UNREAD),
127         MA_(MARK_AS_SPAM),
128         MA_(MARK_AS_HAM),
129         MA_(FORWARD),
130         MA_(FORWARD_AS_ATTACHMENT),
131         MA_(COLOR),
132         MA_(REDIRECT),
133         MA_(CHANGE_SCORE),
134         MA_(SET_SCORE),
135         MA_(STOP),
136         MA_(HIDE),
137         MA_(IGNORE),
138         MA_(WATCH),
139         MA_(ADD_TO_ADDRESSBOOK),
140         MA_(SET_TAG),
141         MA_(UNSET_TAG),
142         MA_(CLEAR_TAGS),
143         /* boolean operations */
144         MB_(OR),
145         MB_(AND)
146 };
147
148 const gchar *get_matchparser_tab_str    (gint id);
149 gint get_matchparser_tab_id             (const gchar *str); 
150
151 MatcherProp *matcherprop_new            (gint            criteria, 
152                                          const gchar    *header,
153                                          gint            matchtype, 
154                                          const gchar    *expr,
155                                          int             value);
156 void matcherprop_free                   (MatcherProp *prop);
157
158 MatcherProp *matcherprop_parse          (gchar  **str);
159
160 MatcherProp *matcherprop_copy           (const MatcherProp *src);
161
162 gboolean matcherprop_match              (MatcherProp    *prop, 
163                                          MsgInfo        *info);
164
165 MatcherList * matcherlist_new           (GSList         *matchers, 
166                                          gboolean       bool_and);
167 void matcherlist_free                   (MatcherList    *cond);
168
169 MatcherList *matcherlist_parse          (gchar          **str);
170
171 gboolean matcherlist_match              (MatcherList    *cond, 
172                                          MsgInfo        *info);
173
174 gint matcher_parse_keyword              (gchar          **str);
175 gint matcher_parse_number               (gchar          **str);
176 gboolean matcher_parse_boolean_op       (gchar          **str);
177 gchar *matcher_parse_regexp             (gchar          **str);
178 gchar *matcher_parse_str                (gchar          **str);
179 gchar *matcherprop_to_string            (MatcherProp    *matcher);
180 gchar *matcherlist_to_string            (const MatcherList      *matchers);
181 gchar *matching_build_command           (const gchar    *cmd, 
182                                          MsgInfo        *info);
183
184 void prefs_matcher_read_config          (void);
185 void prefs_matcher_write_config         (void);
186
187 gchar * matcher_quote_str(const gchar * src);
188
189 #endif