* src/matcher.[ch]
[claws.git] / src / matcher.h
1 /*
2  * Sylpheed -- a GTK+ based, lightweight, and fast e-mail client
3  * Copyright (C) 2002 by the Sylpheed Claws 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 2 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, write to the Free Software
17  * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
18  */
19
20 #ifndef MATCHER_H
21
22 #define MATCHER_H
23
24 #include <sys/types.h>
25 #include <regex.h>
26 #include <glib.h>
27 #include "procmsg.h"
28
29 struct _MatcherProp {
30         int matchtype;
31         int criteria;
32         gchar * header;
33         gchar * expr;
34         int value;
35         regex_t * preg;
36         int error;
37         gboolean result;
38 };
39
40 typedef struct _MatcherProp MatcherProp;
41
42 struct _MatcherList {
43         GSList * matchers;
44         gboolean bool_and;
45 };
46
47 typedef struct _MatcherList MatcherList;
48
49
50 enum {
51         /* match */
52         MATCHCRITERIA_ALL,
53         MATCHCRITERIA_UNREAD, MATCHCRITERIA_NOT_UNREAD,
54         MATCHCRITERIA_NEW, MATCHCRITERIA_NOT_NEW,
55         MATCHCRITERIA_MARKED, MATCHCRITERIA_NOT_MARKED,
56         MATCHCRITERIA_DELETED, MATCHCRITERIA_NOT_DELETED,
57         MATCHCRITERIA_REPLIED, MATCHCRITERIA_NOT_REPLIED,
58         MATCHCRITERIA_FORWARDED, MATCHCRITERIA_NOT_FORWARDED,
59         MATCHCRITERIA_LOCKED, MATCHCRITERIA_NOT_LOCKED,
60         MATCHCRITERIA_SUBJECT, MATCHCRITERIA_NOT_SUBJECT,
61         MATCHCRITERIA_FROM, MATCHCRITERIA_NOT_FROM,
62         MATCHCRITERIA_TO, MATCHCRITERIA_NOT_TO,
63         MATCHCRITERIA_CC, MATCHCRITERIA_NOT_CC,
64         MATCHCRITERIA_TO_OR_CC, MATCHCRITERIA_NOT_TO_AND_NOT_CC,
65         MATCHCRITERIA_AGE_GREATER, MATCHCRITERIA_AGE_LOWER,
66         MATCHCRITERIA_NEWSGROUPS, MATCHCRITERIA_NOT_NEWSGROUPS,
67         MATCHCRITERIA_INREPLYTO, MATCHCRITERIA_NOT_INREPLYTO,
68         MATCHCRITERIA_REFERENCES, MATCHCRITERIA_NOT_REFERENCES,
69         MATCHCRITERIA_SCORE_GREATER, MATCHCRITERIA_SCORE_LOWER,
70         MATCHCRITERIA_HEADER, MATCHCRITERIA_NOT_HEADER,
71         MATCHCRITERIA_HEADERS_PART, MATCHCRITERIA_NOT_HEADERS_PART,
72         MATCHCRITERIA_MESSAGE, MATCHCRITERIA_NOT_MESSAGE,
73         MATCHCRITERIA_BODY_PART, MATCHCRITERIA_NOT_BODY_PART,
74         MATCHCRITERIA_EXECUTE, MATCHCRITERIA_NOT_EXECUTE,
75         MATCHCRITERIA_SCORE_EQUAL,
76         MATCHCRITERIA_SIZE_GREATER, 
77         MATCHCRITERIA_SIZE_SMALLER,
78         MATCHCRITERIA_SIZE_EQUAL,
79         /* match type */
80         MATCHTYPE_MATCHCASE,
81         MATCHTYPE_MATCH,
82         MATCHTYPE_REGEXPCASE,
83         MATCHTYPE_REGEXP,
84         /* actions */
85         MATCHACTION_SCORE,
86         MATCHACTION_EXECUTE,
87         MATCHACTION_MOVE,
88         MATCHACTION_COPY,
89         MATCHACTION_DELETE,
90         MATCHACTION_MARK,
91         MATCHACTION_UNMARK,
92         MATCHACTION_MARK_AS_READ,
93         MATCHACTION_MARK_AS_UNREAD,
94         MATCHACTION_FORWARD,
95         MATCHACTION_FORWARD_AS_ATTACHMENT,
96         MATCHACTION_COLOR,
97         MATCHACTION_REDIRECT,
98         MATCHACTION_DELETE_ON_SERVER,
99         /* boolean operations */
100         MATCHERBOOL_OR,
101         MATCHERBOOL_AND,
102 };
103
104 gchar * get_matchparser_tab_str(gint id);
105 MatcherProp * matcherprop_new(gint criteria, gchar * header,
106                               gint matchtype, gchar * expr,
107                               int age);
108
109 MatcherProp * matcherprop_unquote_new(gint criteria, gchar * header,
110     gint matchtype, gchar * expr,
111     int value);
112
113 void matcherprop_free(MatcherProp * prop);
114 MatcherProp * matcherprop_parse(gchar ** str);
115
116 MatcherProp * matcherprop_copy(MatcherProp *src);
117
118 gboolean matcherprop_match(MatcherProp * prop, MsgInfo * info);
119
120 MatcherList * matcherlist_new(GSList * matchers, gboolean bool_and);
121 void matcherlist_free(MatcherList * cond);
122 MatcherList * matcherlist_parse(gchar ** str);
123
124 gboolean matcherlist_match(MatcherList * cond, MsgInfo * info);
125
126 gint matcher_parse_keyword(gchar ** str);
127 gint matcher_parse_number(gchar ** str);
128 gboolean matcher_parse_boolean_op(gchar ** str);
129 gchar * matcher_parse_regexp(gchar ** str);
130 gchar * matcher_parse_str(gchar ** str);
131 gchar * matcher_escape_str(const gchar *str);
132 gchar * matcher_unescape_str(gchar *str);
133 gchar * matcherprop_to_string(MatcherProp * matcher);
134 gchar * matcherlist_to_string(MatcherList * matchers);
135 gchar * matching_build_command(gchar * cmd, MsgInfo * info);
136
137
138 void prefs_matcher_read_config(void);
139 void prefs_matcher_write_config(void);
140
141
142 #endif